1 /****************************************************************************
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
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 Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
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 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
40 ****************************************************************************/
44 #include "qaxisstep_p.h"
45 #include "qcommonsequencetypes_p.h"
46 #include "qcommonvalues_p.h"
47 #include "qitemmappingiterator_p.h"
48 #include "qsequencemappingiterator_p.h"
49 #include "qpatternistlocale_p.h"
51 #include "qapplytemplate_p.h"
55 using namespace QPatternist;
57 ApplyTemplate::ApplyTemplate(const TemplateMode::Ptr &mode,
58 const WithParam::Hash &withParams,
59 const TemplateMode::Ptr &defaultMode) : TemplateInvoker(withParams)
61 , m_defaultMode(defaultMode)
63 Q_ASSERT_X(m_mode || m_defaultMode, Q_FUNC_INFO,
64 "Either a mode, or the default mode must be supplied.");
67 Item ApplyTemplate::mapToItem(const QXmlNodeModelIndex &node,
68 const DynamicContext::Ptr &) const
73 Item::Iterator::Ptr ApplyTemplate::mapToSequence(const Item &item,
74 const DynamicContext::Ptr &context) const
77 return evaluateSequence(context);
80 TemplateMode::Ptr ApplyTemplate::effectiveMode(const DynamicContext::Ptr &context) const
86 const TemplateMode::Ptr currentMode(context->currentTemplateMode());
95 Template::Ptr ApplyTemplate::findTemplate(const DynamicContext::Ptr &context,
96 const TemplateMode::Ptr &templateMode) const
98 const int count = templateMode->templatePatterns.count();
100 /* It's redundant to initialize these values, but it suppresses false
101 * positives with GCC. */
102 PatternPriority priority = 0;
103 TemplatePattern::ID id = -1;
105 /* Possible optimization: detecting ambiguous rule matches could be forked off to a
106 * low prioirity thread. */
107 for(int i = 0; i < count; ++i)
109 const TemplatePattern::Ptr &candidate = templateMode->templatePatterns.at(i);
110 if(candidate->matchPattern()->evaluateEBV(context))
114 if( candidate->id() != id
115 && candidate->priority() == priority
116 && candidate->templateTarget()->importPrecedence ==
117 result->importPrecedence)
119 context->error(QtXmlPatterns::tr("Ambiguous rule match."),
120 ReportContext::XTRE0540, this);
127 result = candidate->templateTarget();
128 priority = candidate->priority();
129 id = candidate->id();
137 Item::Iterator::Ptr ApplyTemplate::evaluateSequence(const DynamicContext::Ptr &context) const
139 const TemplateMode::Ptr templateMode(effectiveMode(context));
140 const Template::Ptr &templateMatch = findTemplate(context, templateMode);
143 return templateMatch->body->evaluateSequence(templateMatch->createContext(this, context, false));
146 /* None of our templates matched. Proceed with a built-in. */
147 const Item current(context->contextItem());
148 // TODO it can be an atomic value?
149 const QXmlNodeModelIndex::NodeKind kind(current.asNode().kind());
151 if(kind == QXmlNodeModelIndex::Element || kind == QXmlNodeModelIndex::Document)
153 pDebug() << "No template match, using builtin template for element() | document-node()";
155 const Item::Iterator::Ptr focusIterator(makeItemMappingIterator<Item>(ConstPtr(this),
156 current.asNode().iterate(QXmlNodeModelIndex::AxisChild),
159 const DynamicContext::Ptr focus(context->createFocus());
160 focus->setFocusIterator(focusIterator);
161 return makeSequenceMappingIterator<Item>(ConstPtr(this), focusIterator, focus);
163 return CommonValues::emptyIterator;
167 Expression::Ptr ApplyTemplate::compress(const StaticContext::Ptr &context)
169 /* If we have a mode, we will never need the default mode. */
171 m_defaultMode.reset();
173 return TemplateInvoker::compress(context);
176 SequenceType::Ptr ApplyTemplate::staticType() const
178 return CommonSequenceTypes::ZeroOrMoreItems;
181 ExpressionVisitorResult::Ptr ApplyTemplate::accept(const ExpressionVisitor::Ptr &visitor) const
183 return visitor->visit(this);
186 Expression::Properties ApplyTemplate::properties() const
188 return RequiresFocus | DisableElimination;
191 bool ApplyTemplate::configureRecursion(const CallTargetDescription::Ptr &sign)
193 Q_ASSERT_X(false, Q_FUNC_INFO, "We're not expected to be called.");
198 Expression::Ptr ApplyTemplate::body() const
200 Q_ASSERT_X(false, Q_FUNC_INFO, "We're not expected to be called.");
201 return Expression::Ptr();
204 CallTargetDescription::Ptr ApplyTemplate::callTargetDescription() const
206 Q_ASSERT_X(false, Q_FUNC_INFO, "We're not expected to be called.");
207 return CallTargetDescription::Ptr();