Re: [PATCH] cli: make the command line parser's errors more informative.
authorPeter Wang <novalazy@gmail.com>
Tue, 5 Jun 2012 08:40:37 +0000 (18:40 +1000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:47:37 +0000 (09:47 -0800)
aa/2666e8cf3b9ae9153fbb0044946a1426860551 [new file with mode: 0644]

diff --git a/aa/2666e8cf3b9ae9153fbb0044946a1426860551 b/aa/2666e8cf3b9ae9153fbb0044946a1426860551
new file mode 100644 (file)
index 0000000..cd436e3
--- /dev/null
@@ -0,0 +1,151 @@
+Return-Path: <novalazy@gmail.com>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 70331431FAF\r
+       for <notmuch@notmuchmail.org>; Tue,  5 Jun 2012 01:40:46 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.799\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.799 tagged_above=-999 required=5\r
+       tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
+       FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id QwcuxfSLJNbk for <notmuch@notmuchmail.org>;\r
+       Tue,  5 Jun 2012 01:40:45 -0700 (PDT)\r
+Received: from mail-pb0-f53.google.com (mail-pb0-f53.google.com\r
+       [209.85.160.53]) (using TLSv1 with cipher RC4-MD5 (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id C5871431FAE\r
+       for <notmuch@notmuchmail.org>; Tue,  5 Jun 2012 01:40:45 -0700 (PDT)\r
+Received: by pbbrr13 with SMTP id rr13so8999057pbb.26\r
+       for <notmuch@notmuchmail.org>; Tue, 05 Jun 2012 01:40:43 -0700 (PDT)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
+       h=date:message-id:from:to:subject:in-reply-to:references:mime-version\r
+       :content-type:content-disposition:content-transfer-encoding;\r
+       bh=5VyJmRHtGciy2c7Q1hn3Wv9biuJfyT3RIxwnR2Melb0=;\r
+       b=Vkllh1HbnKIvkFMNhIEo3Pp0YVIBvCBsCVPwp0jAQsFty5pRNB1xe2pQ6Z19dDFMNj\r
+       woFLLr6x7yHCSe0KJb1hcXQwKjwaTKvATi66KM8KiJFCbxb8wx1br3KrDyWth/0nWvF2\r
+       qE4ifMXOyQ/fuY85TWinZy9EQRxh7/R5IGeDRCwBuPGM9IR2Mf4rFgJ4rXx/V2/ZS0+V\r
+       NwE8xgql8WXD4t4XcFkTcvvzBFQkBHVViNlccuaqz/iLoizNb9UUGBAOL2KfcBQWO/7m\r
+       06f1YlBwuiZeecLEC638fOuk2JqXOcN5vABNzaVHHEvxGzPjmlT93hsT6PSVVWzl39qJ\r
+       KxEg==\r
+Received: by 10.68.221.106 with SMTP id qd10mr48647015pbc.42.1338885643696;\r
+       Tue, 05 Jun 2012 01:40:43 -0700 (PDT)\r
+Received: from localhost (215.42.233.220.static.exetel.com.au.\r
+       [220.233.42.215])\r
+       by mx.google.com with ESMTPS id pb10sm1647030pbc.68.2012.06.05.01.40.40\r
+       (version=TLSv1/SSLv3 cipher=OTHER);\r
+       Tue, 05 Jun 2012 01:40:41 -0700 (PDT)\r
+Date: Tue, 5 Jun 2012 18:40:37 +1000\r
+Message-ID: <20120605184037.GB14297@hili.localdomain>\r
+From: Peter Wang <novalazy@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: Re: [PATCH] cli: make the command line parser's errors more\r
+       informative.\r
+In-Reply-To: <1338724128-13158-1-git-send-email-markwalters1009@gmail.com>\r
+References: <1338723972-13063-1-git-send-email-markwalters1009@gmail.com>\r
+       <1338724128-13158-1-git-send-email-markwalters1009@gmail.com>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=utf-8\r
+Content-Disposition: inline\r
+Content-Transfer-Encoding: 8bit\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\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, 05 Jun 2012 08:40:46 -0000\r
+\r
+On Sun,  3 Jun 2012 12:48:48 +0100, Mark Walters <markwalters1009@gmail.com> wrote:\r
+>  \r
+> +static notmuch_bool_t\r
+> +_process_int_arg (const notmuch_opt_desc_t *arg_desc, char next, const char *arg_str) {\r
+> +\r
+> +    char *endptr;\r
+> +    if (next == 0 || arg_str[0] == 0) {\r
+> +    fprintf (stderr, "Option \"%s\" needs an integer argument.\n", arg_desc->name);\r
+> +    return FALSE;\r
+> +    }\r
+> +\r
+> +    *((int *)arg_desc->output_var) = strtol (arg_str, &endptr, 10);\r
+> +    if (*endptr == 0)\r
+> +    return TRUE;\r
+\r
+It's usually clearer to write '\0' for the null character.\r
+\r
+> @@ -99,20 +133,13 @@ parse_option (const char *arg,\r
+>          char next = arg[strlen (try->name)];\r
+>          const char *value= arg+strlen(try->name)+1;\r
+>  \r
+> -        char *endptr;\r
+> -\r
+> -        /* Everything but boolean arguments (switches) needs a\r
+> -         * delimiter, and a non-zero length value. Boolean\r
+> -         * arguments may take an optional =true or =false value.\r
+> -         */\r
+> -        if (next != '=' && next != ':' && next != 0) return FALSE;\r
+> -        if (next == 0) {\r
+> -            if (try->opt_type != NOTMUCH_OPT_BOOLEAN &&\r
+> -                try->opt_type != NOTMUCH_OPT_KEYWORD)\r
+> -                return FALSE;\r
+> -        } else {\r
+> -            if (value[0] == 0) return FALSE;\r
+> -        }\r
+> +        /* If this is not the end of the argument (i.e. the next\r
+> +         * character is not a space or a delimiter) we stop\r
+> +         * parsing for this option but allow the parsing to\r
+> +         * continue to for other options. This should allow\r
+> +         * options to be initial segments of other options. */\r
+\r
+It took me a little while to figure out what the last sentence was\r
+about.  Perhaps:\r
+\r
+    If we have not reached the end of the argument (i.e. the next\r
+    character is not a space or delimiter) then the argument could\r
+    still match a longer option name later in the option table.\r
+\r
+(otherwise, "continue to for other")\r
+\r
+> +        if (next != '=' && next != ':' && next != 0)\r
+> +            goto DONE_THIS_OPTION;\r
+\r
+The `goto' could be expressed as a `continue' in a `for' loop, AFAICS.\r
+\r
+>  \r
+>          if (try->output_var == NULL)\r
+>              INTERNAL_ERROR ("output pointer NULL for option %s", try->name);\r
+> @@ -125,12 +152,10 @@ parse_option (const char *arg,\r
+>              return _process_boolean_arg (try, next, value);\r
+>              break;\r
+>          case NOTMUCH_OPT_INT:\r
+> -            *((int *)try->output_var) = strtol (value, &endptr, 10);\r
+> -            return (*endptr == 0);\r
+> +            return _process_int_arg (try, next, value);\r
+>              break;\r
+>          case NOTMUCH_OPT_STRING:\r
+> -            *((const char **)try->output_var) = value;\r
+> -            return TRUE;\r
+> +            return _process_string_arg (try, next, value);\r
+>              break;\r
+>          case NOTMUCH_OPT_POSITION:\r
+>          case NOTMUCH_OPT_END:\r
+> @@ -139,6 +164,7 @@ parse_option (const char *arg,\r
+>              /*UNREACHED*/\r
+>          }\r
+>      }\r
+> +    DONE_THIS_OPTION:\r
+>      try++;\r
+>      }\r
+>      fprintf (stderr, "Unrecognized option: --%s\n", arg);\r
+\r
+Peter\r