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