Default value for createNodeIterator() / createTreeWalker()'s whatToShow parameter...
[WebKit-https.git] / Source / WebCore / dom / NodeIterator.cpp
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  * Copyright (C) 2000 Frederik Holljen (frederik.holljen@hig.no)
4  * Copyright (C) 2001 Peter Kelly (pmk@post.com)
5  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
6  * Copyright (C) 2004, 2008 Apple Inc. All rights reserved.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #include "config.h"
26 #include "NodeIterator.h"
27
28 #include "Document.h"
29 #include "ExceptionCode.h"
30 #include "NodeTraversal.h"
31
32 #include <runtime/JSCJSValueInlines.h>
33
34 namespace WebCore {
35
36 NodeIterator::NodePointer::NodePointer()
37 {
38 }
39
40 NodeIterator::NodePointer::NodePointer(PassRefPtr<Node> n, bool b)
41     : node(n)
42     , isPointerBeforeNode(b)
43 {
44 }
45
46 void NodeIterator::NodePointer::clear()
47 {
48     node = nullptr;
49 }
50
51 bool NodeIterator::NodePointer::moveToNext(Node* root)
52 {
53     if (!node)
54         return false;
55     if (isPointerBeforeNode) {
56         isPointerBeforeNode = false;
57         return true;
58     }
59     node = NodeTraversal::next(*node, root);
60     return node;
61 }
62
63 bool NodeIterator::NodePointer::moveToPrevious(Node* root)
64 {
65     if (!node)
66         return false;
67     if (!isPointerBeforeNode) {
68         isPointerBeforeNode = true;
69         return true;
70     }
71     if (node == root) {
72         node = nullptr;
73         return false;
74     }
75     node = NodeTraversal::previous(*node);
76     return node;
77 }
78
79 NodeIterator::NodeIterator(PassRefPtr<Node> rootNode, unsigned long whatToShow, PassRefPtr<NodeFilter> filter, bool expandEntityReferences)
80     : NodeIteratorBase(rootNode, whatToShow, filter, expandEntityReferences)
81     , m_referenceNode(root(), true)
82     , m_detached(false)
83 {
84     root()->document().attachNodeIterator(this);
85 }
86
87 NodeIterator::~NodeIterator()
88 {
89     root()->document().detachNodeIterator(this);
90 }
91
92 PassRefPtr<Node> NodeIterator::nextNode(JSC::ExecState* state, ExceptionCode& ec)
93 {
94     if (m_detached) {
95         ec = INVALID_STATE_ERR;
96         return 0;
97     }
98
99     RefPtr<Node> result;
100
101     m_candidateNode = m_referenceNode;
102     while (m_candidateNode.moveToNext(root())) {
103         // NodeIterators treat the DOM tree as a flat list of nodes.
104         // In other words, FILTER_REJECT does not pass over descendants
105         // of the rejected node. Hence, FILTER_REJECT is the same as FILTER_SKIP.
106         RefPtr<Node> provisionalResult = m_candidateNode.node;
107         bool nodeWasAccepted = acceptNode(state, provisionalResult.get()) == NodeFilter::FILTER_ACCEPT;
108         if (state && state->hadException())
109             break;
110         if (nodeWasAccepted) {
111             m_referenceNode = m_candidateNode;
112             result = provisionalResult.release();
113             break;
114         }
115     }
116
117     m_candidateNode.clear();
118     return result.release();
119 }
120
121 PassRefPtr<Node> NodeIterator::previousNode(JSC::ExecState* state, ExceptionCode& ec)
122 {
123     if (m_detached) {
124         ec = INVALID_STATE_ERR;
125         return 0;
126     }
127
128     RefPtr<Node> result;
129
130     m_candidateNode = m_referenceNode;
131     while (m_candidateNode.moveToPrevious(root())) {
132         // NodeIterators treat the DOM tree as a flat list of nodes.
133         // In other words, FILTER_REJECT does not pass over descendants
134         // of the rejected node. Hence, FILTER_REJECT is the same as FILTER_SKIP.
135         RefPtr<Node> provisionalResult = m_candidateNode.node;
136         bool nodeWasAccepted = acceptNode(state, provisionalResult.get()) == NodeFilter::FILTER_ACCEPT;
137         if (state && state->hadException())
138             break;
139         if (nodeWasAccepted) {
140             m_referenceNode = m_candidateNode;
141             result = provisionalResult.release();
142             break;
143         }
144     }
145
146     m_candidateNode.clear();
147     return result.release();
148 }
149
150 void NodeIterator::detach()
151 {
152     root()->document().detachNodeIterator(this);
153     m_detached = true;
154     m_referenceNode.node = nullptr;
155 }
156
157 void NodeIterator::nodeWillBeRemoved(Node& removedNode)
158 {
159     updateForNodeRemoval(removedNode, m_candidateNode);
160     updateForNodeRemoval(removedNode, m_referenceNode);
161 }
162
163 void NodeIterator::updateForNodeRemoval(Node& removedNode, NodePointer& referenceNode) const
164 {
165     ASSERT(!m_detached);
166     ASSERT(&root()->document() == &removedNode.document());
167
168     // Iterator is not affected if the removed node is the reference node and is the root.
169     // or if removed node is not the reference node, or the ancestor of the reference node.
170     if (!removedNode.isDescendantOf(root()))
171         return;
172     bool willRemoveReferenceNode = &removedNode == referenceNode.node;
173     bool willRemoveReferenceNodeAncestor = referenceNode.node && referenceNode.node->isDescendantOf(&removedNode);
174     if (!willRemoveReferenceNode && !willRemoveReferenceNodeAncestor)
175         return;
176
177     if (referenceNode.isPointerBeforeNode) {
178         Node* node = NodeTraversal::next(removedNode, root());
179         if (node) {
180             // Move out from under the node being removed if the new reference
181             // node is a descendant of the node being removed.
182             while (node && node->isDescendantOf(&removedNode))
183                 node = NodeTraversal::next(*node, root());
184             if (node)
185                 referenceNode.node = node;
186         } else {
187             node = NodeTraversal::previous(removedNode);
188             if (node) {
189                 // Move out from under the node being removed if the reference node is
190                 // a descendant of the node being removed.
191                 if (willRemoveReferenceNodeAncestor) {
192                     while (node && node->isDescendantOf(&removedNode))
193                         node = NodeTraversal::previous(*node);
194                 }
195                 if (node) {
196                     // Removing last node.
197                     // Need to move the pointer after the node preceding the 
198                     // new reference node.
199                     referenceNode.node = node;
200                     referenceNode.isPointerBeforeNode = false;
201                 }
202             }
203         }
204     } else {
205         Node* node = NodeTraversal::previous(removedNode);
206         if (node) {
207             // Move out from under the node being removed if the reference node is
208             // a descendant of the node being removed.
209             if (willRemoveReferenceNodeAncestor) {
210                 while (node && node->isDescendantOf(&removedNode))
211                     node = NodeTraversal::previous(*node);
212             }
213             if (node)
214                 referenceNode.node = node;
215         } else {
216             // FIXME: This branch doesn't appear to have any LayoutTests.
217             node = NodeTraversal::next(removedNode, root());
218             // Move out from under the node being removed if the reference node is
219             // a descendant of the node being removed.
220             if (willRemoveReferenceNodeAncestor) {
221                 while (node && node->isDescendantOf(&removedNode))
222                     node = NodeTraversal::previous(*node);
223             }
224             if (node)
225                 referenceNode.node = node;
226         }
227     }
228 }
229
230
231 } // namespace WebCore