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.
14 #include <ucw/conf-internal.h>
15 #include <ucw/fastbuf.h>
16 #include <ucw/stkstring.h>
17 #include <ucw/strtonum.h>
23 * Value flags defaults
24 * ~~~~~~~~~~~~~~~~~~~~
26 * OPT_NO_VALUE for OPT_BOOL, OPT_SWITCH and OPT_INC
27 * OPT_MAYBE_VALUE for OPT_STRING, OPT_UNS, OPT_INT
28 * Some of the value flags (OPT_NO_VALUE, OPT_MAYBE_VALUE, OPT_REQUIRED_VALUE)
29 * must be specified for OPT_CALL and OPT_USER.
31 static uns opt_default_value_flags[] = {
32 [OPT_CL_BOOL] = OPT_NO_VALUE,
33 [OPT_CL_STATIC] = OPT_MAYBE_VALUE,
34 [OPT_CL_SWITCH] = OPT_NO_VALUE,
35 [OPT_CL_INC] = OPT_NO_VALUE,
42 struct opt_precomputed {
43 struct opt_item * item;
50 struct opt_precomputed * opts;
51 struct opt_precomputed ** shortopt;
52 struct opt_item ** hooks_before_arg;
53 struct opt_item ** hooks_before_value;
54 struct opt_item ** hooks_after_value;
56 short hooks_before_arg_count;
57 short hooks_before_value_count;
58 short hooks_after_value_count;
63 static void opt_failure(const char * mesg, ...) FORMAT_CHECK(printf,1,2) NONRET;
64 static void opt_failure(const char * mesg, ...) {
67 vfprintf(stderr, mesg, args);
68 fprintf(stderr, "\n");
70 exit(OPT_EXIT_BAD_ARGS);
71 va_end(args); // FIXME: Does this make a sense after exit()?
74 #define FOREACHLINE(text) for (const char * begin = (text), * end = (text); (*end) && (end = strchrnul(begin, '\n')); begin = end+1)
76 static inline uns uns_min(uns x, uns y)
81 void opt_help(const struct opt_section * help) {
85 for (struct opt_item * item = help->opt; item->cls != OPT_CL_END; item++) {
86 if (item->flags & OPT_NO_HELP) continue;
87 if (item->cls == OPT_CL_SECTION) {
95 FOREACHLINE(item->help)
101 struct opt_section * sect;
102 } sections[sections_cnt];
105 const char *lines[lines_cnt][3];
106 memset(lines, 0, sizeof(lines));
109 int linelengths[3] = { -1, -1, -1 };
111 for (struct opt_item * item = help->opt; item->cls != OPT_CL_END; item++) {
112 if (item->flags & OPT_NO_HELP) continue;
114 if (item->cls == OPT_CL_HELP) {
115 if (!*(item->help)) {
119 #define SPLITLINES(text) do { \
120 FOREACHLINE(text) { \
122 for (const char * b = begin, * e = begin; (e < end) && (e = strchrnul(b, '\t')) && (e > end ? (e = end) : end); b = e+1) { \
123 lines[line][cell] = b; \
127 if (*e == '\t' && linelengths[cell] < (e - b)) \
128 linelengths[cell] = e-b; \
133 SPLITLINES(item->help);
137 if (item->cls == OPT_CL_SECTION) {
138 sections[s++] = (struct opt_sectlist) { .pos = line, .sect = item->u.section };
142 uns valoff = strchrnul(item->help, '\t') - item->help;
143 uns eol = strchrnul(item->help, '\n') - item->help;
146 #define VAL(it) ((it->flags & OPT_REQUIRED_VALUE) ? stk_printf("=%.*s", valoff, item->help) : ((it->flags & OPT_NO_VALUE) ? "" : stk_printf("(=%.*s)", valoff, item->help)))
148 lines[line][1] = stk_printf("--%s%s", item->name, VAL(item));
149 if (linelengths[1] < (int) strlen(lines[line][1]))
150 linelengths[1] = strlen(lines[line][1]);
152 if (linelengths[0] < 0)
156 lines[line][0] = stk_printf("-%c,", item->letter);
157 if (linelengths[0] < (int) strlen(lines[line][0]))
158 linelengths[0] = strlen(lines[line][0]);
163 lines[line][2] = item->help + valoff + 1;
168 if (*(item->help + eol))
169 SPLITLINES(item->help + eol + 1);
174 #define FIELD(k) linelengths[k], uns_min(strchrnul(lines[i][k], '\t') - lines[i][k], strchrnul(lines[i][k], '\n') - lines[i][k]), lines[i][k]
175 #define LASTFIELD(k) uns_min(strchrnul(lines[i][k], '\t') - lines[i][k], strchrnul(lines[i][k], '\n') - lines[i][k]), lines[i][k]
176 for (int i=0;i<line;i++) {
177 while (s < sections_cnt && sections[s].pos == i) {
178 opt_help(sections[s].sect);
181 if (lines[i][0] == NULL)
183 else if (linelengths[0] == -1 || lines[i][1] == NULL)
184 printf("%.*s\n", LASTFIELD(0));
185 else if (linelengths[1] == -1 || lines[i][2] == NULL)
186 printf("%-*.*s %.*s\n", FIELD(0), LASTFIELD(1));
188 printf("%-*.*s %-*.*s %.*s\n", FIELD(0), FIELD(1), LASTFIELD(2));
190 while (s < sections_cnt && sections[s].pos == line) {
191 opt_help(sections[s].sect);
196 static struct opt_precomputed * opt_find_item_shortopt(struct opt_context * oc, int chr) {
197 struct opt_precomputed * candidate = oc->shortopt[chr];
199 opt_failure("Invalid option -%c", chr);
200 if (candidate->count++ && (candidate->flags & OPT_SINGLE))
201 opt_failure("Option -%c appeared the second time.", candidate->item->letter);
205 static struct opt_precomputed * opt_find_item_longopt(struct opt_context * oc, char * str) {
206 uns len = strlen(str);
207 struct opt_precomputed * candidate = NULL;
209 for (int i=0; i<oc->opt_count; i++) {
210 if (!oc->opts[i].name)
212 if (!strncmp(oc->opts[i].name, str, len)) {
213 if (strlen(oc->opts[i].name) == len) {
214 if (oc->opts[i].count++ && (oc->opts[i].flags & OPT_SINGLE))
215 opt_failure("Option %s appeared the second time.", oc->opts[i].name);
220 opt_failure("Ambiguous prefix %s: Found matching %s and %s.", str, candidate->name, oc->opts[i].name);
222 candidate = &oc->opts[i];
224 if (!strncmp("no-", str, 3) && !strncmp(oc->opts[i].name, str+3, len-3)) {
225 if (strlen(oc->opts[i].name) == len-3) {
226 if (oc->opts[i].count++ && (oc->opts[i].flags & OPT_SINGLE))
227 opt_failure("Option %s appeared the second time.", oc->opts[i].name);
232 opt_failure("Ambiguous prefix %s: Found matching %s and %s.", str, candidate->name, oc->opts[i].name);
234 candidate = &oc->opts[i];
241 opt_failure("Invalid option %s.", str);
244 #define OPT_PTR(type) ({ \
246 if (item->flags & OPT_MULTIPLE) { \
250 } * n = xmalloc(sizeof(*n)); \
251 clist_add_tail(item->ptr, &(n->n)); \
257 #define OPT_NAME (longopt == 2 ? stk_printf("positional arg #%d", oc->positional_count) : (longopt == 1 ? stk_printf("--%s", opt->name) : stk_printf("-%c", item->letter)))
258 static void opt_parse_value(struct opt_context * oc, struct opt_precomputed * opt, char * value, int longopt) {
259 struct opt_item * item = opt->item;
260 for (int i=0;i<oc->hooks_before_value_count;i++)
261 oc->hooks_before_value[i]->u.call(item, value, oc->hooks_before_value[i]->ptr);
265 if (!value || !strcasecmp(value, "y") || !strcasecmp(value, "yes") || !strcasecmp(value, "true") || !strcasecmp(value, "1"))
266 *((int *) item->ptr) = 1 ^ (!!(opt->flags & OPT_NEGATIVE));
267 else if (!strcasecmp(value, "n") || !strcasecmp(value, "no") || !strcasecmp(value, "false") || !strcasecmp(value, "0"))
268 *((int *) item->ptr) = 0 ^ (!!(opt->flags & OPT_NEGATIVE));
270 opt_failure("Boolean argument for %s has a strange value. Supported (case insensitive): y/n, yes/no, true/false.", OPT_NAME);
275 switch (item->type) {
280 e = cf_parse_int(value, OPT_PTR(int));
282 opt_failure("Integer value parsing failed for %s: %s", OPT_NAME, e);
288 e = cf_parse_u64(value, OPT_PTR(u64));
290 opt_failure("Unsigned 64-bit value parsing failed for %s: %s", OPT_NAME, e);
294 *OPT_PTR(double) = NAN;
296 e = cf_parse_double(value, OPT_PTR(double));
298 opt_failure("Double value parsing failed for %s: %s", OPT_NAME, e);
302 e = cf_parse_ip("0.0.0.0", OPT_PTR(u32));
304 e = cf_parse_ip(value, OPT_PTR(u32));
306 opt_failure("IP parsing failed for %s: %s", OPT_NAME, e);
310 *OPT_PTR(const char *) = NULL;
312 *OPT_PTR(const char *) = xstrdup(value);
320 if (*((int *)item->ptr) != -1)
321 opt_failure("Multiple switches: %s", OPT_NAME);
323 *((int *)item->ptr) = item->u.value;
326 if (opt->flags & OPT_NEGATIVE)
327 (*((int *)item->ptr))--;
329 (*((int *)item->ptr))++;
332 item->u.call(item, value, item->ptr);
337 e = item->u.utype->parser(value, OPT_PTR(void*));
339 opt_failure("User defined type value parsing failed for %s: %s", OPT_NAME, e);
346 for (int i=0;i<oc->hooks_after_value_count;i++)
347 oc->hooks_after_value[i]->u.call(item, value, oc->hooks_after_value[i]->ptr);
351 static int opt_longopt(struct opt_context * oc, char ** argv, int index) {
353 char * name_in = argv[index] + 2; // skipping the -- on the beginning
354 uns pos = strchrnul(name_in, '=') - name_in;
355 struct opt_precomputed * opt = opt_find_item_longopt(oc, strndupa(name_in, pos));
358 if (opt->item->cls == OPT_CL_BOOL && !strncmp(name_in, "no-", 3) && !strncmp(name_in+3, opt->item->name, pos-3))
360 else if (opt->flags & OPT_REQUIRED_VALUE) {
361 if (pos < strlen(name_in))
362 value = name_in + pos + 1;
364 value = argv[index+1];
366 opt_failure("Argument --%s must have a value but nothing supplied.", opt->name);
370 else if (opt->flags & OPT_MAYBE_VALUE) {
371 if (pos < strlen(name_in))
372 value = name_in + pos + 1;
375 if (pos < strlen(name_in))
376 opt_failure("Argument --%s must not have any value.", opt->name);
378 opt_parse_value(oc, opt, value, 1);
382 static int opt_shortopt(struct opt_context * oc, char ** argv, int index) {
384 struct opt_precomputed * opt;
385 while (argv[index][++chr] && (opt = opt_find_item_shortopt(oc, argv[index][chr]))) {
386 if (opt->flags & OPT_NO_VALUE) {
387 opt_parse_value(oc, opt, NULL, 0);
389 else if (opt->flags & OPT_REQUIRED_VALUE) {
390 if (chr == 1 && argv[index][2]) {
391 opt_parse_value(oc, opt, argv[index] + 2, 0);
394 else if (argv[index][chr+1])
395 opt_failure("Option -%c must have a value but found inside a bunch of short opts.", opt->item->letter);
396 else if (!argv[index+1])
397 opt_failure("Option -%c must have a value but nothing supplied.", opt->item->letter);
399 opt_parse_value(oc, opt, argv[index+1], 0);
403 else if (opt->flags & OPT_MAYBE_VALUE) {
404 if (chr == 1 && argv[index][2]) {
405 opt_parse_value(oc, opt, argv[index] + 2, 0);
409 opt_parse_value(oc, opt, NULL, 0);
416 if (argv[index][chr])
417 opt_failure("Unknown option -%c.", argv[index][chr]);
422 static void opt_positional(struct opt_context * oc, char * value) {
423 oc->positional_count++;
424 struct opt_precomputed * opt = opt_find_item_shortopt(oc, (oc->positional_count > oc->positional_max ? 256 : oc->positional_count + 256));
426 ASSERT(oc->positional_count > oc->positional_max);
427 opt_failure("Too many positional args.");
430 opt_parse_value(oc, opt, value, 2);
433 static void opt_count_items(struct opt_context *oc, const struct opt_section *sec)
435 for (const struct opt_item *item = sec->opt; item->cls != OPT_CL_END; item++) {
436 if (item->cls == OPT_CL_SECTION)
437 opt_count_items(oc, item->u.section);
438 else if (item->cls == OPT_CL_HOOK) {
439 if (item->flags & OPT_HOOK_BEFORE_ARG)
440 oc->hooks_before_arg_count++;
441 else if (item->flags & OPT_HOOK_BEFORE_VALUE)
442 oc->hooks_before_value_count++;
443 else if (item->flags & OPT_HOOK_AFTER_VALUE)
444 oc->hooks_after_value_count++;
447 } else if (item->letter || item->name) {
449 if (item->letter > OPT_POSITIONAL_TAIL)
450 oc->positional_max++;
455 static void opt_add_default_flags(struct opt_precomputed *opt)
457 struct opt_item *item = opt->item;
458 uns flags = opt->flags;
460 if (item->letter >= 256) {
461 flags &= ~OPT_VALUE_FLAGS;
462 flags |= OPT_REQUIRED_VALUE;
464 if (!(flags & OPT_VALUE_FLAGS)) {
465 ASSERT(item->cls != OPT_CL_CALL && item->cls != OPT_CL_USER);
466 flags |= opt_default_value_flags[item->cls];
472 static void opt_prepare_items(struct opt_context *oc, const struct opt_section *sec)
474 for (struct opt_item *item = sec->opt; item->cls != OPT_CL_END; item++) {
475 if (item->cls == OPT_CL_SECTION)
476 opt_prepare_items(oc, item->u.section);
477 else if (item->cls == OPT_CL_HOOK) {
478 if (item->flags & OPT_HOOK_BEFORE_ARG)
479 oc->hooks_before_arg[oc->hooks_before_arg_count++] = item;
480 else if (item->flags & OPT_HOOK_BEFORE_VALUE)
481 oc->hooks_before_value[oc->hooks_before_value_count++] = item;
482 else if (item->flags & OPT_HOOK_AFTER_VALUE)
483 oc->hooks_after_value[oc->hooks_after_value_count++] = item;
486 } else if (item->letter || item->name) {
487 struct opt_precomputed * opt = &oc->opts[oc->opt_count++];
489 opt->flags = item->flags;
491 opt->name = item->name;
493 oc->shortopt[(int) item->letter] = opt;
494 opt_add_default_flags(opt);
499 static void opt_check_required(struct opt_context *oc)
501 for (int i = 0; i < oc->opt_count; i++) {
502 struct opt_precomputed *opt = &oc->opts[i];
503 if (!opt->count && (opt->flags & OPT_REQUIRED)) {
504 struct opt_item *item = opt->item;
505 if (item->letter > OPT_POSITIONAL_TAIL)
506 opt_failure("Required positional argument #%d not found.", i - OPT_POSITIONAL_TAIL);
507 else if (item->letter == OPT_POSITIONAL_TAIL)
508 opt_failure("Required positional argument not found.");
509 else if (item->letter && item->name)
510 opt_failure("Required option -%c/--%s not found.", item->letter, item->name);
511 else if (item->letter)
512 opt_failure("Required option -%c not found.", item->letter);
514 opt_failure("Required option --%s not found.", item->name);
519 void opt_parse(const struct opt_section * options, char ** argv) {
520 struct opt_context * oc = alloca(sizeof(*oc));
521 memset(oc, 0, sizeof (*oc));
523 opt_count_items(oc, options);
524 oc->opts = alloca(sizeof(*oc->opts) * oc->opt_count);
525 oc->shortopt = alloca(sizeof(*oc->shortopt) * (oc->positional_max + 257));
526 memset(oc->shortopt, 0, sizeof(*oc->shortopt) * (oc->positional_max + 257));
527 oc->hooks_before_arg = alloca(sizeof (*oc->hooks_before_arg) * oc->hooks_before_arg_count);
528 oc->hooks_before_value = alloca(sizeof (*oc->hooks_before_value) * oc->hooks_before_value_count);
529 oc->hooks_after_value = alloca(sizeof (*oc->hooks_after_value) * oc->hooks_after_value_count);
532 oc->hooks_before_arg_count = 0;
533 oc->hooks_before_value_count = 0;
534 oc->hooks_after_value_count = 0;
535 opt_prepare_items(oc, options);
537 int force_positional = 0;
538 for (int i = 0; argv[i]; i++) {
540 for (int j = 0; j < oc->hooks_before_arg_count; j++)
541 oc->hooks_before_arg[j]->u.call(NULL, NULL, oc->hooks_before_arg[j]->ptr);
542 if (arg[0] != '-' || force_positional)
543 opt_positional(oc, arg);
549 i += opt_longopt(oc, argv, i);
551 i += opt_shortopt(oc, argv, i);
553 opt_positional(oc, arg);
557 opt_check_required(oc);
560 static void opt_conf_end_of_options(struct cf_context *cc) {
562 if (cc->postpone_commit && cf_close_group())
563 opt_failure("Loading of configuration failed");
566 void opt_conf_internal(struct opt_item * opt, const char * value, void * data UNUSED) {
567 struct cf_context *cc = cf_get_context();
568 switch (opt->letter) {
572 opt_failure("Cannot set %s", value);
576 opt_failure("Cannot load config file %s", value);
578 #ifdef CONFIG_UCW_DEBUG
580 opt_conf_end_of_options(cc);
581 struct fastbuf *b = bfdopen(1, 4096);
590 void opt_conf_hook_internal(struct opt_item * opt, const char * value UNUSED, void * data UNUSED) {
593 OPT_CONF_HOOK_CONFIG,
595 } state = OPT_CONF_HOOK_BEGIN;
599 if (opt->letter == 'S' || opt->letter == 'C' || (opt->name && !strcmp(opt->name, "dumpconfig")))
603 case OPT_CONF_HOOK_BEGIN:
605 state = OPT_CONF_HOOK_CONFIG;
607 opt_conf_end_of_options(cf_get_context());
608 state = OPT_CONF_HOOK_OTHERS;
611 case OPT_CONF_HOOK_CONFIG:
613 opt_conf_end_of_options(cf_get_context());
614 state = OPT_CONF_HOOK_OTHERS;
617 case OPT_CONF_HOOK_OTHERS:
619 opt_failure("Config options (-C, -S) must stand before other options.");