cli: Add support for parsing keyword-flag arguments
[notmuch] / command-line-arguments.c
1 #include <assert.h>
2 #include <string.h>
3 #include <stdio.h>
4 #include "error_util.h"
5 #include "command-line-arguments.h"
6
7 /*
8   Search the array of keywords for a given argument, assigning the
9   output variable to the corresponding value.  Return FALSE if nothing
10   matches.
11 */
12
13 static notmuch_bool_t
14 _process_keyword_arg (const notmuch_opt_desc_t *arg_desc, char next, const char *arg_str) {
15
16     const notmuch_keyword_t *keywords = arg_desc->keywords;
17
18     if (next == '\0') {
19         /* No keyword given */
20         arg_str = "";
21     }
22
23     while (keywords->name) {
24         if (strcmp (arg_str, keywords->name) == 0) {
25             if (arg_desc->output_var) {
26                 if (arg_desc->opt_type == NOTMUCH_OPT_KEYWORD_FLAGS)
27                     *((int *)arg_desc->output_var) |= keywords->value;
28                 else
29                     *((int *)arg_desc->output_var) = keywords->value;
30             }
31             return TRUE;
32         }
33         keywords++;
34     }
35     if (next != '\0')
36         fprintf (stderr, "Unknown keyword argument \"%s\" for option \"%s\".\n", arg_str, arg_desc->name);
37     else
38         fprintf (stderr, "Option \"%s\" needs a keyword argument.\n", arg_desc->name);
39     return FALSE;
40 }
41
42 static notmuch_bool_t
43 _process_boolean_arg (const notmuch_opt_desc_t *arg_desc, char next, const char *arg_str) {
44
45     if (next == '\0') {
46         *((notmuch_bool_t *)arg_desc->output_var) = TRUE;
47         return TRUE;
48     }
49     if (strcmp (arg_str, "false") == 0) {
50         *((notmuch_bool_t *)arg_desc->output_var) = FALSE;
51         return TRUE;
52     }
53     if (strcmp (arg_str, "true") == 0) {
54         *((notmuch_bool_t *)arg_desc->output_var) = TRUE;
55         return TRUE;
56     }
57     fprintf (stderr, "Unknown argument \"%s\" for (boolean) option \"%s\".\n", arg_str, arg_desc->name);
58     return FALSE;
59 }
60
61 static notmuch_bool_t
62 _process_int_arg (const notmuch_opt_desc_t *arg_desc, char next, const char *arg_str) {
63
64     char *endptr;
65     if (next == '\0' || arg_str[0] == '\0') {
66         fprintf (stderr, "Option \"%s\" needs an integer argument.\n", arg_desc->name);
67         return FALSE;
68     }
69
70     *((int *)arg_desc->output_var) = strtol (arg_str, &endptr, 10);
71     if (*endptr == '\0')
72         return TRUE;
73
74     fprintf (stderr, "Unable to parse argument \"%s\" for option \"%s\" as an integer.\n",
75              arg_str, arg_desc->name);
76     return FALSE;
77 }
78
79 static notmuch_bool_t
80 _process_string_arg (const notmuch_opt_desc_t *arg_desc, char next, const char *arg_str) {
81
82     if (next == '\0') {
83         fprintf (stderr, "Option \"%s\" needs a string argument.\n", arg_desc->name);
84         return FALSE;
85     }
86     if (arg_str[0] == '\0') {
87         fprintf (stderr, "String argument for option \"%s\" must be non-empty.\n", arg_desc->name);
88         return FALSE;
89     }
90     *((const char **)arg_desc->output_var) = arg_str;
91     return TRUE;
92 }
93
94 /*
95    Search for the {pos_arg_index}th position argument, return FALSE if
96    that does not exist.
97 */
98
99 notmuch_bool_t
100 parse_position_arg (const char *arg_str, int pos_arg_index,
101                     const notmuch_opt_desc_t *arg_desc) {
102
103     int pos_arg_counter = 0;
104     while (arg_desc->opt_type != NOTMUCH_OPT_END){
105         if (arg_desc->opt_type == NOTMUCH_OPT_POSITION) {
106             if (pos_arg_counter == pos_arg_index) {
107                 if (arg_desc->output_var) {
108                     *((const char **)arg_desc->output_var) = arg_str;
109                 }
110                 return TRUE;
111             }
112             pos_arg_counter++;
113         }
114         arg_desc++;
115     }
116     return FALSE;
117 }
118
119 /*
120  * Search for a non-positional (i.e. starting with --) argument matching arg,
121  * parse a possible value, and assign to *output_var
122  */
123
124 notmuch_bool_t
125 parse_option (const char *arg,
126               const notmuch_opt_desc_t *options) {
127
128     assert(arg);
129     assert(options);
130
131     arg += 2;
132
133     const notmuch_opt_desc_t *try;
134     for (try = options; try->opt_type != NOTMUCH_OPT_END; try++) {
135         if (! try->name)
136             continue;
137
138         if (strncmp (arg, try->name, strlen (try->name)) != 0)
139             continue;
140
141         char next = arg[strlen (try->name)];
142         const char *value = arg + strlen(try->name) + 1;
143
144         /*
145          * If we have not reached the end of the argument (i.e. the
146          * next character is not a space or delimiter) then the
147          * argument could still match a longer option name later in
148          * the option table.
149          */
150         if (next != '=' && next != ':' && next != '\0')
151             continue;
152
153         if (try->output_var == NULL)
154             INTERNAL_ERROR ("output pointer NULL for option %s", try->name);
155
156         switch (try->opt_type) {
157         case NOTMUCH_OPT_KEYWORD:
158         case NOTMUCH_OPT_KEYWORD_FLAGS:
159             return _process_keyword_arg (try, next, value);
160         case NOTMUCH_OPT_BOOLEAN:
161             return _process_boolean_arg (try, next, value);
162         case NOTMUCH_OPT_INT:
163             return _process_int_arg (try, next, value);
164         case NOTMUCH_OPT_STRING:
165             return _process_string_arg (try, next, value);
166         case NOTMUCH_OPT_POSITION:
167         case NOTMUCH_OPT_END:
168         default:
169             INTERNAL_ERROR ("unknown or unhandled option type %d", try->opt_type);
170             /*UNREACHED*/
171         }
172     }
173     fprintf (stderr, "Unrecognized option: --%s\n", arg);
174     return FALSE;
175 }
176
177 /* See command-line-arguments.h for description */
178 int
179 parse_arguments (int argc, char **argv,
180                  const notmuch_opt_desc_t *options, int opt_index) {
181
182     int pos_arg_index = 0;
183     notmuch_bool_t more_args = TRUE;
184
185     while (more_args && opt_index < argc) {
186         if (strncmp (argv[opt_index],"--",2) != 0) {
187
188             more_args = parse_position_arg (argv[opt_index], pos_arg_index, options);
189
190             if (more_args) {
191                 pos_arg_index++;
192                 opt_index++;
193             }
194
195         } else {
196
197             if (strlen (argv[opt_index]) == 2)
198                 return opt_index+1;
199
200             more_args = parse_option (argv[opt_index], options);
201             if (more_args) {
202                 opt_index++;
203             } else {
204                 opt_index = -1;
205             }
206
207         }
208     }
209
210     return opt_index;
211 }