src/third_party/WebKit/Source/core/dom/NodeRenderingTraversal.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 NodeRenderingTraversal_h
  28 #define NodeRenderingTraversal_h
  29
  30 #include "core/dom/Element.h"
  31
  32 namespace blink {
  33
  34 class InsertionPoint;
  35 class RenderObject;
  36
  37 namespace NodeRenderingTraversal {
  38
  39 class ParentDetails {
  40 public:
  41     ParentDetails()
  42         : m_insertionPoint(0)
  43     { }
  44
  45     const InsertionPoint* insertionPoint() const { return m_insertionPoint; }
  46
  47     void didTraverseInsertionPoint(const InsertionPoint*);
  48
  49     bool operator==(const ParentDetails& other)
  50     {
  51         return m_insertionPoint == other.m_insertionPoint;
  52     }
  53
  54 private:
  55     const InsertionPoint* m_insertionPoint;
  56 };
  57
  58 ContainerNode* parent(const Node*, ParentDetails* = 0);
  59 bool contains(const ContainerNode*, const Node*);
  60 Node* firstChild(const Node*);
  61 Node* nextSibling(const Node*);
  62 Node* previousSibling(const Node*);
  63 Node* previous(const Node*, const Node* stayWithin);
  64 Node* next(const Node*, const Node* stayWithin);
  65 RenderObject* nextSiblingRenderer(const Node*);
  66 RenderObject* previousSiblingRenderer(const Node*);
  67 RenderObject* nextInTopLayer(const Element*);
  68
  69 inline Element* parentElement(const Node* node)
  70 {
  71     ContainerNode* found = parent(node);
  72     return found && found->isElementNode() ? toElement(found) : 0;
  73 }
  74
  75 }
  76
  77 } // namespace blink
  78
  79 #endif