]> mj.ucw.cz Git - libucw.git/blob - ucw/opt.c
Opt: Streamlined opt_parse_value()
[libucw.git] / ucw / opt.c
1 /*
2  *      UCW Library -- Parsing of command line options
3  *
4  *      (c) 2013 Jan Moskyto Matejka <mq@ucw.cz>
5  *      (c) 2014 Martin Mares <mj@ucw.cz>
6  *
7  *      This software may be freely distributed and used according to the terms
8  *      of the GNU Lesser General Public License.
9  */
10
11 #include <ucw/lib.h>
12 #include <ucw/opt.h>
13 #include <ucw/conf.h>
14 #include <ucw/conf-internal.h>
15 #include <ucw/fastbuf.h>
16 #include <ucw/stkstring.h>
17 #include <ucw/strtonum.h>
18
19 #include <alloca.h>
20 #include <math.h>
21
22 /***
23  * Value flags defaults
24  * ~~~~~~~~~~~~~~~~~~~~
25  *
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.
30  ***/
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,
36     [OPT_CL_CALL] = 0,
37     [OPT_CL_USER] = 0,
38     [OPT_CL_SECTION] = 0,
39     [OPT_CL_HELP] = 0
40 };
41
42 struct opt_precomputed {
43   struct opt_item * item;
44   const char * name;
45   short flags;
46   short count;
47 };
48
49 struct opt_context {
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;
55   short opt_count;
56   short hooks_before_arg_count;
57   short hooks_before_value_count;
58   short hooks_after_value_count;
59   int positional_max;
60   int positional_count;
61 };
62
63 static void opt_failure(const char * mesg, ...) FORMAT_CHECK(printf,1,2) NONRET;
64 static void opt_failure(const char * mesg, ...) {
65   va_list args;
66   va_start(args, mesg);
67   vfprintf(stderr, mesg, args);
68   fprintf(stderr, "\n");
69   opt_usage();
70   exit(OPT_EXIT_BAD_ARGS);
71   va_end(args);         // FIXME: Does this make a sense after exit()?
72 }
73
74 #define FOREACHLINE(text) for (const char * begin = (text), * end = (text); (*end) && (end = strchrnul(begin, '\n')); begin = end+1)
75
76 static inline uns uns_min(uns x, uns y)
77 {
78   return MIN(x, y);
79 }
80
81 void opt_help(const struct opt_section * help) {
82   int sections_cnt = 0;
83   int lines_cnt = 0;
84
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) {
88       sections_cnt++;
89       continue;
90     }
91     if (!*(item->help)) {
92       lines_cnt++;
93       continue;
94     }
95     FOREACHLINE(item->help)
96       lines_cnt++;
97   }
98
99   struct opt_sectlist {
100     int pos;
101     struct opt_section * sect;
102   } sections[sections_cnt];
103   int s = 0;
104
105   const char *lines[lines_cnt][3];
106   memset(lines, 0, sizeof(lines));
107   int line = 0;
108
109   int linelengths[3] = { -1, -1, -1 };
110
111   for (struct opt_item * item = help->opt; item->cls != OPT_CL_END; item++) {
112     if (item->flags & OPT_NO_HELP) continue;
113
114     if (item->cls == OPT_CL_HELP) {
115       if (!*(item->help)) {
116         line++;
117         continue;
118       }
119 #define SPLITLINES(text) do { \
120       FOREACHLINE(text) { \
121         int cell = 0; \
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; \
124           if (cell >= 2) \
125             break; \
126           else \
127             if (*e == '\t' && linelengths[cell] < (e - b)) \
128               linelengths[cell] = e-b; \
129           cell++; \
130         } \
131         line++; \
132       } } while (0)
133       SPLITLINES(item->help);
134       continue;
135     }
136
137     if (item->cls == OPT_CL_SECTION) {
138       sections[s++] = (struct opt_sectlist) { .pos = line, .sect = item->u.section };
139       continue;
140     }
141
142     uns valoff = strchrnul(item->help, '\t') - item->help;
143     uns eol = strchrnul(item->help, '\n') - item->help;
144     if (valoff > eol)
145       valoff = eol;
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)))
147     if (item->name) {
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]);
151       lines[line][0] = "";
152       if (linelengths[0] < 0)
153         linelengths[0] = 0;
154     }
155     if (item->letter) {
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]);
159     }
160 #undef VAL
161
162     if (eol > valoff) {
163       lines[line][2] = item->help + valoff + 1;
164     }
165
166     line++;
167
168     if (*(item->help + eol))
169       SPLITLINES(item->help + eol + 1);
170   }
171 #undef SPLITLINES
172
173   s = 0;
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);
179       s++;
180     }
181     if (lines[i][0] == NULL)
182       printf("\n");
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));
187     else
188       printf("%-*.*s  %-*.*s  %.*s\n", FIELD(0), FIELD(1), LASTFIELD(2));
189   }
190   while (s < sections_cnt && sections[s].pos == line) {
191     opt_help(sections[s].sect);
192     s++;
193   }
194 }
195
196 static struct opt_precomputed * opt_find_item_longopt(struct opt_context * oc, char * str) {
197   uns len = strlen(str);
198   struct opt_precomputed * candidate = NULL;
199
200   for (int i = 0; i < oc->opt_count; i++) {
201     struct opt_precomputed *opt = &oc->opts[i];
202     if (!opt->name)
203       continue;
204
205     if (!strncmp(opt->name, str, len)) {
206       if (strlen(opt->name) == len)
207         return opt;
208     } else if (opt->item->cls == OPT_CL_BOOL && !strncmp("no-", str, 3) && !strncmp(opt->name, str+3, len-3)) {
209       if (strlen(opt->name) == len-3)
210         return opt;
211     } else
212       continue;
213
214     if (candidate)
215       opt_failure("Ambiguous option --%s: matches both --%s and --%s.", str, candidate->name, opt->name);
216     else
217       candidate = opt;
218   }
219
220   if (candidate)
221     return candidate;
222
223   opt_failure("Invalid option --%s.", str);
224 }
225
226 // FIXME: Use simple-lists?
227 #define OPT_PTR(type) ({                        \
228   type * ptr;                                   \
229   if (item->flags & OPT_MULTIPLE) {             \
230     struct {                                    \
231       cnode n;                                  \
232       type v;                                   \
233     } * n = xmalloc(sizeof(*n));                \
234     clist_add_tail(item->ptr, &(n->n));         \
235     ptr = &(n->v);                              \
236   } else                                        \
237     ptr = item->ptr;                            \
238   ptr; })
239
240 #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)))
241
242 static void opt_parse_value(struct opt_context * oc, struct opt_precomputed * opt, char * value, int longopt) {
243   struct opt_item * item = opt->item;
244
245   for (int i = 0; i < oc->hooks_before_value_count; i++)
246     oc->hooks_before_value[i]->u.call(item, value, oc->hooks_before_value[i]->ptr);
247
248   switch (item->cls) {
249     case OPT_CL_BOOL:
250       if (!value || !strcasecmp(value, "y") || !strcasecmp(value, "yes") || !strcasecmp(value, "true") || !strcasecmp(value, "1"))
251         *((int *) item->ptr) = 1 ^ (!!(opt->flags & OPT_NEGATIVE));
252       else if (!strcasecmp(value, "n") || !strcasecmp(value, "no") || !strcasecmp(value, "false") || !strcasecmp(value, "0"))
253         *((int *) item->ptr) = 0 ^ (!!(opt->flags & OPT_NEGATIVE));
254       else
255         opt_failure("Boolean argument for %s has a strange value. Supported (case insensitive): 1/0, y/n, yes/no, true/false.", OPT_NAME);
256       break;
257     case OPT_CL_STATIC:
258       {
259         char * e = NULL;
260         switch (item->type) {
261           case CT_INT:
262             if (!value)
263               *OPT_PTR(int) = 0;
264             else
265               e = cf_parse_int(value, OPT_PTR(int));
266             if (e)
267               opt_failure("Integer value parsing failed for %s: %s", OPT_NAME, e);
268             break;
269           case CT_U64:
270             if (!value)
271               *OPT_PTR(u64) = 0;
272             else
273               e = cf_parse_u64(value, OPT_PTR(u64));
274             if (e)
275               opt_failure("Unsigned 64-bit value parsing failed for %s: %s", OPT_NAME, e);
276             break;
277           case CT_DOUBLE:
278             if (!value)
279               *OPT_PTR(double) = NAN;
280             else
281               e = cf_parse_double(value, OPT_PTR(double));
282             if (e)
283               opt_failure("Floating-point value parsing failed for %s: %s", OPT_NAME, e);
284             break;
285           case CT_IP:
286             if (!value)
287               *OPT_PTR(u32) = 0;
288             else
289               e = cf_parse_ip(value, OPT_PTR(u32));
290             if (e)
291               opt_failure("IP address parsing failed for %s: %s", OPT_NAME, e);
292             break;
293           case CT_STRING:
294             if (!value)
295               *OPT_PTR(const char *) = NULL;
296             else
297               *OPT_PTR(const char *) = xstrdup(value);
298             break;
299           default:
300             ASSERT(0);
301         }
302         break;
303       }
304     case OPT_CL_SWITCH:
305       // FIXME: Really? And who sets the default to -1?
306       if (*((int *)item->ptr) != -1)
307         opt_failure("Multiple switches: %s", OPT_NAME);
308       else
309         *((int *)item->ptr) = item->u.value;
310       break;
311     case OPT_CL_INC:
312       if (opt->flags & OPT_NEGATIVE)
313         (*((int *)item->ptr))--;
314       else
315         (*((int *)item->ptr))++;
316       break;
317     case OPT_CL_CALL:
318       item->u.call(item, value, item->ptr);
319       break;
320     case OPT_CL_USER:
321       {
322         char * e = NULL;
323         e = item->u.utype->parser(value, OPT_PTR(void*));
324         if (e)
325           opt_failure("Cannot parse the value of %s: %s", OPT_NAME, e);
326         break;
327       }
328     default:
329       ASSERT(0);
330   }
331
332   for (int i = 0;i < oc->hooks_after_value_count; i++)
333     oc->hooks_after_value[i]->u.call(item, value, oc->hooks_after_value[i]->ptr);
334 }
335 #undef OPT_NAME
336
337 static int opt_longopt(struct opt_context * oc, char ** argv, int index) {
338   int eaten = 0;
339   char * name_in = argv[index] + 2; // skipping the -- on the beginning
340   uns pos = strchrnul(name_in, '=') - name_in;
341   struct opt_precomputed * opt = opt_find_item_longopt(oc, strndupa(name_in, pos));
342   char * value = NULL;
343
344   // FIXME: Move to opt_parse_value()?
345   if (opt->count++ && (opt->flags & OPT_SINGLE))
346     opt_failure("Option --%s must be specified at most once.", opt->name);
347
348   if (opt->item->cls == OPT_CL_BOOL && !strncmp(name_in, "no-", 3) && !strncmp(name_in+3, opt->item->name, pos-3)) {
349     if (name_in[pos])
350       opt_failure("Option --%s must not have any value.", name_in);
351     value = "n";
352   } else if (opt->flags & OPT_REQUIRED_VALUE) {
353     if (name_in[pos])
354       value = name_in + pos + 1;
355     else {
356       value = argv[index+1];
357       if (!value)
358         opt_failure("Option --%s must have a value, but nothing supplied.", opt->name);
359       eaten++;
360     }
361   } else if (opt->flags & OPT_MAYBE_VALUE) {
362     if (name_in[pos])
363       value = name_in + pos + 1;
364   } else {
365     if (name_in[pos])
366       opt_failure("Option --%s must have no value.", opt->name);
367   }
368   opt_parse_value(oc, opt, value, 1);
369   return eaten;
370 }
371
372 static int opt_shortopt(struct opt_context * oc, char ** argv, int index) {
373   int chr = 0;
374   struct opt_precomputed * opt;
375   int o;
376
377   while (o = argv[index][++chr]) {
378     if (o < 0 || o >= 128)
379       opt_failure("Invalid character 0x%02x in option name. Only ASCII is allowed.", o & 0xff);
380     opt = oc->shortopt[o];
381
382     if (!opt)
383       opt_failure("Unknown option -%c.", o);
384
385     if (opt->count && (opt->flags & OPT_SINGLE))
386       opt_failure("Option -%c must be specified at most once.", o);
387     opt->count++;
388
389     if (opt->flags & OPT_NO_VALUE)
390       opt_parse_value(oc, opt, NULL, 0);
391     else if (opt->flags & OPT_REQUIRED_VALUE) {
392       if (argv[index][chr+1]) {
393         opt_parse_value(oc, opt, argv[index] + chr + 1, 0);
394         return 0;
395       } else if (!argv[index+1])
396         opt_failure("Option -%c must have a value, but nothing supplied.", o);
397       else {
398         opt_parse_value(oc, opt, argv[index+1], 0);
399         return 1;
400       }
401     } else if (opt->flags & OPT_MAYBE_VALUE) {
402       if (argv[index][chr+1]) {
403         opt_parse_value(oc, opt, argv[index] + chr + 1, 0);
404         return 0;
405       } else
406         opt_parse_value(oc, opt, NULL, 0);
407     } else {
408       ASSERT(0);
409     }
410   }
411
412   return 0;
413 }
414
415 static void opt_positional(struct opt_context * oc, char * value) {
416   oc->positional_count++;
417   uns id = oc->positional_count > oc->positional_max ? OPT_POSITIONAL_TAIL : OPT_POSITIONAL(oc->positional_count);
418   struct opt_precomputed * opt = oc->shortopt[id];
419   if (!opt || (opt->flags & OPT_SINGLE) && opt->count)
420     opt_failure("Too many positional arguments.");
421   else {
422     opt->count++;
423     opt_parse_value(oc, opt, value, 2);
424   }
425 }
426
427 static void opt_count_items(struct opt_context *oc, const struct opt_section *sec)
428 {
429   for (const struct opt_item *item = sec->opt; item->cls != OPT_CL_END; item++) {
430     if (item->cls == OPT_CL_SECTION)
431       opt_count_items(oc, item->u.section);
432     else if (item->cls == OPT_CL_HOOK) {
433       if (item->flags & OPT_HOOK_BEFORE_ARG)
434         oc->hooks_before_arg_count++;
435       else if (item->flags & OPT_HOOK_BEFORE_VALUE)
436         oc->hooks_before_value_count++;
437       else if (item->flags & OPT_HOOK_AFTER_VALUE)
438         oc->hooks_after_value_count++;
439       else
440         ASSERT(0);
441     } else if (item->letter || item->name) {
442       oc->opt_count++;
443       if (item->letter > OPT_POSITIONAL_TAIL)
444         oc->positional_max++;
445     }
446   }
447 }
448
449 static void opt_add_default_flags(struct opt_precomputed *opt)
450 {
451   struct opt_item *item = opt->item;
452   uns flags = opt->flags;
453
454   if (item->letter >= OPT_POSITIONAL_TAIL) {
455     flags &= ~OPT_VALUE_FLAGS;
456     flags |= OPT_REQUIRED_VALUE;
457   }
458   if (!(flags & OPT_VALUE_FLAGS)) {
459     ASSERT(item->cls != OPT_CL_CALL && item->cls != OPT_CL_USER);
460     flags |= opt_default_value_flags[item->cls];
461   }
462
463   opt->flags = flags;
464 }
465
466 static void opt_prepare_items(struct opt_context *oc, const struct opt_section *sec)
467 {
468   for (struct opt_item *item = sec->opt; item->cls != OPT_CL_END; item++) {
469     if (item->cls == OPT_CL_SECTION)
470       opt_prepare_items(oc, item->u.section);
471     else if (item->cls == OPT_CL_HOOK) {
472       if (item->flags & OPT_HOOK_BEFORE_ARG)
473         oc->hooks_before_arg[oc->hooks_before_arg_count++] = item;
474       else if (item->flags & OPT_HOOK_BEFORE_VALUE)
475         oc->hooks_before_value[oc->hooks_before_value_count++] = item;
476       else if (item->flags & OPT_HOOK_AFTER_VALUE)
477         oc->hooks_after_value[oc->hooks_after_value_count++] = item;
478       else
479         ASSERT(0);
480     } else if (item->letter || item->name) {
481       struct opt_precomputed * opt = &oc->opts[oc->opt_count++];
482       opt->item = item;
483       opt->flags = item->flags;
484       opt->count = 0;
485       opt->name = item->name;
486       if (item->letter)
487         oc->shortopt[(int) item->letter] = opt;
488       opt_add_default_flags(opt);
489     }
490   }
491 }
492
493 static void opt_check_required(struct opt_context *oc)
494 {
495   for (int i = 0; i < oc->opt_count; i++) {
496     struct opt_precomputed *opt = &oc->opts[i];
497     if (!opt->count && (opt->flags & OPT_REQUIRED)) {
498       struct opt_item *item = opt->item;
499       if (item->letter > OPT_POSITIONAL_TAIL)
500         opt_failure("Required positional argument #%d not found.", i - OPT_POSITIONAL_TAIL);
501       else if (item->letter == OPT_POSITIONAL_TAIL)
502         opt_failure("Required positional argument not found.");
503       else if (item->letter && item->name)
504         opt_failure("Required option -%c/--%s not found.", item->letter, item->name);
505       else if (item->letter)
506         opt_failure("Required option -%c not found.", item->letter);
507       else
508         opt_failure("Required option --%s not found.", item->name);
509     }
510   }
511 }
512
513 void opt_parse(const struct opt_section * options, char ** argv) {
514   struct opt_context * oc = alloca(sizeof(*oc));
515   memset(oc, 0, sizeof (*oc));
516
517   opt_count_items(oc, options);
518   oc->opts = alloca(sizeof(*oc->opts) * oc->opt_count);
519   oc->shortopt = alloca(sizeof(*oc->shortopt) * (oc->positional_max + 257));
520   memset(oc->shortopt, 0, sizeof(*oc->shortopt) * (oc->positional_max + 257));
521   oc->hooks_before_arg = alloca(sizeof (*oc->hooks_before_arg) * oc->hooks_before_arg_count);
522   oc->hooks_before_value = alloca(sizeof (*oc->hooks_before_value) * oc->hooks_before_value_count);
523   oc->hooks_after_value = alloca(sizeof (*oc->hooks_after_value) * oc->hooks_after_value_count);
524
525   oc->opt_count = 0;
526   oc->hooks_before_arg_count = 0;
527   oc->hooks_before_value_count = 0;
528   oc->hooks_after_value_count = 0;
529   opt_prepare_items(oc, options);
530
531   int force_positional = 0;
532   for (int i = 0; argv[i]; i++) {
533     char *arg = argv[i];
534     for (int j = 0; j < oc->hooks_before_arg_count; j++)
535       oc->hooks_before_arg[j]->u.call(NULL, NULL, oc->hooks_before_arg[j]->ptr);
536     if (arg[0] != '-' || force_positional)
537       opt_positional(oc, arg);
538     else {
539       if (arg[1] == '-') {
540         if (arg[2] == '\0')
541           force_positional++;
542         else
543           i += opt_longopt(oc, argv, i);
544       } else if (arg[1])
545         i += opt_shortopt(oc, argv, i);
546       else
547         opt_positional(oc, arg);
548     }
549   }
550
551   opt_check_required(oc);
552 }
553
554 static void opt_conf_end_of_options(struct cf_context *cc) {
555   cf_load_default(cc);
556   if (cc->postpone_commit && cf_close_group())
557     opt_failure("Loading of configuration failed");
558 }
559
560 void opt_conf_internal(struct opt_item * opt, const char * value, void * data UNUSED) {
561   struct cf_context *cc = cf_get_context();
562   switch (opt->letter) {
563     case 'S':
564       cf_load_default(cc);
565       if (cf_set(value))
566         opt_failure("Cannot set %s", value);
567       break;
568     case 'C':
569       if (cf_load(value))
570         opt_failure("Cannot load config file %s", value);
571       break;
572 #ifdef CONFIG_UCW_DEBUG
573     case '0':
574       opt_conf_end_of_options(cc);
575       struct fastbuf *b = bfdopen(1, 4096);
576       cf_dump_sections(b);
577       bclose(b);
578       exit(0);
579       break;
580 #endif
581   }
582 }
583
584 void opt_conf_hook_internal(struct opt_item * opt, const char * value UNUSED, void * data UNUSED) {
585   static enum {
586     OPT_CONF_HOOK_BEGIN,
587     OPT_CONF_HOOK_CONFIG,
588     OPT_CONF_HOOK_OTHERS
589   } state = OPT_CONF_HOOK_BEGIN;
590
591   int confopt = 0;
592
593   if (opt->letter == 'S' || opt->letter == 'C' || (opt->name && !strcmp(opt->name, "dumpconfig")))
594     confopt = 1;
595
596   switch (state) {
597     case OPT_CONF_HOOK_BEGIN:
598       if (confopt)
599         state = OPT_CONF_HOOK_CONFIG;
600       else {
601         opt_conf_end_of_options(cf_get_context());
602         state = OPT_CONF_HOOK_OTHERS;
603       }
604       break;
605     case OPT_CONF_HOOK_CONFIG:
606       if (!confopt) {
607         opt_conf_end_of_options(cf_get_context());
608         state = OPT_CONF_HOOK_OTHERS;
609       }
610       break;
611     case OPT_CONF_HOOK_OTHERS:
612       if (confopt)
613         opt_failure("Config options (-C, -S) must stand before other options.");
614       break;
615     default:
616       ASSERT(0);
617   }
618 }