libbb/getopt32.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * universal getopt32 implementation for busybox
   4  *
   5  * Copyright (C) 2003-2005  Vladimir Oleynik  <dzo@simtreas.ru>
   6  *
   7  * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
   8  */
   9
  10 #include <getopt.h>
  11 #include "libbb.h"
  12
  13 /*      Documentation
  14
  15 uint32_t
  16 getopt32(char **argv, const char *applet_opts, ...)
  17
  18         The command line options must be declared in const char
  19         *applet_opts as a string of chars, for example:
  20
  21         flags = getopt32(argv, "rnug");
  22
  23         If one of the given options is found, a flag value is added to
  24         the return value (an unsigned long).
  25
  26         The flag value is determined by the position of the char in
  27         applet_opts string.  For example, in the above case:
  28
  29         flags = getopt32(argv, "rnug");
  30
  31         "r" will add 1    (bit 0)
  32         "n" will add 2    (bit 1)
  33         "u" will add 4    (bit 2)
  34         "g" will add 8    (bit 3)
  35
  36         and so on.  You can also look at the return value as a bit
  37         field and each option sets one bit.
  38
  39         On exit, global variable optind is set so that if you
  40         will do argc -= optind; argv += optind; then
  41         argc will be equal to number of remaining non-option
  42         arguments, first one would be in argv[0], next in argv[1] and so on
  43         (options and their parameters will be moved into argv[]
  44         positions prior to argv[optind]).
  45
  46  ":"    If one of the options requires an argument, then add a ":"
  47         after the char in applet_opts and provide a pointer to store
  48         the argument.  For example:
  49
  50         char *pointer_to_arg_for_a;
  51         char *pointer_to_arg_for_b;
  52         char *pointer_to_arg_for_c;
  53         char *pointer_to_arg_for_d;
  54
  55         flags = getopt32(argv, "a:b:c:d:",
  56                         &pointer_to_arg_for_a, &pointer_to_arg_for_b,
  57                         &pointer_to_arg_for_c, &pointer_to_arg_for_d);
  58
  59         The type of the pointer (char* or llist_t*) may be controlled
  60         by the "::" special separator that is set in the external string
  61         opt_complementary (see below for more info).
  62
  63  "::"   If option can have an *optional* argument, then add a "::"
  64         after its char in applet_opts and provide a pointer to store
  65         the argument.  Note that optional arguments _must_
  66         immediately follow the option: -oparam, not -o param.
  67
  68  "+"    If the first character in the applet_opts string is a plus,
  69         then option processing will stop as soon as a non-option is
  70         encountered in the argv array.  Useful for applets like env
  71         which should not process arguments to subprograms:
  72         env -i ls -d /
  73         Here we want env to process just the '-i', not the '-d'.
  74
  75 const char *applet_long_options
  76
  77         This struct allows you to define long options:
  78
  79         static const char applet_longopts[] ALIGN1 =
  80                 //"name\0" has_arg val
  81                 "verbose\0" No_argument "v"
  82                 ;
  83         applet_long_options = applet_longopts;
  84
  85         The last member of struct option (val) typically is set to
  86         matching short option from applet_opts. If there is no matching
  87         char in applet_opts, then:
  88         - return bit have next position after short options
  89         - if has_arg is not "No_argument", use ptr for arg also
  90         - opt_complementary affects it too
  91
  92         Note: a good applet will make long options configurable via the
  93         config process and not a required feature.  The current standard
  94         is to name the config option CONFIG_FEATURE_<applet>_LONG_OPTIONS.
  95
  96 const char *opt_complementary
  97
  98  ":"    The colon (":") is used to separate groups of two or more chars
  99         and/or groups of chars and special characters (stating some
 100         conditions to be checked).
 101
 102  "abc"  If groups of two or more chars are specified, the first char
 103         is the main option and the other chars are secondary options.
 104         Their flags will be turned on if the main option is found even
 105         if they are not specifed on the command line.  For example:
 106
 107         opt_complementary = "abc";
 108         flags = getopt32(argv, "abcd")
 109
 110         If getopt() finds "-a" on the command line, then
 111         getopt32's return value will be as if "-a -b -c" were
 112         found.
 113
 114  "ww"   Adjacent double options have a counter associated which indicates
 115         the number of occurences of the option.
 116         For example the ps applet needs:
 117         if w is given once, GNU ps sets the width to 132,
 118         if w is given more than once, it is "unlimited"
 119
 120         int w_counter = 0;
 121         opt_complementary = "ww";
 122         getopt32(argv, "w", &w_counter);
 123         if (w_counter)
 124                 width = (w_counter == 1) ? 132 : INT_MAX;
 125         else
 126                 get_terminal_width(...&width...);
 127
 128         w_counter is a pointer to an integer. It has to be passed to
 129         getopt32() after all other option argument sinks.
 130
 131         For example: accept multiple -v to indicate the level of verbosity
 132         and for each -b optarg, add optarg to my_b. Finally, if b is given,
 133         turn off c and vice versa:
 134
 135         llist_t *my_b = NULL;
 136         int verbose_level = 0;
 137         opt_complementary = "vv:b::b-c:c-b";
 138         f = getopt32(argv, "vb:c", &my_b, &verbose_level);
 139         if (f & 2)       // -c after -b unsets -b flag
 140                 while (my_b) { dosomething_with(my_b->data); my_b = my_b->link; }
 141         if (my_b)        // but llist is stored if -b is specified
 142                 free_llist(my_b);
 143         if (verbose_level) printf("verbose level is %d\n", verbose_level);
 144
 145 Special characters:
 146
 147  "-"    A dash as the first char in a opt_complementary group forces
 148         all arguments to be treated as options, even if they have
 149         no leading dashes. Next char in this case can't be a digit (0-9),
 150         use ':' or end of line. For example:
 151
 152         opt_complementary = "-:w-x:x-w";
 153         getopt32(argv, "wx");
 154
 155         Allows any arguments to be given without a dash (./program w x)
 156         as well as with a dash (./program -x).
 157
 158  "--"   A double dash at the beginning of opt_complementary means the
 159         argv[1] string should always be treated as options, even if it isn't
 160         prefixed with a "-".  This is useful for special syntax in applets
 161         such as "ar" and "tar":
 162         tar xvf foo.tar
 163
 164  "-N"   A dash as the first char in a opt_complementary group followed
 165         by a single digit (0-9) means that at least N non-option
 166         arguments must be present on the command line
 167
 168  "=N"   An equal sign as the first char in a opt_complementary group followed
 169         by a single digit (0-9) means that exactly N non-option
 170         arguments must be present on the command line
 171
 172  "?N"   A "?" as the first char in a opt_complementary group followed
 173         by a single digit (0-9) means that at most N arguments must be present
 174         on the command line.
 175
 176  "V-"   An option with dash before colon or end-of-line results in
 177         bb_show_usage being called if this option is encountered.
 178         This is typically used to implement "print verbose usage message
 179         and exit" option.
 180
 181  "a-b"  A dash between two options causes the second of the two
 182         to be unset (and ignored) if it is given on the command line.
 183
 184         [FIXME: what if they are the same? like "x-x"? Is it ever useful?]
 185
 186         For example:
 187         The du applet has the options "-s" and "-d depth".  If
 188         getopt32 finds -s, then -d is unset or if it finds -d
 189         then -s is unset.  (Note:  busybox implements the GNU
 190         "--max-depth" option as "-d".)  To obtain this behavior, you
 191         set opt_complementary = "s-d:d-s".  Only one flag value is
 192         added to getopt32's return value depending on the
 193         position of the options on the command line.  If one of the
 194         two options requires an argument pointer (":" in applet_opts
 195         as in "d:") optarg is set accordingly.
 196
 197         char *smax_print_depth;
 198
 199         opt_complementary = "s-d:d-s:x-x";
 200         opt = getopt32(argv, "sd:x", &smax_print_depth);
 201
 202         if (opt & 2)
 203                 max_print_depth = atoi(smax_print_depth);
 204         if (opt & 4)
 205                 printf("Detected odd -x usage\n");
 206
 207  "a--b" A double dash between two options, or between an option and a group
 208         of options, means that they are mutually exclusive.  Unlike
 209         the "-" case above, an error will be forced if the options
 210         are used together.
 211
 212         For example:
 213         The cut applet must have only one type of list specified, so
 214         -b, -c and -f are mutually exclusive and should raise an error
 215         if specified together.  In this case you must set
 216         opt_complementary = "b--cf:c--bf:f--bc".  If two of the
 217         mutually exclusive options are found, getopt32 will call
 218         bb_show_usage() and die.
 219
 220  "x--x" Variation of the above, it means that -x option should occur
 221         at most once.
 222
 223  "a+:"  A plus after a char in opt_complementary means that the parameter
 224         for this option is a nonnegative integer. It will be processed
 225         with xatoi_u() - allowed range is 0..INT_MAX.
 226
 227         int param;  // "unsigned param;" will also work
 228         opt_complementary = "p+";
 229         getopt32(argv, "p:", &param);
 230
 231  "a::"  A double colon after a char in opt_complementary means that the
 232         option can occur multiple times. Each occurrence will be saved as
 233         a llist_t element instead of char*.
 234
 235         For example:
 236         The grep applet can have one or more "-e pattern" arguments.
 237         In this case you should use getopt32() as follows:
 238
 239         llist_t *patterns = NULL;
 240
 241         (this pointer must be initializated to NULL if the list is empty
 242         as required by llist_add_to_end(llist_t **old_head, char *new_item).)
 243
 244         opt_complementary = "e::";
 245
 246         getopt32(argv, "e:", &patterns);
 247         $ grep -e user -e root /etc/passwd
 248         root:x:0:0:root:/root:/bin/bash
 249         user:x:500:500::/home/user:/bin/bash
 250
 251  "a?b"  A "?" between an option and a group of options means that
 252         at least one of them is required to occur if the first option
 253         occurs in preceding command line arguments.
 254
 255         For example from "id" applet:
 256
 257         // Don't allow -n -r -rn -ug -rug -nug -rnug
 258         opt_complementary = "r?ug:n?ug:?u--g:g--u";
 259         flags = getopt32(argv, "rnug");
 260
 261         This example allowed only:
 262         $ id; id -u; id -g; id -ru; id -nu; id -rg; id -ng; id -rnu; id -rng
 263
 264  "X"    A opt_complementary group with just a single letter means
 265         that this option is required. If more than one such group exists,
 266         at least one option is required to occur (not all of them).
 267         For example from "start-stop-daemon" applet:
 268
 269         // Don't allow -KS -SK, but -S or -K is required
 270         opt_complementary = "K:S:K--S:S--K";
 271         flags = getopt32(argv, "KS...);
 272
 273
 274         Don't forget to use ':'. For example, "?322-22-23X-x-a"
 275         is interpreted as "?3:22:-2:2-2:2-3Xa:2--x" -
 276         max 3 args; count uses of '-2'; min 2 args; if there is
 277         a '-2' option then unset '-3', '-X' and '-a'; if there is
 278         a '-2' and after it a '-x' then error out.
 279         But it's far too obfuscated. Use ':' to separate groups.
 280 */
 281
 282 /* Code here assumes that 'unsigned' is at least 32 bits wide */
 283
 284 const char *opt_complementary;
 285
 286 enum {
 287         PARAM_STRING,
 288         PARAM_LIST,
 289         PARAM_INT,
 290 };
 291
 292 typedef struct {
 293         unsigned char opt_char;
 294         smallint param_type;
 295         unsigned switch_on;
 296         unsigned switch_off;
 297         unsigned incongruously;
 298         unsigned requires;
 299         void **optarg;  /* char**, llist_t** or int *. */
 300         int *counter;
 301 } t_complementary;
 302
 303 /* You can set applet_long_options for parse called long options */
 304 #if ENABLE_GETOPT_LONG
 305 static const struct option bb_null_long_options[1] = {
 306         { 0, 0, 0, 0 }
 307 };
 308 const char *applet_long_options;
 309 #endif
 310
 311 uint32_t option_mask32;
 312
 313 uint32_t
 314 getopt32(char **argv, const char *applet_opts, ...)
 315 {
 316         int argc;
 317         unsigned flags = 0;
 318         unsigned requires = 0;
 319         t_complementary complementary[33];
 320         int c;
 321         const unsigned char *s;
 322         t_complementary *on_off;
 323         va_list p;
 324 #if ENABLE_GETOPT_LONG
 325         const struct option *l_o;
 326         struct option *long_options = (struct option *) &bb_null_long_options;
 327 #endif
 328         unsigned trigger;
 329         char **pargv = NULL;
 330         int min_arg = 0;
 331         int max_arg = -1;
 332
 333 #define SHOW_USAGE_IF_ERROR     1
 334 #define ALL_ARGV_IS_OPTS        2
 335 #define FIRST_ARGV_IS_OPT       4
 336 #define FREE_FIRST_ARGV_IS_OPT  8
 337         int spec_flgs = 0;
 338
 339         argc = 0;
 340         while (argv[argc])
 341                 argc++;
 342
 343         va_start(p, applet_opts);
 344
 345         c = 0;
 346         on_off = complementary;
 347         memset(on_off, 0, sizeof(complementary));
 348
 349         /* skip GNU extension */
 350         s = (const unsigned char *)applet_opts;
 351         if (*s == '+' || *s == '-')
 352                 s++;
 353         while (*s) {
 354                 if (c >= 32)
 355                         break;
 356                 on_off->opt_char = *s;
 357                 on_off->switch_on = (1 << c);
 358                 if (*++s == ':') {
 359                         on_off->optarg = va_arg(p, void **);
 360                         while (*++s == ':')
 361                                 continue;
 362                 }
 363                 on_off++;
 364                 c++;
 365         }
 366
 367 #if ENABLE_GETOPT_LONG
 368         if (applet_long_options) {
 369                 const char *optstr;
 370                 unsigned i, count;
 371
 372                 count = 1;
 373                 optstr = applet_long_options;
 374                 while (optstr[0]) {
 375                         optstr += strlen(optstr) + 3; /* skip NUL, has_arg, val */
 376                         count++;
 377                 }
 378                 /* count == no. of longopts + 1 */
 379                 long_options = alloca(count * sizeof(*long_options));
 380                 memset(long_options, 0, count * sizeof(*long_options));
 381                 i = 0;
 382                 optstr = applet_long_options;
 383                 while (--count) {
 384                         long_options[i].name = optstr;
 385                         optstr += strlen(optstr) + 1;
 386                         long_options[i].has_arg = (unsigned char)(*optstr++);
 387                         /* long_options[i].flag = NULL; */
 388                         long_options[i].val = (unsigned char)(*optstr++);
 389                         i++;
 390                 }
 391                 for (l_o = long_options; l_o->name; l_o++) {
 392                         if (l_o->flag)
 393                                 continue;
 394                         for (on_off = complementary; on_off->opt_char; on_off++)
 395                                 if (on_off->opt_char == l_o->val)
 396                                         goto next_long;
 397                         if (c >= 32)
 398                                 break;
 399                         on_off->opt_char = l_o->val;
 400                         on_off->switch_on = (1 << c);
 401                         if (l_o->has_arg != no_argument)
 402                                 on_off->optarg = va_arg(p, void **);
 403                         c++;
 404  next_long: ;
 405                 }
 406         }
 407 #endif /* ENABLE_GETOPT_LONG */
 408         for (s = (const unsigned char *)opt_complementary; s && *s; s++) {
 409                 t_complementary *pair;
 410                 unsigned *pair_switch;
 411
 412                 if (*s == ':')
 413                         continue;
 414                 c = s[1];
 415                 if (*s == '?') {
 416                         if (c < '0' || c > '9') {
 417                                 spec_flgs |= SHOW_USAGE_IF_ERROR;
 418                         } else {
 419                                 max_arg = c - '0';
 420                                 s++;
 421                         }
 422                         continue;
 423                 }
 424                 if (*s == '-') {
 425                         if (c < '0' || c > '9') {
 426                                 if (c == '-') {
 427                                         spec_flgs |= FIRST_ARGV_IS_OPT;
 428                                         s++;
 429                                 } else
 430                                         spec_flgs |= ALL_ARGV_IS_OPTS;
 431                         } else {
 432                                 min_arg = c - '0';
 433                                 s++;
 434                         }
 435                         continue;
 436                 }
 437                 if (*s == '=') {
 438                         min_arg = max_arg = c - '0';
 439                         s++;
 440                         continue;
 441                 }
 442                 for (on_off = complementary; on_off->opt_char; on_off++)
 443                         if (on_off->opt_char == *s)
 444                                 break;
 445                 if (c == ':' && s[2] == ':') {
 446                         on_off->param_type = PARAM_LIST;
 447                         continue;
 448                 }
 449                 if (c == '+' && (s[2] == ':' || s[2] == '\0')) {
 450                         on_off->param_type = PARAM_INT;
 451                         continue;
 452                 }
 453                 if (c == ':' || c == '\0') {
 454                         requires |= on_off->switch_on;
 455                         continue;
 456                 }
 457                 if (c == '-' && (s[2] == ':' || s[2] == '\0')) {
 458                         flags |= on_off->switch_on;
 459                         on_off->incongruously |= on_off->switch_on;
 460                         s++;
 461                         continue;
 462                 }
 463                 if (c == *s) {
 464                         on_off->counter = va_arg(p, int *);
 465                         s++;
 466                 }
 467                 pair = on_off;
 468                 pair_switch = &(pair->switch_on);
 469                 for (s++; *s && *s != ':'; s++) {
 470                         if (*s == '?') {
 471                                 pair_switch = &(pair->requires);
 472                         } else if (*s == '-') {
 473                                 if (pair_switch == &(pair->switch_off))
 474                                         pair_switch = &(pair->incongruously);
 475                                 else
 476                                         pair_switch = &(pair->switch_off);
 477                         } else {
 478                                 for (on_off = complementary; on_off->opt_char; on_off++)
 479                                         if (on_off->opt_char == *s) {
 480                                                 *pair_switch |= on_off->switch_on;
 481                                                 break;
 482                                         }
 483                         }
 484                 }
 485                 s--;
 486         }
 487         va_end(p);
 488
 489         if (spec_flgs & FIRST_ARGV_IS_OPT) {
 490                 if (argv[1] && argv[1][0] != '-' && argv[1][0] != '\0') {
 491                         argv[1] = xasprintf("-%s", argv[1]);
 492                         if (ENABLE_FEATURE_CLEAN_UP)
 493                                 spec_flgs |= FREE_FIRST_ARGV_IS_OPT;
 494                 }
 495         }
 496
 497         /* In case getopt32 was already called:
 498          * reset the libc getopt() function, which keeps internal state.
 499          *
 500          * BSD-derived getopt() functions require that optind be set to 1 in
 501          * order to reset getopt() state.  This used to be generally accepted
 502          * way of resetting getopt().  However, glibc's getopt()
 503          * has additional getopt() state beyond optind, and requires that
 504          * optind be set to zero to reset its state.  So the unfortunate state of
 505          * affairs is that BSD-derived versions of getopt() misbehave if
 506          * optind is set to 0 in order to reset getopt(), and glibc's getopt()
 507          * will core dump if optind is set 1 in order to reset getopt().
 508          *
 509          * More modern versions of BSD require that optreset be set to 1 in
 510          * order to reset getopt().   Sigh.  Standards, anyone?
 511          */
 512 #ifdef __GLIBC__
 513         optind = 0;
 514 #else /* BSD style */
 515         optind = 1;
 516         /* optreset = 1; */
 517 #endif
 518         /* optarg = NULL; opterr = 0; optopt = 0; - do we need this?? */
 519
 520         /* Note: just "getopt() <= 0" will not work well for
 521          * "fake" short options, like this one:
 522          * wget $'-\203' "Test: test" http://kernel.org/
 523          * (supposed to act as --header, but doesn't) */
 524 #if ENABLE_GETOPT_LONG
 525         while ((c = getopt_long(argc, argv, applet_opts,
 526                         long_options, NULL)) != -1) {
 527 #else
 528         while ((c = getopt(argc, argv, applet_opts)) != -1) {
 529 #endif
 530                 c &= 0xff; /* fight libc's sign extension */
 531  loop_arg_is_opt:
 532                 for (on_off = complementary; on_off->opt_char != c; on_off++) {
 533                         /* c==0 if long opt have non NULL flag */
 534                         if (on_off->opt_char == '\0' && c != '\0')
 535                                 bb_show_usage();
 536                 }
 537                 if (flags & on_off->incongruously)
 538                         bb_show_usage();
 539                 trigger = on_off->switch_on & on_off->switch_off;
 540                 flags &= ~(on_off->switch_off ^ trigger);
 541                 flags |= on_off->switch_on ^ trigger;
 542                 flags ^= trigger;
 543                 if (on_off->counter)
 544                         (*(on_off->counter))++;
 545                 if (on_off->param_type == PARAM_LIST) {
 546                         llist_add_to_end((llist_t **)(on_off->optarg), optarg);
 547                 } else if (on_off->param_type == PARAM_INT) {
 548                         *(unsigned*)(on_off->optarg) = xatoi_u(optarg);
 549                 } else if (on_off->optarg) {
 550                         *(char **)(on_off->optarg) = optarg;
 551                 }
 552                 if (pargv != NULL)
 553                         break;
 554         }
 555
 556         if (spec_flgs & ALL_ARGV_IS_OPTS) {
 557                 /* process argv is option, for example "ps" applet */
 558                 if (pargv == NULL)
 559                         pargv = argv + optind;
 560                 while (*pargv) {
 561                         c = **pargv;
 562                         if (c == '\0') {
 563                                 pargv++;
 564                         } else {
 565                                 (*pargv)++;
 566                                 goto loop_arg_is_opt;
 567                         }
 568                 }
 569         }
 570
 571 #if (ENABLE_AR || ENABLE_TAR) && ENABLE_FEATURE_CLEAN_UP
 572         if (spec_flgs & FREE_FIRST_ARGV_IS_OPT)
 573                 free(argv[1]);
 574 #endif
 575         /* check depending requires for given options */
 576         for (on_off = complementary; on_off->opt_char; on_off++) {
 577                 if (on_off->requires && (flags & on_off->switch_on) &&
 578                                         (flags & on_off->requires) == 0)
 579                         bb_show_usage();
 580         }
 581         if (requires && (flags & requires) == 0)
 582                 bb_show_usage();
 583         argc -= optind;
 584         if (argc < min_arg || (max_arg >= 0 && argc > max_arg))
 585                 bb_show_usage();
 586
 587         option_mask32 = flags;
 588         return flags;
 589 }