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/opt-internal.h>
  14 #include <ucw/stkstring.h>
  15 #include <ucw/strtonum.h>
  16
  17 #include <alloca.h>
  18 #include <math.h>
  19
  20 /***
  21  * Value flags defaults
  22  * ~~~~~~~~~~~~~~~~~~~~
  23  *
  24  * OPT_NO_VALUE for OPT_BOOL, OPT_SWITCH and OPT_INC
  25  * OPT_MAYBE_VALUE for OPT_STRING, OPT_UNS, OPT_INT
  26  * Some of the value flags (OPT_NO_VALUE, OPT_MAYBE_VALUE, OPT_REQUIRED_VALUE)
  27  * must be specified for OPT_CALL and OPT_USER.
  28  ***/
  29 static uns opt_default_value_flags[] = {
  30     [OPT_CL_BOOL] = OPT_NO_VALUE,
  31     [OPT_CL_STATIC] = OPT_MAYBE_VALUE,
  32     [OPT_CL_SWITCH] = OPT_NO_VALUE,
  33     [OPT_CL_INC] = OPT_NO_VALUE,
  34     [OPT_CL_CALL] = 0,
  35     [OPT_CL_USER] = 0,
  36     [OPT_CL_SECTION] = 0,
  37     [OPT_CL_HELP] = 0
  38 };
  39
  40 struct opt_context {
  41   struct opt_precomputed * opts;
  42   struct opt_precomputed ** shortopt;
  43   struct opt_item ** hooks;
  44   int opt_count;
  45   int hook_count;
  46   int positional_max;
  47   int positional_count;
  48   bool stop_parsing;
  49 };
  50
  51 void opt_failure(const char * mesg, ...) {
  52   va_list args;
  53   va_start(args, mesg);
  54   vfprintf(stderr, mesg, args);
  55   fprintf(stderr, "\nRun with --help for more information.\n");
  56   exit(OPT_EXIT_BAD_ARGS);
  57 }
  58
  59 static char *opt_name(struct opt_context *oc, struct opt_precomputed *opt)
  60 {
  61   struct opt_item *item = opt->item;
  62   char *res;
  63   if (item->letter >= OPT_POSITIONAL_TAIL)
  64     res = stk_printf("positional argument #%d", oc->positional_count);
  65   else if (opt->flags & OPT_SEEN_AS_LONG)
  66     res = stk_printf("--%s", opt->name);
  67   else
  68     res = stk_printf("-%c", item->letter);
  69   return xstrdup(res);
  70 }
  71
  72 #define THIS_OPT opt_name(oc, opt)
  73
  74 void opt_precompute(struct opt_precomputed *opt, struct opt_item *item)
  75 {
  76   opt->item = item;
  77   opt->count = 0;
  78   opt->name = item->name;
  79   uns flags = item->flags;
  80
  81   if (item->letter >= OPT_POSITIONAL_TAIL) {
  82     flags &= ~OPT_VALUE_FLAGS;
  83     flags |= OPT_REQUIRED_VALUE;
  84   }
  85   if (!(flags & OPT_VALUE_FLAGS)) {
  86     ASSERT(item->cls != OPT_CL_CALL && item->cls != OPT_CL_USER);
  87     flags |= opt_default_value_flags[item->cls];
  88   }
  89
  90   opt->flags = flags;
  91 }
  92
  93 static void opt_invoke_hooks(struct opt_context *oc, uns event, struct opt_item *item, char *value)
  94 {
  95   for (int i = 0; i < oc->hook_count; i++) {
  96     struct opt_item *hook = oc->hooks[i];
  97     if (hook->flags & event)
  98       hook->u.hook(item, event, value, hook->ptr);
  99   }
 100 }
 101
 102 static struct opt_precomputed * opt_find_item_longopt(struct opt_context * oc, char * str) {
 103   uns len = strlen(str);
 104   struct opt_precomputed * candidate = NULL;
 105
 106   for (int i = 0; i < oc->opt_count; i++) {
 107     struct opt_precomputed *opt = &oc->opts[i];
 108     if (!opt->name)
 109       continue;
 110
 111     if (!strncmp(opt->name, str, len)) {
 112       if (strlen(opt->name) == len)
 113         return opt;
 114     } else if (opt->item->cls == OPT_CL_BOOL && !strncmp("no-", str, 3) && !strncmp(opt->name, str+3, len-3)) {
 115       if (strlen(opt->name) == len-3)
 116         return opt;
 117     } else
 118       continue;
 119
 120     if (candidate)
 121       opt_failure("Ambiguous option --%s: matches both --%s and --%s.", str, candidate->name, opt->name);
 122     else
 123       candidate = opt;
 124   }
 125
 126   if (candidate)
 127     return candidate;
 128
 129   opt_failure("Invalid option --%s.", str);
 130 }
 131
 132 // FIXME: Use simple-lists?
 133 #define OPT_PTR(type) ({                        \
 134   type * ptr;                                   \
 135   if (item->flags & OPT_MULTIPLE) {             \
 136     struct {                                    \
 137       cnode n;                                  \
 138       type v;                                   \
 139     } * n = xmalloc(sizeof(*n));                \
 140     clist_add_tail(item->ptr, &(n->n));         \
 141     ptr = &(n->v);                              \
 142   } else                                        \
 143     ptr = item->ptr;                            \
 144   ptr; })
 145
 146 static void opt_parse_value(struct opt_context * oc, struct opt_precomputed * opt, char * value) {
 147   struct opt_item * item = opt->item;
 148
 149   if (opt->count++ && (opt->flags & OPT_SINGLE))
 150     opt_failure("Option %s must be specified at most once.", THIS_OPT);
 151
 152   if (opt->flags & OPT_LAST_ARG)
 153     oc->stop_parsing = 1;
 154
 155   opt_invoke_hooks(oc, OPT_HOOK_BEFORE_VALUE, item, value);
 156
 157   switch (item->cls) {
 158     case OPT_CL_BOOL:
 159       if (!value || !strcasecmp(value, "y") || !strcasecmp(value, "yes") || !strcasecmp(value, "true") || !strcasecmp(value, "1"))
 160         *((int *) item->ptr) = 1 ^ (!!(opt->flags & OPT_NEGATIVE));
 161       else if (!strcasecmp(value, "n") || !strcasecmp(value, "no") || !strcasecmp(value, "false") || !strcasecmp(value, "0"))
 162         *((int *) item->ptr) = 0 ^ (!!(opt->flags & OPT_NEGATIVE));
 163       else
 164         opt_failure("Boolean argument for %s has a strange value. Supported (case insensitive): 1/0, y/n, yes/no, true/false.", THIS_OPT);
 165       break;
 166     case OPT_CL_STATIC:
 167       {
 168         char * e = NULL;
 169         switch (item->type) {
 170           case CT_INT:
 171             if (!value)
 172               *OPT_PTR(int) = 0;
 173             else
 174               e = cf_parse_int(value, OPT_PTR(int));
 175             if (e)
 176               opt_failure("Integer value parsing failed for %s: %s", THIS_OPT, e);
 177             break;
 178           case CT_U64:
 179             if (!value)
 180               *OPT_PTR(u64) = 0;
 181             else
 182               e = cf_parse_u64(value, OPT_PTR(u64));
 183             if (e)
 184               opt_failure("Unsigned 64-bit value parsing failed for %s: %s", THIS_OPT, e);
 185             break;
 186           case CT_DOUBLE:
 187             if (!value)
 188               *OPT_PTR(double) = NAN;
 189             else
 190               e = cf_parse_double(value, OPT_PTR(double));
 191             if (e)
 192               opt_failure("Floating-point value parsing failed for %s: %s", THIS_OPT, e);
 193             break;
 194           case CT_IP:
 195             if (!value)
 196               *OPT_PTR(u32) = 0;
 197             else
 198               e = cf_parse_ip(value, OPT_PTR(u32));
 199             if (e)
 200               opt_failure("IP address parsing failed for %s: %s", THIS_OPT, e);
 201             break;
 202           case CT_STRING:
 203             if (!value)
 204               *OPT_PTR(const char *) = NULL;
 205             else
 206               *OPT_PTR(const char *) = xstrdup(value);
 207             break;
 208           default:
 209             ASSERT(0);
 210         }
 211         break;
 212       }
 213     case OPT_CL_SWITCH:
 214       if ((opt->flags & OPT_SINGLE) && *((int *)item->ptr) != -1)
 215         opt_failure("Multiple switches: %s", THIS_OPT);
 216       else
 217         *((int *)item->ptr) = item->u.value;
 218       break;
 219     case OPT_CL_INC:
 220       if (opt->flags & OPT_NEGATIVE)
 221         (*((int *)item->ptr))--;
 222       else
 223         (*((int *)item->ptr))++;
 224       break;
 225     case OPT_CL_CALL:
 226       item->u.call(item, value, item->ptr);
 227       break;
 228     case OPT_CL_USER:
 229       {
 230         char * e = NULL;
 231         e = item->u.utype->parser(value, OPT_PTR(void*));
 232         if (e)
 233           opt_failure("Cannot parse the value of %s: %s", THIS_OPT, e);
 234         break;
 235       }
 236     default:
 237       ASSERT(0);
 238   }
 239
 240   opt_invoke_hooks(oc, OPT_HOOK_AFTER_VALUE, item, value);
 241 }
 242
 243 static int opt_longopt(struct opt_context * oc, char ** argv, int index) {
 244   int eaten = 0;
 245   char * name_in = argv[index] + 2; // skipping the -- on the beginning
 246   uns pos = strchrnul(name_in, '=') - name_in;
 247   struct opt_precomputed * opt = opt_find_item_longopt(oc, strndupa(name_in, pos));
 248   char * value = NULL;
 249
 250   opt->flags |= OPT_SEEN_AS_LONG;
 251
 252   if (opt->item->cls == OPT_CL_BOOL && !strncmp(name_in, "no-", 3) && !strncmp(name_in+3, opt->item->name, pos-3)) {
 253     if (name_in[pos])
 254       opt_failure("Option --%s must not have any value.", name_in);
 255     value = "n";
 256   } else if (opt->flags & OPT_REQUIRED_VALUE) {
 257     if (name_in[pos])
 258       value = name_in + pos + 1;
 259     else {
 260       value = argv[index+1];
 261       if (!value)
 262         opt_failure("Option %s must have a value, but nothing supplied.", THIS_OPT);
 263       eaten++;
 264     }
 265   } else if (opt->flags & OPT_MAYBE_VALUE) {
 266     if (name_in[pos])
 267       value = name_in + pos + 1;
 268   } else {
 269     if (name_in[pos])
 270       opt_failure("Option %s must have no value.", THIS_OPT);
 271   }
 272   opt_parse_value(oc, opt, value);
 273   return eaten;
 274 }
 275
 276 static int opt_shortopt(struct opt_context * oc, char ** argv, int index) {
 277   int chr = 0;
 278   struct opt_precomputed * opt;
 279   int o;
 280
 281   while (o = argv[index][++chr]) {
 282     if (o < 0 || o >= 128)
 283       opt_failure("Invalid character 0x%02x in option name. Only ASCII is allowed.", o & 0xff);
 284     opt = oc->shortopt[o];
 285
 286     if (!opt)
 287       opt_failure("Unknown option -%c.", o);
 288
 289     opt->flags &= ~OPT_SEEN_AS_LONG;
 290
 291     if (opt->flags & OPT_NO_VALUE)
 292       opt_parse_value(oc, opt, NULL);
 293     else if (opt->flags & OPT_REQUIRED_VALUE) {
 294       if (argv[index][chr+1]) {
 295         opt_parse_value(oc, opt, argv[index] + chr + 1);
 296         return 0;
 297       } else if (!argv[index+1])
 298         opt_failure("Option -%c must have a value, but nothing supplied.", o);
 299       else {
 300         opt_parse_value(oc, opt, argv[index+1]);
 301         return 1;
 302       }
 303     } else if (opt->flags & OPT_MAYBE_VALUE) {
 304       if (argv[index][chr+1]) {
 305         opt_parse_value(oc, opt, argv[index] + chr + 1);
 306         return 0;
 307       } else
 308         opt_parse_value(oc, opt, NULL);
 309     } else {
 310       ASSERT(0);
 311     }
 312   }
 313
 314   return 0;
 315 }
 316
 317 static void opt_positional(struct opt_context * oc, char * value) {
 318   oc->positional_count++;
 319   uns id = oc->positional_count > oc->positional_max ? OPT_POSITIONAL_TAIL : OPT_POSITIONAL(oc->positional_count);
 320   struct opt_precomputed * opt = oc->shortopt[id];
 321   if (!opt)
 322     opt_failure("Too many positional arguments.");
 323   else {
 324     opt->flags &= OPT_SEEN_AS_LONG;
 325     opt_parse_value(oc, opt, value);
 326   }
 327 }
 328
 329 static void opt_count_items(struct opt_context *oc, const struct opt_section *sec)
 330 {
 331   for (const struct opt_item *item = sec->opt; item->cls != OPT_CL_END; item++) {
 332     if (item->cls == OPT_CL_SECTION)
 333       opt_count_items(oc, item->u.section);
 334     else if (item->cls == OPT_CL_HOOK)
 335       oc->hook_count++;
 336     else if (item->letter || item->name) {
 337       oc->opt_count++;
 338       if (item->letter > OPT_POSITIONAL_TAIL)
 339         oc->positional_max++;
 340     }
 341   }
 342 }
 343
 344 static void opt_prepare_items(struct opt_context *oc, const struct opt_section *sec)
 345 {
 346   for (struct opt_item *item = sec->opt; item->cls != OPT_CL_END; item++) {
 347     if (item->cls == OPT_CL_SECTION)
 348       opt_prepare_items(oc, item->u.section);
 349     else if (item->cls == OPT_CL_HOOK)
 350       oc->hooks[oc->hook_count++] = item;
 351     else if (item->letter || item->name) {
 352       struct opt_precomputed * opt = &oc->opts[oc->opt_count++];
 353       opt_precompute(opt, item);
 354       if (item->letter)
 355         oc->shortopt[(int) item->letter] = opt;
 356     }
 357   }
 358 }
 359
 360 static void opt_check_required(struct opt_context *oc)
 361 {
 362   for (int i = 0; i < oc->opt_count; i++) {
 363     struct opt_precomputed *opt = &oc->opts[i];
 364     if (!opt->count && (opt->flags & OPT_REQUIRED)) {
 365       struct opt_item *item = opt->item;
 366       if (item->letter > OPT_POSITIONAL_TAIL)
 367         opt_failure("Required positional argument #%d not found.", item->letter - OPT_POSITIONAL_TAIL);
 368       else if (item->letter == OPT_POSITIONAL_TAIL)
 369         opt_failure("Required positional argument not found.");
 370       else if (item->letter && item->name)
 371         opt_failure("Required option -%c/--%s not found.", item->letter, item->name);
 372       else if (item->letter)
 373         opt_failure("Required option -%c not found.", item->letter);
 374       else
 375         opt_failure("Required option --%s not found.", item->name);
 376     }
 377   }
 378 }
 379
 380 int opt_parse(const struct opt_section * options, char ** argv) {
 381   struct opt_context * oc = alloca(sizeof(*oc));
 382   memset(oc, 0, sizeof (*oc));
 383
 384   opt_count_items(oc, options);
 385   oc->opts = alloca(sizeof(*oc->opts) * oc->opt_count);
 386   oc->shortopt = alloca(sizeof(*oc->shortopt) * (oc->positional_max + 257));
 387   memset(oc->shortopt, 0, sizeof(*oc->shortopt) * (oc->positional_max + 257));
 388   oc->hooks = alloca(sizeof (*oc->hooks) * oc->hook_count);
 389
 390   oc->opt_count = 0;
 391   oc->hook_count = 0;
 392   opt_prepare_items(oc, options);
 393
 394   int force_positional = 0;
 395   int i;
 396   for (i=0; argv[i] && !oc->stop_parsing; i++) {
 397     char *arg = argv[i];
 398     opt_invoke_hooks(oc, OPT_HOOK_BEFORE_ARG, NULL, NULL);
 399     if (arg[0] != '-' || force_positional)
 400       opt_positional(oc, arg);
 401     else {
 402       if (arg[1] == '-') {
 403         if (arg[2] == '\0')
 404           force_positional++;
 405         else
 406           i += opt_longopt(oc, argv, i);
 407       } else if (arg[1])
 408         i += opt_shortopt(oc, argv, i);
 409       else
 410         opt_positional(oc, arg);
 411     }
 412   }
 413
 414   opt_check_required(oc);
 415   opt_invoke_hooks(oc, OPT_HOOK_FINAL, NULL, NULL);
 416   return i;
 417 }