/****************************************************************************
**
** Copyright (C) 2010 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$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** 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 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.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $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 "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_HEADER
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
QT_END_HEADER
#endif