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_ApplyTemplate_H
51#define Patternist_ApplyTemplate_H
52
53#include <private/qtemplatemode_p.h>
54
55QT_BEGIN_NAMESPACE
56
57namespace QPatternist
58{
59 /**
60 * @short When combined with other components, implements
61 * @c xsl:apply-templates.
62 *
63 * Note that ApplyTemplate isn't named ApplyTemplates. The reason for this
64 * is that ApplyTemplate doesn't do the iteration part. An @c
65 * <xsl:apply-templates/> instruction is rewritten into:
66 *
67 * @code
68 * child::node/() map apply-template()
69 * @endcode
70 *
71 * Hence, this expression requires a focus, although it can consist of
72 * atomic values.
73 *
74 * @since 4.5
75 * @author Frans Englich <frans.englich@nokia.com>
76 * @ingroup Patternist_expressions
77 */
78 class ApplyTemplate : public TemplateInvoker
79 {
80 public:
81 typedef QExplicitlySharedDataPointer<ApplyTemplate> Ptr;
82
83 /**
84 * @short @p mode may be @c null. If it is, ApplyTemplate interprets
85 * that as that it should use the #current mode.
86 *
87 * @see StaticContext::currentTemplateMode()
88 */
89 ApplyTemplate(const TemplateMode::Ptr &mode,
90 const WithParam::Hash &withParams,
91 const TemplateMode::Ptr &defaultMode);
92
93 virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
94
95 virtual SequenceType::Ptr staticType() const;
96 virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
97 virtual Properties properties() const;
98
99 /**
100 * The only reason this function exists, is in order to convert
101 * QXmlNodeModelIndex to QPatternist::Item. So, this is a huge
102 * performance setback. It applies for one of the builtin templates.
103 */
104 inline Item mapToItem(const QXmlNodeModelIndex &node,
105 const DynamicContext::Ptr &context) const;
106 inline Item::Iterator::Ptr mapToSequence(const Item &item,
107 const DynamicContext::Ptr &context) const;
108
109 inline TemplateMode::Ptr mode() const;
110
111 virtual bool configureRecursion(const CallTargetDescription::Ptr &sign);
112 virtual Expression::Ptr body() const;
113 virtual CallTargetDescription::Ptr callTargetDescription() const;
114
115 Expression::Ptr compress(const StaticContext::Ptr &context);
116
117 private:
118 typedef QExplicitlySharedDataPointer<const ApplyTemplate> ConstPtr;
119
120 Template::Ptr findTemplate(const DynamicContext::Ptr &context,
121 const TemplateMode::Ptr &templateMode) const;
122 /**
123 * @note You typically want to use effectiveMode().
124 */
125 const TemplateMode::Ptr m_mode;
126
127 TemplateMode::Ptr m_defaultMode;
128
129 inline TemplateMode::Ptr effectiveMode(const DynamicContext::Ptr &context) const;
130 };
131
132 TemplateMode::Ptr ApplyTemplate::mode() const
133 {
134 return m_mode;
135 }
136}
137
138QT_END_NAMESPACE
139
140#endif
141

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