summaryrefslogtreecommitdiff
path: root/lib/mu-query-match-deciders.hh
blob: bd1960596b5977ca7b9d783bb41d254ede6a6270 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/*
** Copyright (C) 2021-2024 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
**
** 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 3, 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 Street, Fifth Floor, Boston, MA 02110-1301, USA.
**
*/

#ifndef MU_QUERY_MATCH_DECIDERS_HH__
#define MU_QUERY_MATCH_DECIDERS_HH__

#include <unordered_set>
#include <unordered_map>
#include <memory>

#include "mu-xapian-db.hh"

#include "mu-query-results.hh"

namespace Mu {
using StringSet = std::unordered_set<std::string>;

struct DeciderInfo {
	QueryMatches matches;
	StringSet    thread_ids;
	StringSet    message_ids;
};

/**
 * Make a "leader" decider, that is, a MatchDecider for either a singular or the
 * first query in the leader/related pair of queries. Gather information for
 * threading, and the subsequent "related" query.
 *
 * @param qflags     query flags
 * @param match_info receives information about the matches.
 *
 * @return a unique_ptr to a match decider.
 */
std::unique_ptr<Xapian::MatchDecider> make_leader_decider(QueryFlags qflags, DeciderInfo& info);

/**
 * Make a "related" decider, that is, a MatchDecider for the second query
 * in the leader/related pair of queries.
 *
 * @param qflags     query flags
 * @param match_info receives information about the matches.
 *
 * @return a unique_ptr to a match decider.
 */
std::unique_ptr<Xapian::MatchDecider> make_related_decider(QueryFlags qflags, DeciderInfo& info);

/**
 * Make a "thread" decider, that is, a MatchDecider that removes all but the
 * document excepts for the ones found during initial/related searches.
 *
 * @param qflags     query flags
 * @param match_info receives information about the matches.
 *
 * @return a unique_ptr to a match decider.
 */
std::unique_ptr<Xapian::MatchDecider> make_thread_decider(QueryFlags qflags, DeciderInfo& info);

} // namespace Mu

#endif /* MU_QUERY_MATCH_DECIDERS_HH__ */