src/xmlpatterns/functions/qabstractfunctionfactory_p.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    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 #ifndef Patternist_AbstractFunctionFactory_H
       
    53 #define Patternist_AbstractFunctionFactory_H
       
    54 
       
    55 #include "qcommonnamespaces_p.h"
       
    56 #include "qfunctionfactory_p.h"
       
    57 #include "qfunctionsignature_p.h"
       
    58 
       
    59 QT_BEGIN_HEADER
       
    60 
       
    61 QT_BEGIN_NAMESPACE
       
    62 
       
    63 namespace QPatternist
       
    64 {
       
    65 
       
    66     /**
       
    67      * @short Supplies convenience code for the function factories.
       
    68      *
       
    69      * @ingroup Patternist_functions
       
    70      * @see XPath10CoreFunctions
       
    71      * @see XPath20CoreFunctions
       
    72      * @see XSLT10CoreFunctions
       
    73      * @author Vincent Ricard <magic@magicninja.org>
       
    74      */
       
    75     class AbstractFunctionFactory : public FunctionFactory
       
    76     {
       
    77     public:
       
    78         virtual Expression::Ptr createFunctionCall(const QXmlName name,
       
    79                                                    const Expression::List &arguments,
       
    80                                                    const StaticContext::Ptr &context,
       
    81                                                    const SourceLocationReflection *const r);
       
    82 
       
    83         virtual FunctionSignature::Hash functionSignatures() const;
       
    84 
       
    85     protected:
       
    86         /**
       
    87          * This function is responsible for creating the actual Expression, corresponding
       
    88          * to @p localName and the function signature @p sign. It is called by
       
    89          * createFunctionCall(), once it have been determined the function actually
       
    90          * exists and have the correct arity.
       
    91          *
       
    92          * This function will only be called for names in the @c fn namespace.
       
    93          */
       
    94         virtual Expression::Ptr retrieveExpression(const QXmlName name,
       
    95                                                    const Expression::List &args,
       
    96                                                    const FunctionSignature::Ptr &sign) const = 0;
       
    97 
       
    98         inline
       
    99         FunctionSignature::Ptr addFunction(const QXmlName::LocalNameCode localName,
       
   100                                            const FunctionSignature::Arity minArgs,
       
   101                                            const FunctionSignature::Arity maxArgs,
       
   102                                            const SequenceType::Ptr &returnType,
       
   103                                            const Expression::Properties props)
       
   104         {
       
   105             return addFunction(localName,
       
   106                                minArgs,
       
   107                                maxArgs,
       
   108                                returnType,
       
   109                                Expression::IDIgnorableExpression,
       
   110                                props);
       
   111         }
       
   112 
       
   113         FunctionSignature::Ptr addFunction(const QXmlName::LocalNameCode &localName,
       
   114                                            const FunctionSignature::Arity minArgs,
       
   115                                            const FunctionSignature::Arity maxArgs,
       
   116                                            const SequenceType::Ptr &returnType,
       
   117                                            const Expression::ID id = Expression::IDIgnorableExpression,
       
   118                                            const Expression::Properties props = Expression::Properties(),
       
   119                                            const StandardNamespaces::ID ns = StandardNamespaces::fn)
       
   120         {
       
   121             const QXmlName name(ns, localName);
       
   122 
       
   123             const FunctionSignature::Ptr s(new FunctionSignature(name, minArgs, maxArgs,
       
   124                                                                  returnType, props, id));
       
   125 
       
   126             m_signatures.insert(name, s);
       
   127             return s;
       
   128         }
       
   129 
       
   130         static inline QXmlName::LocalNameCode argument(const NamePool::Ptr &np, const char *const name)
       
   131         {
       
   132             return np->allocateLocalName(QLatin1String(name));
       
   133         }
       
   134 
       
   135         FunctionSignature::Hash m_signatures;
       
   136 
       
   137     private:
       
   138         /**
       
   139          * @short Determines whether @p arity is a valid number of
       
   140          * arguments for the function with signature @p sign.
       
   141          *
       
   142          * If it is not, a static error with error code ReportContext::XPST0017
       
   143          * is issued via @p context.
       
   144          */
       
   145         void verifyArity(const FunctionSignature::Ptr &sign,
       
   146                          const StaticContext::Ptr &context,
       
   147                          const xsInteger arity,
       
   148                          const SourceLocationReflection *const r) const;
       
   149 
       
   150     };
       
   151 }
       
   152 
       
   153 QT_END_NAMESPACE
       
   154 
       
   155 QT_END_HEADER
       
   156 
       
   157 #endif