1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtXmlPatterns module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL21$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** $QT_END_LICENSE$
**
****************************************************************************/
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
#ifndef Patternist_RangeIterator_H
#define Patternist_RangeIterator_H
#include <private/qitem_p.h>
QT_BEGIN_NAMESPACE
namespace QPatternist
{
/**
* @short RangeIterator represents a sequence of integers between a
* start and end value.
*
* The RangeIterator contains the evaluation logic for the range expression, <tt>N to M</tt>,
* and its behavior is therefore consistent with the definition of that XPath expression.
* Hence, the detailed behavior of the RangeIterator can be found in the XPath 2.0
* specification.
*
* @see <a href="http://www.w3.org/TR/xpath20/\#doc-xpath-RangeExpr">XML Path Language
* (XPath) 2.0, 3.3 Sequence Expressions, RangeExpr</a>
* @see RangeExpression
* @author Frans Englich <frans.englich@nokia.com>
* @ingroup Patternist_iterators
* @todo Documentation is missing
*/
class Q_AUTOTEST_EXPORT RangeIterator : public Item::Iterator
{
public:
/**
* RangeIterator can iterate in both directions.
* This enumerator exist for identifying different directions.
*/
enum Direction
{
/**
* Signifies that the QAbstractXmlForwardIterator operates in a reverse direction, where the
* first item returned by the next() function is from the beginning of the
* source sequence.
*/
Backward = 0,
/**
* Signifies the forward direction. Iterators do conceptually operate
* in the forward direction by default.
*/
Forward = 1
};
/**
* Creates an QAbstractXmlForwardIterator that returns integer values from consecutive sequence
* of integers between @p start and @p end, where the step taken
* between each integer is 1 with polarity as specified in @p direction.
*
* @note @p start must be smaller than @p end, not larger
* or equal. This is not checked.
*/
RangeIterator(const xsInteger start,
const Direction direction,
const xsInteger end);
virtual Item next();
virtual Item current() const;
virtual xsInteger position() const;
virtual xsInteger count();
virtual Item::Iterator::Ptr toReversed();
virtual Item::Iterator::Ptr copy() const;
private:
xsInteger m_start;
xsInteger m_end;
Item m_current;
xsInteger m_position;
xsInteger m_count;
const Direction m_direction;
/**
* We only need to store -1 or 1, so save memory with a bit field.
*/
const qint8 m_increment : 2;
};
}
QT_END_NAMESPACE
#endif
|
