honey_spellingwordslist.h

Go to the documentation of this file.

 
/* Copyright (C) 2005,2008,2009,2010,2011,2017,2024 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, see
 * <https://www.gnu.org/licenses/>.
 */
 
#ifndef XAPIAN_INCLUDED_HONEY_SPELLINGWORDSLIST_H
#define XAPIAN_INCLUDED_HONEY_SPELLINGWORDSLIST_H
 
#include "backends/alltermslist.h"
#include "honey_spelling.h"
#include "honey_cursor.h"
 
class HoneyDatabase;
 
class HoneySpellingWordsList : public AllTermsList {
    HoneySpellingWordsList(const HoneySpellingWordsList&);
 
    void operator=(const HoneySpellingWordsList&);
 
    Xapian::Internal::intrusive_ptr<const HoneyDatabase> database;
 
    HoneyCursor* cursor;
 
    mutable Xapian::termcount termfreq = 0;
 
    void read_termfreq() const;
 
  public:
    HoneySpellingWordsList(const HoneyDatabase* database_, HoneyCursor* cursor_)
        : database(database_), cursor(cursor_)
    {
        // Set the cursor to its end to signal we haven't started yet.  Then
        // if the first action is next() we can move the cursor to the first
        // word with:
        //
        // cursor.find_entry_ge(string(1, KEY_PREFIX_WORD));
        cursor->to_end();
    }
 
    ~HoneySpellingWordsList();
 
    Xapian::termcount get_approx_size() const;
 
    Xapian::doccount get_termfreq() const;
 
    TermList* next();
 
    TermList* skip_to(std::string_view term);
};
 
#endif /* XAPIAN_INCLUDED_HONEY_SPELLINGWORDSLIST_H */