src/xmlpatterns/functions/qfunctionfactorycollection_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 //
  43 //  W A R N I N G
  44 //  -------------
  45 //
  46 // This file is not part of the Qt API.  It exists purely as an
  47 // implementation detail.  This header file may change from version to
  48 // version without notice, or even be removed.
  49 //
  50 // We mean it.
  51
  52
  53 #ifndef Patternist_FunctionFactoryCollection_H
  54 #define Patternist_FunctionFactoryCollection_H
  55
  56 #include <private/qfunctionfactory_p.h>
  57
  58 QT_BEGIN_HEADER
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 namespace QPatternist
  63 {
  64     /**
  65      * @short A FunctionFactoryCollection instance is a FunctionFactory in its own right,
  66      * but looks in its contained collection of factories for requested functions.
  67      *
  68      * @note the order of adding function libraries is significant.
  69      *
  70      * @ingroup Patternist_functions
  71      * @author Frans Englich <frans.englich@nokia.com>
  72      */
  73     class Q_AUTOTEST_EXPORT FunctionFactoryCollection: public FunctionFactory
  74                                                      , public FunctionFactory::List
  75     {
  76     public:
  77
  78         typedef QExplicitlySharedDataPointer<FunctionFactoryCollection> Ptr;
  79
  80         /**
  81          * Creates a function call node.
  82          */
  83         virtual Expression::Ptr createFunctionCall(const QXmlName,
  84                                                    const Expression::List &arguments,
  85                                                    const StaticContext::Ptr &context,
  86                                                    const SourceLocationReflection *const r);
  87         virtual bool isAvailable(const NamePool::Ptr &np, const QXmlName name, const xsInteger arity);
  88
  89         virtual FunctionSignature::Hash functionSignatures() const;
  90
  91         virtual FunctionSignature::Ptr retrieveFunctionSignature(const NamePool::Ptr &np, const QXmlName name);
  92
  93         /**
  94          * @return a FunctionFactory containing all core functions and constructor
  95          * functions required for XPath 2.. The functions specified for XQuery 1.0
  96          * are the same as for XPath 2.0 so this FunctionFactory work for XQuery
  97          * as well.
  98          */
  99         static FunctionFactory::Ptr xpath20Factory(const NamePool::Ptr &np);
 100
 101         /**
 102          * @return a FunctionFactory containing all core functions required for XPath 1.0.
 103          */
 104         static FunctionFactory::Ptr xpath10Factory();
 105
 106         /**
 107          * @return a FunctionFactory containing all core functions required for XSL-T 2.0
 108          * functions.
 109          */
 110         static FunctionFactory::Ptr xslt20Factory(const NamePool::Ptr &np);
 111     };
 112 }
 113
 114 QT_END_NAMESPACE
 115
 116 QT_END_HEADER
 117
 118 #endif