1 /****************************************************************************
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
40 ****************************************************************************/
46 // This file is not part of the Qt API. It exists purely as an
47 // implementation detail. This header file may change from version to
48 // version without notice, or even be removed.
52 #ifndef Patternist_ExpressionDispatch_H
53 #define Patternist_ExpressionDispatch_H
55 #include <QSharedData>
66 class ArgumentConverter;
67 class ArgumentReference;
68 class ArithmeticExpression;
70 class AttributeConstructor;
71 class AttributeNameValidator;
74 class CardinalityVerifier;
75 class CardinalityVerifier;
80 class CollationChecker;
81 class CollationChecker;
84 class CommentConstructor;
85 class CommentConstructor;
86 class ComputedNamespaceConstructor;
89 class CurrentItemStore;
90 class DocumentConstructor;
91 class DynamicContextStore;
93 class ElementConstructor;
95 class ExpressionSequence;
96 class ExpressionVariableReference;
97 class ExternalVariableReference;
98 class FirstItemPredicate;
101 class GeneralComparison;
102 class GenericPredicate;
108 class LiteralSequence;
109 class NamespaceConstructor;
110 class NCNameConstructor;
111 class NodeComparison;
112 class NodeSortExpression;
115 class ParentNodeAxis;
117 class PositionalVariableReference;
118 class ProcessingInstructionConstructor;
119 class QNameConstructor;
120 class QuantifiedExpression;
121 class RangeExpression;
122 class RangeVariableReference;
124 class SimpleContentConstructor;
125 class StaticBaseURIStore;
126 class StaticCompatibilityStore;
127 class TemplateParameterReference;
128 class TextNodeConstructor;
130 class TruthPredicate;
131 class UnresolvedVariableReference;
132 class UntypedAtomicConverter;
133 class UserFunctionCallsite;
134 class ValidationError;
135 class ValueComparison;
136 template<bool IsForGlobal> class EvaluationCache;
139 * @todo Documentation's missing
141 * @defgroup Patternist_expr_dispatch Expression Dispatching
145 * @ingroup Patternist_expr_dispatch
146 * @author Frans Englich <frans.englich@nokia.com>
148 class ExpressionVisitorResult : public QSharedData
151 typedef QExplicitlySharedDataPointer<ExpressionVisitorResult> Ptr;
152 ExpressionVisitorResult() {}
153 virtual ~ExpressionVisitorResult() {}
157 * @ingroup Patternist_expr_dispatch
158 * @author Frans Englich <frans.englich@nokia.com>
160 class ExpressionVisitor : public QSharedData
163 typedef QExplicitlySharedDataPointer<ExpressionVisitor> Ptr;
164 virtual ~ExpressionVisitor() {}
166 virtual ExpressionVisitorResult::Ptr visit(const AndExpression *) const = 0;
167 virtual ExpressionVisitorResult::Ptr visit(const ApplyTemplate *) const = 0;
168 virtual ExpressionVisitorResult::Ptr visit(const ArgumentConverter *) const = 0;
169 virtual ExpressionVisitorResult::Ptr visit(const ArgumentReference *) const = 0;
170 virtual ExpressionVisitorResult::Ptr visit(const ArithmeticExpression *) const = 0;
171 virtual ExpressionVisitorResult::Ptr visit(const Atomizer *) const = 0;
172 virtual ExpressionVisitorResult::Ptr visit(const AttributeConstructor *) const = 0;
173 virtual ExpressionVisitorResult::Ptr visit(const AttributeNameValidator *) const = 0;
174 virtual ExpressionVisitorResult::Ptr visit(const AxisStep *) const = 0;
175 virtual ExpressionVisitorResult::Ptr visit(const CallTemplate *) const = 0;
176 virtual ExpressionVisitorResult::Ptr visit(const CardinalityVerifier *) const = 0;
177 virtual ExpressionVisitorResult::Ptr visit(const CastableAs *) const = 0;
178 virtual ExpressionVisitorResult::Ptr visit(const CastAs *) const = 0;
179 virtual ExpressionVisitorResult::Ptr visit(const CollationChecker *) const = 0;
180 virtual ExpressionVisitorResult::Ptr visit(const CombineNodes *) const = 0;
181 virtual ExpressionVisitorResult::Ptr visit(const CommentConstructor *) const = 0;
182 virtual ExpressionVisitorResult::Ptr visit(const ComputedNamespaceConstructor *) const = 0;
183 virtual ExpressionVisitorResult::Ptr visit(const ContextItem *) const = 0;
184 virtual ExpressionVisitorResult::Ptr visit(const CopyOf *) const = 0;
185 virtual ExpressionVisitorResult::Ptr visit(const CurrentItemStore *) const = 0;
186 virtual ExpressionVisitorResult::Ptr visit(const DocumentConstructor *) const = 0;
187 virtual ExpressionVisitorResult::Ptr visit(const DynamicContextStore *) const = 0;
188 virtual ExpressionVisitorResult::Ptr visit(const EBVExtractor *) const = 0;
189 virtual ExpressionVisitorResult::Ptr visit(const ElementConstructor *) const = 0;
190 virtual ExpressionVisitorResult::Ptr visit(const EmptySequence *) const = 0;
191 virtual ExpressionVisitorResult::Ptr visit(const EvaluationCache<false> *) const = 0;
192 virtual ExpressionVisitorResult::Ptr visit(const EvaluationCache<true> *) const = 0;
193 virtual ExpressionVisitorResult::Ptr visit(const ExpressionSequence *) const = 0;
194 virtual ExpressionVisitorResult::Ptr visit(const ExpressionVariableReference *) const = 0;
195 virtual ExpressionVisitorResult::Ptr visit(const ExternalVariableReference *) const = 0;
196 virtual ExpressionVisitorResult::Ptr visit(const FirstItemPredicate *) const = 0;
197 virtual ExpressionVisitorResult::Ptr visit(const ForClause *) const = 0;
198 virtual ExpressionVisitorResult::Ptr visit(const FunctionCall *) const = 0;
199 virtual ExpressionVisitorResult::Ptr visit(const GeneralComparison *) const = 0;
200 virtual ExpressionVisitorResult::Ptr visit(const GenericPredicate *) const = 0;
201 virtual ExpressionVisitorResult::Ptr visit(const IfThenClause *) const = 0;
202 virtual ExpressionVisitorResult::Ptr visit(const InstanceOf *) const = 0;
203 virtual ExpressionVisitorResult::Ptr visit(const ItemVerifier *) const = 0;
204 virtual ExpressionVisitorResult::Ptr visit(const LetClause *) const = 0;
205 virtual ExpressionVisitorResult::Ptr visit(const Literal *) const = 0;
206 virtual ExpressionVisitorResult::Ptr visit(const LiteralSequence *) const = 0;
207 virtual ExpressionVisitorResult::Ptr visit(const NamespaceConstructor *) const = 0;
208 virtual ExpressionVisitorResult::Ptr visit(const NCNameConstructor *) const = 0;
209 virtual ExpressionVisitorResult::Ptr visit(const NodeComparison *) const = 0;
210 virtual ExpressionVisitorResult::Ptr visit(const NodeSortExpression *) const = 0;
211 virtual ExpressionVisitorResult::Ptr visit(const OrderBy *) const = 0;
212 virtual ExpressionVisitorResult::Ptr visit(const OrExpression *) const = 0;
213 virtual ExpressionVisitorResult::Ptr visit(const ParentNodeAxis *) const = 0;
214 virtual ExpressionVisitorResult::Ptr visit(const Path *) const = 0;
215 virtual ExpressionVisitorResult::Ptr visit(const PositionalVariableReference *) const = 0;
216 virtual ExpressionVisitorResult::Ptr visit(const ProcessingInstructionConstructor *) const = 0;
217 virtual ExpressionVisitorResult::Ptr visit(const QNameConstructor *) const = 0;
218 virtual ExpressionVisitorResult::Ptr visit(const QuantifiedExpression *) const = 0;
219 virtual ExpressionVisitorResult::Ptr visit(const RangeExpression *) const = 0;
220 virtual ExpressionVisitorResult::Ptr visit(const RangeVariableReference *) const = 0;
221 virtual ExpressionVisitorResult::Ptr visit(const ReturnOrderBy *) const = 0;
222 virtual ExpressionVisitorResult::Ptr visit(const SimpleContentConstructor *) const = 0;
223 virtual ExpressionVisitorResult::Ptr visit(const StaticBaseURIStore *) const = 0;
224 virtual ExpressionVisitorResult::Ptr visit(const StaticCompatibilityStore *) const = 0;
225 virtual ExpressionVisitorResult::Ptr visit(const TemplateParameterReference *) const = 0;
226 virtual ExpressionVisitorResult::Ptr visit(const TextNodeConstructor *) const = 0;
227 virtual ExpressionVisitorResult::Ptr visit(const TreatAs *) const = 0;
228 virtual ExpressionVisitorResult::Ptr visit(const TruthPredicate *) const = 0;
229 virtual ExpressionVisitorResult::Ptr visit(const UnresolvedVariableReference *) const = 0;
230 virtual ExpressionVisitorResult::Ptr visit(const UntypedAtomicConverter *) const = 0;
231 virtual ExpressionVisitorResult::Ptr visit(const UserFunctionCallsite *) const = 0;
232 virtual ExpressionVisitorResult::Ptr visit(const ValidationError *) const = 0;
233 virtual ExpressionVisitorResult::Ptr visit(const ValueComparison *) const = 0;