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
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtXmlPatterns module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL21$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** $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_StringValueFNs_H
#define Patternist_StringValueFNs_H
#include <QByteArray>
#include <private/qfunctioncall_p.h>
/**
* @file
* @short Contains classes implementing the functions found in
* <a href="http://www.w3.org/TR/xpath-functions/#string-value-functions">XQuery 1.0 and
* XPath 2.0 Functions and Operators, 7.4 Functions on AtomicString Values</a>.
*
* @ingroup Patternist_functions
*/
QT_BEGIN_NAMESPACE
namespace QPatternist
{
/**
* @short Implements the function <tt>fn:concat()</tt>.
*
* @ingroup Patternist_functions
* @author Frans Englich <frans.englich@nokia.com>
*/
class ConcatFN : public FunctionCall
{
public:
virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
};
/**
* @short Implements the function <tt>fn:string-join()</tt>.
*
* @ingroup Patternist_functions
* @author Frans Englich <frans.englich@nokia.com>
*/
class StringJoinFN : public FunctionCall
{
public:
virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
/**
* Optimization: when the cardinality of the sequence of items to join
* cannot be two or more, we have no effect and therefore rewrite
* ourselves to our first operand.
*/
virtual Expression::Ptr compress(const StaticContext::Ptr &context);
};
/**
* @short Implements the function <tt>fn:substring()</tt>.
*
* @ingroup Patternist_functions
* @author Frans Englich <frans.englich@nokia.com>
*/
class SubstringFN : public FunctionCall
{
public:
virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
};
/**
* @short Implements the function <tt>fn:string-length()</tt>.
*
* @ingroup Patternist_functions
* @author Frans Englich <frans.englich@nokia.com>
*/
class StringLengthFN : public FunctionCall
{
public:
virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
};
/**
* @short Implements the function <tt>fn:normalize-space()</tt>.
*
* @ingroup Patternist_functions
* @author Frans Englich <frans.englich@nokia.com>
*/
class NormalizeSpaceFN : public FunctionCall
{
public:
virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
};
/**
* @short Implements the function <tt>fn:normalize-unicode()</tt>.
*
* What perhaps can be said significant with the implementation, is that it
* attempts to determine the normalization form at compile time, in order to
* reduce string work at runtime.
*
* @ingroup Patternist_functions
* @author Frans Englich <frans.englich@nokia.com>
*/
class NormalizeUnicodeFN : public FunctionCall
{
public:
/**
* Initializes private data.
*/
NormalizeUnicodeFN();
virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
virtual Expression::Ptr compress(const StaticContext::Ptr &context);
private:
int determineNormalizationForm(const DynamicContext::Ptr &context) const;
QString::NormalizationForm m_normForm;
};
/**
* @short Implements the function <tt>fn:upper-case()</tt>.
*
* @ingroup Patternist_functions
* @author Frans Englich <frans.englich@nokia.com>
*/
class UpperCaseFN : public FunctionCall
{
public:
virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
};
/**
* @short Implements the function <tt>fn:lower-case()</tt>.
*
* @short Implements the function <tt>fn:concat()</tt>.
* @ingroup Patternist_functions
* @author Frans Englich <frans.englich@nokia.com>
*/
class LowerCaseFN : public FunctionCall
{
public:
virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
};
/**
* @short Implements the function <tt>fn:translate()</tt>.
*
* @ingroup Patternist_functions
* @author Frans Englich <frans.englich@nokia.com>
*/
class TranslateFN : public FunctionCall
{
public:
virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
};
/**
* @short Provides functionality for encoding strings. Sub-classed by various
* function implementations.
*
* @ingroup Patternist_functions
* @author Frans Englich <frans.englich@nokia.com>
*/
class EncodeString : public FunctionCall
{
public:
/**
* Evaluates its first operand. If it is the empty sequence, an empty string
* is returned. Otherwise, the item's string value is returned percent encoded
* as specified in this class's constructor.
*/
virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
protected:
/**
* Encodes its operand with QUrl::toPercentEncoding(), with @p includeChars as
* the characters to encode, and @p excludeChars as the characters to not encode.
*/
EncodeString(const QByteArray &excludeChars, const QByteArray &includeChars);
private:
const QByteArray m_excludeChars;
const QByteArray m_includeChars;
};
/**
* @short Implements the function <tt>fn:encode-for-uri()</tt>.
*
* @ingroup Patternist_functions
* @author Frans Englich <frans.englich@nokia.com>
*/
class EncodeForURIFN : public EncodeString
{
public:
/**
* Performs internal initialization.
*/
EncodeForURIFN();
private:
static const char *const include;
};
/**
* @short Implements the function <tt>fn:iri-to-uri()</tt>.
*
* @ingroup Patternist_functions
* @author Frans Englich <frans.englich@nokia.com>
*/
class IriToURIFN : public EncodeString
{
public:
/**
* Performs internal initialization.
*/
IriToURIFN();
private:
static const char *const exclude;
};
/**
* @short Implements the function <tt>fn:escape-html-uri()</tt>.
*
* @ingroup Patternist_functions
* @author Frans Englich <frans.englich@nokia.com>
*/
class EscapeHtmlURIFN : public EncodeString
{
public:
/**
* Performs internal initialization.
*/
EscapeHtmlURIFN();
private:
static const char *const include;
static const char *const exclude;
};
}
QT_END_NAMESPACE
#endif
|
