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_RangeIterator_H
51#define Patternist_RangeIterator_H
52
53#include <private/qitem_p.h>
54
55QT_BEGIN_NAMESPACE
56
57namespace QPatternist
58{
59 /**
60 * @short RangeIterator represents a sequence of integers between a
61 * start and end value.
62 *
63 * The RangeIterator contains the evaluation logic for the range expression, <tt>N to M</tt>,
64 * and its behavior is therefore consistent with the definition of that XPath expression.
65 * Hence, the detailed behavior of the RangeIterator can be found in the XPath 2.0
66 * specification.
67 *
68 * @see <a href="http://www.w3.org/TR/xpath20/\#doc-xpath-RangeExpr">XML Path Language
69 * (XPath) 2.0, 3.3 Sequence Expressions, RangeExpr</a>
70 * @see RangeExpression
71 * @author Frans Englich <frans.englich@nokia.com>
72 * @ingroup Patternist_iterators
73 * @todo Documentation is missing
74 */
75 class Q_AUTOTEST_EXPORT RangeIterator : public Item::Iterator
76 {
77 public:
78
79 /**
80 * RangeIterator can iterate in both directions.
81 * This enumerator exist for identifying different directions.
82 */
83 enum Direction
84 {
85 /**
86 * Signifies that the QAbstractXmlForwardIterator operates in a reverse direction, where the
87 * first item returned by the next() function is from the beginning of the
88 * source sequence.
89 */
90 Backward = 0,
91
92 /**
93 * Signifies the forward direction. Iterators do conceptually operate
94 * in the forward direction by default.
95 */
96 Forward = 1
97 };
98
99 /**
100 * Creates an QAbstractXmlForwardIterator that returns integer values from consecutive sequence
101 * of integers between @p start and @p end, where the step taken
102 * between each integer is 1 with polarity as specified in @p direction.
103 *
104 * @note @p start must be smaller than @p end, not larger
105 * or equal. This is not checked.
106 */
107 RangeIterator(const xsInteger start,
108 const Direction direction,
109 const xsInteger end);
110
111 virtual Item next();
112 virtual Item current() const;
113 virtual xsInteger position() const;
114 virtual xsInteger count();
115 virtual Item::Iterator::Ptr toReversed();
116 virtual Item::Iterator::Ptr copy() const;
117
118 private:
119 xsInteger m_start;
120 xsInteger m_end;
121 Item m_current;
122 xsInteger m_position;
123 xsInteger m_count;
124 const Direction m_direction;
125
126 /**
127 * We only need to store -1 or 1, so save memory with a bit field.
128 */
129 const qint8 m_increment : 2;
130 };
131}
132
133QT_END_NAMESPACE
134
135#endif
136

Provided by KDAB

Privacy Policy
Start learning QML with our Intro Training
Find out more

source code of qtxmlpatterns/src/xmlpatterns/iterators/qrangeiterator_p.h