From: Carl Worth Date: Tue, 24 Nov 2009 19:35:08 +0000 (-0800) Subject: Merge buttons-for-body-and-headers branch. X-Git-Tag: 0.1~337 X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=c1e16435cfe4471c3415d9f625f7230d59c8afb4;hp=0ad3534b949b4a9848051197aa51c9c8ce3f81fb Merge buttons-for-body-and-headers branch. Thanks, Alexander! --- diff --git a/lib/messages.c b/lib/messages.c index 2f7c283e..54c0ab07 100644 --- a/lib/messages.c +++ b/lib/messages.c @@ -20,13 +20,6 @@ #include "notmuch-private.h" -#include /* GList */ - - -struct _notmuch_messages { - notmuch_message_node_t *iterator; -}; - /* Create a new notmuch_message_list_t object, with 'ctx' as its * talloc owner. * @@ -85,20 +78,45 @@ _notmuch_messages_create (notmuch_message_list_t *list) if (unlikely (messages == NULL)) return NULL; + messages->is_of_list_type = TRUE; messages->iterator = list->head; return messages; } +/* We're using the "is_of_type_list" to conditionally defer to the + * notmuch_mset_messages_t implementation of notmuch_messages_t in + * query.cc. It's ugly that that's over in query.cc, and it's ugly + * that we're not using a union here. Both of those uglies are due to + * C++: + * + * 1. I didn't want to force a C++ header file onto + * notmuch-private.h and suddenly subject all our code to a + * C++ compiler and its rules. + * + * 2. C++ won't allow me to put C++ objects, (with non-trivial + * constructors) into a union anyway. Even though I'd + * carefully control object construction with placement new + * anyway. *sigh* + */ notmuch_bool_t notmuch_messages_has_more (notmuch_messages_t *messages) { - return (messages != NULL && messages->iterator != NULL); + if (messages == NULL) + return FALSE; + + if (! messages->is_of_list_type) + return _notmuch_mset_messages_has_more (messages); + + return (messages->iterator != NULL); } notmuch_message_t * notmuch_messages_get (notmuch_messages_t *messages) { + if (! messages->is_of_list_type) + return _notmuch_mset_messages_get (messages); + if (messages->iterator == NULL) return NULL; @@ -108,6 +126,9 @@ notmuch_messages_get (notmuch_messages_t *messages) void notmuch_messages_advance (notmuch_messages_t *messages) { + if (! messages->is_of_list_type) + return _notmuch_mset_messages_advance (messages); + if (messages->iterator == NULL) return; diff --git a/lib/notmuch-private.h b/lib/notmuch-private.h index 2b4bf319..d3f9a4c4 100644 --- a/lib/notmuch-private.h +++ b/lib/notmuch-private.h @@ -290,6 +290,15 @@ typedef struct _notmuch_message_list { notmuch_message_node_t **tail; } notmuch_message_list_t; +/* There's a rumor that there's an alternate struct _notmuch_messages + * somewhere with some nasty C++ objects in it. We'll try to maintain + * ignorance of that here. (See notmuch_mset_messages_t in query.cc) + */ +struct _notmuch_messages { + notmuch_bool_t is_of_list_type; + notmuch_message_node_t *iterator; +}; + notmuch_message_list_t * _notmuch_message_list_create (const void *ctx); @@ -304,6 +313,17 @@ _notmuch_message_list_add_message (notmuch_message_list_t *list, notmuch_messages_t * _notmuch_messages_create (notmuch_message_list_t *list); +/* query.cc */ + +notmuch_bool_t +_notmuch_mset_messages_has_more (notmuch_messages_t *messages); + +notmuch_message_t * +_notmuch_mset_messages_get (notmuch_messages_t *messages); + +void +_notmuch_mset_messages_advance (notmuch_messages_t *messages); + /* message.cc */ void diff --git a/lib/notmuch.h b/lib/notmuch.h index 260cc22d..8bba442f 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -322,14 +322,6 @@ notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort); * object is owned by the query and as such, will only be valid until * notmuch_query_destroy. * - * The 'first' and 'max_threads' arguments can be used to obtain - * partial results from the search. For example, to get results 10 at - * a time, pass 'max_threads' as 10 and for 'first' pass the values 0, - * 10, 20, etc. As a special case, a value of -1 for 'max_threads' - * indicates that no limiting is to be performed. So a search with - * 'first' == 0 and 'max_threads' == -1 will return the complete - * results of the search. - * * Typical usage might be: * * notmuch_query_t *query; @@ -362,22 +354,13 @@ notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort); * to call it if the query is about to be destroyed). */ notmuch_threads_t * -notmuch_query_search_threads (notmuch_query_t *query, - int first, int max_threads); +notmuch_query_search_threads (notmuch_query_t *query); /* Execute a query for messages, returning a notmuch_messages_t object * which can be used to iterate over the results. The returned * messages object is owned by the query and as such, will only be * valid until notmuch_query_destroy. * - * The 'first' and 'max_messages' arguments can be used to obtain - * partial results from the search. For example, to get results 10 at - * a time, pass 'max_messages' as 10 and for 'first' pass the values - * 0, 10, 20, etc. As a special case, a value of -1 for 'max_messages' - * indicates that no limiting is to be performed. So a search with - * 'first' == 0 and 'max_messages' == -1 will return the complete - * results of the search. - * * Typical usage might be: * * notmuch_query_t *query; @@ -410,8 +393,7 @@ notmuch_query_search_threads (notmuch_query_t *query, * reason to call it if the query is about to be destroyed). */ notmuch_messages_t * -notmuch_query_search_messages (notmuch_query_t *query, - int first, int max_messages); +notmuch_query_search_messages (notmuch_query_t *query); /* Destroy a notmuch_query_t along with any associated resources. * diff --git a/lib/query.cc b/lib/query.cc index 686d75f9..a571a618 100644 --- a/lib/query.cc +++ b/lib/query.cc @@ -31,16 +31,20 @@ struct _notmuch_query { notmuch_sort_t sort; }; -struct _notmuch_messages { +typedef struct _notmuch_mset_messages { + notmuch_messages_t base; notmuch_database_t *notmuch; Xapian::MSetIterator iterator; Xapian::MSetIterator iterator_end; -}; +} notmuch_mset_messages_t; struct _notmuch_threads { - notmuch_database_t *notmuch; - GPtrArray *threads; - unsigned int index; + notmuch_query_t *query; + GHashTable *threads; + notmuch_messages_t *messages; + + /* This thread ID is our iterator state. */ + const char *thread_id; }; notmuch_query_t * @@ -72,21 +76,42 @@ notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort) query->sort = sort; } +/* We end up having to call the destructors explicitly because we had + * to use "placement new" in order to initialize C++ objects within a + * block that we allocated with talloc. So C++ is making talloc + * slightly less simple to use, (we wouldn't need + * talloc_set_destructor at all otherwise). + */ +static int +_notmuch_messages_destructor (notmuch_mset_messages_t *messages) +{ + messages->iterator.~MSetIterator (); + messages->iterator_end.~MSetIterator (); + + return 0; +} + notmuch_messages_t * -notmuch_query_search_messages (notmuch_query_t *query, - int first, - int max_messages) +notmuch_query_search_messages (notmuch_query_t *query) { notmuch_database_t *notmuch = query->notmuch; const char *query_string = query->query_string; - notmuch_message_list_t *message_list; - Xapian::MSetIterator i; + notmuch_mset_messages_t *messages; - message_list = _notmuch_message_list_create (query); - if (unlikely (message_list == NULL)) + messages = talloc (query, notmuch_mset_messages_t); + if (unlikely (messages == NULL)) return NULL; try { + + messages->base.is_of_list_type = FALSE; + messages->base.iterator = NULL; + messages->notmuch = notmuch; + new (&messages->iterator) Xapian::MSetIterator (); + new (&messages->iterator_end) Xapian::MSetIterator (); + + talloc_set_destructor (messages, _notmuch_messages_destructor); + Xapian::Enquire enquire (*notmuch->xapian_db); Xapian::Query mail_query (talloc_asprintf (query, "%s%s", _find_prefix ("type"), @@ -127,26 +152,10 @@ notmuch_query_search_messages (notmuch_query_t *query, enquire.set_query (final_query); - if (max_messages == -1) - max_messages = notmuch->xapian_db->get_doccount (); - mset = enquire.get_mset (first, max_messages); - - for (i = mset.begin (); i != mset.end (); i++) { - notmuch_message_t *message; - notmuch_private_status_t status; - - message = _notmuch_message_create (message_list, notmuch, - *i, &status); - if (message == NULL) - { - if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) - INTERNAL_ERROR ("A message iterator contains a " - "non-existent document ID.\n"); - break; - } - - _notmuch_message_list_add_message (message_list, message); - } + mset = enquire.get_mset (0, notmuch->xapian_db->get_doccount ()); + + messages->iterator = mset.begin (); + messages->iterator_end = mset.end (); } catch (const Xapian::Error &error) { fprintf (stderr, "A Xapian exception occurred performing query: %s\n", @@ -155,93 +164,87 @@ notmuch_query_search_messages (notmuch_query_t *query, notmuch->exception_reported = TRUE; } - return _notmuch_messages_create (message_list); + return &messages->base; } -/* Glib objects force use to use a talloc destructor as well, (but not - * nearly as ugly as the for messages due to C++ objects). At - * this point, I'd really like to have some talloc-friendly - * equivalents for the few pieces of glib that I'm using. */ -static int -_notmuch_threads_destructor (notmuch_threads_t *threads) +notmuch_bool_t +_notmuch_mset_messages_has_more (notmuch_messages_t *messages) { - g_ptr_array_free (threads->threads, TRUE); + notmuch_mset_messages_t *mset_messages; - return 0; + mset_messages = (notmuch_mset_messages_t *) messages; + + return (mset_messages->iterator != mset_messages->iterator_end); } -notmuch_threads_t * -notmuch_query_search_threads (notmuch_query_t *query, - int first, - int max_threads) +notmuch_message_t * +_notmuch_mset_messages_get (notmuch_messages_t *messages) { - notmuch_threads_t *threads; - notmuch_thread_t *thread; - const char *thread_id; - notmuch_messages_t *messages; notmuch_message_t *message; - GHashTable *seen; - int messages_seen = 0, threads_seen = 0; + Xapian::docid doc_id; + notmuch_private_status_t status; + notmuch_mset_messages_t *mset_messages; - threads = talloc (query, notmuch_threads_t); - if (threads == NULL) - return NULL; + mset_messages = (notmuch_mset_messages_t *) messages; - threads->notmuch = query->notmuch; - threads->threads = g_ptr_array_new (); - threads->index = 0; + if (! _notmuch_mset_messages_has_more (&mset_messages->base)) + return NULL; - talloc_set_destructor (threads, _notmuch_threads_destructor); + doc_id = *mset_messages->iterator; - seen = g_hash_table_new_full (g_str_hash, g_str_equal, - free, NULL); + message = _notmuch_message_create (mset_messages, + mset_messages->notmuch, doc_id, + &status); - while (max_threads < 0 || threads_seen < first + max_threads) + if (message == NULL && + status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) { - int messages_seen_previously = messages_seen; + INTERNAL_ERROR ("a messages iterator contains a non-existent document ID.\n"); + } - for (messages = notmuch_query_search_messages (query, - messages_seen, - max_threads); - notmuch_messages_has_more (messages); - notmuch_messages_advance (messages)) - { - message = notmuch_messages_get (messages); + return message; +} - thread_id = notmuch_message_get_thread_id (message); +void +_notmuch_mset_messages_advance (notmuch_messages_t *messages) +{ + notmuch_mset_messages_t *mset_messages; - if (! g_hash_table_lookup_extended (seen, - thread_id, NULL, - (void **) &thread)) - { - if (threads_seen >= first) { - thread = _notmuch_thread_create (query, query->notmuch, - thread_id, - query->query_string); - g_ptr_array_add (threads->threads, thread); - } else { - thread = NULL; - } + mset_messages = (notmuch_mset_messages_t *) messages; - g_hash_table_insert (seen, xstrdup (thread_id), thread); + mset_messages->iterator++; +} - threads_seen++; - } +/* Glib objects force use to use a talloc destructor as well, (but not + * nearly as ugly as the for messages due to C++ objects). At + * this point, I'd really like to have some talloc-friendly + * equivalents for the few pieces of glib that I'm using. */ +static int +_notmuch_threads_destructor (notmuch_threads_t *threads) +{ + g_hash_table_unref (threads->threads); - notmuch_message_destroy (message); + return 0; +} - messages_seen++; +notmuch_threads_t * +notmuch_query_search_threads (notmuch_query_t *query) +{ + notmuch_threads_t *threads; - if (max_threads >= 0 && threads_seen >= first + max_threads) - break; - } + threads = talloc (query, notmuch_threads_t); + if (threads == NULL) + return NULL; - /* Stop if we're not seeing any more messages. */ - if (messages_seen == messages_seen_previously) - break; - } + threads->query = query; + threads->threads = g_hash_table_new_full (g_str_hash, g_str_equal, + free, NULL); + + threads->messages = notmuch_query_search_messages (query); - g_hash_table_unref (seen); + threads->thread_id = NULL; + + talloc_set_destructor (threads, _notmuch_threads_destructor); return threads; } @@ -255,7 +258,32 @@ notmuch_query_destroy (notmuch_query_t *query) notmuch_bool_t notmuch_threads_has_more (notmuch_threads_t *threads) { - return (threads->index < threads->threads->len); + notmuch_message_t *message; + + if (threads->thread_id) + return TRUE; + + while (notmuch_messages_has_more (threads->messages)) + { + message = notmuch_messages_get (threads->messages); + + threads->thread_id = notmuch_message_get_thread_id (message); + + if (! g_hash_table_lookup_extended (threads->threads, + threads->thread_id, + NULL, NULL)) + { + g_hash_table_insert (threads->threads, + xstrdup (threads->thread_id), NULL); + notmuch_messages_advance (threads->messages); + return TRUE; + } + + notmuch_messages_advance (threads->messages); + } + + threads->thread_id = NULL; + return FALSE; } notmuch_thread_t * @@ -264,14 +292,16 @@ notmuch_threads_get (notmuch_threads_t *threads) if (! notmuch_threads_has_more (threads)) return NULL; - return (notmuch_thread_t *) g_ptr_array_index (threads->threads, - threads->index); + return _notmuch_thread_create (threads->query, + threads->query->notmuch, + threads->thread_id, + threads->query->query_string); } void notmuch_threads_advance (notmuch_threads_t *threads) { - threads->index++; + threads->thread_id = NULL; } void diff --git a/lib/thread.cc b/lib/thread.cc index 267f4dba..58d88c2d 100644 --- a/lib/thread.cc +++ b/lib/thread.cc @@ -260,7 +260,7 @@ _notmuch_thread_create (void *ctx, notmuch_query_set_sort (thread_id_query, NOTMUCH_SORT_OLDEST_FIRST); - for (messages = notmuch_query_search_messages (thread_id_query, 0, -1); + for (messages = notmuch_query_search_messages (thread_id_query); notmuch_messages_has_more (messages); notmuch_messages_advance (messages)) { @@ -271,7 +271,7 @@ _notmuch_thread_create (void *ctx, notmuch_query_destroy (thread_id_query); - for (messages = notmuch_query_search_messages (matched_query, 0, -1); + for (messages = notmuch_query_search_messages (matched_query); notmuch_messages_has_more (messages); notmuch_messages_advance (messages)) { diff --git a/notmuch-dump.c b/notmuch-dump.c index fc06f3f9..ea326bb6 100644 --- a/notmuch-dump.c +++ b/notmuch-dump.c @@ -58,7 +58,7 @@ notmuch_dump_command (unused (void *ctx), int argc, char *argv[]) output = stdout; } - for (messages = notmuch_query_search_messages (query, 0, -1); + for (messages = notmuch_query_search_messages (query); notmuch_messages_has_more (messages); notmuch_messages_advance (messages)) { diff --git a/notmuch-reply.c b/notmuch-reply.c index cd81e769..65bd3564 100644 --- a/notmuch-reply.c +++ b/notmuch-reply.c @@ -234,7 +234,7 @@ notmuch_reply_command (void *ctx, int argc, char *argv[]) return 1; } - for (messages = notmuch_query_search_messages (query, 0, -1); + for (messages = notmuch_query_search_messages (query); notmuch_messages_has_more (messages); notmuch_messages_advance (messages)) { diff --git a/notmuch-search.c b/notmuch-search.c index fc2baaa7..dc44eb66 100644 --- a/notmuch-search.c +++ b/notmuch-search.c @@ -20,40 +20,24 @@ #include "notmuch-client.h" -/* If the user asks for more than this number of threads, then break - the results down into chunks so that results start appearing - quickly rather than the user having to wait until all results are - available before anything appears. - - Since each subsequent chunk ends up having to re-do threading work - done by all previous chunks, we double the chunk size repeatedly - until all desired results have been returned. -*/ -#define NOTMUCH_SEARCH_INITIAL_CHUNK_SIZE 100 - -/* Do the actual search for a chunk of threads and display the results, - (returning the number of threads found in this chunk). */ -static int +static void do_search_threads (const void *ctx, notmuch_query_t *query, - notmuch_sort_t sort, - int first, int max_threads) + notmuch_sort_t sort) { notmuch_thread_t *thread; notmuch_threads_t *threads; notmuch_tags_t *tags; time_t date; const char *relative_date; - int num_threads = 0; - for (threads = notmuch_query_search_threads (query, first, max_threads); + for (threads = notmuch_query_search_threads (query); notmuch_threads_has_more (threads); notmuch_threads_advance (threads)) { int first_tag = 1; thread = notmuch_threads_get (threads); - num_threads++; if (sort == NOTMUCH_SORT_OLDEST_FIRST) date = notmuch_thread_get_oldest_date (thread); @@ -84,8 +68,6 @@ do_search_threads (const void *ctx, notmuch_thread_destroy (thread); } - - return num_threads; } int @@ -95,32 +77,16 @@ notmuch_search_command (void *ctx, int argc, char *argv[]) notmuch_database_t *notmuch; notmuch_query_t *query; char *query_str; - int i, first = 0, max_threads = -1; - char *opt, *end; + char *opt; notmuch_sort_t sort = NOTMUCH_SORT_NEWEST_FIRST; - int chunk_size; - int threads_in_chunk; + int i; for (i = 0; i < argc && argv[i][0] == '-'; i++) { if (strcmp (argv[i], "--") == 0) { i++; break; } - if (STRNCMP_LITERAL (argv[i], "--first=") == 0) { - opt = argv[i] + sizeof ("--first=") - 1; - first = strtoul (opt, &end, 10); - if (*opt == '\0' || *end != '\0') { - fprintf (stderr, "Invalid value for --first: %s\n", opt); - return 1; - } - } else if (STRNCMP_LITERAL (argv[i], "--max-threads=") == 0) { - opt = argv[i] + sizeof ("--max-threads=") - 1; - max_threads = strtoul (opt, &end, 10); - if (*opt == '\0' || *end != '\0') { - fprintf (stderr, "Invalid value for --max-threads: %s\n", opt); - return 1; - } - } else if (STRNCMP_LITERAL (argv[i], "--sort=") == 0) { + if (STRNCMP_LITERAL (argv[i], "--sort=") == 0) { opt = argv[i] + sizeof ("--sort=") - 1; if (strcmp (opt, "oldest-first") == 0) { sort = NOTMUCH_SORT_OLDEST_FIRST; @@ -166,25 +132,7 @@ notmuch_search_command (void *ctx, int argc, char *argv[]) notmuch_query_set_sort (query, sort); - /* If we receive a max-threads option, then the user is - responsible for any chunking and we return all results at - once. */ - if (max_threads < 0) - chunk_size = NOTMUCH_SEARCH_INITIAL_CHUNK_SIZE; - else - chunk_size = max_threads; - - do { - threads_in_chunk = do_search_threads (ctx, query, sort, - first, chunk_size); - if (chunk_size == max_threads) - break; - - first += chunk_size; - - chunk_size *= 2; - - } while (threads_in_chunk); + do_search_threads (ctx, query, sort); notmuch_query_destroy (query); notmuch_database_close (notmuch); diff --git a/notmuch-show.c b/notmuch-show.c index c7f13204..edebacaa 100644 --- a/notmuch-show.c +++ b/notmuch-show.c @@ -238,7 +238,7 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[])) return 1; } - for (threads = notmuch_query_search_threads (query, 0, -1); + for (threads = notmuch_query_search_threads (query); notmuch_threads_has_more (threads); notmuch_threads_advance (threads)) { diff --git a/notmuch-tag.c b/notmuch-tag.c index e2311f61..07cb8c5f 100644 --- a/notmuch-tag.c +++ b/notmuch-tag.c @@ -105,7 +105,7 @@ notmuch_tag_command (void *ctx, unused (int argc), unused (char *argv[])) return 1; } - for (messages = notmuch_query_search_messages (query, 0, -1); + for (messages = notmuch_query_search_messages (query); notmuch_messages_has_more (messages) && !interrupted; notmuch_messages_advance (messages)) { diff --git a/notmuch.1 b/notmuch.1 index c5a7711f..2be77f99 100644 --- a/notmuch.1 +++ b/notmuch.1 @@ -154,29 +154,6 @@ Supported options for include .RS 4 .TP 4 -.BR \-\-max\-threads= - -Restricts displayed search results to a subset of the complete results -that would match the terms. With this option, no more than -thread results will be displayed. If this option is not used, then all -matching threads will be displayed. See also the -.B \-\-first -option. - -.TP -.BR \-\-first= - -Omits the first threads from the search results that would -otherwise be displayed. Together with the -.BR \-\-max\-threads -option, this can be used to perform incremental searches. For example, -the first 50 thread results can be displayed with -.B "\-\-first=0 \-\-max\-threads=50" -and the next 50 could be displayed with -.B "\-\-first=50 \-\-max\-threads=50" -etc. - -.TP .BR \-\-sort= ( newest\-first | oldest\-first ) This option can be used to present results in either chronological order diff --git a/notmuch.c b/notmuch.c index b84e2844..f45b6924 100644 --- a/notmuch.c +++ b/notmuch.c @@ -162,16 +162,6 @@ command_t commands[] = { "\n" "\t\tSupported options for search include:\n" "\n" - "\t\t--max-threads=\n" - "\n" - "\t\t\tRestricts displayed search results to a subset\n" - "\t\t\tof the results that would match the terms.\n" - "\n" - "\t\t--first=\n" - "\n" - "\t\t\tOmits the first threads from the search\n" - "\t\t\tresults that would otherwise be displayed.\n" - "\n" "\t\t--sort=(newest-first|oldest-first)\n" "\n" "\t\t\tPresent results in either chronological order\n"