[PATCH 4/4] cli: add standard option processing to config, help and setup

diff --git a/36/2aec6e132f752e5107263e02ca657de71738e2 b/36/2aec6e132f752e5107263e02ca657de71738e2
new file mode 100644 (file)
index 0000000..45cb8b5
--- /dev/null
+++ b/36/2aec6e132f752e5107263e02ca657de71738e2
@@ -0,0 +1,180 @@
+Return-Path: <bremner@tesseract.cs.unb.ca>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by arlo.cworth.org (Postfix) with ESMTP id B17516DE1B09\r
+ for <notmuch@notmuchmail.org>; Tue,  7 Apr 2015 12:33:40 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at cworth.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.419\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.419 tagged_above=-999 required=5 tests=[AWL=0.409, \r
+ T_HEADER_FROM_DIFFERENT_DOMAINS=0.01] autolearn=disabled\r
+Received: from arlo.cworth.org ([127.0.0.1])\r
+ by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id 62ymMWw1fqm9 for <notmuch@notmuchmail.org>;\r
+ Tue,  7 Apr 2015 12:33:38 -0700 (PDT)\r
+Received: from mx.xen14.node3324.gplhost.com (gitolite.debian.net\r
+ [87.98.215.224])\r
+ by arlo.cworth.org (Postfix) with ESMTPS id 8DCDD6DE1B00\r
+ for <notmuch@notmuchmail.org>; Tue,  7 Apr 2015 12:33:38 -0700 (PDT)\r
+Received: from remotemail by mx.xen14.node3324.gplhost.com with local (Exim\r
+ 4.80) (envelope-from <bremner@tesseract.cs.unb.ca>)\r
+ id 1YfZE9-0001y9-4H; Tue, 07 Apr 2015 19:32:01 +0000\r
+Received: (nullmailer pid 16656 invoked by uid 1000); Tue, 07 Apr 2015\r
+ 19:30:51 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: Mark Walters <markwalters1009@gmail.com>, David Bremner\r
+ <david@tethera.net>, notmuch@notmuchmail.org\r
+Subject: [PATCH 4/4] cli: add standard option processing to config, help and\r
+ setup\r
+Date: Wed,  8 Apr 2015 04:30:42 +0900\r
+Message-Id: <1428435042-16503-5-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 2.1.4\r
+In-Reply-To: <1428435042-16503-1-git-send-email-david@tethera.net>\r
+References: <871tjws8w8.fsf@qmul.ac.uk>\r
+ <1428435042-16503-1-git-send-email-david@tethera.net>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.18\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch/>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Tue, 07 Apr 2015 19:33:40 -0000\r
+\r
+In particular this fixes a recently encountered bug where the\r
+"--config" argument to "notmuch setup" is silently ignored, which the\r
+unpleasant consequence of overwriting the users config file.\r
+---\r
+ notmuch-client.h     |  2 ++\r
+ notmuch-config.c     |  9 ++++++++-\r
+ notmuch-setup.c      |  3 +++\r
+ notmuch.c            | 32 +++++++++++++++++++++++++++++++-\r
+ test/random-corpus.c |  9 +++++++++\r
+ 5 files changed, 53 insertions(+), 2 deletions(-)\r
+\r
+diff --git a/notmuch-client.h b/notmuch-client.h\r
+index 8ecfac6..78680aa 100644\r
+--- a/notmuch-client.h\r
++++ b/notmuch-client.h\r
+@@ -468,4 +468,6 @@ notmuch_database_dump (notmuch_database_t *notmuch,\r
+ #include "command-line-arguments.h"\r
+ extern const notmuch_opt_desc_t  notmuch_shared_options [];\r
+ void notmuch_process_shared_options (const char* subcommand_name);\r
++int notmuch_minimal_options (const char* subcommand_name,\r
++                           int argc, char **argv);\r
+ #endif\r
+diff --git a/notmuch-config.c b/notmuch-config.c\r
+index 2d5c297..9348278 100644\r
+--- a/notmuch-config.c\r
++++ b/notmuch-config.c\r
+@@ -872,8 +872,15 @@ int\r
+ notmuch_config_command (notmuch_config_t *config, int argc, char *argv[])\r
+ {\r
+     int ret;\r
++    int opt_index;\r
+ \r
+-    argc--; argv++; /* skip subcommand argument */\r
++    opt_index = notmuch_minimal_options ("config", argc, argv);\r
++    if (opt_index < 0)\r
++      return EXIT_FAILURE;\r
++\r
++    /* skip at least subcommand argument */\r
++    argc-= opt_index;\r
++    argv+= opt_index;\r
+ \r
+     if (argc < 1) {\r
+       fprintf (stderr, "Error: notmuch config requires at least one argument.\n");\r
+diff --git a/notmuch-setup.c b/notmuch-setup.c\r
+index 36a6171..7dd5822 100644\r
+--- a/notmuch-setup.c\r
++++ b/notmuch-setup.c\r
+@@ -145,6 +145,9 @@ notmuch_setup_command (notmuch_config_t *config,\r
+       chomp_newline (response);                               \\r
+     } while (0)\r
+ \r
++    if (notmuch_minimal_options ("setup", argc, argv) < 0)\r
++      return EXIT_FAILURE;\r
++\r
+     if (notmuch_config_is_new (config))\r
+       welcome_message_pre_setup ();\r
+ \r
+diff --git a/notmuch.c b/notmuch.c\r
+index 3a9da90..2198b73 100644\r
+--- a/notmuch.c\r
++++ b/notmuch.c\r
+@@ -71,6 +71,28 @@ notmuch_process_shared_options (const char *subcommand_name) {\r
+     }\r
+ }\r
+ \r
++/* This is suitable for subcommands that do not actually open the\r
++ * database.\r
++ */\r
++int notmuch_minimal_options (const char *subcommand_name,\r
++                                int argc, char **argv)\r
++{\r
++    int opt_index;\r
++\r
++    notmuch_opt_desc_t options[] = {\r
++      { NOTMUCH_OPT_INHERIT, (void *) &notmuch_shared_options, NULL, 0, 0 },\r
++      { 0, 0, 0, 0, 0 }\r
++    };\r
++\r
++    opt_index = parse_arguments (argc, argv, options, 1);\r
++\r
++    if (opt_index < 0)\r
++      return -1;\r
++\r
++    /* We can't use argv here as it is sometimes NULL */\r
++    notmuch_process_shared_options (subcommand_name);\r
++    return opt_index;\r
++}\r
+ \r
+ static command_t commands[] = {\r
+     { NULL, notmuch_command, TRUE,\r
+@@ -250,7 +272,15 @@ _help_for (const char *topic_name)\r
+ static int\r
+ notmuch_help_command (unused (notmuch_config_t * config), int argc, char *argv[])\r
+ {\r
+-    argc--; argv++; /* Ignore "help" */\r
++    int opt_index;\r
++\r
++    opt_index = notmuch_minimal_options ("help", argc, argv);\r
++    if (opt_index < 0)\r
++      return EXIT_FAILURE;\r
++\r
++    /* skip at least subcommand argument */\r
++    argc-= opt_index;\r
++    argv+= opt_index;\r
+ \r
+     if (argc == 0) {\r
+       return _help_for (NULL);\r
+diff --git a/test/random-corpus.c b/test/random-corpus.c\r
+index 790193d..6c467bb 100644\r
+--- a/test/random-corpus.c\r
++++ b/test/random-corpus.c\r
+@@ -114,6 +114,15 @@ random_utf8_string (void *ctx, size_t char_count)\r
+     return buf;\r
+ }\r
+ \r
++/* stubs since we cannot link with notmuch.o */\r
++const notmuch_opt_desc_t notmuch_shared_options[] = {\r
++      { 0, 0, 0, 0, 0 }\r
++};\r
++\r
++void\r
++notmuch_process_shared_options (unused (const char *dummy))\r
++{\r
++}\r
+ \r
+ int\r
+ main (int argc, char **argv)\r
+-- \r
+2.1.4\r
+\r