/****************************************************************************

**

** 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_PatternMatchingFNs_H

#define Patternist_PatternMatchingFNs_H

#include "qpatternplatform_p.h"

/**

 * @file

 * @short Contains classes implementing the functions found in

 * <a href="http://www.w3.org/TR/xpath-functions/#string.match">XQuery 1.0 and

 * XPath 2.0 Functions and Operators, 7.6 AtomicString Functions that Use Pattern Matching</a>.

 *

 * @ingroup Patternist_functions

 */

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

namespace QPatternist

{

    /**

     * @short Implements the function <tt>fn:matches()</tt>.

     *

     * @ingroup Patternist_functions

     * @author Frans Englich <frans.englich@nokia.com>

     */

    class MatchesFN : public PatternPlatform

    {

    public:

        MatchesFN();

        virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;

    };

    /**

     * @short Implements the function <tt>fn:replace()</tt>.

     *

     * @ingroup Patternist_functions

     * @author Frans Englich <frans.englich@nokia.com>

     */

    class ReplaceFN : public PatternPlatform

    {

    public:

        ReplaceFN();

        virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;

        /**

         * Overridden to attempt to pre-compile the replacement string.

         */

        virtual Expression::Ptr compress(const StaticContext::Ptr &context);

    private:

        /**

         * @short Centralizes the translation string.

         */

        static inline QString errorAtEnd(const char ch);

        /**

         * Reads the string in the third argument and converts it to a a QRegExp compatible

         * replacement string, containing sub-group references and so forth.

         */

        QString parseReplacement(const int captureCount,

                                 const DynamicContext::Ptr &context) const;

        QString m_replacementString;

    };

    /**

     * @short Implements the function <tt>fn:tokenize()</tt>.

     *

     * @ingroup Patternist_functions

     * @author Frans Englich <frans.englich@nokia.com>

     */

    class TokenizeFN : public PatternPlatform

    {

    public:

        TokenizeFN();

        inline Item mapToItem(const QString &subject, const DynamicContext::Ptr &) const;

        virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;

    private:

        typedef QExplicitlySharedDataPointer<const TokenizeFN> ConstPtr;

    };

}

QT_END_NAMESPACE

QT_END_HEADER

#endif