1 /****************************************************************************
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
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.
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.
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.
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.
40 ****************************************************************************/
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.
52 #ifndef Patternist_UserFunctionCallsite_H
53 #define Patternist_UserFunctionCallsite_H
55 #include "qcallsite_p.h"
56 #include "qfunctionsignature_p.h"
57 #include "qunlimitedcontainer_p.h"
58 #include "quserfunction_p.h"
59 #include "qvariabledeclaration_p.h"
67 * @short Performs a call to a UserFunction.
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>.
74 * @see ArgumentReference
75 * @author Frans Englich <frans.englich@nokia.com>
76 * @ingroup Patternist_expressions
78 class UserFunctionCallsite : public CallSite
81 typedef QExplicitlySharedDataPointer<UserFunctionCallsite> Ptr;
82 typedef QList<UserFunctionCallsite::Ptr> List;
84 UserFunctionCallsite(const QXmlName name,
85 const FunctionSignature::Arity arity);
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;
92 virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
93 const SequenceType::Ptr &reqType);
96 * We call compress on our body.
98 virtual Expression::Ptr compress(const StaticContext::Ptr &context);
100 virtual Expression::Properties properties() const;
103 * @short Returns the types declared in the function declaration.
105 * @see CallTemplate::expectedOperandTypes()
107 virtual SequenceType::List expectedOperandTypes() const;
109 virtual SequenceType::Ptr staticType() const;
110 virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
113 * @returns always IDUserFunctionCallsite.
115 virtual ID id() const;
118 * If @p slotOffset is -1, it means this function has no arguments.
120 void setSource(const UserFunction::Ptr &userFunction,
121 const VariableSlotID cacheSlotOffset);
124 * @returns @c true, if a function definition with signature @p sign
125 * would be valid to call from this callsite, otherwise @c false.
127 bool isSignatureValid(const FunctionSignature::Ptr &sign) const;
129 FunctionSignature::Arity arity() const;
131 inline Expression::Ptr body() const
136 virtual bool configureRecursion(const CallTargetDescription::Ptr &sign);
137 virtual CallTargetDescription::Ptr callTargetDescription() const;
141 * Creates a new context sets the arguments, and returns it.
143 DynamicContext::Ptr bindVariables(const DynamicContext::Ptr &context) const;
145 const FunctionSignature::Arity m_arity;
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.
151 VariableSlotID m_expressionSlotOffset;
154 * @note This may be different from m_functionDeclaration->body(). It
155 * may differ on a per-callsite basis.
157 Expression::Ptr m_body;
158 UserFunction::Ptr m_functionDeclaration;
162 * @short Formats UserFunctionCallsite.
164 * @relates UserFunctionCallsite
166 static inline QString formatFunction(const UserFunctionCallsite::Ptr &func)
170 // TODO Make UserFunctionCallsite always use a FunctionSignature
171 return QLatin1String("<span class='XQuery-function'>") +
173 //escape(func->name()->toString()) +
174 QLatin1String("</span>");