2 * UCW Library -- Parsing of command-line options
4 * (c) 2013 Jan Moskyto Matejka <mq@ucw.cz>
5 * (c) 2014 Martin Mares <mj@ucw.cz>
7 * This software may be freely distributed and used according to the terms
8 * of the GNU Lesser General Public License.
13 #include <ucw/opt-internal.h>
14 #include <ucw/stkstring.h>
15 #include <ucw/strtonum.h>
20 static uns opt_default_value_flags[] = {
21 [OPT_CL_BOOL] = OPT_NO_VALUE,
22 [OPT_CL_STATIC] = OPT_MAYBE_VALUE,
23 [OPT_CL_SWITCH] = OPT_NO_VALUE,
24 [OPT_CL_INC] = OPT_NO_VALUE,
31 void opt_failure(const char * mesg, ...) {
34 vfprintf(stderr, mesg, args);
35 fprintf(stderr, "\nRun with --help for more information.\n");
36 exit(OPT_EXIT_BAD_ARGS);
39 static char *opt_name(struct opt_context *oc, struct opt_precomputed *opt)
41 struct opt_item *item = opt->item;
43 if (item->letter >= OPT_POSITIONAL_TAIL)
44 res = stk_printf("positional argument #%d", oc->positional_count);
45 else if (opt->flags & OPT_SEEN_AS_LONG)
46 res = stk_printf("--%s", opt->name);
48 res = stk_printf("-%c", item->letter);
52 #define THIS_OPT opt_name(oc, opt)
54 void opt_precompute(struct opt_precomputed *opt, struct opt_item *item)
58 opt->name = item->name;
59 uns flags = item->flags;
61 if (item->letter >= OPT_POSITIONAL_TAIL) {
62 flags &= ~OPT_VALUE_FLAGS;
63 flags |= OPT_REQUIRED_VALUE;
65 if (!(flags & OPT_VALUE_FLAGS)) {
66 ASSERT(item->cls != OPT_CL_CALL && item->cls != OPT_CL_USER);
67 flags |= opt_default_value_flags[item->cls];
73 static void opt_invoke_hooks(struct opt_context *oc, uns event, struct opt_item *item, char *value)
75 for (int i = 0; i < oc->hook_count; i++) {
76 struct opt_item *hook = oc->hooks[i];
77 if (hook->flags & event) {
78 void *data = (hook->flags & OPT_HOOK_INTERNAL) ? oc : hook->ptr;
79 hook->u.hook(item, event, value, data);
84 static struct opt_precomputed * opt_find_item_longopt(struct opt_context * oc, char * str) {
85 uns len = strlen(str);
86 struct opt_precomputed * candidate = NULL;
88 for (int i = 0; i < oc->opt_count; i++) {
89 struct opt_precomputed *opt = &oc->opts[i];
93 if (!strncmp(opt->name, str, len)) {
94 if (strlen(opt->name) == len)
96 } else if (opt->item->cls == OPT_CL_BOOL && !strncmp("no-", str, 3) && !strncmp(opt->name, str+3, len-3)) {
97 if (strlen(opt->name) == len-3)
103 opt_failure("Ambiguous option --%s: matches both --%s and --%s.", str, candidate->name, opt->name);
111 opt_failure("Invalid option --%s.", str);
114 // FIXME: Use simple-lists?
115 #define OPT_PTR(type) ({ \
117 if (item->flags & OPT_MULTIPLE) { \
121 } * n = xmalloc(sizeof(*n)); \
122 clist_add_tail(item->ptr, &(n->n)); \
128 static void opt_parse_value(struct opt_context * oc, struct opt_precomputed * opt, char * value) {
129 struct opt_item * item = opt->item;
131 if (opt->count++ && (opt->flags & OPT_SINGLE))
132 opt_failure("Option %s must be specified at most once.", THIS_OPT);
134 if (opt->flags & OPT_LAST_ARG)
135 oc->stop_parsing = 1;
137 opt_invoke_hooks(oc, OPT_HOOK_BEFORE_VALUE, item, value);
141 if (!value || !strcasecmp(value, "y") || !strcasecmp(value, "yes") || !strcasecmp(value, "true") || !strcasecmp(value, "1"))
142 *((int *) item->ptr) = 1 ^ (!!(opt->flags & OPT_NEGATIVE));
143 else if (!strcasecmp(value, "n") || !strcasecmp(value, "no") || !strcasecmp(value, "false") || !strcasecmp(value, "0"))
144 *((int *) item->ptr) = 0 ^ (!!(opt->flags & OPT_NEGATIVE));
146 opt_failure("Boolean argument for %s has a strange value. Supported (case insensitive): 1/0, y/n, yes/no, true/false.", THIS_OPT);
151 switch (item->type) {
156 e = cf_parse_int(value, OPT_PTR(int));
158 opt_failure("Integer value parsing failed for %s: %s", THIS_OPT, e);
164 e = cf_parse_u64(value, OPT_PTR(u64));
166 opt_failure("Unsigned 64-bit value parsing failed for %s: %s", THIS_OPT, e);
170 *OPT_PTR(double) = NAN;
172 e = cf_parse_double(value, OPT_PTR(double));
174 opt_failure("Floating-point value parsing failed for %s: %s", THIS_OPT, e);
180 e = cf_parse_ip(value, OPT_PTR(u32));
182 opt_failure("IP address parsing failed for %s: %s", THIS_OPT, e);
186 *OPT_PTR(const char *) = NULL;
188 *OPT_PTR(const char *) = xstrdup(value);
196 if ((opt->flags & OPT_SINGLE) && *((int *)item->ptr) != -1)
197 opt_failure("Multiple switches: %s", THIS_OPT);
199 *((int *)item->ptr) = item->u.value;
202 if (opt->flags & OPT_NEGATIVE)
203 (*((int *)item->ptr))--;
205 (*((int *)item->ptr))++;
209 void *data = (opt->flags & OPT_INTERNAL) ? oc : item->ptr;
210 item->u.call(item, value, data);
216 e = item->u.utype->parser(value, OPT_PTR(void*));
218 opt_failure("Cannot parse the value of %s: %s", THIS_OPT, e);
225 opt_invoke_hooks(oc, OPT_HOOK_AFTER_VALUE, item, value);
228 static int opt_longopt(struct opt_context * oc, char ** argv, int index) {
230 char * name_in = argv[index] + 2; // skipping the -- on the beginning
231 uns pos = strchrnul(name_in, '=') - name_in;
232 struct opt_precomputed * opt = opt_find_item_longopt(oc, strndupa(name_in, pos));
235 opt->flags |= OPT_SEEN_AS_LONG;
237 if (opt->item->cls == OPT_CL_BOOL && !strncmp(name_in, "no-", 3) && !strncmp(name_in+3, opt->item->name, pos-3)) {
239 opt_failure("Option --%s must not have any value.", name_in);
241 } else if (opt->flags & OPT_REQUIRED_VALUE) {
243 value = name_in + pos + 1;
245 value = argv[index+1];
247 opt_failure("Option %s must have a value, but nothing supplied.", THIS_OPT);
250 } else if (opt->flags & OPT_MAYBE_VALUE) {
252 value = name_in + pos + 1;
255 opt_failure("Option %s must have no value.", THIS_OPT);
257 opt_parse_value(oc, opt, value);
261 static int opt_shortopt(struct opt_context * oc, char ** argv, int index) {
263 struct opt_precomputed * opt;
266 while (o = argv[index][++chr]) {
267 if (o < 0 || o >= 128)
268 opt_failure("Invalid character 0x%02x in option name. Only ASCII is allowed.", o & 0xff);
269 opt = oc->shortopt[o];
272 opt_failure("Unknown option -%c.", o);
274 opt->flags &= ~OPT_SEEN_AS_LONG;
276 if (opt->flags & OPT_NO_VALUE)
277 opt_parse_value(oc, opt, NULL);
278 else if (opt->flags & OPT_REQUIRED_VALUE) {
279 if (argv[index][chr+1]) {
280 opt_parse_value(oc, opt, argv[index] + chr + 1);
282 } else if (!argv[index+1])
283 opt_failure("Option -%c must have a value, but nothing supplied.", o);
285 opt_parse_value(oc, opt, argv[index+1]);
288 } else if (opt->flags & OPT_MAYBE_VALUE) {
289 if (argv[index][chr+1]) {
290 opt_parse_value(oc, opt, argv[index] + chr + 1);
293 opt_parse_value(oc, opt, NULL);
302 static void opt_positional(struct opt_context * oc, char * value) {
303 oc->positional_count++;
304 uns id = oc->positional_count > oc->positional_max ? OPT_POSITIONAL_TAIL : OPT_POSITIONAL(oc->positional_count);
305 struct opt_precomputed * opt = oc->shortopt[id];
307 opt_failure("Too many positional arguments.");
309 opt->flags &= OPT_SEEN_AS_LONG;
310 opt_parse_value(oc, opt, value);
314 static void opt_count_items(struct opt_context *oc, const struct opt_section *sec)
316 for (const struct opt_item *item = sec->opt; item->cls != OPT_CL_END; item++) {
317 if (item->cls == OPT_CL_SECTION)
318 opt_count_items(oc, item->u.section);
319 else if (item->cls == OPT_CL_HOOK)
321 else if (item->letter || item->name) {
323 if (item->letter > OPT_POSITIONAL_TAIL)
324 oc->positional_max++;
329 static void opt_prepare_items(struct opt_context *oc, const struct opt_section *sec)
331 for (struct opt_item *item = sec->opt; item->cls != OPT_CL_END; item++) {
332 if (item->cls == OPT_CL_SECTION)
333 opt_prepare_items(oc, item->u.section);
334 else if (item->cls == OPT_CL_HOOK)
335 oc->hooks[oc->hook_count++] = item;
336 else if (item->letter || item->name) {
337 struct opt_precomputed * opt = &oc->opts[oc->opt_count++];
338 opt_precompute(opt, item);
340 oc->shortopt[(int) item->letter] = opt;
345 static void opt_check_required(struct opt_context *oc)
347 for (int i = 0; i < oc->opt_count; i++) {
348 struct opt_precomputed *opt = &oc->opts[i];
349 if (!opt->count && (opt->flags & OPT_REQUIRED)) {
350 struct opt_item *item = opt->item;
351 if (item->letter > OPT_POSITIONAL_TAIL)
352 opt_failure("Required positional argument #%d not found.", item->letter - OPT_POSITIONAL_TAIL);
353 else if (item->letter == OPT_POSITIONAL_TAIL)
354 opt_failure("Required positional argument not found.");
355 else if (item->letter && item->name)
356 opt_failure("Required option -%c/--%s not found.", item->letter, item->name);
357 else if (item->letter)
358 opt_failure("Required option -%c not found.", item->letter);
360 opt_failure("Required option --%s not found.", item->name);
365 int opt_parse(const struct opt_section * options, char ** argv) {
366 struct opt_context * oc = alloca(sizeof(*oc));
367 memset(oc, 0, sizeof (*oc));
368 oc->options = options;
370 opt_count_items(oc, options);
371 oc->opts = alloca(sizeof(*oc->opts) * oc->opt_count);
372 oc->shortopt = alloca(sizeof(*oc->shortopt) * (oc->positional_max + 257));
373 memset(oc->shortopt, 0, sizeof(*oc->shortopt) * (oc->positional_max + 257));
374 oc->hooks = alloca(sizeof (*oc->hooks) * oc->hook_count);
378 opt_prepare_items(oc, options);
380 int force_positional = 0;
382 for (i=0; argv[i] && !oc->stop_parsing; i++) {
384 opt_invoke_hooks(oc, OPT_HOOK_BEFORE_ARG, NULL, NULL);
385 if (arg[0] != '-' || force_positional)
386 opt_positional(oc, arg);
392 i += opt_longopt(oc, argv, i);
394 i += opt_shortopt(oc, argv, i);
396 opt_positional(oc, arg);
400 opt_check_required(oc);
401 opt_invoke_hooks(oc, OPT_HOOK_FINAL, NULL, NULL);