From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Cc: David Bremner <bremner@debian.org>
Subject: [PATCH 1/4] command-line-arguments.[ch]: new argument parsing framework for notmuch.
Date: Wed, 7 Dec 2011 08:34:37 -0400 [thread overview]
Message-ID: <1323261280-29907-1-git-send-email-david@tethera.net> (raw)
In-Reply-To: <87iplso9c9.fsf@zancas.localnet>
From: David Bremner <bremner@debian.org>
As we noticed when Jani kindly converted things to getopt_long, much
of the work in argument parsing in notmuch is due to the the key-value
style arguments like --format=(raw|json|text).
The framework here provides positional arguments, simple switches,
and --key=value style arguments that can take a value being an integer,
a string, or one of a set of keywords.
---
Makefile.local | 1 +
command-line-arguments.c | 159 ++++++++++++++++++++++++++++++++++++++++++++++
command-line-arguments.h | 39 +++++++++++
notmuch-client.h | 1 +
4 files changed, 200 insertions(+), 0 deletions(-)
create mode 100644 command-line-arguments.c
create mode 100644 command-line-arguments.h
diff --git a/Makefile.local b/Makefile.local
index 15e6d88..28e371a 100644
--- a/Makefile.local
+++ b/Makefile.local
@@ -295,6 +295,7 @@ clean:
distclean: clean
notmuch_client_srcs = \
+ command-line-arguments.c\
debugger.c \
gmime-filter-reply.c \
gmime-filter-headers.c \
diff --git a/command-line-arguments.c b/command-line-arguments.c
new file mode 100644
index 0000000..96ed9ba
--- /dev/null
+++ b/command-line-arguments.c
@@ -0,0 +1,159 @@
+#include <assert.h>
+#include <string.h>
+#include <stdio.h>
+#include "error_util.h"
+#include "command-line-arguments.h"
+
+/*
+ Search the array of keywords for a given argument, assigning the
+ output variable to the corresponding value. Return FALSE if nothing
+ matches.
+*/
+
+static notmuch_bool_t
+_process_keyword_arg (const notmuch_opt_desc_t *arg_desc, const char *arg_str) {
+
+ notmuch_keyword_t *keywords = arg_desc->keywords;
+
+ while (keywords->name) {
+ if (strcmp (arg_str, keywords->name) == 0) {
+ if (arg_desc->output_var) {
+ *((int *)arg_desc->output_var) = keywords->value;
+ }
+ return TRUE;
+ }
+ keywords++;
+ }
+ fprintf (stderr, "unknown keyword: %s\n", arg_str);
+ return FALSE;
+}
+
+/*
+ Search for the {pos_arg_index}th position argument, return FALSE if
+ that does not exist.
+*/
+
+notmuch_bool_t
+parse_position_arg (const char *arg_str, int pos_arg_index, const notmuch_opt_desc_t *arg_desc) {
+
+ int pos_arg_counter = 0;
+ while (arg_desc->name){
+ if (arg_desc->opt_type == NOTMUCH_OPT_POSITION) {
+ if (pos_arg_counter == pos_arg_index) {
+ if (arg_desc->output_var) {
+ *((const char **)arg_desc->output_var) = arg_str;
+ }
+ return TRUE;
+ }
+ pos_arg_counter++;
+ }
+ arg_desc++;
+ }
+ return FALSE;
+}
+
+notmuch_bool_t
+parse_option (const char *arg,
+ const notmuch_opt_desc_t *options) {
+
+ assert(arg);
+ assert(options);
+
+ arg += 2;
+
+ const notmuch_opt_desc_t *try = options;
+ while (try->name) {
+ if (strncmp (arg, try->name, strlen (try->name)) == 0) {
+ 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
+ */
+
+ if (try->opt_type != NOTMUCH_OPT_BOOLEAN) {
+ if (next != '=' && next != ':') return FALSE;
+ if (value[0] == 0) return FALSE;
+ } else {
+ if (next != 0) return FALSE;
+ }
+
+ if (try->output_var == NULL)
+ INTERNAL_ERROR ("output pointer NULL for option %s", try->name);
+
+ switch (try->opt_type) {
+ case NOTMUCH_OPT_KEYWORD:
+ return _process_keyword_arg (try, value);
+ break;
+ case NOTMUCH_OPT_BOOLEAN:
+ *((notmuch_bool_t *)try->output_var) = TRUE;
+ return TRUE;
+ break;
+ case NOTMUCH_OPT_INT:
+ *((int *)try->output_var) = strtol (value, &endptr, 10);
+ return (*endptr == 0);
+ break;
+ case NOTMUCH_OPT_STRING:
+ *((const char **)try->output_var) = value;
+ case NOTMUCH_OPT_POSITION:
+ case NOTMUCH_OPT_NULL:
+ default:
+ INTERNAL_ERROR ("unknown or unhandled option type %d", try->opt_type);
+ /*UNREACHED*/
+ }
+ }
+ try++;
+ }
+ fprintf (stderr, "Unrecognized option: --%s\n", arg);
+ return FALSE;
+}
+
+/*
+ Parse command line arguments according to structure options,
+ starting at position opt_index.
+
+ All output of parsed values is via pointers in options.
+
+ Parsing stops at -- (consumed) or at the (k+1)st argument
+ not starting with -- (a "positional argument") if options contains
+ k positional argument descriptors.
+
+ Returns the index of first non-parsed argument, or -1 in case of error.
+
+ */
+int
+parse_arguments (int argc, char **argv,
+ const notmuch_opt_desc_t *options, int opt_index) {
+
+ int pos_arg_index = 0;
+ notmuch_bool_t more_args = TRUE;
+
+ while (more_args && opt_index < argc) {
+ if (strncmp (argv[opt_index],"--",2) != 0) {
+
+ more_args = parse_position_arg (argv[opt_index], pos_arg_index, options);
+
+ if (more_args) {
+ pos_arg_index++;
+ opt_index++;
+ }
+
+ } else {
+
+ if (strlen (argv[opt_index]) == 2)
+ return opt_index+1;
+
+ more_args = parse_option (argv[opt_index], options);
+ if (more_args) {
+ opt_index++;
+ } else {
+ opt_index = -1;
+ }
+
+ }
+ }
+
+ return opt_index;
+}
diff --git a/command-line-arguments.h b/command-line-arguments.h
new file mode 100644
index 0000000..caebe18
--- /dev/null
+++ b/command-line-arguments.h
@@ -0,0 +1,39 @@
+#ifndef NOTMUCH_OPTS_H
+#define NOTMUCH_OPTS_H
+
+#include "notmuch.h"
+
+enum notmuch_opt_type {
+ NOTMUCH_OPT_NULL = 0,
+ NOTMUCH_OPT_BOOLEAN,
+ NOTMUCH_OPT_INT,
+ NOTMUCH_OPT_KEYWORD,
+ NOTMUCH_OPT_STRING,
+ NOTMUCH_OPT_POSITION
+};
+
+typedef struct notmuch_keyword {
+ const char *name;
+ int value;
+} notmuch_keyword_t;
+
+typedef struct notmuch_opt_desc {
+ const char *name;
+ int arg_id;
+ enum notmuch_opt_type opt_type;
+ struct notmuch_keyword *keywords;
+ void *output_var;
+} notmuch_opt_desc_t;
+
+notmuch_bool_t
+parse_option (const char *arg, const notmuch_opt_desc_t* options);
+
+notmuch_bool_t
+parse_position_arg (const char *arg,
+ int position_arg_index,
+ const notmuch_opt_desc_t* options);
+
+int
+parse_arguments(int argc, char **argv, const notmuch_opt_desc_t *options, int opt_index);
+
+#endif
diff --git a/notmuch-client.h b/notmuch-client.h
index b50cb38..703f856 100644
--- a/notmuch-client.h
+++ b/notmuch-client.h
@@ -238,4 +238,5 @@ notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
notmuch_bool_t
debugger_is_active (void);
+#include "command-line-arguments.h"
#endif
--
1.7.7.3
next prev parent reply other threads:[~2011-12-07 12:34 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-12-04 15:47 David Bremner
2011-12-04 15:47 ` [PATCH 1/4] notmuch-opts.[ch]: new argument parsing framework for notmuch David Bremner
2011-12-06 20:41 ` Jani Nikula
2011-12-07 12:27 ` David Bremner
2011-12-07 12:34 ` David Bremner [this message]
2011-12-07 12:34 ` [PATCH 2/4] notmuch-dump: convert to command-line-arguments David Bremner
2011-12-07 12:34 ` [PATCH 3/4] notmuch-restore: " David Bremner
2011-12-07 12:34 ` [PATCH 4/4] notmuch-search: " David Bremner
2011-12-07 19:26 ` David Bremner
2011-12-07 19:26 ` [PATCH v4 1/5] command-line-arguments.[ch]: new argument parsing framework for notmuch David Bremner
2011-12-09 1:40 ` David Bremner
2011-12-07 19:26 ` [PATCH v4 2/5] test: tests for command-line-arguments.c David Bremner
2011-12-07 19:26 ` [PATCH v4 3/5] notmuch-dump: convert to command-line-arguments David Bremner
2011-12-07 19:26 ` [PATCH v4 4/5] notmuch-restore: " David Bremner
2011-12-07 19:26 ` [PATCH v4 5/5] notmuch-search: " David Bremner
2011-12-06 20:55 ` [PATCH 1/4] notmuch-opts.[ch]: new argument parsing framework for notmuch Jani Nikula
2011-12-04 15:47 ` [PATCH 2/4] notmuch-dump: convert to notmuch-opts argument handling David Bremner
2011-12-06 20:43 ` Jani Nikula
2011-12-04 15:47 ` [PATCH 3/4] notmuch-restore: " David Bremner
2011-12-06 20:48 ` Jani Nikula
2011-12-04 15:47 ` [PATCH 4/4] notmuch-search: convert to notmuch-opts argument parsing David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1323261280-29907-1-git-send-email-david@tethera.net \
--to=david@tethera.net \
--cc=bremner@debian.org \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).