4916c7370126376a81736f922a60c52707695208
[WebKit-https.git] / Source / WebCore / xml / XPathStep.cpp
1 /*
2  * Copyright (C) 2005 Frerich Raabe <raabe@kde.org>
3  * Copyright (C) 2006, 2009 Apple Inc. All rights reserved.
4  * Copyright (C) 2007 Alexey Proskuryakov <ap@webkit.org>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27
28 #include "config.h"
29 #include "XPathStep.h"
30
31 #include "Attr.h"
32 #include "Document.h"
33 #include "HTMLElement.h"
34 #include "NodeTraversal.h"
35 #include "XMLNSNames.h"
36 #include "XPathParser.h"
37 #include "XPathUtil.h"
38
39 namespace WebCore {
40 namespace XPath {
41
42 Step::Step(Axis axis, NodeTest nodeTest)
43     : m_axis(axis)
44     , m_nodeTest(WTF::move(nodeTest))
45 {
46 }
47
48 Step::Step(Axis axis, NodeTest nodeTest, Vector<std::unique_ptr<Expression>> predicates)
49     : m_axis(axis)
50     , m_nodeTest(WTF::move(nodeTest))
51     , m_predicates(WTF::move(predicates))
52 {
53 }
54
55 Step::~Step()
56 {
57 }
58
59 void Step::optimize()
60 {
61     // Evaluate predicates as part of node test if possible to avoid building unnecessary NodeSets.
62     // E.g., there is no need to build a set of all "foo" nodes to evaluate "foo[@bar]", we can check the predicate while enumerating.
63     // This optimization can be applied to predicates that are not context node list sensitive, or to first predicate that is only context position sensitive, e.g. foo[position() mod 2 = 0].
64     Vector<std::unique_ptr<Expression>> remainingPredicates;
65     for (size_t i = 0; i < m_predicates.size(); ++i) {
66         auto& predicate = m_predicates[i];
67         if ((!predicateIsContextPositionSensitive(*predicate) || m_nodeTest.m_mergedPredicates.isEmpty()) && !predicate->isContextSizeSensitive() && remainingPredicates.isEmpty())
68             m_nodeTest.m_mergedPredicates.append(WTF::move(predicate));
69         else
70             remainingPredicates.append(WTF::move(predicate));
71     }
72     m_predicates = WTF::move(remainingPredicates);
73 }
74
75 void optimizeStepPair(Step& first, Step& second, bool& dropSecondStep)
76 {
77     dropSecondStep = false;
78
79     if (first.m_axis != Step::DescendantOrSelfAxis)
80         return;
81
82     if (first.m_nodeTest.m_kind != Step::NodeTest::AnyNodeTest)
83         return;
84
85     if (!first.m_predicates.isEmpty())
86         return;
87
88     if (!first.m_nodeTest.m_mergedPredicates.isEmpty())
89         return;
90
91     ASSERT(first.m_nodeTest.m_data.isEmpty());
92     ASSERT(first.m_nodeTest.m_namespaceURI.isEmpty());
93
94     // Optimize the common case of "//" AKA /descendant-or-self::node()/child::NodeTest to /descendant::NodeTest.
95     if (second.m_axis != Step::ChildAxis)
96         return;
97
98     if (!second.predicatesAreContextListInsensitive())
99         return;
100
101     first.m_axis = Step::DescendantAxis;
102     first.m_nodeTest = WTF::move(second.m_nodeTest);
103     first.m_predicates = WTF::move(second.m_predicates);
104     first.optimize();
105     dropSecondStep = true;
106 }
107
108 bool Step::predicatesAreContextListInsensitive() const
109 {
110     for (size_t i = 0; i < m_predicates.size(); ++i) {
111         auto& predicate = *m_predicates[i];
112         if (predicateIsContextPositionSensitive(predicate) || predicate.isContextSizeSensitive())
113             return false;
114     }
115
116     for (size_t i = 0; i < m_nodeTest.m_mergedPredicates.size(); ++i) {
117         auto& predicate = *m_nodeTest.m_mergedPredicates[i];
118         if (predicateIsContextPositionSensitive(predicate) || predicate.isContextSizeSensitive())
119             return false;
120     }
121
122     return true;
123 }
124
125 void Step::evaluate(Node& context, NodeSet& nodes) const
126 {
127     EvaluationContext& evaluationContext = Expression::evaluationContext();
128     evaluationContext.position = 0;
129
130     nodesInAxis(context, nodes);
131
132     // Check predicates that couldn't be merged into node test.
133     for (unsigned i = 0; i < m_predicates.size(); i++) {
134         auto& predicate = *m_predicates[i];
135
136         NodeSet newNodes;
137         if (!nodes.isSorted())
138             newNodes.markSorted(false);
139
140         for (unsigned j = 0; j < nodes.size(); j++) {
141             Node* node = nodes[j];
142
143             evaluationContext.node = node;
144             evaluationContext.size = nodes.size();
145             evaluationContext.position = j + 1;
146             if (evaluatePredicate(predicate))
147                 newNodes.append(node);
148         }
149
150         nodes = WTF::move(newNodes);
151     }
152 }
153
154 #if !ASSERT_DISABLED
155 static inline Node::NodeType primaryNodeType(Step::Axis axis)
156 {
157     switch (axis) {
158         case Step::AttributeAxis:
159             return Node::ATTRIBUTE_NODE;
160         case Step::NamespaceAxis:
161             return Node::XPATH_NAMESPACE_NODE;
162         default:
163             return Node::ELEMENT_NODE;
164     }
165 }
166 #endif
167
168 // Evaluate NodeTest without considering merged predicates.
169 inline bool nodeMatchesBasicTest(Node& node, Step::Axis axis, const Step::NodeTest& nodeTest)
170 {
171     switch (nodeTest.m_kind) {
172         case Step::NodeTest::TextNodeTest:
173             return node.nodeType() == Node::TEXT_NODE || node.nodeType() == Node::CDATA_SECTION_NODE;
174         case Step::NodeTest::CommentNodeTest:
175             return node.nodeType() == Node::COMMENT_NODE;
176         case Step::NodeTest::ProcessingInstructionNodeTest: {
177             const AtomicString& name = nodeTest.m_data;
178             return node.nodeType() == Node::PROCESSING_INSTRUCTION_NODE && (name.isEmpty() || node.nodeName() == name);
179         }
180         case Step::NodeTest::AnyNodeTest:
181             return true;
182         case Step::NodeTest::NameTest: {
183             const AtomicString& name = nodeTest.m_data;
184             const AtomicString& namespaceURI = nodeTest.m_namespaceURI;
185
186             if (axis == Step::AttributeAxis) {
187                 ASSERT(node.isAttributeNode());
188
189                 // In XPath land, namespace nodes are not accessible on the attribute axis.
190                 if (node.namespaceURI() == XMLNSNames::xmlnsNamespaceURI)
191                     return false;
192
193                 if (name == starAtom)
194                     return namespaceURI.isEmpty() || node.namespaceURI() == namespaceURI;
195
196                 return node.localName() == name && node.namespaceURI() == namespaceURI;
197             }
198
199             // Node test on the namespace axis is not implemented yet, the caller has a check for it.
200             ASSERT(axis != Step::NamespaceAxis);
201
202             // For other axes, the principal node type is element.
203             ASSERT(primaryNodeType(axis) == Node::ELEMENT_NODE);
204             if (!node.isElementNode())
205                 return false;
206
207             if (name == starAtom)
208                 return namespaceURI.isEmpty() || namespaceURI == node.namespaceURI();
209
210             if (node.document().isHTMLDocument()) {
211                 if (is<HTMLElement>(node)) {
212                     // Paths without namespaces should match HTML elements in HTML documents despite those having an XHTML namespace. Names are compared case-insensitively.
213                     return equalIgnoringCase(downcast<HTMLElement>(node).localName(), name) && (namespaceURI.isNull() || namespaceURI == node.namespaceURI());
214                 }
215                 // An expression without any prefix shouldn't match no-namespace nodes (because HTML5 says so).
216                 return toElement(node).hasLocalName(name) && namespaceURI == node.namespaceURI() && !namespaceURI.isNull();
217             }
218             return toElement(node).hasLocalName(name) && namespaceURI == node.namespaceURI();
219         }
220     }
221     ASSERT_NOT_REACHED();
222     return false;
223 }
224
225 inline bool nodeMatches(Node& node, Step::Axis axis, const Step::NodeTest& nodeTest)
226 {
227     if (!nodeMatchesBasicTest(node, axis, nodeTest))
228         return false;
229
230     EvaluationContext& evaluationContext = Expression::evaluationContext();
231
232     // Only the first merged predicate may depend on position.
233     ++evaluationContext.position;
234
235     auto& mergedPredicates = nodeTest.m_mergedPredicates;
236     for (unsigned i = 0; i < mergedPredicates.size(); i++) {
237         // No need to set context size - we only get here when evaluating predicates that do not depend on it.
238         evaluationContext.node = &node;
239         if (!evaluatePredicate(*mergedPredicates[i]))
240             return false;
241     }
242
243     return true;
244 }
245
246 // Result nodes are ordered in axis order. Node test (including merged predicates) is applied.
247 void Step::nodesInAxis(Node& context, NodeSet& nodes) const
248 {
249     ASSERT(nodes.isEmpty());
250     switch (m_axis) {
251         case ChildAxis:
252             if (context.isAttributeNode()) // In XPath model, attribute nodes do not have children.
253                 return;
254             for (Node* node = context.firstChild(); node; node = node->nextSibling()) {
255                 if (nodeMatches(*node, ChildAxis, m_nodeTest))
256                     nodes.append(node);
257             }
258             return;
259         case DescendantAxis:
260             if (context.isAttributeNode()) // In XPath model, attribute nodes do not have children.
261                 return;
262             for (Node* node = context.firstChild(); node; node = NodeTraversal::next(node, &context)) {
263                 if (nodeMatches(*node, DescendantAxis, m_nodeTest))
264                     nodes.append(node);
265             }
266             return;
267         case ParentAxis:
268             if (context.isAttributeNode()) {
269                 Element* node = static_cast<Attr&>(context).ownerElement();
270                 if (nodeMatches(*node, ParentAxis, m_nodeTest))
271                     nodes.append(node);
272             } else {
273                 ContainerNode* node = context.parentNode();
274                 if (node && nodeMatches(*node, ParentAxis, m_nodeTest))
275                     nodes.append(node);
276             }
277             return;
278         case AncestorAxis: {
279             Node* node = &context;
280             if (context.isAttributeNode()) {
281                 node = static_cast<Attr&>(context).ownerElement();
282                 if (nodeMatches(*node, AncestorAxis, m_nodeTest))
283                     nodes.append(node);
284             }
285             for (node = node->parentNode(); node; node = node->parentNode()) {
286                 if (nodeMatches(*node, AncestorAxis, m_nodeTest))
287                     nodes.append(node);
288             }
289             nodes.markSorted(false);
290             return;
291         }
292         case FollowingSiblingAxis:
293             if (context.nodeType() == Node::ATTRIBUTE_NODE || context.nodeType() == Node::XPATH_NAMESPACE_NODE)
294                 return;
295             for (Node* node = context.nextSibling(); node; node = node->nextSibling()) {
296                 if (nodeMatches(*node, FollowingSiblingAxis, m_nodeTest))
297                     nodes.append(node);
298             }
299             return;
300         case PrecedingSiblingAxis:
301             if (context.nodeType() == Node::ATTRIBUTE_NODE || context.nodeType() == Node::XPATH_NAMESPACE_NODE)
302                 return;
303             for (Node* node = context.previousSibling(); node; node = node->previousSibling()) {
304                 if (nodeMatches(*node, PrecedingSiblingAxis, m_nodeTest))
305                     nodes.append(node);
306             }
307             nodes.markSorted(false);
308             return;
309         case FollowingAxis:
310             if (context.isAttributeNode()) {
311                 Node* node = static_cast<Attr&>(context).ownerElement();
312                 while ((node = NodeTraversal::next(node))) {
313                     if (nodeMatches(*node, FollowingAxis, m_nodeTest))
314                         nodes.append(node);
315                 }
316             } else {
317                 for (Node* parent = &context; !isRootDomNode(parent); parent = parent->parentNode()) {
318                     for (Node* node = parent->nextSibling(); node; node = node->nextSibling()) {
319                         if (nodeMatches(*node, FollowingAxis, m_nodeTest))
320                             nodes.append(node);
321                         for (Node* child = node->firstChild(); child; child = NodeTraversal::next(child, node)) {
322                             if (nodeMatches(*child, FollowingAxis, m_nodeTest))
323                                 nodes.append(child);
324                         }
325                     }
326                 }
327             }
328             return;
329         case PrecedingAxis: {
330             Node* node;
331             if (context.isAttributeNode())
332                 node = static_cast<Attr&>(context).ownerElement();
333             else
334                 node = &context;
335             while (ContainerNode* parent = node->parentNode()) {
336                 for (node = NodeTraversal::previous(node); node != parent; node = NodeTraversal::previous(node)) {
337                     if (nodeMatches(*node, PrecedingAxis, m_nodeTest))
338                         nodes.append(node);
339                 }
340                 node = parent;
341             }
342             nodes.markSorted(false);
343             return;
344         }
345         case AttributeAxis: {
346             if (!context.isElementNode())
347                 return;
348
349             Element& contextElement = toElement(context);
350
351             // Avoid lazily creating attribute nodes for attributes that we do not need anyway.
352             if (m_nodeTest.m_kind == NodeTest::NameTest && m_nodeTest.m_data != starAtom) {
353                 RefPtr<Attr> attr = contextElement.getAttributeNodeNS(m_nodeTest.m_namespaceURI, m_nodeTest.m_data);
354                 if (attr && attr->namespaceURI() != XMLNSNames::xmlnsNamespaceURI) { // In XPath land, namespace nodes are not accessible on the attribute axis.
355                     if (nodeMatches(*attr, AttributeAxis, m_nodeTest)) // Still need to check merged predicates.
356                         nodes.append(attr.release());
357                 }
358                 return;
359             }
360             
361             if (!contextElement.hasAttributes())
362                 return;
363
364             for (const Attribute& attribute : contextElement.attributesIterator()) {
365                 RefPtr<Attr> attr = contextElement.ensureAttr(attribute.name());
366                 if (nodeMatches(*attr, AttributeAxis, m_nodeTest))
367                     nodes.append(attr.release());
368             }
369             return;
370         }
371         case NamespaceAxis:
372             // XPath namespace nodes are not implemented yet.
373             return;
374         case SelfAxis:
375             if (nodeMatches(context, SelfAxis, m_nodeTest))
376                 nodes.append(&context);
377             return;
378         case DescendantOrSelfAxis:
379             if (nodeMatches(context, DescendantOrSelfAxis, m_nodeTest))
380                 nodes.append(&context);
381             if (context.isAttributeNode()) // In XPath model, attribute nodes do not have children.
382                 return;
383             for (Node* node = context.firstChild(); node; node = NodeTraversal::next(node, &context)) {
384                 if (nodeMatches(*node, DescendantOrSelfAxis, m_nodeTest))
385                     nodes.append(node);
386             }
387             return;
388         case AncestorOrSelfAxis: {
389             if (nodeMatches(context, AncestorOrSelfAxis, m_nodeTest))
390                 nodes.append(&context);
391             Node* node = &context;
392             if (context.isAttributeNode()) {
393                 node = static_cast<Attr&>(context).ownerElement();
394                 if (nodeMatches(*node, AncestorOrSelfAxis, m_nodeTest))
395                     nodes.append(node);
396             }
397             for (node = node->parentNode(); node; node = node->parentNode()) {
398                 if (nodeMatches(*node, AncestorOrSelfAxis, m_nodeTest))
399                     nodes.append(node);
400             }
401             nodes.markSorted(false);
402             return;
403         }
404     }
405     ASSERT_NOT_REACHED();
406 }
407
408 }
409 }