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_Template_H
51#define Patternist_Template_H
52
53#include <QSharedData>
54#include <QVector>
55
56#include <private/qdynamiccontext_p.h>
57#include <private/qexpression_p.h>
58#include <private/qsourcelocationreflection_p.h>
59#include <private/qtemplateinvoker_p.h>
60#include <private/qvariabledeclaration_p.h>
61
62QT_BEGIN_NAMESPACE
63
64namespace QPatternist
65{
66 /**
67 * @short Contains data related to a template.
68 *
69 * A Template is associated with a mode, by being housed
70 * inside a TemplateMode instance.
71 *
72 * Template has role very similar to UserFunction.
73 *
74 * @see TemplateMode
75 * @see TemplatePattern
76 * @see UserFunction
77 * @author Frans Englich <frans.englich@nokia.com>
78 * @ingroup Patternist_expressions
79 * @since 4.5
80 */
81 class Q_AUTOTEST_EXPORT Template : public QSharedData, public SourceLocationReflection
82
83 {
84 public:
85 typedef QExplicitlySharedDataPointer<Template> Ptr;
86 typedef QVector<Template::Ptr> Vector;
87
88 inline Template(const ImportPrecedence ip,
89 const SequenceType::Ptr &reqType) : importPrecedence(ip)
90 , m_reqType(reqType)
91 {
92 }
93 ~Template();
94
95 Expression::Ptr body;
96
97 /**
98 * Returns @c this.
99 */
100 virtual const SourceLocationReflection* actualReflection() const;
101
102 const ImportPrecedence importPrecedence;
103
104 VariableDeclaration::List templateParameters;
105
106 /**
107 * If @p isCallTemplate, the caller is @c xsl:call-template, as opposed
108 * to for instance @c xsl:apply-templates. This affects error
109 * reporting.
110 */
111 DynamicContext::Ptr createContext(const TemplateInvoker *const invoker,
112 const DynamicContext::Ptr &context,
113 const bool isCallTemplate) const;
114
115 /**
116 * Since we have our template parameters in templateParameters, we need
117 * this separate step to do the regular phases:
118 * Expression::typeCheck(), and Expression::compress().
119 */
120 void compileParameters(const StaticContext::Ptr &context);
121
122 /**
123 * A value which takes into account the body and its template
124 * parameters.
125 */
126 Expression::Properties properties() const;
127
128 Expression::Properties dependencies() const;
129
130 static void raiseXTSE0680(const ReportContext::Ptr &context,
131 const QXmlName &name,
132 const SourceLocationReflection *const reflection);
133
134 private:
135 DynamicContext::TemplateParameterHash parametersAsHash() const;
136 const SequenceType::Ptr m_reqType;
137 };
138}
139
140QT_END_NAMESPACE
141
142#endif
143

source code of qtxmlpatterns/src/xmlpatterns/expr/qtemplate_p.h