Remove equalIgnoringCase since all callers really wanted equalIgnoringASCIICase
[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 "HTMLDocument.h"
34 #include "HTMLElement.h"
35 #include "NodeTraversal.h"
36 #include "XMLNSNames.h"
37 #include "XPathParser.h"
38 #include "XPathUtil.h"
39
40 namespace WebCore {
41 namespace XPath {
42
43 Step::Step(Axis axis, NodeTest nodeTest)
44     : m_axis(axis)
45     , m_nodeTest(WTFMove(nodeTest))
46 {
47 }
48
49 Step::Step(Axis axis, NodeTest nodeTest, Vector<std::unique_ptr<Expression>> predicates)
50     : m_axis(axis)
51     , m_nodeTest(WTFMove(nodeTest))
52     , m_predicates(WTFMove(predicates))
53 {
54 }
55
56 Step::~Step()
57 {
58 }
59
60 void Step::optimize()
61 {
62     // Evaluate predicates as part of node test if possible to avoid building unnecessary NodeSets.
63     // 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.
64     // 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].
65     Vector<std::unique_ptr<Expression>> remainingPredicates;
66     for (auto& predicate : m_predicates) {
67         if ((!predicateIsContextPositionSensitive(*predicate) || m_nodeTest.m_mergedPredicates.isEmpty()) && !predicate->isContextSizeSensitive() && remainingPredicates.isEmpty())
68             m_nodeTest.m_mergedPredicates.append(WTFMove(predicate));
69         else
70             remainingPredicates.append(WTFMove(predicate));
71     }
72     m_predicates = WTFMove(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 = WTFMove(second.m_nodeTest);
103     first.m_predicates = WTFMove(second.m_predicates);
104     first.optimize();
105     dropSecondStep = true;
106 }
107
108 bool Step::predicatesAreContextListInsensitive() const
109 {
110     for (auto& predicate : m_predicates) {
111         if (predicateIsContextPositionSensitive(*predicate) || predicate->isContextSizeSensitive())
112             return false;
113     }
114
115     for (auto& predicate : m_nodeTest.m_mergedPredicates) {
116         if (predicateIsContextPositionSensitive(*predicate) || predicate->isContextSizeSensitive())
117             return false;
118     }
119
120     return true;
121 }
122
123 void Step::evaluate(Node& context, NodeSet& nodes) const
124 {
125     EvaluationContext& evaluationContext = Expression::evaluationContext();
126     evaluationContext.position = 0;
127
128     nodesInAxis(context, nodes);
129
130     // Check predicates that couldn't be merged into node test.
131     for (auto& predicate : m_predicates) {
132         NodeSet newNodes;
133         if (!nodes.isSorted())
134             newNodes.markSorted(false);
135
136         for (unsigned j = 0; j < nodes.size(); j++) {
137             Node* node = nodes[j];
138
139             evaluationContext.node = node;
140             evaluationContext.size = nodes.size();
141             evaluationContext.position = j + 1;
142             if (evaluatePredicate(*predicate))
143                 newNodes.append(node);
144         }
145
146         nodes = WTFMove(newNodes);
147     }
148 }
149
150 #if !ASSERT_DISABLED
151 static inline Node::NodeType primaryNodeType(Step::Axis axis)
152 {
153     switch (axis) {
154         case Step::AttributeAxis:
155             return Node::ATTRIBUTE_NODE;
156         default:
157             return Node::ELEMENT_NODE;
158     }
159 }
160 #endif
161
162 // Evaluate NodeTest without considering merged predicates.
163 inline bool nodeMatchesBasicTest(Node& node, Step::Axis axis, const Step::NodeTest& nodeTest)
164 {
165     switch (nodeTest.m_kind) {
166         case Step::NodeTest::TextNodeTest:
167             return node.nodeType() == Node::TEXT_NODE || node.nodeType() == Node::CDATA_SECTION_NODE;
168         case Step::NodeTest::CommentNodeTest:
169             return node.nodeType() == Node::COMMENT_NODE;
170         case Step::NodeTest::ProcessingInstructionNodeTest: {
171             const AtomicString& name = nodeTest.m_data;
172             return node.nodeType() == Node::PROCESSING_INSTRUCTION_NODE && (name.isEmpty() || node.nodeName() == name);
173         }
174         case Step::NodeTest::AnyNodeTest:
175             return true;
176         case Step::NodeTest::NameTest: {
177             const AtomicString& name = nodeTest.m_data;
178             const AtomicString& namespaceURI = nodeTest.m_namespaceURI;
179
180             if (axis == Step::AttributeAxis) {
181                 ASSERT(node.isAttributeNode());
182
183                 // In XPath land, namespace nodes are not accessible on the attribute axis.
184                 if (node.namespaceURI() == XMLNSNames::xmlnsNamespaceURI)
185                     return false;
186
187                 if (name == starAtom)
188                     return namespaceURI.isEmpty() || node.namespaceURI() == namespaceURI;
189
190                 return node.localName() == name && node.namespaceURI() == namespaceURI;
191             }
192
193             // Node test on the namespace axis is not implemented yet, the caller has a check for it.
194             ASSERT(axis != Step::NamespaceAxis);
195
196             // For other axes, the principal node type is element.
197             ASSERT(primaryNodeType(axis) == Node::ELEMENT_NODE);
198             if (!is<Element>(node))
199                 return false;
200
201             if (name == starAtom)
202                 return namespaceURI.isEmpty() || namespaceURI == node.namespaceURI();
203
204             if (is<HTMLDocument>(node.document())) {
205                 if (is<HTMLElement>(node)) {
206                     // Paths without namespaces should match HTML elements in HTML documents despite those having an XHTML namespace. Names are compared case-insensitively.
207                     return equalIgnoringASCIICase(downcast<HTMLElement>(node).localName(), name) && (namespaceURI.isNull() || namespaceURI == node.namespaceURI());
208                 }
209                 // An expression without any prefix shouldn't match no-namespace nodes (because HTML5 says so).
210                 return downcast<Element>(node).hasLocalName(name) && namespaceURI == node.namespaceURI() && !namespaceURI.isNull();
211             }
212             return downcast<Element>(node).hasLocalName(name) && namespaceURI == node.namespaceURI();
213         }
214     }
215     ASSERT_NOT_REACHED();
216     return false;
217 }
218
219 inline bool nodeMatches(Node& node, Step::Axis axis, const Step::NodeTest& nodeTest)
220 {
221     if (!nodeMatchesBasicTest(node, axis, nodeTest))
222         return false;
223
224     EvaluationContext& evaluationContext = Expression::evaluationContext();
225
226     // Only the first merged predicate may depend on position.
227     ++evaluationContext.position;
228
229     for (auto& predicate : nodeTest.m_mergedPredicates) {
230         // No need to set context size - we only get here when evaluating predicates that do not depend on it.
231         evaluationContext.node = &node;
232         if (!evaluatePredicate(*predicate))
233             return false;
234     }
235
236     return true;
237 }
238
239 // Result nodes are ordered in axis order. Node test (including merged predicates) is applied.
240 void Step::nodesInAxis(Node& context, NodeSet& nodes) const
241 {
242     ASSERT(nodes.isEmpty());
243     switch (m_axis) {
244         case ChildAxis:
245             if (context.isAttributeNode()) // In XPath model, attribute nodes do not have children.
246                 return;
247             for (Node* node = context.firstChild(); node; node = node->nextSibling()) {
248                 if (nodeMatches(*node, ChildAxis, m_nodeTest))
249                     nodes.append(node);
250             }
251             return;
252         case DescendantAxis:
253             if (context.isAttributeNode()) // In XPath model, attribute nodes do not have children.
254                 return;
255             for (Node* node = context.firstChild(); node; node = NodeTraversal::next(*node, &context)) {
256                 if (nodeMatches(*node, DescendantAxis, m_nodeTest))
257                     nodes.append(node);
258             }
259             return;
260         case ParentAxis:
261             if (context.isAttributeNode()) {
262                 Element* node = static_cast<Attr&>(context).ownerElement();
263                 if (nodeMatches(*node, ParentAxis, m_nodeTest))
264                     nodes.append(node);
265             } else {
266                 ContainerNode* node = context.parentNode();
267                 if (node && nodeMatches(*node, ParentAxis, m_nodeTest))
268                     nodes.append(node);
269             }
270             return;
271         case AncestorAxis: {
272             Node* node = &context;
273             if (context.isAttributeNode()) {
274                 node = static_cast<Attr&>(context).ownerElement();
275                 if (nodeMatches(*node, AncestorAxis, m_nodeTest))
276                     nodes.append(node);
277             }
278             for (node = node->parentNode(); node; node = node->parentNode()) {
279                 if (nodeMatches(*node, AncestorAxis, m_nodeTest))
280                     nodes.append(node);
281             }
282             nodes.markSorted(false);
283             return;
284         }
285         case FollowingSiblingAxis:
286             if (context.isAttributeNode())
287                 return;
288             for (Node* node = context.nextSibling(); node; node = node->nextSibling()) {
289                 if (nodeMatches(*node, FollowingSiblingAxis, m_nodeTest))
290                     nodes.append(node);
291             }
292             return;
293         case PrecedingSiblingAxis:
294             if (context.isAttributeNode())
295                 return;
296             for (Node* node = context.previousSibling(); node; node = node->previousSibling()) {
297                 if (nodeMatches(*node, PrecedingSiblingAxis, m_nodeTest))
298                     nodes.append(node);
299             }
300             nodes.markSorted(false);
301             return;
302         case FollowingAxis:
303             if (context.isAttributeNode()) {
304                 Node* node = static_cast<Attr&>(context).ownerElement();
305                 while ((node = NodeTraversal::next(*node))) {
306                     if (nodeMatches(*node, FollowingAxis, m_nodeTest))
307                         nodes.append(node);
308                 }
309             } else {
310                 for (Node* parent = &context; !isRootDomNode(parent); parent = parent->parentNode()) {
311                     for (Node* node = parent->nextSibling(); node; node = node->nextSibling()) {
312                         if (nodeMatches(*node, FollowingAxis, m_nodeTest))
313                             nodes.append(node);
314                         for (Node* child = node->firstChild(); child; child = NodeTraversal::next(*child, node)) {
315                             if (nodeMatches(*child, FollowingAxis, m_nodeTest))
316                                 nodes.append(child);
317                         }
318                     }
319                 }
320             }
321             return;
322         case PrecedingAxis: {
323             Node* node;
324             if (context.isAttributeNode())
325                 node = static_cast<Attr&>(context).ownerElement();
326             else
327                 node = &context;
328             while (ContainerNode* parent = node->parentNode()) {
329                 for (node = NodeTraversal::previous(*node); node != parent; node = NodeTraversal::previous(*node)) {
330                     if (nodeMatches(*node, PrecedingAxis, m_nodeTest))
331                         nodes.append(node);
332                 }
333                 node = parent;
334             }
335             nodes.markSorted(false);
336             return;
337         }
338         case AttributeAxis: {
339             if (!is<Element>(context))
340                 return;
341
342             Element& contextElement = downcast<Element>(context);
343
344             // Avoid lazily creating attribute nodes for attributes that we do not need anyway.
345             if (m_nodeTest.m_kind == NodeTest::NameTest && m_nodeTest.m_data != starAtom) {
346                 RefPtr<Attr> attr = contextElement.getAttributeNodeNS(m_nodeTest.m_namespaceURI, m_nodeTest.m_data);
347                 if (attr && attr->namespaceURI() != XMLNSNames::xmlnsNamespaceURI) { // In XPath land, namespace nodes are not accessible on the attribute axis.
348                     if (nodeMatches(*attr, AttributeAxis, m_nodeTest)) // Still need to check merged predicates.
349                         nodes.append(attr.release());
350                 }
351                 return;
352             }
353             
354             if (!contextElement.hasAttributes())
355                 return;
356
357             for (const Attribute& attribute : contextElement.attributesIterator()) {
358                 RefPtr<Attr> attr = contextElement.ensureAttr(attribute.name());
359                 if (nodeMatches(*attr, AttributeAxis, m_nodeTest))
360                     nodes.append(attr.release());
361             }
362             return;
363         }
364         case NamespaceAxis:
365             // XPath namespace nodes are not implemented yet.
366             return;
367         case SelfAxis:
368             if (nodeMatches(context, SelfAxis, m_nodeTest))
369                 nodes.append(&context);
370             return;
371         case DescendantOrSelfAxis:
372             if (nodeMatches(context, DescendantOrSelfAxis, m_nodeTest))
373                 nodes.append(&context);
374             if (context.isAttributeNode()) // In XPath model, attribute nodes do not have children.
375                 return;
376             for (Node* node = context.firstChild(); node; node = NodeTraversal::next(*node, &context)) {
377                 if (nodeMatches(*node, DescendantOrSelfAxis, m_nodeTest))
378                     nodes.append(node);
379             }
380             return;
381         case AncestorOrSelfAxis: {
382             if (nodeMatches(context, AncestorOrSelfAxis, m_nodeTest))
383                 nodes.append(&context);
384             Node* node = &context;
385             if (context.isAttributeNode()) {
386                 node = static_cast<Attr&>(context).ownerElement();
387                 if (nodeMatches(*node, AncestorOrSelfAxis, m_nodeTest))
388                     nodes.append(node);
389             }
390             for (node = node->parentNode(); node; node = node->parentNode()) {
391                 if (nodeMatches(*node, AncestorOrSelfAxis, m_nodeTest))
392                     nodes.append(node);
393             }
394             nodes.markSorted(false);
395             return;
396         }
397     }
398     ASSERT_NOT_REACHED();
399 }
400
401 }
402 }