src/xmlpatterns/expr/quserfunctioncallsite_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 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 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  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_UserFunctionCallsite_H
  53 #define Patternist_UserFunctionCallsite_H
  54
  55 #include <private/qcallsite_p.h>
  56 #include <private/qfunctionsignature_p.h>
  57 #include <private/qunlimitedcontainer_p.h>
  58 #include <private/quserfunction_p.h>
  59 #include <private/qvariabledeclaration_p.h>
  60
  61 QT_BEGIN_HEADER
  62 QT_BEGIN_NAMESPACE
  63
  64 namespace QPatternist
  65 {
  66     /**
  67      * @short Performs a call to a UserFunction.
  68      *
  69      * UserFunctionCallsite is the call site to a function that has been
  70      * declared in the query using <tt>declare function</tt>. That is, it is
  71      * never used for builtin functions such as <tt>fn:count()</tt>.
  72      *
  73      * @see UserFunction
  74      * @see ArgumentReference
  75      * @author Frans Englich <frans.englich@nokia.com>
  76      * @ingroup Patternist_expressions
  77      */
  78     class UserFunctionCallsite : public CallSite
  79     {
  80     public:
  81         typedef QExplicitlySharedDataPointer<UserFunctionCallsite> Ptr;
  82         typedef QList<UserFunctionCallsite::Ptr> List;
  83
  84         UserFunctionCallsite(const QXmlName name,
  85                              const FunctionSignature::Arity arity);
  86
  87         virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;
  88         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
  89         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
  90         virtual void evaluateToSequenceReceiver(const DynamicContext::Ptr &context) const;
  91
  92         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
  93                                           const SequenceType::Ptr &reqType);
  94
  95         /**
  96          * We call compress on our body.
  97          */
  98         virtual Expression::Ptr compress(const StaticContext::Ptr &context);
  99
 100         virtual Expression::Properties properties() const;
 101
 102         /**
 103          * @short Returns the types declared in the function declaration.
 104          *
 105          * @see CallTemplate::expectedOperandTypes()
 106          */
 107         virtual SequenceType::List expectedOperandTypes() const;
 108
 109         virtual SequenceType::Ptr staticType() const;
 110         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
 111
 112         /**
 113          * @returns always IDUserFunctionCallsite.
 114          */
 115         virtual ID id() const;
 116
 117         /**
 118          * If @p slotOffset is -1, it means this function has no arguments.
 119          */
 120         void setSource(const UserFunction::Ptr &userFunction,
 121                        const VariableSlotID cacheSlotOffset);
 122
 123         /**
 124          * @returns @c true, if a function definition with signature @p sign
 125          * would be valid to call from this callsite, otherwise @c false.
 126          */
 127         bool isSignatureValid(const FunctionSignature::Ptr &sign) const;
 128
 129         FunctionSignature::Arity arity() const;
 130
 131         inline Expression::Ptr body() const
 132         {
 133             return m_body;
 134         }
 135
 136         virtual bool configureRecursion(const CallTargetDescription::Ptr &sign);
 137         virtual CallTargetDescription::Ptr callTargetDescription() const;
 138
 139     private:
 140         /**
 141          * Creates a new context sets the arguments, and returns it.
 142          */
 143         DynamicContext::Ptr bindVariables(const DynamicContext::Ptr &context) const;
 144
 145         const FunctionSignature::Arity  m_arity;
 146         /**
 147          * The reason this variable, as well as others, aren't const, is that
 148          * the binding to the actual function, is resolved after this
 149          * UserFunctionCallsite has been created.
 150          */
 151         VariableSlotID                  m_expressionSlotOffset;
 152
 153         /**
 154          * @note This may be different from m_functionDeclaration->body(). It
 155          * may differ on a per-callsite basis.
 156          */
 157         Expression::Ptr                 m_body;
 158         UserFunction::Ptr               m_functionDeclaration;
 159     };
 160
 161     /**
 162      * @short Formats UserFunctionCallsite.
 163      *
 164      * @relates UserFunctionCallsite
 165      */
 166     static inline QString formatFunction(const UserFunctionCallsite::Ptr &func)
 167     {
 168         Q_UNUSED(func);
 169         // TODO TODO TODO
 170         // TODO Make UserFunctionCallsite always use a FunctionSignature
 171         return QLatin1String("<span class='XQuery-function'>")  +
 172                QString() +
 173                //escape(func->name()->toString())                 +
 174                QLatin1String("</span>");
 175     }
 176 }
 177
 178 QT_END_NAMESPACE
 179
 180 QT_END_HEADER
 181
 182 #endif