include/xapian/termiterator.h

Go to the documentation of this file.

/* Copyright 1999,2000,2001 BrightStation PLC
 * Copyright 2002 Ananova Ltd
 * Copyright 2003,2004,2005,2006,2007 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

#include <iterator>
#include <string>

#include <xapian/base.h>
#include <xapian/types.h>
#include <xapian/positioniterator.h>
#include <xapian/visibility.h>

namespace Xapian {

class Database;

class TermNameWrapper {
    private:
        std::string tname;
    public:
        explicit TermNameWrapper(const std::string & tname_) : tname(tname_) { }
        const std::string & operator*() const { return tname; }
};

class XAPIAN_VISIBILITY_DEFAULT TermIterator {
    public:
        class Internal;
        Xapian::Internal::RefCntPtr<Internal> internal;

        explicit TermIterator(Internal *internal_);

        TermIterator();

        ~TermIterator();

        TermIterator(const TermIterator &other);

        void operator=(const TermIterator &other);

        std::string operator *() const;

        TermIterator & operator++();

        TermNameWrapper operator++(int) {
            std::string tmp = **this;
            operator++();
            return TermNameWrapper(tmp);
        }

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

        Xapian::termcount get_wdf() const;

        Xapian::doccount get_termfreq() const;

        Xapian::termcount positionlist_count() const;

        PositionIterator positionlist_begin() const;

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

        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;
};

inline bool
operator==(const TermIterator &a, const TermIterator &b)
{
    return (a.internal.get() == b.internal.get());
}

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

}

#endif /* XAPIAN_INCLUDED_TERMITERATOR_H */

---