1 /****************************************************************************
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
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_StringValueFNs_H
53 #define Patternist_StringValueFNs_H
57 #include "qfunctioncall_p.h"
61 * @short Contains classes implementing the functions found in
62 * <a href="http://www.w3.org/TR/xpath-functions/#string-value-functions">XQuery 1.0 and
63 * XPath 2.0 Functions and Operators, 7.4 Functions on AtomicString Values</a>.
65 * @ingroup Patternist_functions
76 * @short Implements the function <tt>fn:concat()</tt>.
78 * @ingroup Patternist_functions
79 * @author Frans Englich <frans.englich@nokia.com>
81 class ConcatFN : public FunctionCall
84 virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
88 * @short Implements the function <tt>fn:string-join()</tt>.
90 * @ingroup Patternist_functions
91 * @author Frans Englich <frans.englich@nokia.com>
93 class StringJoinFN : public FunctionCall
96 virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
99 * Optimization: when the cardinality of the sequence of items to join
100 * cannot be two or more, we have no effect and therefore rewrite
101 * ourselves to our first operand.
103 virtual Expression::Ptr compress(const StaticContext::Ptr &context);
107 * @short Implements the function <tt>fn:substring()</tt>.
109 * @ingroup Patternist_functions
110 * @author Frans Englich <frans.englich@nokia.com>
112 class SubstringFN : public FunctionCall
115 virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
119 * @short Implements the function <tt>fn:string-length()</tt>.
121 * @ingroup Patternist_functions
122 * @author Frans Englich <frans.englich@nokia.com>
124 class StringLengthFN : public FunctionCall
127 virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
131 * @short Implements the function <tt>fn:normalize-space()</tt>.
133 * @ingroup Patternist_functions
134 * @author Frans Englich <frans.englich@nokia.com>
136 class NormalizeSpaceFN : public FunctionCall
139 virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
143 * @short Implements the function <tt>fn:normalize-unicode()</tt>.
145 * What perhaps can be said significant with the implementation, is that it
146 * attempts to determine the normalization form at compile time, in order to
147 * reduce string work at runtime.
149 * @ingroup Patternist_functions
150 * @author Frans Englich <frans.englich@nokia.com>
152 class NormalizeUnicodeFN : public FunctionCall
156 * Initializes private data.
158 NormalizeUnicodeFN();
159 virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
160 virtual Expression::Ptr compress(const StaticContext::Ptr &context);
163 int determineNormalizationForm(const DynamicContext::Ptr &context) const;
164 QString::NormalizationForm m_normForm;
168 * @short Implements the function <tt>fn:upper-case()</tt>.
170 * @ingroup Patternist_functions
171 * @author Frans Englich <frans.englich@nokia.com>
173 class UpperCaseFN : public FunctionCall
176 virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
180 * @short Implements the function <tt>fn:lower-case()</tt>.
182 * @short Implements the function <tt>fn:concat()</tt>.
183 * @ingroup Patternist_functions
184 * @author Frans Englich <frans.englich@nokia.com>
186 class LowerCaseFN : public FunctionCall
189 virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
193 * @short Implements the function <tt>fn:translate()</tt>.
195 * @ingroup Patternist_functions
196 * @author Frans Englich <frans.englich@nokia.com>
198 class TranslateFN : public FunctionCall
201 virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
205 * @short Provides functionality for encoding strings. Sub-classed by various
206 * function implementations.
208 * @ingroup Patternist_functions
209 * @author Frans Englich <frans.englich@nokia.com>
211 class EncodeString : public FunctionCall
215 * Evaluates its first operand. If it is the empty sequence, an empty string
216 * is returned. Otherwise, the item's string value is returned percent encoded
217 * as specified in this class's constructor.
219 virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
223 * Encodes its operand with QUrl::toPercentEncoding(), with @p includeChars as
224 * the characters to encode, and @p excludeChars as the characters to not encode.
226 EncodeString(const QByteArray &excludeChars, const QByteArray &includeChars);
229 const QByteArray m_excludeChars;
230 const QByteArray m_includeChars;
234 * @short Implements the function <tt>fn:encode-for-uri()</tt>.
236 * @ingroup Patternist_functions
237 * @author Frans Englich <frans.englich@nokia.com>
239 class EncodeForURIFN : public EncodeString
243 * Performs internal initialization.
248 static const char *const include;
252 * @short Implements the function <tt>fn:iri-to-uri()</tt>.
254 * @ingroup Patternist_functions
255 * @author Frans Englich <frans.englich@nokia.com>
257 class IriToURIFN : public EncodeString
261 * Performs internal initialization.
266 static const char *const exclude;
270 * @short Implements the function <tt>fn:escape-html-uri()</tt>.
272 * @ingroup Patternist_functions
273 * @author Frans Englich <frans.englich@nokia.com>
275 class EscapeHtmlURIFN : public EncodeString
279 * Performs internal initialization.
284 static const char *const include;
285 static const char *const exclude;