aboutsummaryrefslogtreecommitdiffhomepage
path: root/lib
diff options
context:
space:
mode:
authorGravatar Mark Walters <markwalters1009@gmail.com>2012-04-07 17:10:03 +0100
committerGravatar David Bremner <bremner@debian.org>2012-04-07 22:58:33 -0300
commitd6fbef4690968c8d0b8e9dc19a903e693cace316 (patch)
treef455852bd1864df3e37dc546a75825843f559ee4 /lib
parent052000f85ae2e75efdf882a7fd15ef5698001c42 (diff)
lib: change default for notmuch_query_set_omit_excluded
Diffstat (limited to 'lib')
-rw-r--r--lib/notmuch.h23
-rw-r--r--lib/query.cc10
2 files changed, 23 insertions, 10 deletions
diff --git a/lib/notmuch.h b/lib/notmuch.h
index babd2086..673c4237 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -449,12 +449,25 @@ typedef enum {
const char *
notmuch_query_get_query_string (notmuch_query_t *query);
-/* Specify whether to results should omit the excluded results rather
- * than just marking them excluded. This is useful for passing a
- * notmuch_messages_t not containing the excluded messages to other
- * functions. */
+/* Specify whether to omit excluded results or simply flag them. By
+ * default, this is set to TRUE.
+ *
+ * If this is TRUE, notmuch_query_search_messages will omit excluded
+ * messages from the results. notmuch_query_search_threads will omit
+ * threads that match only in excluded messages, but will include all
+ * messages in threads that match in at least one non-excluded
+ * message.
+ *
+ * The performance difference when calling
+ * notmuch_query_search_messages should be relatively small (and both
+ * should be very fast). However, in some cases,
+ * notmuch_query_search_threads is very much faster when omitting
+ * excluded messages as it does not need to construct the threads that
+ * only match in excluded messages.
+ */
+
void
-notmuch_query_set_omit_excluded_messages (notmuch_query_t *query, notmuch_bool_t omit);
+notmuch_query_set_omit_excluded (notmuch_query_t *query, notmuch_bool_t omit_excluded);
/* Specify the sorting desired for this query. */
void
diff --git a/lib/query.cc b/lib/query.cc
index 68ac1e40..e9c1a2d1 100644
--- a/lib/query.cc
+++ b/lib/query.cc
@@ -28,7 +28,7 @@ struct _notmuch_query {
const char *query_string;
notmuch_sort_t sort;
notmuch_string_list_t *exclude_terms;
- notmuch_bool_t omit_excluded_messages;
+ notmuch_bool_t omit_excluded;
};
typedef struct _notmuch_mset_messages {
@@ -92,7 +92,7 @@ notmuch_query_create (notmuch_database_t *notmuch,
query->exclude_terms = _notmuch_string_list_create (query);
- query->omit_excluded_messages = FALSE;
+ query->omit_excluded = TRUE;
return query;
}
@@ -104,9 +104,9 @@ notmuch_query_get_query_string (notmuch_query_t *query)
}
void
-notmuch_query_set_omit_excluded_messages (notmuch_query_t *query, notmuch_bool_t omit)
+notmuch_query_set_omit_excluded (notmuch_query_t *query, notmuch_bool_t omit_excluded)
{
- query->omit_excluded_messages = omit;
+ query->omit_excluded = omit_excluded;
}
void
@@ -220,7 +220,7 @@ notmuch_query_search_messages (notmuch_query_t *query)
if (query->exclude_terms) {
exclude_query = _notmuch_exclude_tags (query, final_query);
- if (query->omit_excluded_messages)
+ if (query->omit_excluded)
final_query = Xapian::Query (Xapian::Query::OP_AND_NOT,
final_query, exclude_query);
else {