third_party/WebKit/Source/core/dom/LayoutTreeBuilderTraversal.h

   1 /*
   2  * Copyright (C) 2012 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Neither the name of Google Inc. nor the names of its
  11  * contributors may be used to endorse or promote products derived from
  12  * this software without specific prior written permission.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  15  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  16  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  17  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  18  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  19  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  20  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef LayoutTreeBuilderTraversal_h
  28 #define LayoutTreeBuilderTraversal_h
  29
  30 #include "core/CoreExport.h"
  31 #include "core/dom/Element.h"
  32
  33 namespace blink {
  34
  35 class InsertionPoint;
  36 class LayoutObject;
  37
  38 namespace LayoutTreeBuilderTraversal {
  39
  40 class ParentDetails {
  41     STACK_ALLOCATED();
  42 public:
  43     ParentDetails()
  44         : m_insertionPoint(nullptr)
  45     { }
  46
  47     const InsertionPoint* insertionPoint() const { return m_insertionPoint; }
  48
  49     void didTraverseInsertionPoint(const InsertionPoint*);
  50
  51     bool operator==(const ParentDetails& other)
  52     {
  53         return m_insertionPoint == other.m_insertionPoint;
  54     }
  55
  56 private:
  57     RawPtrWillBeMember<const InsertionPoint> m_insertionPoint;
  58 };
  59
  60 CORE_EXPORT ContainerNode* parent(const Node&, ParentDetails* = 0);
  61 CORE_EXPORT Node* firstChild(const Node&);
  62 CORE_EXPORT Node* nextSibling(const Node&);
  63 Node* previousSibling(const Node&);
  64 Node* previous(const Node&, const Node* stayWithin);
  65 Node* next(const Node&, const Node* stayWithin);
  66 Node* nextSkippingChildren(const Node&, const Node* stayWithin);
  67 LayoutObject* nextSiblingLayoutObject(const Node&);
  68 LayoutObject* previousSiblingLayoutObject(const Node&);
  69 LayoutObject* nextInTopLayer(const Element&);
  70
  71 inline Element* parentElement(const Node& node)
  72 {
  73     ContainerNode* found = parent(node);
  74     return found && found->isElementNode() ? toElement(found) : 0;
  75 }
  76
  77 }
  78
  79 } // namespace blink
  80
  81 #endif