/**************************************************************************** ** ** Copyright (C) 2016 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtXmlPatterns module of the Qt Toolkit. ** ** $QT_BEGIN_LICENSE:LGPL$ ** 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 https://www.qt.io/terms-conditions. For further ** information use the contact form at https://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 3 as published by the Free Software ** Foundation and appearing in the file LICENSE.LGPL3 included in the ** packaging of this file. Please review the following information to ** ensure the GNU Lesser General Public License version 3 requirements ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. ** ** GNU General Public License Usage ** Alternatively, this file may be used under the terms of the GNU ** General Public License version 2.0 or (at your option) the GNU General ** Public license version 3 or any later version approved by the KDE Free ** Qt Foundation. The licenses are as published by the Free Software ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 ** included in the packaging of this file. Please review the following ** information to ensure the GNU General Public License requirements will ** be met: https://www.gnu.org/licenses/gpl-2.0.html and ** https://www.gnu.org/licenses/gpl-3.0.html. ** ** $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 #include /** * @file * @short Contains classes implementing the functions found in * XQuery 1.0 and * XPath 2.0 Functions and Operators, 7.4 Functions on AtomicString Values. * * @ingroup Patternist_functions */ QT_BEGIN_NAMESPACE namespace QPatternist { /** * @short Implements the function fn:concat(). * * @ingroup Patternist_functions * @author Frans Englich */ class ConcatFN : public FunctionCall { public: virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const; }; /** * @short Implements the function fn:string-join(). * * @ingroup Patternist_functions * @author Frans Englich */ 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 fn:substring(). * * @ingroup Patternist_functions * @author Frans Englich */ class SubstringFN : public FunctionCall { public: virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const; }; /** * @short Implements the function fn:string-length(). * * @ingroup Patternist_functions * @author Frans Englich */ class StringLengthFN : public FunctionCall { public: virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const; }; /** * @short Implements the function fn:normalize-space(). * * @ingroup Patternist_functions * @author Frans Englich */ class NormalizeSpaceFN : public FunctionCall { public: virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const; }; /** * @short Implements the function fn:normalize-unicode(). * * 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 */ 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 fn:upper-case(). * * @ingroup Patternist_functions * @author Frans Englich */ class UpperCaseFN : public FunctionCall { public: virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const; }; /** * @short Implements the function fn:lower-case(). * * @short Implements the function fn:concat(). * @ingroup Patternist_functions * @author Frans Englich */ class LowerCaseFN : public FunctionCall { public: virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const; }; /** * @short Implements the function fn:translate(). * * @ingroup Patternist_functions * @author Frans Englich */ 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 */ 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 fn:encode-for-uri(). * * @ingroup Patternist_functions * @author Frans Englich */ class EncodeForURIFN : public EncodeString { public: /** * Performs internal initialization. */ EncodeForURIFN(); private: static const char *const include; }; /** * @short Implements the function fn:iri-to-uri(). * * @ingroup Patternist_functions * @author Frans Englich */ class IriToURIFN : public EncodeString { public: /** * Performs internal initialization. */ IriToURIFN(); private: static const char *const exclude; }; /** * @short Implements the function fn:escape-html-uri(). * * @ingroup Patternist_functions * @author Frans Englich */ class EscapeHtmlURIFN : public EncodeString { public: /** * Performs internal initialization. */ EscapeHtmlURIFN(); private: static const char *const include; static const char *const exclude; }; } QT_END_NAMESPACE #endif