rset.h

Go to the documentation of this file.

 
/* Copyright (C) 2015,2016,2017 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_RSET_H
#define XAPIAN_INCLUDED_RSET_H
 
#if !defined XAPIAN_IN_XAPIAN_H && !defined XAPIAN_LIB_BUILD
# error Never use <xapian/rset.h> directly; include <xapian.h> instead.
#endif
 
#include <xapian/attributes.h>
#include <xapian/intrusive_ptr.h>
#include <xapian/mset.h>
#include <xapian/types.h>
#include <xapian/visibility.h>
 
namespace Xapian {
 
class ESetIterator;
 
class XAPIAN_VISIBILITY_DEFAULT RSet {
  public:
    class Internal;
    Xapian::Internal::intrusive_ptr<Internal> internal;
 
    RSet(const RSet & o);
 
    RSet & operator=(const RSet & o);
 
    RSet(RSet && o);
 
    RSet & operator=(RSet && o);
 
    RSet();
 
    XAPIAN_VISIBILITY_INTERNAL
    explicit RSet(Internal* internal_);
 
    ~RSet();
 
    Xapian::doccount size() const;
 
    bool empty() const { return size() == 0; }
 
    void swap(RSet & o) { internal.swap(o.internal); }
 
    void add_document(Xapian::docid did);
 
    void add_document(const Xapian::MSetIterator& it) {
        add_document(*it);
    }
 
    void remove_document(Xapian::docid did);
 
    void remove_document(const Xapian::MSetIterator& it) {
        remove_document(*it);
    }
 
    bool contains(Xapian::docid did) const;
 
    bool contains(const Xapian::MSetIterator& it) const {
        return contains(*it);
    }
 
    std::string get_description() const;
};
 
}
 
#endif // XAPIAN_INCLUDED_RSET_H