1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
|
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtXmlPatterns module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
#ifndef Patternist_StaticContext_H
#define Patternist_StaticContext_H
#include "qexternalvariableloader_p.h"
#include "qitemtype_p.h"
#include "qnamepool_p.h"
#include "qnamespaceresolver_p.h"
#include "qreportcontext_p.h"
#include "qresourceloader_p.h"
QT_BEGIN_HEADER
QT_BEGIN_NAMESPACE
class QUrl;
template<typename Key, typename T> class QHash;
namespace QPatternist
{
class DynamicContext;
class Expression;
class FunctionFactory;
class SchemaTypeFactory;
/**
* @short Carries information and facilities used at compilation time.
*
* A representation of the Static Context in XPath 2.0. The Static Context
* contains information which doesn't change and is the "outer scope" of the
* expression. It provides for example a base URI the expression can relate to and
* what functions and variables that are available for the expression.
*
* @see <a href="http://www.w3.org/TR/xpath20/#static_context">XML Path
* Language (XPath) 2.0, 2.1.1 Static Context</a>
* @author Frans Englich <frans.englich@nokia.com>
*/
class StaticContext : public ReportContext
{
public:
/**
* A smart pointer wrapping StaticContext instances.
*/
typedef QExplicitlySharedDataPointer<StaticContext> Ptr;
/**
* @see <a href="http://www.w3.org/TR/xquery/#id-boundary-space-decls">XQuery 1.0:
* An XML Query Language, 4.3 Boundary-space Declaration</a>
* @see <a href="http://www.w3.org/TR/xquery/#dt-boundary-space-policy">XQuery 1.0:
* An XML Query Language, Definition: Boundary-space policy</a>
*/
enum BoundarySpacePolicy
{
BSPPreserve,
BSPStrip
};
/**
* @see <a href="http://www.w3.org/TR/xquery/#id-construction-declaration">XQuery 1.0:
* An XML Query Language, 4.6 Construction Declaration</a>
* @see <a href="http://www.w3.org/TR/xquery/#dt-construction-mode">XQuery 1.0:
* An XML Query Language, Definition: Construction mode</a>
*/
enum ConstructionMode
{
CMPreserve,
CMStrip
};
/**
* @see <a href="http://www.w3.org/TR/xquery/#id-default-ordering-decl">XQuery 1.0:
* An XML Query Language, 4.7 Ordering Mode Declaration</a>
* @see <a href="http://www.w3.org/TR/xquery/#dt-ordering-mode">XQuery 1.0:
* An XML Query Language, Definition: Ordering mode</a>
*/
enum OrderingMode
{
Ordered,
Unordered
};
/**
* @see <a href="http://www.w3.org/TR/xquery/#id-empty-order-decl">XQuery 1.0:
* An XML Query Language, 4.8 Empty Order Declaration</a>
* @see <a href="http://www.w3.org/TR/xquery/#dt-default-empty-order">XQuery 1.0:
* An XML Query Language, Definition: Default order for empty sequences</a>
*/
enum OrderingEmptySequence
{
Greatest,
Least
};
enum InheritMode
{
Inherit,
NoInherit
};
enum PreserveMode
{
Preserve,
NoPreserve
};
inline StaticContext()
{
}
virtual ~StaticContext();
virtual NamespaceResolver::Ptr namespaceBindings() const = 0;
virtual void setNamespaceBindings(const NamespaceResolver::Ptr &) = 0;
virtual QExplicitlySharedDataPointer<FunctionFactory> functionSignatures() const = 0;
virtual QExplicitlySharedDataPointer<SchemaTypeFactory> schemaDefinitions() const = 0;
/**
* The base URI of the context. Typically, this is the base URI
* if of the element that contained the expression.
*
* The base URI is in this implementation is never undefined, but is
* always valid.
*/
virtual QUrl baseURI() const = 0;
virtual void setBaseURI(const QUrl &uri) = 0;
/**
* @returns always the standard function namespace defined in
* <a href="http://www.w3.org/TR/xpath-functions/">XQuery 1.0 and
* XPath 2.0 Functions and Operators</a>
*/
virtual QString defaultFunctionNamespace() const = 0;
virtual void setDefaultFunctionNamespace(const QString &ns) = 0;
virtual QString defaultElementNamespace() const = 0;
virtual void setDefaultElementNamespace(const QString &ns) = 0;
/**
* @returns the URI identifying the default collation. The function
* is responsible for ensuring a collation is always returned. If
* a collation is not provided by the user or the host language in the
* context, the Unicode codepoint URI should be returned.
*/
virtual QUrl defaultCollation() const = 0;
virtual void setDefaultCollation(const QUrl &uri) = 0;
/**
* Determine whether Backwards Compatible Mode is used.
*
* @see <a href="http://www.w3.org/TR/xpath20/#id-backwards-compatibility">XML Path
* Language (XPath) 2.0, I Backwards Compatibility with XPath 1.0 (Non-Normative)</a>
* @see <a href="http://www.w3.org/TR/xpath20/#dt-xpath-compat-mode">XML Path
* Language (XPath) 2.0, Definition: XPath 1.0 compatibility mode</a>
*/
virtual bool compatModeEnabled() const = 0;
virtual void setCompatModeEnabled(const bool newVal) = 0;
/**
* This is the DynamicContext that is used for pre-evaluation at
* compilation time, const-folding at the static stage.
*/
virtual QExplicitlySharedDataPointer<DynamicContext> dynamicContext() const = 0;
virtual BoundarySpacePolicy boundarySpacePolicy() const = 0;
virtual void setBoundarySpacePolicy(const BoundarySpacePolicy policy) = 0;
virtual ConstructionMode constructionMode() const = 0;
virtual void setConstructionMode(const ConstructionMode mode) = 0;
virtual OrderingMode orderingMode() const = 0;
virtual void setOrderingMode(const OrderingMode mode) = 0;
virtual OrderingEmptySequence orderingEmptySequence() const = 0;
virtual void setOrderingEmptySequence(const OrderingEmptySequence ordering) = 0;
virtual InheritMode inheritMode() const = 0;
virtual void setInheritMode(const InheritMode mode) = 0;
virtual PreserveMode preserveMode() const = 0;
virtual void setPreserveMode(const PreserveMode mode) = 0;
/**
* @short The static type of the context item.
*
* Different StaticContext instances are used for different nodes in the
* AST to properly reflect the type of the focus. If the focus is undefined,
* this function must return @c null.
*
* @see <a href="http://www.w3.org/TR/xquery/#dt-context-item-static-type">XQuery
* 1.0: An XML Query Language, Definition: Context item static type</a>
*/
virtual ItemType::Ptr contextItemType() const = 0;
/**
* @short The static type of the current item, as returned by @c
* fn:current().
*/
virtual ItemType::Ptr currentItemType() const = 0;
/**
* Copies this StaticContext and returns the copy.
*
* The copy and original must not be independent. Since the StaticContext is modified
* during the compilation process, the copy must be independent from the original
* to the degree that is required for the subclass in question.
*/
virtual StaticContext::Ptr copy() const = 0;
virtual ExternalVariableLoader::Ptr externalVariableLoader() const = 0;
virtual ResourceLoader::Ptr resourceLoader() const = 0;
virtual NamePool::Ptr namePool() const = 0;
/**
* @short Adds @p location for @p reflection.
*/
virtual void addLocation(const SourceLocationReflection *const reflection,
const QSourceLocation &location) = 0;
/**
* @short Returns a hash of the contained locations.
*
* The key is the address for the expression, and the value is its location. Note
* that the key cannot be dereferenced, there's no guarantee the
* Expression is in scope. The key is merely an identifier.
*/
virtual LocationHash sourceLocations() const = 0;
virtual VariableSlotID currentRangeSlot() const = 0;
virtual VariableSlotID allocateRangeSlot() = 0;
/**
* @short Ensures source locations are handled in such a manner that @p
* existingNode wraps @p newNode.
*
* Ensures that the source locations for @p existingNode, applies to
* @p newNode.
*/
void wrapExpressionWith(const SourceLocationReflection *const existingNode,
const QExplicitlySharedDataPointer<Expression> &newNode);
};
}
QT_END_NAMESPACE
QT_END_HEADER
#endif
|
