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

**

** Copyright (C) 2009 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_SequenceGeneratingFNs_H

#define Patternist_SequenceGeneratingFNs_H

#include "qanyuri_p.h"

#include "qcontextnodechecker_p.h"

#include "qstaticbaseuricontainer_p.h"

/**

 * @file

 * @short Contains classes implementing the functions found in

 * <a href="http://www.w3.org/TR/xpath-functions/#fns-that-generate-sequences">XQuery 1.0 and

 * XPath 2.0 Functions and Operators, 15.5 Functions and Operators that Generate Sequences</a>.

 *

 * @ingroup Patternist_functions

 */

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

namespace QPatternist

{

    /**

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

     *

     * @ingroup Patternist_functions

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

     */

    class IdFN : public ContextNodeChecker

    {

    public:

        IdFN();

        typedef QPair<DynamicContext::Ptr, const QAbstractXmlNodeModel *> IDContext;

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

        inline Item mapToItem(const QString &id,

                              const IDContext &context) const;

        virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,

                                          const SequenceType::Ptr &reqType);

    private:

        typedef QExplicitlySharedDataPointer<const IdFN> ConstPtr;

        bool m_hasCreatedSorter;

    };

    /**

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

     *

     * @ingroup Patternist_functions

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

     */

    class IdrefFN : public ContextNodeChecker

    {

    public:

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

    };

    /**

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

     *

     * @ingroup Patternist_functions

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

     */

    class DocFN : public StaticBaseUriContainer

    {

    public:

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

        /**

         * The implementation of this function is placed in a different compilation unit,

         * namely qsequencefns.cpp, to workaround a compiler bug on

         * solaris-cc-64, suspected to be related to the instantiation of QUrl::toQUrl().

         *

         * @see <a

         * href="http://onesearch.sun.com/search/onesearch/index.jsp?qt=6532605&site=sunsolve&otf=ss&col=support-sunsolve&otf=sunsolve&site=ss&col=search-sunsolve">Sun,

         * multiply-defined label for template instance, bug 6532605</a>

         */

        virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,

                                          const SequenceType::Ptr &reqType);

        virtual SequenceType::Ptr staticType() const;

    private:

        SequenceType::Ptr m_type;

    };

    /**

     * @short Implements the function <tt>fn:doc-available()</tt>.

     *

     * @ingroup Patternist_functions

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

     */

    class DocAvailableFN : public StaticBaseUriContainer

    {

    public:

        virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;

    };

    /**

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

     *

     * @ingroup Patternist_functions

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

     */

    class CollectionFN : public FunctionCall

    {

    public:

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

    };

}

QT_END_NAMESPACE

QT_END_HEADER

#endif