termiterator.h

Go to the documentation of this file.

/* Copyright (C) 2007,2008,2009,2010,2011,2012,2013,2014,2015,2023 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
 * USA
 */

#ifndef XAPIAN_INCLUDED_TERMITERATOR_H
#define XAPIAN_INCLUDED_TERMITERATOR_H

#if !defined XAPIAN_IN_XAPIAN_H && !defined XAPIAN_LIB_BUILD
# error Never use <xapian/termiterator.h> directly; include <xapian.h> instead.
#endif

#include <iterator>
#include <string>

#include <xapian/attributes.h>
#include <xapian/derefwrapper.h>
#include <xapian/positioniterator.h>
#include <xapian/types.h>
#include <xapian/visibility.h>

namespace Xapian {

class XAPIAN_VISIBILITY_DEFAULT TermIterator {
  public:
    class Internal;
    Internal * internal;

    explicit TermIterator(Internal *internal_);

    TermIterator(const TermIterator & o);

    TermIterator & operator=(const TermIterator & o);

#ifdef XAPIAN_MOVE_SEMANTICS
    TermIterator(TermIterator && o)
        : internal(o.internal) {
        o.internal = nullptr;
    }

    TermIterator & operator=(TermIterator && o) {
        if (this != &o) {
            if (internal) decref();
            internal = o.internal;
            o.internal = nullptr;
        }
        return *this;
    }
#endif

    XAPIAN_NOTHROW(TermIterator())
        : internal() { }

    ~TermIterator() {
        if (internal) decref();
    }

    std::string operator*() const;

    Xapian::termcount get_wdf() const;

    Xapian::doccount get_termfreq() const;

    Xapian::termcount positionlist_count() const;

    PositionIterator positionlist_begin() const;

    PositionIterator XAPIAN_NOTHROW(positionlist_end() const) {
        return PositionIterator();
    }

    TermIterator & operator++();

    DerefWrapper_<std::string> operator++(int) {
        const std::string & term(**this);
        operator++();
        return DerefWrapper_<std::string>(term);
    }

    void skip_to(const std::string &term);

    std::string get_description() const;

    // @{
    typedef std::input_iterator_tag iterator_category;
    typedef std::string value_type;
    typedef Xapian::termcount_diff difference_type;
    typedef std::string * pointer;
    typedef std::string & reference;
    // @}

  private:
    void decref();

    void post_advance(Internal * res);
};

bool
XAPIAN_NOTHROW(operator==(const TermIterator &a, const TermIterator &b));

inline bool
operator==(const TermIterator &a, const TermIterator &b) XAPIAN_NOEXCEPT
{
    // Use a pointer comparison - this ensures both that (a == a) and correct
    // handling of end iterators (which we ensure have NULL internals).
    return a.internal == b.internal;
}

bool
XAPIAN_NOTHROW(operator!=(const TermIterator &a, const TermIterator &b));

inline bool
operator!=(const TermIterator &a, const TermIterator &b) XAPIAN_NOEXCEPT
{
    return !(a == b);
}

}

#endif // XAPIAN_INCLUDED_TERMITERATOR_H