On Sun, 12 Oct 2014, Michal Sojka <sojk...@fel.cvut.cz> wrote:
> Many functions that implement the search command need to access command
> line options. Instead of passing each option in a separate variable, put
> them in a structure and pass only this structure.
>
> This will become handy in the following patches.
Hi
This basically looks good to me. I have some style queries/preferences
mentioned below but am happy to be overruled by you or others.
> ---
> notmuch-search.c | 122
> ++++++++++++++++++++++++++++---------------------------
> 1 file changed, 62 insertions(+), 60 deletions(-)
>
> diff --git a/notmuch-search.c b/notmuch-search.c
> index bc9be45..5ac2a26 100644
> --- a/notmuch-search.c
> +++ b/notmuch-search.c
> @@ -30,6 +30,16 @@ typedef enum {
> OUTPUT_TAGS
> } output_t;
>
> +typedef struct {
> + sprinter_t *format;
> + notmuch_query_t *query;
> + notmuch_sort_t sort;
> + output_t output;
> + int offset;
> + int limit;
> + int dupe;
> +} search_options_t;
> +
I don't think of format as being a "search option", whereas I do think
of all the others as search options. So I would prefer to omit format
from search_options_t and pass it explicitly.
> /* Return two stable query strings that identify exactly the matched
> * and unmatched messages currently in thread. If there are no
> * matched or unmatched messages, the returned buffers will be
> @@ -70,46 +80,42 @@ get_thread_query (notmuch_thread_t *thread,
> }
>
> static int
> -do_search_threads (sprinter_t *format,
> - notmuch_query_t *query,
> - notmuch_sort_t sort,
> - output_t output,
> - int offset,
> - int limit)
> +do_search_threads (search_options_t *o)
Personally, I prefer longer variable names (and names which aren't 'o'):
even just opt would be a definite improvement in my opinion.
> {
> notmuch_thread_t *thread;
> notmuch_threads_t *threads;
> notmuch_tags_t *tags;
> + sprinter_t *format = o->format;
> time_t date;
> int i;
>
> - if (offset < 0) {
> - offset += notmuch_query_count_threads (query);
> - if (offset < 0)
> - offset = 0;
> + if (o->offset < 0) {
> + o->offset += notmuch_query_count_threads (o->query);
> + if (o->offset < 0)
> + o->offset = 0;
> }
>
> - threads = notmuch_query_search_threads (query);
> + threads = notmuch_query_search_threads (o->query);
> if (threads == NULL)
> return 1;
>
> format->begin_list (format);
>
> for (i = 0;
> - notmuch_threads_valid (threads) && (limit < 0 || i < offset + limit);
> + notmuch_threads_valid (threads) && (o->limit < 0 || i < o->offset +
> o->limit);
> notmuch_threads_move_to_next (threads), i++)
> {
> thread = notmuch_threads_get (threads);
>
> - if (i < offset) {
> + if (i < o->offset) {
> notmuch_thread_destroy (thread);
> continue;
> }
>
> - if (output == OUTPUT_THREADS) {
> + if (o->output == OUTPUT_THREADS) {
> format->set_prefix (format, "thread");
> format->string (format,
> - notmuch_thread_get_thread_id (thread));
> + notmuch_thread_get_thread_id (thread));
> format->separator (format);
> } else { /* output == OUTPUT_SUMMARY */
> void *ctx_quote = talloc_new (thread);
> @@ -123,7 +129,7 @@ do_search_threads (sprinter_t *format,
>
> format->begin_map (format);
>
> - if (sort == NOTMUCH_SORT_OLDEST_FIRST)
> + if (o->sort == NOTMUCH_SORT_OLDEST_FIRST)
> date = notmuch_thread_get_oldest_date (thread);
> else
> date = notmuch_thread_get_newest_date (thread);
> @@ -215,40 +221,36 @@ do_search_threads (sprinter_t *format,
> }
>
> static int
> -do_search_messages (sprinter_t *format,
> - notmuch_query_t *query,
> - output_t output,
> - int offset,
> - int limit,
> - int dupe)
> +do_search_messages (search_options_t *o)
> {
> notmuch_message_t *message;
> notmuch_messages_t *messages;
> notmuch_filenames_t *filenames;
> + sprinter_t *format = o->format;
> int i;
>
> - if (offset < 0) {
> - offset += notmuch_query_count_messages (query);
> - if (offset < 0)
> - offset = 0;
> + if (o->offset < 0) {
> + o->offset += notmuch_query_count_messages (o->query);
> + if (o->offset < 0)
> + o->offset = 0;
> }
>
> - messages = notmuch_query_search_messages (query);
> + messages = notmuch_query_search_messages (o->query);
> if (messages == NULL)
> return 1;
>
> format->begin_list (format);
>
> for (i = 0;
> - notmuch_messages_valid (messages) && (limit < 0 || i < offset + limit);
> + notmuch_messages_valid (messages) && (o->limit < 0 || i < o->offset +
> o->limit);
> notmuch_messages_move_to_next (messages), i++)
> {
> - if (i < offset)
> + if (i < o->offset)
> continue;
>
> message = notmuch_messages_get (messages);
>
> - if (output == OUTPUT_FILES) {
> + if (o->output == OUTPUT_FILES) {
> int j;
> filenames = notmuch_message_get_filenames (message);
>
> @@ -256,7 +258,7 @@ do_search_messages (sprinter_t *format,
> notmuch_filenames_valid (filenames);
> notmuch_filenames_move_to_next (filenames), j++)
> {
> - if (dupe < 0 || dupe == j) {
> + if (o->dupe < 0 || o->dupe == j) {
> format->string (format, notmuch_filenames_get (filenames));
> format->separator (format);
> }
> @@ -333,16 +335,16 @@ int
> notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])
> {
> notmuch_database_t *notmuch;
> - notmuch_query_t *query;
> + search_options_t o = {
> + .sort = NOTMUCH_SORT_NEWEST_FIRST,
> + .output = OUTPUT_SUMMARY,
> + .offset = 0,
> + .limit = -1, /* unlimited */
> + .dupe = -1,
> + };
> char *query_str;
> - notmuch_sort_t sort = NOTMUCH_SORT_NEWEST_FIRST;
> - sprinter_t *format = NULL;
> int opt_index, ret;
> - output_t output = OUTPUT_SUMMARY;
> - int offset = 0;
> - int limit = -1; /* unlimited */
> notmuch_exclude_t exclude = NOTMUCH_EXCLUDE_TRUE;
> - int dupe = -1;
> unsigned int i;
>
> enum {
> @@ -353,7 +355,7 @@ notmuch_search_command (notmuch_config_t *config, int
> argc, char *argv[])
> } format_sel = NOTMUCH_FORMAT_TEXT;
>
> notmuch_opt_desc_t options[] = {
> - { NOTMUCH_OPT_KEYWORD, &sort, "sort", 's',
> + { NOTMUCH_OPT_KEYWORD, &o.sort, "sort", 's',
> (notmuch_keyword_t []){ { "oldest-first", NOTMUCH_SORT_OLDEST_FIRST },
> { "newest-first", NOTMUCH_SORT_NEWEST_FIRST },
> { 0, 0 } } },
> @@ -364,7 +366,7 @@ notmuch_search_command (notmuch_config_t *config, int
> argc, char *argv[])
> { "text0", NOTMUCH_FORMAT_TEXT0 },
> { 0, 0 } } },
> { NOTMUCH_OPT_INT, ¬much_format_version, "format-version", 0, 0 },
> - { NOTMUCH_OPT_KEYWORD, &output, "output", 'o',
> + { NOTMUCH_OPT_KEYWORD, &o.output, "output", 'o',
> (notmuch_keyword_t []){ { "summary", OUTPUT_SUMMARY },
> { "threads", OUTPUT_THREADS },
> { "messages", OUTPUT_MESSAGES },
> @@ -377,9 +379,9 @@ notmuch_search_command (notmuch_config_t *config, int
> argc, char *argv[])
> { "flag", NOTMUCH_EXCLUDE_FLAG },
> { "all", NOTMUCH_EXCLUDE_ALL },
> { 0, 0 } } },
> - { NOTMUCH_OPT_INT, &offset, "offset", 'O', 0 },
> - { NOTMUCH_OPT_INT, &limit, "limit", 'L', 0 },
> - { NOTMUCH_OPT_INT, &dupe, "duplicate", 'D', 0 },
> + { NOTMUCH_OPT_INT, &o.offset, "offset", 'O', 0 },
> + { NOTMUCH_OPT_INT, &o.limit, "limit", 'L', 0 },
> + { NOTMUCH_OPT_INT, &o.dupe, "duplicate", 'D', 0 },
> { 0, 0, 0, 0, 0 }
> };
>
> @@ -389,20 +391,20 @@ notmuch_search_command (notmuch_config_t *config, int
> argc, char *argv[])
>
> switch (format_sel) {
> case NOTMUCH_FORMAT_TEXT:
> - format = sprinter_text_create (config, stdout);
> + o.format = sprinter_text_create (config, stdout);
> break;
> case NOTMUCH_FORMAT_TEXT0:
> - if (output == OUTPUT_SUMMARY) {
> + if (o.output == OUTPUT_SUMMARY) {
> fprintf (stderr, "Error: --format=text0 is not compatible with
> --output=summary.\n");
> return EXIT_FAILURE;
> }
> - format = sprinter_text0_create (config, stdout);
> + o.format = sprinter_text0_create (config, stdout);
> break;
> case NOTMUCH_FORMAT_JSON:
> - format = sprinter_json_create (config, stdout);
> + o.format = sprinter_json_create (config, stdout);
> break;
> case NOTMUCH_FORMAT_SEXP:
> - format = sprinter_sexp_create (config, stdout);
> + o.format = sprinter_sexp_create (config, stdout);
> break;
> default:
> /* this should never happen */
> @@ -425,15 +427,15 @@ notmuch_search_command (notmuch_config_t *config, int
> argc, char *argv[])
> return EXIT_FAILURE;
> }
>
> - query = notmuch_query_create (notmuch, query_str);
> - if (query == NULL) {
> + o.query = notmuch_query_create (notmuch, query_str);
> + if (o.query == NULL) {
> fprintf (stderr, "Out of memory\n");
> return EXIT_FAILURE;
> }
>
> - notmuch_query_set_sort (query, sort);
> + notmuch_query_set_sort (o.query, o.sort);
>
> - if (exclude == NOTMUCH_EXCLUDE_FLAG && output != OUTPUT_SUMMARY) {
> + if (exclude == NOTMUCH_EXCLUDE_FLAG && o.output != OUTPUT_SUMMARY) {
> /* If we are not doing summary output there is nowhere to
> * print the excluded flag so fall back on including the
> * excluded messages. */
> @@ -448,29 +450,29 @@ notmuch_search_command (notmuch_config_t *config, int
> argc, char *argv[])
> search_exclude_tags = notmuch_config_get_search_exclude_tags
> (config, &search_exclude_tags_length);
> for (i = 0; i < search_exclude_tags_length; i++)
> - notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
> - notmuch_query_set_omit_excluded (query, exclude);
> + notmuch_query_add_tag_exclude (o.query, search_exclude_tags[i]);
> + notmuch_query_set_omit_excluded (o.query, exclude);
> }
>
> - switch (output) {
> + switch (o.output) {
> default:
> case OUTPUT_SUMMARY:
> case OUTPUT_THREADS:
> - ret = do_search_threads (format, query, sort, output, offset, limit);
> + ret = do_search_threads (&o);
> break;
> case OUTPUT_MESSAGES:
> case OUTPUT_FILES:
> - ret = do_search_messages (format, query, output, offset, limit, dupe);
> + ret = do_search_messages (&o);
> break;
> case OUTPUT_TAGS:
> - ret = do_search_tags (notmuch, format, query);
> + ret = do_search_tags (notmuch, o.format, o.query);
It feels slightly strange to me to have do_search_tags taking a
different argument style than the other two do_search_* functions so I
would slightly prefer making it do_search_tags (&o).
Obviously all of these are trivialities, so as I said above, I am happy
to be overruled.
Best wishes
Mark
> break;
> }
>
> - notmuch_query_destroy (query);
> + notmuch_query_destroy (o.query);
> notmuch_database_destroy (notmuch);
>
> - talloc_free (format);
> + talloc_free (o.format);
>
> return ret ? EXIT_FAILURE : EXIT_SUCCESS;
> }
> --
> 2.1.1
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch
_______________________________________________
notmuch mailing list
notmuch@notmuchmail.org
http://notmuchmail.org/mailman/listinfo/notmuch
