]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-search.c
cli: add support for hierarchical command line option arrays
[notmuch] / notmuch-search.c
index 2c47b80684633b9428fb42c1f5fa3e49cbf366a8..f11535942d566e4e386008b2adcbefa2cc318ec7 100644 (file)
@@ -34,8 +34,18 @@ typedef enum {
 
 #define OUTPUT_ADDRESS_FLAGS (OUTPUT_SENDER | OUTPUT_RECIPIENTS)
 
+typedef enum {
+    NOTMUCH_FORMAT_JSON,
+    NOTMUCH_FORMAT_TEXT,
+    NOTMUCH_FORMAT_TEXT0,
+    NOTMUCH_FORMAT_SEXP
+} format_sel_t;
+
 typedef struct {
+    notmuch_database_t *notmuch;
+    format_sel_t format_sel;
     sprinter_t *format;
+    notmuch_exclude_t exclude;
     notmuch_query_t *query;
     notmuch_sort_t sort;
     output_t output;
@@ -413,14 +423,14 @@ do_search_messages (search_context_t *ctx)
 }
 
 static int
-do_search_tags (notmuch_database_t *notmuch,
-               const search_context_t *ctx)
+do_search_tags (const search_context_t *ctx)
 {
     notmuch_messages_t *messages = NULL;
     notmuch_tags_t *tags;
     const char *tag;
     sprinter_t *format = ctx->format;
     notmuch_query_t *query = ctx->query;
+    notmuch_database_t *notmuch = ctx->notmuch;
 
     /* should the following only special case if no excluded terms
      * specified? */
@@ -461,91 +471,28 @@ do_search_tags (notmuch_database_t *notmuch,
     return 0;
 }
 
-int
-notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])
+static int
+_notmuch_search_prepare (search_context_t *ctx, notmuch_config_t *config, int argc, char *argv[])
 {
-    notmuch_database_t *notmuch;
-    search_context_t ctx = {
-       .sort = NOTMUCH_SORT_NEWEST_FIRST,
-       .output = 0,
-       .offset = 0,
-       .limit = -1, /* unlimited */
-       .dupe = -1,
-    };
     char *query_str;
-    int opt_index, ret;
-    notmuch_exclude_t exclude = NOTMUCH_EXCLUDE_TRUE;
     unsigned int i;
 
-    enum {
-       NOTMUCH_FORMAT_JSON,
-       NOTMUCH_FORMAT_TEXT,
-       NOTMUCH_FORMAT_TEXT0,
-       NOTMUCH_FORMAT_SEXP
-    } format_sel = NOTMUCH_FORMAT_TEXT;
-
-    notmuch_opt_desc_t options[] = {
-       { NOTMUCH_OPT_KEYWORD, &ctx.sort, "sort", 's',
-         (notmuch_keyword_t []){ { "oldest-first", NOTMUCH_SORT_OLDEST_FIRST },
-                                 { "newest-first", NOTMUCH_SORT_NEWEST_FIRST },
-                                 { 0, 0 } } },
-       { NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f',
-         (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
-                                 { "sexp", NOTMUCH_FORMAT_SEXP },
-                                 { "text", NOTMUCH_FORMAT_TEXT },
-                                 { "text0", NOTMUCH_FORMAT_TEXT0 },
-                                 { 0, 0 } } },
-       { NOTMUCH_OPT_INT, &notmuch_format_version, "format-version", 0, 0 },
-       { NOTMUCH_OPT_KEYWORD_FLAGS, &ctx.output, "output", 'o',
-         (notmuch_keyword_t []){ { "summary", OUTPUT_SUMMARY },
-                                 { "threads", OUTPUT_THREADS },
-                                 { "messages", OUTPUT_MESSAGES },
-                                 { "sender", OUTPUT_SENDER },
-                                 { "recipients", OUTPUT_RECIPIENTS },
-                                 { "files", OUTPUT_FILES },
-                                 { "tags", OUTPUT_TAGS },
-                                 { 0, 0 } } },
-        { NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x',
-          (notmuch_keyword_t []){ { "true", NOTMUCH_EXCLUDE_TRUE },
-                                  { "false", NOTMUCH_EXCLUDE_FALSE },
-                                  { "flag", NOTMUCH_EXCLUDE_FLAG },
-                                  { "all", NOTMUCH_EXCLUDE_ALL },
-                                  { 0, 0 } } },
-       { NOTMUCH_OPT_INT, &ctx.offset, "offset", 'O', 0 },
-       { NOTMUCH_OPT_INT, &ctx.limit, "limit", 'L', 0  },
-       { NOTMUCH_OPT_INT, &ctx.dupe, "duplicate", 'D', 0  },
-       { 0, 0, 0, 0, 0 }
-    };
-
-    opt_index = parse_arguments (argc, argv, options, 1);
-    if (opt_index < 0)
-       return EXIT_FAILURE;
-
-    if (! ctx.output)
-       ctx.output = OUTPUT_SUMMARY;
-
-    if (ctx.output != OUTPUT_FILES && ctx.output != OUTPUT_MESSAGES &&
-       ctx.dupe != -1) {
-        fprintf (stderr, "Error: --duplicate=N is only supported with --output=files and --output=messages.\n");
-        return EXIT_FAILURE;
-    }
-
-    switch (format_sel) {
+    switch (ctx->format_sel) {
     case NOTMUCH_FORMAT_TEXT:
-       ctx.format = sprinter_text_create (config, stdout);
+       ctx->format = sprinter_text_create (config, stdout);
        break;
     case NOTMUCH_FORMAT_TEXT0:
-       if (ctx.output == OUTPUT_SUMMARY) {
+       if (ctx->output == OUTPUT_SUMMARY) {
            fprintf (stderr, "Error: --format=text0 is not compatible with --output=summary.\n");
            return EXIT_FAILURE;
        }
-       ctx.format = sprinter_text0_create (config, stdout);
+       ctx->format = sprinter_text0_create (config, stdout);
        break;
     case NOTMUCH_FORMAT_JSON:
-       ctx.format = sprinter_json_create (config, stdout);
+       ctx->format = sprinter_json_create (config, stdout);
        break;
     case NOTMUCH_FORMAT_SEXP:
-       ctx.format = sprinter_sexp_create (config, stdout);
+       ctx->format = sprinter_sexp_create (config, stdout);
        break;
     default:
        /* this should never happen */
@@ -555,10 +502,10 @@ notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])
     notmuch_exit_if_unsupported_format ();
 
     if (notmuch_database_open (notmuch_config_get_database_path (config),
-                              NOTMUCH_DATABASE_MODE_READ_ONLY, &notmuch))
+                              NOTMUCH_DATABASE_MODE_READ_ONLY, &ctx->notmuch))
        return EXIT_FAILURE;
 
