matcher.h

Go to the documentation of this file.

 
/* Copyright (C) 2017,2018,2019 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_MATCHER_H
#define XAPIAN_INCLUDED_MATCHER_H
 
#ifndef PACKAGE
# error config.h must be included first in each C++ source file
#endif
 
#include "api/enquireinternal.h"
#include "localsubmatch.h"
#include "remotesubmatch.h"
#include "weight/weightinternal.h"
 
#include "xapian/database.h"
 
#include <memory>
#include <vector>
 
namespace Xapian {
    class KeyMaker;
    class MatchDecider;
    class MSet;
    class Query;
    class Weight;
}
 
class Matcher {
    typedef Xapian::Internal::opt_intrusive_ptr<Xapian::MatchSpy> opt_ptr_spy;
 
    Xapian::Database db;
 
    std::vector<std::unique_ptr<LocalSubMatch>> locals;
 
#ifdef XAPIAN_HAS_REMOTE_BACKEND
    std::vector<std::unique_ptr<RemoteSubMatch>> remotes;
 
# ifndef HAVE_POLL
    std::size_t first_nonselectable;
# endif
#endif
 
    Matcher(const Matcher&) = delete;
 
    Matcher& operator=(const Matcher&) = delete;
 
    Xapian::MSet get_local_mset(Xapian::doccount first,
                                Xapian::doccount maxitems,
                                Xapian::doccount check_at_least,
                                const Xapian::Weight& wtscheme,
                                const Xapian::MatchDecider* mdecider,
                                const Xapian::KeyMaker* sorter,
                                Xapian::valueno collapse_key,
                                Xapian::doccount collapse_max,
                                int percent_threshold,
                                double percent_threshold_factor,
                                double weight_threshold,
                                Xapian::Enquire::docid_order order,
                                Xapian::valueno sort_key,
                                Xapian::Enquire::Internal::sort_setting sort_by,
                                bool sort_val_reverse,
                                double time_limit,
                                const std::vector<opt_ptr_spy>& matchspies);
 
    template<typename Action> void for_all_remotes(Action action);
 
  public:
    Matcher(const Xapian::Database& db_,
            const Xapian::Query& query,
            Xapian::termcount query_length,
            const Xapian::RSet* rset,
            Xapian::Weight::Internal& stats,
            const Xapian::Weight& wtscheme,
            bool have_mdecider,
            Xapian::valueno collapse_key,
            Xapian::doccount collapse_max,
            int percent_threshold,
            double weight_threshold,
            Xapian::Enquire::docid_order order,
            Xapian::valueno sort_key,
            Xapian::Enquire::Internal::sort_setting sort_by,
            bool sort_val_reverse,
            double time_limit,
            const std::vector<opt_ptr_spy>& matchspies);
 
    Xapian::MSet get_mset(Xapian::doccount first,
                          Xapian::doccount maxitems,
                          Xapian::doccount check_at_least,
                          Xapian::Weight::Internal& stats,
                          const Xapian::Weight& wtscheme,
                          const Xapian::MatchDecider* mdecider,
                          const Xapian::KeyMaker* sorter,
                          Xapian::valueno collapse_key,
                          Xapian::doccount collapse_max,
                          int percent_threshold,
                          double weight_threshold,
                          Xapian::Enquire::docid_order order,
                          Xapian::valueno sort_key,
                          Xapian::Enquire::Internal::sort_setting sort_by,
                          bool sort_val_reverse,
                          double time_limit,
                          const std::vector<opt_ptr_spy>& matchspies);
};
 
#endif // XAPIAN_INCLUDED_MATCHER_H