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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>LCOV - lcov.info - /usr/include/xapian/termiterator.h</title>
<link rel="stylesheet" type="text/css" href="../../../gcov.css">
</head>
<body>
<table width="100%" border=0 cellspacing=0 cellpadding=0>
<tr><td class="title">LTP GCOV extension - code coverage report</td></tr>
<tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr>
<tr>
<td width="100%">
<table cellpadding=1 border=0 width="100%">
<tr>
<td class="headerItem" width="20%">Current view:</td>
<td class="headerValue" width="80%" colspan=4><a href="../../../index.html">directory</a> - <a href="index.html">usr/include/xapian</a> - termiterator.h</td>
</tr>
<tr>
<td class="headerItem" width="20%">Test:</td>
<td class="headerValue" width="80%" colspan=4>lcov.info</td>
</tr>
<tr>
<td class="headerItem" width="20%">Date:</td>
<td class="headerValue" width="20%">2008-08-14</td>
<td width="20%"></td>
<td class="headerItem" width="20%">Instrumented lines:</td>
<td class="headerValue" width="20%">4</td>
</tr>
<tr>
<td class="headerItem" width="20%">Code covered:</td>
<td class="headerValue" width="20%">100.0 %</td>
<td width="20%"></td>
<td class="headerItem" width="20%">Executed lines:</td>
<td class="headerValue" width="20%">4</td>
</tr>
</table>
</td>
</tr>
<tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr>
</table>
<table cellpadding=0 cellspacing=0 border=0>
<tr>
<td><br></td>
</tr>
<tr>
<td><pre class="source">
<span class="lineNum"> 1 </span> : /** \file termiterator.h
<span class="lineNum"> 2 </span> : * \brief Classes for iterating through term lists
<span class="lineNum"> 3 </span> : */
<span class="lineNum"> 4 </span> : /* Copyright 1999,2000,2001 BrightStation PLC
<span class="lineNum"> 5 </span> : * Copyright 2002 Ananova Ltd
<span class="lineNum"> 6 </span> : * Copyright 2003,2004,2005,2006,2007 Olly Betts
<span class="lineNum"> 7 </span> : *
<span class="lineNum"> 8 </span> : * This program is free software; you can redistribute it and/or
<span class="lineNum"> 9 </span> : * modify it under the terms of the GNU General Public License as
<span class="lineNum"> 10 </span> : * published by the Free Software Foundation; either version 2 of the
<span class="lineNum"> 11 </span> : * License, or (at your option) any later version.
<span class="lineNum"> 12 </span> : *
<span class="lineNum"> 13 </span> : * This program is distributed in the hope that it will be useful,
<span class="lineNum"> 14 </span> : * but WITHOUT ANY WARRANTY; without even the implied warranty of
<span class="lineNum"> 15 </span> : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
<span class="lineNum"> 16 </span> : * GNU General Public License for more details.
<span class="lineNum"> 17 </span> : *
<span class="lineNum"> 18 </span> : * You should have received a copy of the GNU General Public License
<span class="lineNum"> 19 </span> : * along with this program; if not, write to the Free Software
<span class="lineNum"> 20 </span> : * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
<span class="lineNum"> 21 </span> : * USA
<span class="lineNum"> 22 </span> : */
<span class="lineNum"> 23 </span> :
<span class="lineNum"> 24 </span> : #ifndef XAPIAN_INCLUDED_TERMITERATOR_H
<span class="lineNum"> 25 </span> : #define XAPIAN_INCLUDED_TERMITERATOR_H
<span class="lineNum"> 26 </span> :
<span class="lineNum"> 27 </span> : #include <iterator>
<span class="lineNum"> 28 </span> : #include <string>
<span class="lineNum"> 29 </span> :
<span class="lineNum"> 30 </span> : #include <xapian/base.h>
<span class="lineNum"> 31 </span> : #include <xapian/types.h>
<span class="lineNum"> 32 </span> : #include <xapian/positioniterator.h>
<span class="lineNum"> 33 </span> : #include <xapian/visibility.h>
<span class="lineNum"> 34 </span> :
<span class="lineNum"> 35 </span> : namespace Xapian {
<span class="lineNum"> 36 </span> :
<span class="lineNum"> 37 </span> : class Database;
<span class="lineNum"> 38 </span> :
<span class="lineNum"> 39 </span> : /** @internal A wrapper class for a termname which returns the termname if
<span class="lineNum"> 40 </span> : * dereferenced with *. We need this to implement input_iterator semantics.
<span class="lineNum"> 41 </span> : */
<span class="lineNum"> 42 </span> : class TermNameWrapper {
<span class="lineNum"> 43 </span> : private:
<span class="lineNum"> 44 </span> : std::string tname;
<span class="lineNum"> 45 </span> : public:
<span class="lineNum"> 46 </span> : explicit TermNameWrapper(const std::string & tname_) : tname(tname_) { }
<span class="lineNum"> 47 </span> : const std::string & operator*() const { return tname; }
<span class="lineNum"> 48 </span> : };
<span class="lineNum"> 49 </span> :
<span class="lineNum"> 50 </span> : /** An iterator pointing to items in a list of terms.
<span class="lineNum"> 51 </span> : */
<span class="lineNum"> 52 </span> : class XAPIAN_VISIBILITY_DEFAULT TermIterator {
<span class="lineNum"> 53 </span> : public:
<span class="lineNum"> 54 </span> : class Internal;
<span class="lineNum"> 55 </span> : /// @internal Reference counted internals.
<span class="lineNum"> 56 </span> : Xapian::Internal::RefCntPtr<Internal> internal;
<span class="lineNum"> 57 </span> :
<span class="lineNum"> 58 </span> : /// @internal Reference counted internals.
<span class="lineNum"> 59 </span> : explicit TermIterator(Internal *internal_);
<span class="lineNum"> 60 </span> :
<span class="lineNum"> 61 </span> : /// Default constructor - for declaring an uninitialised iterator.
<span class="lineNum"> 62 </span> : TermIterator();
<span class="lineNum"> 63 </span> :
<span class="lineNum"> 64 </span> : /// Destructor.
<span class="lineNum"> 65 </span> : ~TermIterator();
<span class="lineNum"> 66 </span> :
<span class="lineNum"> 67 </span> : /** Copying is allowed. The internals are reference counted, so
<span class="lineNum"> 68 </span> : * copying is also cheap.
<span class="lineNum"> 69 </span> : */
<span class="lineNum"> 70 </span> : TermIterator(const TermIterator &other);
<span class="lineNum"> 71 </span> :
<span class="lineNum"> 72 </span> : /** Assignment is allowed. The internals are reference counted,
<span class="lineNum"> 73 </span> : * so assignment is also cheap.
<span class="lineNum"> 74 </span> : */
<span class="lineNum"> 75 </span> : void operator=(const TermIterator &other);
<span class="lineNum"> 76 </span> :
<span class="lineNum"> 77 </span> : /// Return the current term.
<span class="lineNum"> 78 </span> : std::string operator *() const;
<span class="lineNum"> 79 </span> :
<span class="lineNum"> 80 </span> : TermIterator & operator++();
<span class="lineNum"> 81 </span> :
<span class="lineNum"> 82 </span> : TermNameWrapper operator++(int) {
<span class="lineNum"> 83 </span> : std::string tmp = **this;
<span class="lineNum"> 84 </span> : operator++();
<span class="lineNum"> 85 </span> : return TermNameWrapper(tmp);
<span class="lineNum"> 86 </span> : }
<span class="lineNum"> 87 </span> :
<span class="lineNum"> 88 </span> : /** Skip the iterator to term tname, or the first term after tname
<span class="lineNum"> 89 </span> : * if tname isn't in the list of terms being iterated.
<span class="lineNum"> 90 </span> : */
<span class="lineNum"> 91 </span> : void skip_to(const std::string & tname);
<span class="lineNum"> 92 </span> :
<span class="lineNum"> 93 </span> : /** Return the wdf of the current term (if meaningful).
<span class="lineNum"> 94 </span> : *
<span class="lineNum"> 95 </span> : * The wdf (within document frequency) is the number of occurences
<span class="lineNum"> 96 </span> : * of a term in a particular document.
<span class="lineNum"> 97 </span> : */
<span class="lineNum"> 98 </span> : Xapian::termcount get_wdf() const;
<span class="lineNum"> 99 </span> :
<span class="lineNum"> 100 </span> : /** Return the term frequency of the current term (if meaningful).
<span class="lineNum"> 101 </span> : *
<span class="lineNum"> 102 </span> : * The term frequency is the number of documents which a term indexes.
<span class="lineNum"> 103 </span> : */
<span class="lineNum"> 104 </span> : Xapian::doccount get_termfreq() const;
<span class="lineNum"> 105 </span> :
<span class="lineNum"> 106 </span> : /** Return length of positionlist for current term.
<span class="lineNum"> 107 </span> : */
<span class="lineNum"> 108 </span> : Xapian::termcount positionlist_count() const;
<span class="lineNum"> 109 </span> :
<span class="lineNum"> 110 </span> : /** Return PositionIterator pointing to start of positionlist for
<span class="lineNum"> 111 </span> : * current term.
<span class="lineNum"> 112 </span> : */
<span class="lineNum"> 113 </span> : PositionIterator positionlist_begin() const;
<span class="lineNum"> 114 </span> :
<span class="lineNum"> 115 </span> : /** Return PositionIterator pointing to end of positionlist for
<span class="lineNum"> 116 </span> : * current term.
<span class="lineNum"> 117 </span> : */
<span class="lineNum"> 118 </span> : PositionIterator positionlist_end() const {
<span class="lineNum"> 119 </span> : return PositionIterator(NULL);
<span class="lineNum"> 120 </span> : }
<span class="lineNum"> 121 </span> :
<span class="lineNum"> 122 </span> : /// Return a string describing this object.
<span class="lineNum"> 123 </span> : std::string get_description() const;
<span class="lineNum"> 124 </span> :
<span class="lineNum"> 125 </span> : /// Allow use as an STL iterator
<span class="lineNum"> 126 </span> : //@{
<span class="lineNum"> 127 </span> : typedef std::input_iterator_tag iterator_category;
<span class="lineNum"> 128 </span> : typedef std::string value_type;
<span class="lineNum"> 129 </span> : typedef Xapian::termcount_diff difference_type;
<span class="lineNum"> 130 </span> : typedef std::string * pointer;
<span class="lineNum"> 131 </span> : typedef std::string & reference;
<span class="lineNum"> 132 </span> : //@}
<span class="lineNum"> 133 </span> : };
<span class="lineNum"> 134 </span> :
<span class="lineNum"> 135 </span> : inline bool
<span class="lineNum"> 136 </span><span class="lineCov"> 5 : operator==(const TermIterator &a, const TermIterator &b)</span>
<span class="lineNum"> 137 </span> : {
<span class="lineNum"> 138 </span><span class="lineCov"> 5 : return (a.internal.get() == b.internal.get());</span>
<span class="lineNum"> 139 </span> : }
<span class="lineNum"> 140 </span> :
<span class="lineNum"> 141 </span> : inline bool
<span class="lineNum"> 142 </span><span class="lineCov"> 5 : operator!=(const TermIterator &a, const TermIterator &b)</span>
<span class="lineNum"> 143 </span> : {
<span class="lineNum"> 144 </span><span class="lineCov"> 5 : return !(a == b);</span>
<span class="lineNum"> 145 </span> : }
<span class="lineNum"> 146 </span> :
<span class="lineNum"> 147 </span> : }
<span class="lineNum"> 148 </span> :
<span class="lineNum"> 149 </span> : #endif /* XAPIAN_INCLUDED_TERMITERATOR_H */
</pre>
</td>
</tr>
</table>
<br>
<table width="100%" border=0 cellspacing=0 cellpadding=0>
<tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr>
<tr><td class="versionInfo">Generated by: <a href="http://ltp.sourceforge.net/coverage/lcov.php" target="_parent">LTP GCOV extension version 1.6</a></td></tr>
</table>
<br>
</body>
</html>
|
