honey_synonym.h

Go to the documentation of this file.

 
/* Copyright (C) 2005,2007,2008,2009,2011,2014,2016,2017,2024 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, see
 * <https://www.gnu.org/licenses/>.
 */
 
#ifndef XAPIAN_INCLUDED_HONEY_SYNONYM_H
#define XAPIAN_INCLUDED_HONEY_SYNONYM_H
 
#include <xapian/types.h>
 
#include "api/termlist.h"
#include "backends/alltermslist.h"
#include "honey_cursor.h"
#include "honey_lazytable.h"
 
#include <functional>
#include <set>
#include <string>
#include <string_view>
 
class HoneyDatabase;
 
namespace Honey {
    class RootInfo;
}
 
class HoneySynonymTable : public HoneyLazyTable {
    mutable std::string last_term;
 
    mutable std::set<std::string, std::less<>> last_synonyms;
 
  public:
    HoneySynonymTable(const std::string& dbdir, bool readonly)
        : HoneyLazyTable("synonym", dbdir + "/synonym.", readonly) { }
 
    HoneySynonymTable(int fd, off_t offset_, bool readonly)
        : HoneyLazyTable("synonym", fd, offset_, readonly) { }
 
    // Merge in batched-up changes.
    void merge_changes();
 
    // Discard batched-up changes.
    void discard_changes() {
        last_term.resize(0);
        last_synonyms.clear();
    }
 
    void add_synonym(std::string_view term, std::string_view synonym);
 
    void remove_synonym(std::string_view term, std::string_view synonym);
 
    void clear_synonyms(std::string_view term);
 
    TermList* open_termlist(std::string_view term) const;
 
    bool is_modified() const {
        return !last_term.empty() || HoneyTable::is_modified();
    }
 
    void flush_db() {
        merge_changes();
        HoneyTable::flush_db();
    }
 
    void cancel(const Honey::RootInfo& root_info,
                honey_revision_number_t rev) {
        discard_changes();
        HoneyTable::cancel(root_info, rev);
    }
 
    // @}
};
 
class HoneyCursor;
 
class HoneySynonymTermList : public AllTermsList {
    HoneySynonymTermList(const HoneySynonymTermList&);
 
    void operator=(const HoneySynonymTermList&);
 
    Xapian::Internal::intrusive_ptr<const HoneyDatabase> database;
 
    HoneyCursor* cursor;
 
    std::string prefix;
 
  public:
    HoneySynonymTermList(const HoneyDatabase* database_,
                         HoneyCursor* cursor_,
                         std::string_view prefix_)
        : database(database_), cursor(cursor_), prefix(prefix_)
    {
        // Set the cursor to its end to signal we haven't started yet.
        cursor->to_end();
    }
 
    ~HoneySynonymTermList();
 
    Xapian::termcount get_approx_size() const;
 
    Xapian::doccount get_termfreq() const;
 
    TermList* next();
 
    TermList* skip_to(std::string_view term);
};
 
#endif // XAPIAN_INCLUDED_HONEY_SYNONYM_H