From 5a66b2d1dea9de4a77775195edbc3136b88a2be1 Mon Sep 17 00:00:00 2001 From: David Bremner Date: Wed, 8 Apr 2015 04:30:41 +0900 Subject: [PATCH] [PATCH 3/4] cli: define shared options, use for --help and --version --- c4/c7ec8c8f60dd54736ab7fa83f18538b402e008 | 390 ++++++++++++++++++++++ 1 file changed, 390 insertions(+) create mode 100644 c4/c7ec8c8f60dd54736ab7fa83f18538b402e008 diff --git a/c4/c7ec8c8f60dd54736ab7fa83f18538b402e008 b/c4/c7ec8c8f60dd54736ab7fa83f18538b402e008 new file mode 100644 index 000000000..c827b3563 --- /dev/null +++ b/c4/c7ec8c8f60dd54736ab7fa83f18538b402e008 @@ -0,0 +1,390 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by arlo.cworth.org (Postfix) with ESMTP id 8D3CD6DE1AEF + for ; Tue, 7 Apr 2015 12:33:23 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at cworth.org +X-Spam-Flag: NO +X-Spam-Score: 0.424 +X-Spam-Level: +X-Spam-Status: No, score=0.424 tagged_above=-999 required=5 tests=[AWL=0.414, + T_HEADER_FROM_DIFFERENT_DOMAINS=0.01] autolearn=disabled +Received: from arlo.cworth.org ([127.0.0.1]) + by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id JLYqZMON8xGW for ; + Tue, 7 Apr 2015 12:33:21 -0700 (PDT) +Received: from mx.xen14.node3324.gplhost.com (gitolite.debian.net + [87.98.215.224]) + by arlo.cworth.org (Postfix) with ESMTPS id A1B8F6DE1AE3 + for ; Tue, 7 Apr 2015 12:33:21 -0700 (PDT) +Received: from remotemail by mx.xen14.node3324.gplhost.com with local (Exim + 4.80) (envelope-from ) + id 1YfZDr-0001y1-LH; Tue, 07 Apr 2015 19:31:43 +0000 +Received: (nullmailer pid 16654 invoked by uid 1000); Tue, 07 Apr 2015 + 19:30:50 -0000 +From: David Bremner +To: Mark Walters , David Bremner + , notmuch@notmuchmail.org +Subject: [PATCH 3/4] cli: define shared options, use for --help and --version +Date: Wed, 8 Apr 2015 04:30:41 +0900 +Message-Id: <1428435042-16503-4-git-send-email-david@tethera.net> +X-Mailer: git-send-email 2.1.4 +In-Reply-To: <1428435042-16503-1-git-send-email-david@tethera.net> +References: <871tjws8w8.fsf@qmul.ac.uk> + <1428435042-16503-1-git-send-email-david@tethera.net> +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.18 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Tue, 07 Apr 2015 19:33:23 -0000 + +Unfortunately it seems trickier to support --config globally + +The non-trivial changes are in notmuch.c; most of the other changes +consists of blindly inserting two lines into every subcommand. +--- + notmuch-client.h | 2 ++ + notmuch-compact.c | 4 ++++ + notmuch-count.c | 3 +++ + notmuch-dump.c | 3 +++ + notmuch-insert.c | 3 +++ + notmuch-new.c | 3 +++ + notmuch-reply.c | 3 +++ + notmuch-restore.c | 2 ++ + notmuch-search.c | 6 ++++++ + notmuch-show.c | 3 +++ + notmuch-tag.c | 3 +++ + notmuch.c | 52 +++++++++++++++++++++++++++++++--------------------- + 12 files changed, 66 insertions(+), 21 deletions(-) + +diff --git a/notmuch-client.h b/notmuch-client.h +index fb3021c..8ecfac6 100644 +--- a/notmuch-client.h ++++ b/notmuch-client.h +@@ -466,4 +466,6 @@ notmuch_database_dump (notmuch_database_t *notmuch, + notmuch_bool_t gzip_output); + + #include "command-line-arguments.h" ++extern const notmuch_opt_desc_t notmuch_shared_options []; ++void notmuch_process_shared_options (const char* subcommand_name); + #endif +diff --git a/notmuch-compact.c b/notmuch-compact.c +index 2fc012a..5be551d 100644 +--- a/notmuch-compact.c ++++ b/notmuch-compact.c +@@ -38,12 +38,16 @@ notmuch_compact_command (notmuch_config_t *config, int argc, char *argv[]) + notmuch_opt_desc_t options[] = { + { NOTMUCH_OPT_STRING, &backup_path, "backup", 0, 0 }, + { NOTMUCH_OPT_BOOLEAN, &quiet, "quiet", 'q', 0 }, ++ { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 }, ++ { 0, 0, 0, 0, 0} + }; + + opt_index = parse_arguments (argc, argv, options, 1); + if (opt_index < 0) + return EXIT_FAILURE; + ++ notmuch_process_shared_options (argv[0]); ++ + if (! quiet) + printf ("Compacting database...\n"); + ret = notmuch_database_compact (path, backup_path, +diff --git a/notmuch-count.c b/notmuch-count.c +index 6058f7c..57a88a8 100644 +--- a/notmuch-count.c ++++ b/notmuch-count.c +@@ -146,6 +146,7 @@ notmuch_count_command (notmuch_config_t *config, int argc, char *argv[]) + { 0, 0 } } }, + { NOTMUCH_OPT_BOOLEAN, &batch, "batch", 0, 0 }, + { NOTMUCH_OPT_STRING, &input_file_name, "input", 'i', 0 }, ++ { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 }, + { 0, 0, 0, 0, 0 } + }; + +@@ -153,6 +154,8 @@ notmuch_count_command (notmuch_config_t *config, int argc, char *argv[]) + if (opt_index < 0) + return EXIT_FAILURE; + ++ notmuch_process_shared_options (argv[0]); ++ + if (input_file_name) { + batch = TRUE; + input = fopen (input_file_name, "r"); +diff --git a/notmuch-dump.c b/notmuch-dump.c +index 9c6ad7f..fab22bd 100644 +--- a/notmuch-dump.c ++++ b/notmuch-dump.c +@@ -228,6 +228,7 @@ notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]) + { 0, 0 } } }, + { NOTMUCH_OPT_STRING, &output_file_name, "output", 'o', 0 }, + { NOTMUCH_OPT_BOOLEAN, &gzip_output, "gzip", 'z', 0 }, ++ { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 }, + { 0, 0, 0, 0, 0 } + }; + +@@ -235,6 +236,8 @@ notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]) + if (opt_index < 0) + return EXIT_FAILURE; + ++ notmuch_process_shared_options (argv[0]); ++ + if (opt_index < argc) { + query_str = query_string_from_args (notmuch, argc - opt_index, argv + opt_index); + if (query_str == NULL) { +diff --git a/notmuch-insert.c b/notmuch-insert.c +index 90fe3ba..697880f 100644 +--- a/notmuch-insert.c ++++ b/notmuch-insert.c +@@ -466,6 +466,7 @@ notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]) + { NOTMUCH_OPT_BOOLEAN, &create_folder, "create-folder", 0, 0 }, + { NOTMUCH_OPT_BOOLEAN, &keep, "keep", 0, 0 }, + { NOTMUCH_OPT_BOOLEAN, &no_hooks, "no-hooks", 'n', 0 }, ++ { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 }, + { NOTMUCH_OPT_END, 0, 0, 0, 0 } + }; + +@@ -473,6 +474,8 @@ notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[]) + if (opt_index < 0) + return EXIT_FAILURE; + ++ notmuch_process_shared_options (argv[0]); ++ + db_path = notmuch_config_get_database_path (config); + new_tags = notmuch_config_get_new_tags (config, &new_tags_length); + synchronize_flags = notmuch_config_get_maildir_synchronize_flags (config); +diff --git a/notmuch-new.c b/notmuch-new.c +index e6c283e..895f5d9 100644 +--- a/notmuch-new.c ++++ b/notmuch-new.c +@@ -934,6 +934,7 @@ notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]) + { NOTMUCH_OPT_BOOLEAN, &verbose, "verbose", 'v', 0 }, + { NOTMUCH_OPT_BOOLEAN, &add_files_state.debug, "debug", 'd', 0 }, + { NOTMUCH_OPT_BOOLEAN, &no_hooks, "no-hooks", 'n', 0 }, ++ { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 }, + { 0, 0, 0, 0, 0 } + }; + +@@ -941,6 +942,8 @@ notmuch_new_command (notmuch_config_t *config, int argc, char *argv[]) + if (opt_index < 0) + return EXIT_FAILURE; + ++ notmuch_process_shared_options (argv[0]); ++ + /* quiet trumps verbose */ + if (quiet) + add_files_state.verbosity = VERBOSITY_QUIET; +diff --git a/notmuch-reply.c b/notmuch-reply.c +index d51fdfc..4464741 100644 +--- a/notmuch-reply.c ++++ b/notmuch-reply.c +@@ -790,6 +790,7 @@ notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[]) + { "sender", FALSE }, + { 0, 0 } } }, + { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.decrypt, "decrypt", 'd', 0 }, ++ { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 }, + { 0, 0, 0, 0, 0 } + }; + +@@ -797,6 +798,8 @@ notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[]) + if (opt_index < 0) + return EXIT_FAILURE; + ++ notmuch_process_shared_options (argv[0]); ++ + if (format == FORMAT_HEADERS_ONLY) { + reply_format_func = notmuch_reply_format_headers_only; + } else if (format == FORMAT_JSON) { +diff --git a/notmuch-restore.c b/notmuch-restore.c +index 584d9f9..2a534dc 100644 +--- a/notmuch-restore.c ++++ b/notmuch-restore.c +@@ -154,6 +154,7 @@ notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[]) + { 0, 0 } } }, + { NOTMUCH_OPT_STRING, &input_file_name, "input", 'i', 0 }, + { NOTMUCH_OPT_BOOLEAN, &accumulate, "accumulate", 'a', 0 }, ++ { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 }, + { 0, 0, 0, 0, 0 } + }; + +@@ -163,6 +164,7 @@ notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[]) + goto DONE; + } + ++ notmuch_process_shared_options (argv[0]); + name_for_error = input_file_name ? input_file_name : "stdin"; + + if (! accumulate) +diff --git a/notmuch-search.c b/notmuch-search.c +index b81ac01..b89a17e 100644 +--- a/notmuch-search.c ++++ b/notmuch-search.c +@@ -681,6 +681,7 @@ notmuch_search_command (notmuch_config_t *config, int argc, char *argv[]) + { NOTMUCH_OPT_INT, &ctx->limit, "limit", 'L', 0 }, + { NOTMUCH_OPT_INT, &ctx->dupe, "duplicate", 'D', 0 }, + { NOTMUCH_OPT_INHERIT, (void *) &common_options, NULL, 0, 0 }, ++ { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 }, + { 0, 0, 0, 0, 0 } + }; + +@@ -689,6 +690,8 @@ notmuch_search_command (notmuch_config_t *config, int argc, char *argv[]) + if (opt_index < 0) + return EXIT_FAILURE; + ++ notmuch_process_shared_options (argv[0]); ++ + 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"); +@@ -737,6 +740,7 @@ notmuch_address_command (notmuch_config_t *config, int argc, char *argv[]) + { "false", NOTMUCH_EXCLUDE_FALSE }, + { 0, 0 } } }, + { NOTMUCH_OPT_INHERIT, (void *) &common_options, NULL, 0, 0 }, ++ { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 }, + { 0, 0, 0, 0, 0 } + }; + +@@ -744,6 +748,8 @@ notmuch_address_command (notmuch_config_t *config, int argc, char *argv[]) + if (opt_index < 0) + return EXIT_FAILURE; + ++ notmuch_process_shared_options (argv[0]); ++ + if (! (ctx->output & (OUTPUT_SENDER | OUTPUT_RECIPIENTS))) + ctx->output |= OUTPUT_SENDER; + +diff --git a/notmuch-show.c b/notmuch-show.c +index 43bf71c..b80933a 100644 +--- a/notmuch-show.c ++++ b/notmuch-show.c +@@ -1114,6 +1114,7 @@ notmuch_show_command (notmuch_config_t *config, int argc, char *argv[]) + { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.verify, "verify", 'v', 0 }, + { NOTMUCH_OPT_BOOLEAN, ¶ms.output_body, "body", 'b', 0 }, + { NOTMUCH_OPT_BOOLEAN, ¶ms.include_html, "include-html", 0, 0 }, ++ { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 }, + { 0, 0, 0, 0, 0 } + }; + +@@ -1121,6 +1122,8 @@ notmuch_show_command (notmuch_config_t *config, int argc, char *argv[]) + if (opt_index < 0) + return EXIT_FAILURE; + ++ notmuch_process_shared_options (argv[0]); ++ + /* decryption implies verification */ + if (params.crypto.decrypt) + params.crypto.verify = TRUE; +diff --git a/notmuch-tag.c b/notmuch-tag.c +index 5b2f1e4..35f971d 100644 +--- a/notmuch-tag.c ++++ b/notmuch-tag.c +@@ -206,6 +206,7 @@ notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[]) + { NOTMUCH_OPT_BOOLEAN, &batch, "batch", 0, 0 }, + { NOTMUCH_OPT_STRING, &input_file_name, "input", 'i', 0 }, + { NOTMUCH_OPT_BOOLEAN, &remove_all, "remove-all", 0, 0 }, ++ { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 }, + { 0, 0, 0, 0, 0 } + }; + +@@ -213,6 +214,8 @@ notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[]) + if (opt_index < 0) + return EXIT_FAILURE; + ++ notmuch_process_shared_options (argv[0]); ++ + if (input_file_name) { + batch = TRUE; + input = fopen (input_file_name, "r"); +diff --git a/notmuch.c b/notmuch.c +index bff941f..3a9da90 100644 +--- a/notmuch.c ++++ b/notmuch.c +@@ -43,6 +43,35 @@ notmuch_help_command (notmuch_config_t *config, int argc, char *argv[]); + static int + notmuch_command (notmuch_config_t *config, int argc, char *argv[]); + ++static int ++_help_for (const char *topic); ++ ++static notmuch_bool_t print_version = FALSE, print_help = FALSE; ++ ++const notmuch_opt_desc_t notmuch_shared_options [] = { ++ { NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 }, ++ { NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 }, ++ {0, 0, 0, 0, 0} ++}; ++ ++/* any subcommand wanting to support these options should call ++ * inherit notmuch_shared_options and call ++ * notmuch_process_shared_options (subcommand_name); ++ */ ++void ++notmuch_process_shared_options (const char *subcommand_name) { ++ if (print_version) { ++ printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n"); ++ exit (EXIT_SUCCESS); ++ } ++ ++ if (print_help) { ++ int ret = _help_for (subcommand_name); ++ exit (ret); ++ } ++} ++ ++ + static command_t commands[] = { + { NULL, notmuch_command, TRUE, + "Notmuch main command." }, +@@ -295,14 +324,12 @@ main (int argc, char *argv[]) + command_t *command; + char *config_file_name = NULL; + notmuch_config_t *config = NULL; +- notmuch_bool_t print_help=FALSE, print_version=FALSE; + int opt_index; + int ret; + + notmuch_opt_desc_t options[] = { +- { NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 }, +- { NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 }, + { NOTMUCH_OPT_STRING, &config_file_name, "config", 'c', 0 }, ++ { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 }, + { 0, 0, 0, 0, 0 } + }; + +@@ -324,24 +351,7 @@ main (int argc, char *argv[]) + goto DONE; + } + +- /* Handle notmuch --help [command] and notmuch command --help. */ +- if (print_help || +- (opt_index + 1 < argc && strcmp (argv[opt_index + 1], "--help") == 0)) { +- /* +- * Pass the first positional argument as argv[1] so the help +- * command can give help for it. The help command ignores the +- * argv[0] passed to it. +- */ +- ret = notmuch_help_command (NULL, argc - opt_index + 1, +- argv + opt_index - 1); +- goto DONE; +- } +- +- if (print_version) { +- printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n"); +- ret = EXIT_SUCCESS; +- goto DONE; +- } ++ notmuch_process_shared_options (NULL); + + if (opt_index < argc) + command_name = argv[opt_index]; +-- +2.1.4 + -- 2.26.2