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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
/** @file
* @brief Class for iterating over term positions.
*/
/* Copyright (C) 2008,2009,2010,2011,2012,2013,2014,2015 Olly Betts
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
* USA
*/
#ifndef XAPIAN_INCLUDED_POSITIONITERATOR_H
#define XAPIAN_INCLUDED_POSITIONITERATOR_H
#if !defined XAPIAN_IN_XAPIAN_H && !defined XAPIAN_LIB_BUILD
# error Never use <xapian/positioniterator.h> directly; include <xapian.h> instead.
#endif
#include <iterator>
#include <string>
#include <xapian/attributes.h>
#include <xapian/derefwrapper.h>
#include <xapian/types.h>
#include <xapian/visibility.h>
namespace Xapian {
/// Class for iterating over term positions.
class XAPIAN_VISIBILITY_DEFAULT PositionIterator {
void decref();
public:
/// Class representing the PositionIterator internals.
class Internal;
/// @private @internal Reference counted internals.
Internal * internal;
/// @private @internal Construct given internals.
explicit PositionIterator(Internal *internal_);
/// Copy constructor.
PositionIterator(const PositionIterator & o);
/// Assignment.
PositionIterator & operator=(const PositionIterator & o);
#ifdef XAPIAN_MOVE_SEMANTICS
/// Move constructor.
PositionIterator(PositionIterator && o)
: internal(o.internal) {
o.internal = nullptr;
}
/// Move assignment operator.
PositionIterator & operator=(PositionIterator && o) {
if (this != &o) {
if (internal) decref();
internal = o.internal;
o.internal = nullptr;
}
return *this;
}
#endif
/** Default constructor.
*
* Creates an uninitialised iterator, which can't be used before being
* assigned to, but is sometimes syntactically convenient.
*/
XAPIAN_NOTHROW(PositionIterator())
: internal() { }
/// Destructor.
~PositionIterator() {
if (internal) decref();
}
/// Return the term position at the current iterator position.
Xapian::termpos operator*() const;
/// Advance the iterator to the next position.
PositionIterator & operator++();
/// Advance the iterator to the next position (postfix version).
DerefWrapper_<Xapian::termpos> operator++(int) {
Xapian::termpos pos(**this);
operator++();
return DerefWrapper_<Xapian::termpos>(pos);
}
/** Advance the iterator to term position @a termpos.
*
* @param termpos The position to advance to. If this position isn't in
* the stream being iterated, then the iterator is moved
* to the next term position after it which is.
*/
void skip_to(Xapian::termpos termpos);
/// Return a string describing this object.
std::string get_description() const;
/** @private @internal PositionIterator is what the C++ STL calls an
* input_iterator.
*
* The following typedefs allow std::iterator_traits<> to work so that
* this iterator can be used with the STL.
*
* These are deliberately hidden from the Doxygen-generated docs, as the
* machinery here isn't interesting to API users. They just need to know
* that Xapian iterator classes are compatible with the STL.
*/
// @{
/// @private
typedef std::input_iterator_tag iterator_category;
/// @private
typedef Xapian::termpos value_type;
/// @private
typedef Xapian::termpos_diff difference_type;
/// @private
typedef value_type* pointer;
/// @private
typedef value_type reference;
// @}
};
bool
XAPIAN_NOTHROW(operator==(const PositionIterator &a, const PositionIterator &b));
/// Equality test for PositionIterator objects.
inline bool
operator==(const PositionIterator &a, const PositionIterator &b) XAPIAN_NOEXCEPT
{
// Use a pointer comparison - this ensures both that (a == a) and correct
// handling of end iterators (which we ensure have NULL internals).
return a.internal == b.internal;
}
bool
XAPIAN_NOTHROW(operator!=(const PositionIterator &a, const PositionIterator &b));
/// Inequality test for PositionIterator objects.
inline bool
operator!=(const PositionIterator &a, const PositionIterator &b) XAPIAN_NOEXCEPT
{
return !(a == b);
}
}
#endif // XAPIAN_INCLUDED_POSITIONITERATOR_H
|
