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_ForClause_H
51#define Patternist_ForClause_H
52
53#include <private/qpaircontainer_p.h>
54
55QT_BEGIN_NAMESPACE
56
57namespace QPatternist
58{
59
60 /**
61 * @short Implements XPath 2.0's @c for expression.
62 *
63 * @see <a href="http://www.w3.org/TR/xpath20/#id-for-expressions">XML Path Language
64 * (XPath) 2.0, 3.7 For Expressions</a>
65 * @author Frans Englich <frans.englich@nokia.com>
66 * @ingroup Patternist_expressions
67 */
68 class ForClause : public PairContainer
69 {
70 public:
71 /**
72 * If @p positionSlot is -1, no positional variable will be used.
73 */
74 ForClause(const VariableSlotID varSlot,
75 const Expression::Ptr &bindingSequence,
76 const Expression::Ptr &returnExpression,
77 const VariableSlotID positionSlot);
78
79 virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
80 virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
81 virtual void evaluateToSequenceReceiver(const DynamicContext::Ptr &context) const;
82
83 virtual SequenceType::Ptr staticType() const;
84 virtual SequenceType::List expectedOperandTypes() const;
85 virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
86 const SequenceType::Ptr &reqType);
87 virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
88 virtual QList<QExplicitlySharedDataPointer<OptimizationPass> > optimizationPasses() const;
89
90 inline Item mapToItem(const Item &item,
91 const DynamicContext::Ptr &context) const;
92 virtual ID id() const;
93 inline Item::Iterator::Ptr mapToSequence(const Item &item,
94 const DynamicContext::Ptr &context) const;
95
96 /**
97 * Sets m_allowsMany properly.
98 */
99 virtual Expression::Ptr compress(const StaticContext::Ptr &context);
100
101 private:
102 inline void riggPositionalVariable(const DynamicContext::Ptr &context,
103 const Item::Iterator::Ptr &source) const;
104 typedef QExplicitlySharedDataPointer<const ForClause> ConstPtr;
105 const VariableSlotID m_varSlot;
106 const VariableSlotID m_positionSlot;
107 /**
108 * Initialized to @c false. This default is always safe.
109 */
110 bool m_allowsMany;
111 };
112}
113
114QT_END_NAMESPACE
115
116#endif
117

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