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

**

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

#define Patternist_FunctionFactoryCollection_H

#include "qfunctionfactory_p.h"

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

namespace QPatternist

{

    /**

     * @short A FunctionFactoryCollection instance is a FunctionFactory in its own right,

     * but looks in its contained collection of factories for requested functions.

     *

     * @note the order of adding function libraries is significant.

     *

     * @ingroup Patternist_functions

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

     */

    class Q_AUTOTEST_EXPORT FunctionFactoryCollection: public FunctionFactory

                                                     , public FunctionFactory::List

    {

    public:

        typedef QExplicitlySharedDataPointer<FunctionFactoryCollection> Ptr;

        /**

         * Creates a function call node.

         */

        virtual Expression::Ptr createFunctionCall(const QXmlName,

                                                   const Expression::List &arguments,

                                                   const StaticContext::Ptr &context,

                                                   const SourceLocationReflection *const r);

        virtual bool isAvailable(const NamePool::Ptr &np, const QXmlName name, const xsInteger arity);

        virtual FunctionSignature::Hash functionSignatures() const;

        virtual FunctionSignature::Ptr retrieveFunctionSignature(const NamePool::Ptr &np, const QXmlName name);

        /**

         * @return a FunctionFactory containing all core functions and constructor

         * functions required for XPath 2.. The functions specified for XQuery 1.0

         * are the same as for XPath 2.0 so this FunctionFactory work for XQuery

         * as well.

         */

        static FunctionFactory::Ptr xpath20Factory(const NamePool::Ptr &np);

        /**

         * @return a FunctionFactory containing all core functions required for XPath 1.0.

         */

        static FunctionFactory::Ptr xpath10Factory();

        /**

         * @return a FunctionFactory containing all core functions required for XSL-T 2.0

         * functions.

         */

        static FunctionFactory::Ptr xslt20Factory(const NamePool::Ptr &np);

    };

}

QT_END_NAMESPACE

QT_END_HEADER

#endif