include/xapian/valueiterator.h

Go to the documentation of this file.

/* Copyright (C) 2008 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_VALUEITERATOR_H
#define XAPIAN_INCLUDED_VALUEITERATOR_H

#include <iterator>
#include <string>

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

namespace Xapian {

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

    explicit ValueIterator(Internal *internal_);

    ValueIterator(const ValueIterator & o);

    ValueIterator & operator=(const ValueIterator & o);

    ValueIterator();

    ~ValueIterator();

    std::string operator*() const;

    ValueIterator & operator++();

    DerefStringWrapper_ operator++(int) {
        std::string value(**this);
        operator++();
        return DerefStringWrapper_(value);
    }

    Xapian::docid get_docid() const;

    Xapian::valueno get_valueno() const;

    void skip_to(Xapian::docid docid_or_slot);

    bool check(Xapian::docid docid);

    std::string get_description() const;

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

inline bool
operator==(const ValueIterator &a, const ValueIterator &b)
{
    // 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.get() == b.internal.get();
}

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

}

#endif // XAPIAN_INCLUDED_VALUEITERATOR_H

---