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 ** 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
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.
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.
28 ** If you have questions regarding the use of this file, please contact
29 ** Nokia at qt-info@nokia.com.
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_TemplateInvoker_H
53 #define Patternist_TemplateInvoker_H
55 #include "qcallsite_p.h"
56 #include "qwithparam_p.h"
64 * @short Base class for classes that invokes @em templates, such as
65 * CallTemplate and ApplyTemplate.
67 * TemplateInvoker has the member m_withParams, which is the @c
68 * xsl:with-param instructions of the caller. The definite source for the
69 * expressions is m_withParams, not Expression::operands(). However, the
70 * order of operands() is defined, while m_withParams is not since it's a
71 * hash. Therefore operands() is definite on order.
73 * TemplateInvoker is intended to be sub-classed.
75 * @author Frans Englich <frans.englich@nokia.com>
76 * @ingroup Patternist_expressions
79 class TemplateInvoker : public CallSite
82 virtual Expression::Ptr compress(const StaticContext::Ptr &context);
84 inline const WithParam::Hash &withParams() const;
85 WithParam::Hash m_withParams;
88 * This is a bit complicated by that we have two required types, one
89 * specified by @c xsl:param in the template declaration, and one on @c
92 * @see UserFunctionCallsite::expectedOperandTypes()
93 * @see <a href="http://www.w3.org/TR/xslt20/#with-param">XSL
94 * Transformations (XSLT) Version 2.0, 10.1.1 Passing Parameters to Templates</a>
96 virtual SequenceType::List expectedOperandTypes() const;
99 * @p withParams may be empty.
101 TemplateInvoker(const WithParam::Hash &withParams,
102 const QXmlName &name = QXmlName());
105 Q_DISABLE_COPY(TemplateInvoker)
108 const WithParam::Hash &TemplateInvoker::withParams() const