termlist.h

Go to the documentation of this file.

 
/* Copyright (C) 2007,2010,2013,2020,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_TERMLIST_H
#define XAPIAN_INCLUDED_TERMLIST_H
 
#include "api/smallvector.h"
 
#include "backends/positionlist.h"
 
#include <string>
#include <string_view>
 
#include "xapian/intrusive_ptr.h"
#include <xapian/types.h>
#include <xapian/termiterator.h>
 
namespace Xapian {
    namespace Internal {
        class ExpandStats;
    }
}
 
class Xapian::TermIterator::Internal : public Xapian::Internal::intrusive_base {
    void operator=(const Internal &) = delete;
 
    Internal(const Internal &) = delete;
 
  protected:
    Internal() { }
 
    std::string current_term;
 
  public:
    virtual ~Internal();
 
    virtual Xapian::termcount get_approx_size() const = 0;
 
    virtual void accumulate_stats(Xapian::Internal::ExpandStats & stats) const;
 
    const std::string& get_termname() const {
        return current_term;
    }
 
    virtual Xapian::termcount get_wdf() const = 0;
 
    virtual Xapian::doccount get_termfreq() const = 0;
 
    virtual Internal * next() = 0;
 
    virtual Internal* skip_to(std::string_view term) = 0;
 
    virtual Xapian::termcount positionlist_count() const = 0;
 
    virtual const Xapian::VecCOW<Xapian::termpos> * get_vec_termpos() const;
 
    virtual PositionList* positionlist_begin() const = 0;
 
    size_t shard_index = 0;
};
 
// In the external API headers, this class is Xapian::TermIterator::Internal,
// but in the library code it's still known as "TermList" in most places.
typedef Xapian::TermIterator::Internal TermList;
 
#endif // XAPIAN_INCLUDED_TERMLIST_H