/** @file
 * @brief Access to metadata for a honey database.
 */
/* Copyright (C) 2005,2007,2008,2009,2011,2017,2024 Olly Betts
 * Copyright (C) 2008 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_METADATA_H
#define XAPIAN_INCLUDED_HONEY_METADATA_H

#include <xapian/intrusive_ptr.h>
#include <xapian/database.h>
#include <xapian/types.h>

#include "backends/alltermslist.h"
#include "honey_table.h"
#include "api/termlist.h"

#include <string>
#include <string_view>

class HoneyCursor;

class HoneyMetadataTermList : public AllTermsList {
    /// Copying is not allowed.
    HoneyMetadataTermList(const HoneyMetadataTermList&);

    /// Assignment is not allowed.
    void operator=(const HoneyMetadataTermList&);

    /// Keep a reference to our database to stop it being deleted.
    Xapian::Internal::intrusive_ptr<const Xapian::Database::Internal> database;

    /** A cursor which runs through the postlist table reading metadata keys.
     */
    HoneyCursor* cursor;

    /** The prefix that all returned keys must have.
     */
    std::string prefix;

  public:
    HoneyMetadataTermList(const Xapian::Database::Internal* database_,
                          HoneyCursor* cursor_,
                          std::string_view prefix_);

    ~HoneyMetadataTermList();

    Xapian::termcount get_approx_size() const;

    /** Return the term frequency for the term at the current position.
     *
     *  Not meaningful for a HoneyMetadataTermList.
     */
    Xapian::doccount get_termfreq() const;

    /// Advance to the next term in the list.
    TermList* next();

    /// Advance to the first key which is >= @a key.
    TermList* skip_to(std::string_view key);
};

#endif // XAPIAN_INCLUDED_HONEY_METADATA_H
