termiterator.h

Go to the documentation of this file.

 
/* Copyright (C) 2007-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_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 <string_view>
 
#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;
 
    XAPIAN_VISIBILITY_INTERNAL
    explicit TermIterator(Internal *internal_);
 
    TermIterator(const TermIterator & o);
 
    TermIterator & operator=(const TermIterator & o);
 
    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;
    }
 
    TermIterator() noexcept
        : 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 positionlist_end() const noexcept {
        return PositionIterator();
    }
 
    TermIterator & operator++();
 
    DerefWrapper_<std::string> operator++(int) {
        const std::string & term(**this);
        operator++();
        return DerefWrapper_<std::string>(term);
    }
 
    void skip_to(std::string_view 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 value_type* pointer;
    typedef value_type reference;
    // @}
 
  private:
    void decref();
 
    XAPIAN_VISIBILITY_INTERNAL
    void post_advance(Internal * res);
};
 
inline bool
operator==(const TermIterator& a, const TermIterator& b) 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;
}
 
inline bool
operator!=(const TermIterator& a, const TermIterator& b) noexcept
{
    return !(a == b);
}
 
}
 
#endif // XAPIAN_INCLUDED_TERMITERATOR_H