Fix the !(ENABLE(SHADOW_DOM) || ENABLE(DETAILS_ELEMENT)) after r196281
[WebKit-https.git] / Source / WebCore / dom / ComposedTreeIterator.h
1 /*
2  * Copyright (C) 2015-2016 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "ElementAndTextDescendantIterator.h"
27 #include "ShadowRoot.h"
28
29 #ifndef ComposedTreeIterator_h
30 #define ComposedTreeIterator_h
31
32 namespace WebCore {
33
34 class HTMLSlotElement;
35
36 class ComposedTreeIterator {
37 public:
38     ComposedTreeIterator();
39     ComposedTreeIterator(ContainerNode& root);
40     ComposedTreeIterator(ContainerNode& root, Node& current);
41
42     Node& operator*() { return current(); }
43     Node* operator->() { return &current(); }
44
45     bool operator==(const ComposedTreeIterator& other) const { return context().iterator == other.context().iterator; }
46     bool operator!=(const ComposedTreeIterator& other) const { return context().iterator != other.context().iterator; }
47
48     ComposedTreeIterator& operator++() { return traverseNext(); }
49
50     ComposedTreeIterator& traverseNext();
51     ComposedTreeIterator& traverseNextSkippingChildren();
52     ComposedTreeIterator& traverseNextSibling();
53     ComposedTreeIterator& traversePreviousSibling();
54
55     unsigned depth() const;
56
57 private:
58     void initializeContextStack(ContainerNode& root, Node& current);
59     void traverseNextInShadowTree();
60     void traverseNextLeavingContext();
61     bool pushContext(ShadowRoot&);
62 #if ENABLE(SHADOW_DOM) || ENABLE(DETAILS_ELEMENT)
63     bool advanceInSlot(int direction);
64     void traverseSiblingInSlot(int direction);
65 #endif
66
67     struct Context {
68         Context() { }
69         explicit Context(ContainerNode& root)
70             : iterator(root)
71         { }
72         Context(ContainerNode& root, Node& node, size_t slotNodeIndex = notFound)
73             : iterator(root, &node)
74             , slotNodeIndex(slotNodeIndex)
75         { }
76
77         ElementAndTextDescendantIterator iterator;
78         size_t slotNodeIndex { notFound };
79     };
80     Context& context() { return m_contextStack.last(); }
81     const Context& context() const { return m_contextStack.last(); }
82     Node& current() { return *context().iterator; }
83
84     Vector<Context, 4> m_contextStack;
85 };
86
87 inline ComposedTreeIterator::ComposedTreeIterator()
88 {
89     m_contextStack.uncheckedAppend({ });
90 }
91
92 inline ComposedTreeIterator& ComposedTreeIterator::traverseNext()
93 {
94     if (auto* shadowRoot = context().iterator->shadowRoot()) {
95         if (pushContext(*shadowRoot))
96             return *this;
97     }
98
99     if (m_contextStack.size() > 1) {
100         traverseNextInShadowTree();
101         return *this;
102     }
103
104     context().iterator.traverseNext();
105     return *this;
106 }
107
108 inline ComposedTreeIterator& ComposedTreeIterator::traverseNextSkippingChildren()
109 {
110     context().iterator.traverseNextSkippingChildren();
111
112     if (!context().iterator && m_contextStack.size() > 1)
113         traverseNextLeavingContext();
114     
115     return *this;
116 }
117
118 inline ComposedTreeIterator& ComposedTreeIterator::traverseNextSibling()
119 {
120 #if ENABLE(SHADOW_DOM) || ENABLE(DETAILS_ELEMENT)
121     if (current().parentNode()->shadowRoot()) {
122         traverseSiblingInSlot(1);
123         return *this;
124     }
125 #endif
126     context().iterator.traverseNextSibling();
127     return *this;
128 }
129
130 inline ComposedTreeIterator& ComposedTreeIterator::traversePreviousSibling()
131 {
132 #if ENABLE(SHADOW_DOM) || ENABLE(DETAILS_ELEMENT)
133     if (current().parentNode()->shadowRoot()) {
134         traverseSiblingInSlot(-1);
135         return *this;
136     }
137 #endif
138     context().iterator.traversePreviousSibling();
139     return *this;
140 }
141
142 inline unsigned ComposedTreeIterator::depth() const
143 {
144     unsigned depth = 0;
145     for (auto& context : m_contextStack)
146         depth += context.iterator.depth();
147     return depth;
148 }
149
150 class ComposedTreeDescendantAdapter {
151 public:
152     ComposedTreeDescendantAdapter(ContainerNode& parent)
153         : m_parent(parent)
154     { }
155
156     ComposedTreeIterator begin() { return ComposedTreeIterator(m_parent); }
157     ComposedTreeIterator end() { return { }; }
158     ComposedTreeIterator at(const Node& child) { return ComposedTreeIterator(m_parent, const_cast<Node&>(child)); }
159     
160 private:
161     ContainerNode& m_parent;
162 };
163
164 class ComposedTreeChildAdapter {
165 public:
166     class Iterator : public ComposedTreeIterator {
167     public:
168         Iterator() = default;
169         explicit Iterator(ContainerNode& root)
170             : ComposedTreeIterator(root)
171         { }
172         Iterator(ContainerNode& root, Node& current)
173             : ComposedTreeIterator(root, current)
174         { }
175
176         Iterator& operator++() { return static_cast<Iterator&>(traverseNextSibling()); }
177         Iterator& operator--() { return static_cast<Iterator&>(traversePreviousSibling()); }
178     };
179
180     ComposedTreeChildAdapter(ContainerNode& parent)
181         : m_parent(parent)
182     { }
183
184     Iterator begin() { return Iterator(m_parent); }
185     Iterator end() { return { }; }
186     Iterator at(const Node& child) { return Iterator(m_parent, const_cast<Node&>(child)); }
187
188 private:
189     ContainerNode& m_parent;
190 };
191
192 // FIXME: We should have const versions too.
193 inline ComposedTreeDescendantAdapter composedTreeDescendants(ContainerNode& parent)
194 {
195     return ComposedTreeDescendantAdapter(parent);
196 }
197
198 inline ComposedTreeChildAdapter composedTreeChildren(ContainerNode& parent)
199 {
200     return ComposedTreeChildAdapter(parent);
201 }
202
203 }
204
205 #endif