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
|
/* flint_spellingwordslist.h: A termlist containing all words which are spelling targets.
*
* Copyright (C) 2005,2008 Olly Betts
* Copyright (C) 2007 Lemur Consulting Ltd
*
* 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_HGUARD_FLINT_SPELLINGWORDSLIST_H
#define XAPIAN_HGUARD_FLINT_SPELLINGWORDSLIST_H
#include "alltermslist.h"
#include "database.h"
#include "flint_spelling.h"
class FlintCursor;
class FlintSpellingWordsList : public AllTermsList {
/// Copying is not allowed.
FlintSpellingWordsList(const FlintSpellingWordsList &);
/// Assignment is not allowed.
void operator=(const FlintSpellingWordsList &);
/// Keep a reference to our database to stop it being deleted.
Xapian::Internal::RefCntPtr<const Xapian::Database::Internal> database;
/** A cursor which runs through the spelling table reading termnames from
* the keys.
*/
FlintCursor * cursor;
/** The term frequency of the term at the current position.
*
* If this value is zero, then we haven't read the term frequency or
* collection frequency for the current term yet. We need to call
* read_termfreq() to read these.
*/
mutable Xapian::termcount termfreq;
/// Read and cache the term frequency.
void read_termfreq() const;
public:
FlintSpellingWordsList(Xapian::Internal::RefCntPtr<const Xapian::Database::Internal> database_,
FlintCursor * cursor_)
: database(database_), cursor(cursor_), termfreq(0) {
// Seek to the entry before the first key with a "W" prefix, so the
// first next() will advance us to the first such entry.
cursor->find_entry(std::string("W", 1));
}
/// Destructor.
~FlintSpellingWordsList();
/** Returns the current termname.
*
* Either next() or skip_to() must have been called before this
* method can be called.
*/
std::string get_termname() const;
/** Returns the term frequency of the current term.
*
* Either next() or skip_to() must have been called before this
* method can be called.
*/
Xapian::doccount get_termfreq() const;
/** Returns the collection frequency of the current term.
*
* Either next() or skip_to() must have been called before this
* method can be called.
*/
Xapian::termcount get_collection_freq() const;
/// Advance to the next term in the list.
TermList * next();
/// Advance to the first term which is >= tname.
TermList * skip_to(const std::string &tname);
/// True if we're off the end of the list
bool at_end() const;
};
#endif /* XAPIAN_HGUARD_FLINT_SPELLINGWORDSLIST_H */
|
