submatch.h

Go to the documentation of this file.

/* Copyright (C) 2006,2007,2009,2011,2014 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_SUBMATCH_H
#define XAPIAN_INCLUDED_SUBMATCH_H

#include "xapian/intrusive_ptr.h"
#include <xapian/types.h>

#include "api/omenquireinternal.h"
#include "api/postlist.h"
#include "xapian/weight.h"

class MultiMatch;

class SubMatch : public Xapian::Internal::intrusive_base {
  public:
    virtual ~SubMatch() { }

    virtual bool prepare_match(bool nowait,
                               Xapian::Weight::Internal & total_stats) = 0;

    virtual void start_match(Xapian::doccount first,
                             Xapian::doccount maxitems,
                             Xapian::doccount check_at_least,
                             Xapian::Weight::Internal & total_stats) = 0;

    virtual PostList * get_postlist(MultiMatch *matcher,
                                    Xapian::termcount* total_subqs_ptr,
                                    Xapian::Weight::Internal& total_stats) = 0;
};

#endif /* XAPIAN_INCLUDED_SUBMATCH_H */