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_RangeExpression_H
51 #define Patternist_RangeExpression_H
52 
53 #include <private/qpaircontainer_p.h>
54 
55 QT_BEGIN_NAMESPACE
56 
57 namespace QPatternist
58 {
59 
60     /**
61      * @short Implements XPath 2.0's @c to expression.
62      *
63      * Despite its name, RangeExpression is not related to RangeVariableDeclaration.
64      *
65      * @see <a href="http://www.w3.org/TR/xpath20/#construct_seq">XML Path Language
66      * (XPath) 2.0, 3.3.1 Constructing Sequences</a>
67      * @see RangeIterator
68      * @author Frans Englich <frans.englich@nokia.com>
69      * @ingroup Patternist_expressions
70      */
71     class RangeExpression : public PairContainer
72     {
73     public:
74         RangeExpression(const Expression::Ptr &operand1, const Expression::Ptr &operand2);
75 
76         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &) const;
77         /**
78          * It's likely that this function gets called if staticType() inferred
79          * the cardinality to an exact number. In that case, we know that the
80          * first arguments is the same as the second argument.
81          */
82         virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
83 
84         virtual SequenceType::List expectedOperandTypes() const;
85 
86         /**
87          * @returns always CommonSequenceTypes::ZeroOrMoreIntegers
88          */
89         virtual SequenceType::Ptr staticType() const;
90 
91         /**
92          * Disables compression for optimization reasons. For example, the
93          * expression "1 to 1000" would consume thousand allocated instances
94          * of Integer, and RangeIterator is well suited for dynamic evaluation.
95          *
96          * @returns Expression::DisableElimination
97          */
98         virtual Expression::Properties properties() const;
99 
100         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
101     };
102 }
103 
104 QT_END_NAMESPACE
105 
106 #endif
107