Reviewed by Darin.
[WebKit-https.git] / WebCore / xml / XPathStep.h
1 /*
2  * Copyright 2005 Frerich Raabe <raabe@kde.org>
3  * Copyright (C) 2006 Apple Computer, Inc.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #ifndef XPathStep_h
28 #define XPathStep_h
29
30 #if ENABLE(XPATH)
31
32 #include "Node.h"
33 #include "XPathExpressionNode.h"
34 #include "XPathNodeSet.h"
35
36 namespace WebCore {
37
38     namespace XPath {
39
40         class Predicate;
41         
42         class Step : public ParseNode, Noncopyable {
43         public:
44             enum Axis {
45                 AncestorAxis, AncestorOrSelfAxis, AttributeAxis,
46                 ChildAxis, DescendantAxis, DescendantOrSelfAxis,
47                 FollowingAxis, FollowingSiblingAxis, NamespaceAxis,
48                 ParentAxis, PrecedingAxis, PrecedingSiblingAxis,
49                 SelfAxis
50             };
51             
52             class NodeTest {
53             public:
54                 enum Kind {
55                     TextNodeTest, CommentNodeTest, ProcessingInstructionNodeTest, AnyNodeTest, NameTest,
56                     ElementNodeTest // XPath 2.0
57                 };
58                 
59                 NodeTest(Kind kind, const String& data = String()) : m_kind(kind), m_data(data) {}
60                 
61                 Kind kind() const { return m_kind; }
62                 const String data() const { return m_data; }
63                 
64             private:
65                 Kind m_kind;
66                 String m_data;
67             };
68
69             Step(Axis, const NodeTest& nodeTest, const Vector<Predicate*>& predicates = Vector<Predicate*>());
70             Step(Axis, const NodeTest& nodeTest, const String& namespaceURI, const Vector<Predicate*>& predicates = Vector<Predicate*>());
71             ~Step();
72
73             NodeSet evaluate(Node* context) const;
74             
75             Axis axis() const { return m_axis; }
76             NodeTest nodeTest() const { return m_nodeTest; }
77             const String& nodeTestData() const { return m_nodeTestData; }
78             const String& namespaceURI() const { return m_namespaceURI; }
79             const Vector<Predicate*>& predicates() const { return m_predicates; }
80             
81             void setAxis(Axis axis) { m_axis = axis; }
82             void setNodeTest(NodeTest nodeTest) { m_nodeTest = nodeTest; }
83             void setNodeTestData(const String& nodeTestData) { m_nodeTestData = nodeTestData; }
84             void setNamespaceURI(const String& namespaceURI) { m_namespaceURI = namespaceURI; }
85             void setPredicates(const Vector<Predicate*>& predicates) { m_predicates = predicates; }
86             
87         private:
88             void parseNodeTest(const String&);
89             NodeSet nodesInAxis(Node* context) const;
90             bool nodeMatches(Node*) const;
91             String namespaceFromNodetest(const String& nodeTest) const;
92             Node::NodeType primaryNodeType(Axis) const;
93
94             Axis m_axis;
95             NodeTest m_nodeTest;
96             String m_nodeTestData;
97             String m_namespaceURI;
98             Vector<Predicate*> m_predicates;
99         };
100
101     }
102
103 }
104
105 #endif // ENABLE(XPATH)
106
107 #endif // XPath_Step_H