-    query_str = query_string_from_args (notmuch, argc-opt_index, argv+opt_index);
+    query_str = query_string_from_args (ctx->notmuch, argc, argv);
     if (query_str == NULL) {
        fprintf (stderr, "Out of memory.\n");
        return EXIT_FAILURE;
@@ -568,51 +515,125 @@ notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])
        return EXIT_FAILURE;
     }
 
-    ctx.query = notmuch_query_create (notmuch, query_str);
-    if (ctx.query == NULL) {
+    ctx->query = notmuch_query_create (ctx->notmuch, query_str);
+    if (ctx->query == NULL) {
        fprintf (stderr, "Out of memory\n");
        return EXIT_FAILURE;
     }
 
-    notmuch_query_set_sort (ctx.query, ctx.sort);
+    notmuch_query_set_sort (ctx->query, ctx->sort);
 
-    if (exclude == NOTMUCH_EXCLUDE_FLAG && ctx.output != OUTPUT_SUMMARY) {
+    if (ctx->exclude == NOTMUCH_EXCLUDE_FLAG && ctx->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. */
        fprintf (stderr, "Warning: this output format cannot flag excluded messages.\n");
-       exclude = NOTMUCH_EXCLUDE_FALSE;
+       ctx->exclude = NOTMUCH_EXCLUDE_FALSE;
     }
 
-    if (exclude != NOTMUCH_EXCLUDE_FALSE) {
+    if (ctx->exclude != NOTMUCH_EXCLUDE_FALSE) {
        const char **search_exclude_tags;
        size_t search_exclude_tags_length;
 
        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 (ctx.query, search_exclude_tags[i]);
-       notmuch_query_set_omit_excluded (ctx.query, exclude);
+           notmuch_query_add_tag_exclude (ctx->query, search_exclude_tags[i]);
+       notmuch_query_set_omit_excluded (ctx->query, ctx->exclude);
     }
 
-    if (ctx.output == OUTPUT_SUMMARY ||
-       ctx.output == OUTPUT_THREADS)
-       ret = do_search_threads (&ctx);
-    else if (ctx.output == OUTPUT_MESSAGES ||
-            ctx.output == OUTPUT_FILES ||
-            (ctx.output & OUTPUT_ADDRESS_FLAGS && !(ctx.output & ~OUTPUT_ADDRESS_FLAGS)))
-       ret = do_search_messages (&ctx);
-    else if (ctx.output == OUTPUT_TAGS)
-       ret = do_search_tags (notmuch, &ctx);
+    return 0;
+}
+
+static void
+_notmuch_search_cleanup (search_context_t *ctx)
+{
+    notmuch_query_destroy (ctx->query);
+    notmuch_database_destroy (ctx->notmuch);
+
+    talloc_free (ctx->format);
+}
+
+int
+notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])
+{
+    search_context_t search_context = {
+       .format_sel = NOTMUCH_FORMAT_TEXT,
+       .exclude = NOTMUCH_EXCLUDE_TRUE,
+       .sort = NOTMUCH_SORT_NEWEST_FIRST,
+       .output = 0,
+       .offset = 0,
+       .limit = -1, /* unlimited */
+       .dupe = -1,
+    };
+    search_context_t *ctx = &search_context;
+    int opt_index, ret;
+
+    notmuch_opt_desc_t options[] = {
+       { NOTMUCH_OPT_KEYWORD, &ctx->sort, "sort", 's',
+         (notmuch_keyword_t []){ { "oldest-first", NOTMUCH_SORT_OLDEST_FIRST },
+                                 { "newest-first", NOTMUCH_SORT_NEWEST_FIRST },
+                                 { 0, 0 } } },
+       { NOTMUCH_OPT_KEYWORD, &ctx->format_sel, "format", 'f',
+         (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
+                                 { "sexp", NOTMUCH_FORMAT_SEXP },
+                                 { "text", NOTMUCH_FORMAT_TEXT },
+                                 { "text0", NOTMUCH_FORMAT_TEXT0 },
+                                 { 0, 0 } } },
+       { NOTMUCH_OPT_INT, &notmuch_format_version, "format-version", 0, 0 },
+       { NOTMUCH_OPT_KEYWORD_FLAGS, &ctx->output, "output", 'o',
+         (notmuch_keyword_t []){ { "summary", OUTPUT_SUMMARY },
+                                 { "threads", OUTPUT_THREADS },
+                                 { "messages", OUTPUT_MESSAGES },
+                                 { "sender", OUTPUT_SENDER },
+                                 { "recipients", OUTPUT_RECIPIENTS },
+                                 { "files", OUTPUT_FILES },
+                                 { "tags", OUTPUT_TAGS },
+                                 { 0, 0 } } },
+        { NOTMUCH_OPT_KEYWORD, &ctx->exclude, "exclude", 'x',
+          (notmuch_keyword_t []){ { "true", NOTMUCH_EXCLUDE_TRUE },
+                                  { "false", NOTMUCH_EXCLUDE_FALSE },
+                                  { "flag", NOTMUCH_EXCLUDE_FLAG },
+                                  { "all", NOTMUCH_EXCLUDE_ALL },
+                                  { 0, 0 } } },
+       { NOTMUCH_OPT_INT, &ctx->offset, "offset", 'O', 0 },
+       { NOTMUCH_OPT_INT, &ctx->limit, "limit", 'L', 0  },
+       { NOTMUCH_OPT_INT, &ctx->dupe, "duplicate", 'D', 0  },
+       { 0, 0, 0, 0, 0 }
+    };
+
+    opt_index = parse_arguments (argc, argv, options, 1);
+    if (opt_index < 0)
+       return EXIT_FAILURE;
+
+    if (! ctx->output)
+       ctx->output = OUTPUT_SUMMARY;
+
+    if (ctx->output != OUTPUT_FILES && ctx->output != OUTPUT_MESSAGES &&
+       ctx->dupe != -1) {
+        fprintf (stderr, "Error: --duplicate=N is only supported with --output=files and --output=messages.\n");
+        return EXIT_FAILURE;
+    }
+
+    if (_notmuch_search_prepare (ctx, config,
+                                argc - opt_index, argv + opt_index))
+       return EXIT_FAILURE;
+
+    if (ctx->output == OUTPUT_SUMMARY ||
+       ctx->output == OUTPUT_THREADS)
+       ret = do_search_threads (ctx);
+    else if (ctx->output == OUTPUT_MESSAGES ||
+            ctx->output == OUTPUT_FILES ||
+            (ctx->output & OUTPUT_ADDRESS_FLAGS && !(ctx->output & ~OUTPUT_ADDRESS_FLAGS)))
+       ret = do_search_messages (ctx);
+    else if (ctx->output == OUTPUT_TAGS)
+       ret = do_search_tags (ctx);
     else {
        fprintf (stderr, "Error: the combination of outputs is not supported.\n");
        ret = 1;
     }
 
-    notmuch_query_destroy (ctx.query);
-    notmuch_database_destroy (notmuch);
-
-    talloc_free (ctx.format);
+    _notmuch_search_cleanup (ctx);
 
     return ret ? EXIT_FAILURE : EXIT_SUCCESS;
 }