honey_termlist.h

Go to the documentation of this file.

 
/* Copyright (C) 2007,2008,2009,2010,2011,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_TERMLIST_H
#define XAPIAN_INCLUDED_HONEY_TERMLIST_H
 
#include <algorithm>
#include <string>
 
#include "xapian/intrusive_ptr.h"
#include <xapian/positioniterator.h>
#include <xapian/types.h>
 
namespace Xapian {
    namespace Internal {
        class ExpandStats;
    }
}
 
#include "honey_database.h"
#include "api/termlist.h"
#include "honey_table.h"
 
class HoneyTermList : public TermList {
    void operator=(const HoneyTermList&);
 
    HoneyTermList(const HoneyTermList&);
 
    Xapian::Internal::intrusive_ptr<const HoneyDatabase> db;
 
    Xapian::docid did;
 
    Xapian::termcount doclen;
 
    Xapian::termcount termlist_size;
 
    std::string data;
 
    const char* pos;
 
    const char* end;
 
    Xapian::termcount current_wdf;
 
    mutable Xapian::doccount current_termfreq;
 
  public:
    HoneyTermList(const HoneyDatabase* db_, Xapian::docid did_);
 
    Xapian::termcount get_doclength() const {
        return doclen;
    }
 
    Xapian::termcount size() const {
        return termlist_size;
    }
 
    Xapian::termcount get_unique_terms() const {
        // We approximate get_unique_terms() by the length of the termlist
        // (which counts boolean terms too) but clamp the result to be no
        // larger than the document length.
        return std::min(termlist_size, doclen);
    }
 
    Xapian::termcount get_approx_size() const;
 
    void accumulate_stats(Xapian::Internal::ExpandStats& stats) const;
 
    Xapian::termcount get_wdf() const;
 
    Xapian::doccount get_termfreq() const;
 
    TermList* next();
 
    TermList* skip_to(std::string_view term);
 
    Xapian::termcount positionlist_count() const;
 
    PositionList* positionlist_begin() const;
};
 
#endif // XAPIAN_INCLUDED_HONEY_TERMLIST_H