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