1 | /**************************************************************************** |
2 | ** |
3 | ** Copyright (C) 2016 The Qt Company Ltd. |
4 | ** Contact: https://www.qt.io/licensing/ |
5 | ** |
6 | ** This file is part of the QtXmlPatterns module of the Qt Toolkit. |
7 | ** |
8 | ** $QT_BEGIN_LICENSE:LGPL$ |
9 | ** Commercial License Usage |
10 | ** Licensees holding valid commercial Qt licenses may use this file in |
11 | ** accordance with the commercial license agreement provided with the |
12 | ** Software or, alternatively, in accordance with the terms contained in |
13 | ** a written agreement between you and The Qt Company. For licensing terms |
14 | ** and conditions see https://www.qt.io/terms-conditions. For further |
15 | ** information use the contact form at https://www.qt.io/contact-us. |
16 | ** |
17 | ** GNU Lesser General Public License Usage |
18 | ** Alternatively, this file may be used under the terms of the GNU Lesser |
19 | ** General Public License version 3 as published by the Free Software |
20 | ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
21 | ** packaging of this file. Please review the following information to |
22 | ** ensure the GNU Lesser General Public License version 3 requirements |
23 | ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
24 | ** |
25 | ** GNU General Public License Usage |
26 | ** Alternatively, this file may be used under the terms of the GNU |
27 | ** General Public License version 2.0 or (at your option) the GNU General |
28 | ** Public license version 3 or any later version approved by the KDE Free |
29 | ** Qt Foundation. The licenses are as published by the Free Software |
30 | ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
31 | ** included in the packaging of this file. Please review the following |
32 | ** information to ensure the GNU General Public License requirements will |
33 | ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
34 | ** https://www.gnu.org/licenses/gpl-3.0.html. |
35 | ** |
36 | ** $QT_END_LICENSE$ |
37 | ** |
38 | ****************************************************************************/ |
39 | |
40 | // |
41 | // W A R N I N G |
42 | // ------------- |
43 | // |
44 | // This file is not part of the Qt API. It exists purely as an |
45 | // implementation detail. This header file may change from version to |
46 | // version without notice, or even be removed. |
47 | // |
48 | // We mean it. |
49 | |
50 | #ifndef Patternist_TemplateInvoker_H |
51 | #define Patternist_TemplateInvoker_H |
52 | |
53 | #include <private/qcallsite_p.h> |
54 | #include <private/qwithparam_p.h> |
55 | |
56 | QT_BEGIN_NAMESPACE |
57 | |
58 | namespace QPatternist |
59 | { |
60 | /** |
61 | * @short Base class for classes that invokes @em templates, such as |
62 | * CallTemplate and ApplyTemplate. |
63 | * |
64 | * TemplateInvoker has the member m_withParams, which is the @c |
65 | * xsl:with-param instructions of the caller. The definite source for the |
66 | * expressions is m_withParams, not Expression::operands(). However, the |
67 | * order of operands() is defined, while m_withParams is not since it's a |
68 | * hash. Therefore operands() is definite on order. |
69 | * |
70 | * TemplateInvoker is intended to be sub-classed. |
71 | * |
72 | * @author Frans Englich <frans.englich@nokia.com> |
73 | * @ingroup Patternist_expressions |
74 | * @since 4.5 |
75 | */ |
76 | class TemplateInvoker : public CallSite |
77 | { |
78 | public: |
79 | virtual Expression::Ptr compress(const StaticContext::Ptr &context); |
80 | |
81 | inline const WithParam::Hash &withParams() const; |
82 | WithParam::Hash m_withParams; |
83 | |
84 | /** |
85 | * This is a bit complicated by that we have two required types, one |
86 | * specified by @c xsl:param in the template declaration, and one on @c |
87 | * xsl:with-param. |
88 | * |
89 | * @see UserFunctionCallsite::expectedOperandTypes() |
90 | * @see <a href="http://www.w3.org/TR/xslt20/#with-param">XSL |
91 | * Transformations (XSLT) Version 2.0, 10.1.1 Passing Parameters to Templates</a> |
92 | */ |
93 | virtual SequenceType::List expectedOperandTypes() const; |
94 | protected: |
95 | /** |
96 | * @p withParams may be empty. |
97 | */ |
98 | TemplateInvoker(const WithParam::Hash &withParams, |
99 | const QXmlName &name = QXmlName()); |
100 | |
101 | private: |
102 | Q_DISABLE_COPY(TemplateInvoker) |
103 | }; |
104 | |
105 | const WithParam::Hash &TemplateInvoker::withParams() const |
106 | { |
107 | return m_withParams; |
108 | } |
109 | |
110 | } |
111 | |
112 | QT_END_NAMESPACE |
113 | |
114 | #endif |
115 | |
116 | |