X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=libbb%2Fgetopt32.c;h=d0e83d88ee4d31090527a7f2f632907e9ebe0312;hb=0b170e6a096b0d5010e29a39f3b270c3a7bc4945;hp=28b47974e7f2f0334efd8bb15f5b54653c1c22d2;hpb=3f3aa2a57dc648ade9083f3b3ad83cce8206b912;p=oweals%2Fbusybox.git diff --git a/libbb/getopt32.c b/libbb/getopt32.c index 28b47974e..d0e83d88e 100644 --- a/libbb/getopt32.c +++ b/libbb/getopt32.c @@ -4,21 +4,23 @@ * * Copyright (C) 2003-2005 Vladimir Oleynik * - * Licensed under GPLv2 or later, see file LICENSE in this tarball for details. + * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG +# include +#endif #include "libbb.h" -#include /* Documentation uint32_t -getopt32(int argc, char **argv, const char *applet_opts, ...) +getopt32(char **argv, const char *applet_opts, ...) The command line options must be declared in const char *applet_opts as a string of chars, for example: - flags = getopt32(argc, argv, "rnug"); + flags = getopt32(argv, "rnug"); If one of the given options is found, a flag value is added to the return value (an unsigned long). @@ -26,11 +28,11 @@ getopt32(int argc, char **argv, const char *applet_opts, ...) The flag value is determined by the position of the char in applet_opts string. For example, in the above case: - flags = getopt32(argc, argv, "rnug"); + flags = getopt32(argv, "rnug"); "r" will add 1 (bit 0) "n" will add 2 (bit 1) - "u will add 4 (bit 2) + "u" will add 4 (bit 2) "g" will add 8 (bit 3) and so on. You can also look at the return value as a bit @@ -52,9 +54,9 @@ getopt32(int argc, char **argv, const char *applet_opts, ...) char *pointer_to_arg_for_c; char *pointer_to_arg_for_d; - flags = getopt32(argc, argv, "a:b:c:d:", - &pointer_to_arg_for_a, &pointer_to_arg_for_b, - &pointer_to_arg_for_c, &pointer_to_arg_for_d); + flags = getopt32(argv, "a:b:c:d:", + &pointer_to_arg_for_a, &pointer_to_arg_for_b, + &pointer_to_arg_for_c, &pointer_to_arg_for_d); The type of the pointer (char* or llist_t*) may be controlled by the "::" special separator that is set in the external string @@ -72,24 +74,24 @@ getopt32(int argc, char **argv, const char *applet_opts, ...) env -i ls -d / Here we want env to process just the '-i', not the '-d'. -const struct option *applet_long_options + "!" Report bad option, missing required options, + inconsistent options with all-ones return value (instead of abort). + +const char *applet_long_options - This struct allows you to define long options. The syntax for - declaring the array is just like that of getopt's longopts. - (see getopt(3)) + This struct allows you to define long options: - static const struct option applet_long_options[] = { - //name,has_arg,flag,val - { "verbose", 0, 0, 'v' }, - { 0, 0, 0, 0 } - }; - applet_long_options = applet_long_options; + static const char applet_longopts[] ALIGN1 = + //"name\0" has_arg val + "verbose\0" No_argument "v" + ; + applet_long_options = applet_longopts; The last member of struct option (val) typically is set to matching short option from applet_opts. If there is no matching char in applet_opts, then: - return bit have next position after short options - - if has_arg is not "no_argument", use ptr for arg also + - if has_arg is not "No_argument", use ptr for arg also - opt_complementary affects it too Note: a good applet will make long options configurable via the @@ -108,25 +110,25 @@ const char *opt_complementary if they are not specifed on the command line. For example: opt_complementary = "abc"; - flags = getopt32(argc, argv, "abcd") + flags = getopt32(argv, "abcd") If getopt() finds "-a" on the command line, then getopt32's return value will be as if "-a -b -c" were found. "ww" Adjacent double options have a counter associated which indicates - the number of occurences of the option. + the number of occurrences of the option. For example the ps applet needs: if w is given once, GNU ps sets the width to 132, if w is given more than once, it is "unlimited" - int w_counter = 0; + int w_counter = 0; // must be initialized! opt_complementary = "ww"; - getopt32(argc, argv, "w", &w_counter); + getopt32(argv, "w", &w_counter); if (w_counter) - width = (w_counter == 1) ? 132 : INT_MAX; + width = (w_counter == 1) ? 132 : INT_MAX; else - get_terminal_width(...&width...); + get_terminal_width(...&width...); w_counter is a pointer to an integer. It has to be passed to getopt32() after all other option argument sinks. @@ -138,32 +140,40 @@ const char *opt_complementary llist_t *my_b = NULL; int verbose_level = 0; opt_complementary = "vv:b::b-c:c-b"; - f = getopt32(argc, argv, "vb:c", &my_b, &verbose_level); + f = getopt32(argv, "vb:c", &my_b, &verbose_level); if (f & 2) // -c after -b unsets -b flag - while (my_b) { dosomething_with(my_b->data); my_b = my_b->link; } + while (my_b) dosomething_with(llist_pop(&my_b)); if (my_b) // but llist is stored if -b is specified - free_llist(my_b); + free_llist(my_b); if (verbose_level) printf("verbose level is %d\n", verbose_level); Special characters: - "-" A dash as the first char in a opt_complementary group forces - all arguments to be treated as options, even if they have - no leading dashes. Next char in this case can't be a digit (0-9), - use ':' or end of line. For example: + "-" A group consisting of just a dash forces all arguments + to be treated as options, even if they have no leading dashes. + Next char in this case can't be a digit (0-9), use ':' or end of line. + Example: - opt_complementary = "-:w-x:x-w"; - getopt32(argc, argv, "wx"); + opt_complementary = "-:w-x:x-w"; // "-w-x:x-w" would also work, + getopt32(argv, "wx"); // but is less readable - Allows any arguments to be given without a dash (./program w x) + This makes it possible to use options without a dash (./program w x) as well as with a dash (./program -x). + NB: getopt32() will leak a small amount of memory if you use + this option! Do not use it if there is a possibility of recursive + getopt32() calls. + "--" A double dash at the beginning of opt_complementary means the argv[1] string should always be treated as options, even if it isn't prefixed with a "-". This is useful for special syntax in applets such as "ar" and "tar": tar xvf foo.tar + NB: getopt32() will leak a small amount of memory if you use + this option! Do not use it if there is a possibility of recursive + getopt32() calls. + "-N" A dash as the first char in a opt_complementary group followed by a single digit (0-9) means that at least N non-option arguments must be present on the command line @@ -177,11 +187,11 @@ Special characters: on the command line. "V-" An option with dash before colon or end-of-line results in - bb_show_usage being called if this option is encountered. + bb_show_usage() being called if this option is encountered. This is typically used to implement "print verbose usage message and exit" option. - "-" A dash between two options causes the second of the two + "a-b" A dash between two options causes the second of the two to be unset (and ignored) if it is given on the command line. [FIXME: what if they are the same? like "x-x"? Is it ever useful?] @@ -200,38 +210,38 @@ Special characters: char *smax_print_depth; opt_complementary = "s-d:d-s:x-x"; - opt = getopt32(argc, argv, "sd:x", &smax_print_depth); + opt = getopt32(argv, "sd:x", &smax_print_depth); if (opt & 2) - max_print_depth = atoi(smax_print_depth); + max_print_depth = atoi(smax_print_depth); if (opt & 4) - printf("Detected odd -x usage\n"); + printf("Detected odd -x usage\n"); - "--" A double dash between two options, or between an option and a group + "a--b" A double dash between two options, or between an option and a group of options, means that they are mutually exclusive. Unlike the "-" case above, an error will be forced if the options are used together. For example: The cut applet must have only one type of list specified, so - -b, -c and -f are mutally exclusive and should raise an error + -b, -c and -f are mutually exclusive and should raise an error if specified together. In this case you must set opt_complementary = "b--cf:c--bf:f--bc". If two of the - mutually exclusive options are found, getopt32's - return value will have the error flag set (BB_GETOPT_ERROR) so - that we can check for it: - - if (flags & BB_GETOPT_ERROR) - bb_show_usage(); + mutually exclusive options are found, getopt32 will call + bb_show_usage() and die. "x--x" Variation of the above, it means that -x option should occur at most once. - "?" A "?" as the first char in a opt_complementary group means: - if BB_GETOPT_ERROR is detected, don't return, call bb_show_usage - and exit instead. Next char after '?' can't be a digit. + "a+" A plus after a char in opt_complementary means that the parameter + for this option is a nonnegative integer. It will be processed + with xatoi_positive() - allowed range is 0..INT_MAX. + + int param; // "unsigned param;" will also work + opt_complementary = "p+"; + getopt32(argv, "p:", ¶m); - "::" A double colon after a char in opt_complementary means that the + "a::" A double colon after a char in opt_complementary means that the option can occur multiple times. Each occurrence will be saved as a llist_t element instead of char*. @@ -246,20 +256,20 @@ Special characters: opt_complementary = "e::"; - getopt32(argc, argv, "e:", &patterns); + getopt32(argv, "e:", &patterns); $ grep -e user -e root /etc/passwd root:x:0:0:root:/root:/bin/bash user:x:500:500::/home/user:/bin/bash - "?" An "?" between an option and a group of options means that + "a?b" A "?" between an option and a group of options means that at least one of them is required to occur if the first option occurs in preceding command line arguments. For example from "id" applet: // Don't allow -n -r -rn -ug -rug -nug -rnug - opt_complementary = "r?ug:n?ug:?u--g:g--u"; - flags = getopt32(argc, argv, "rnug"); + opt_complementary = "r?ug:n?ug:u--g:g--u"; + flags = getopt32(argv, "rnug"); This example allowed only: $ id; id -u; id -g; id -ru; id -nu; id -rg; id -ng; id -rnu; id -rng @@ -270,8 +280,8 @@ Special characters: For example from "start-stop-daemon" applet: // Don't allow -KS -SK, but -S or -K is required - opt_complementary = "K:S:?K--S:S--K"; - flags = getopt32(argc, argv, "KS...); + opt_complementary = "K:S:K--S:S--K"; + flags = getopt32(argv, "KS...); Don't forget to use ':'. For example, "?322-22-23X-x-a" @@ -279,97 +289,148 @@ Special characters: max 3 args; count uses of '-2'; min 2 args; if there is a '-2' option then unset '-3', '-X' and '-a'; if there is a '-2' and after it a '-x' then error out. + But it's far too obfuscated. Use ':' to separate groups. */ /* Code here assumes that 'unsigned' is at least 32 bits wide */ +const char *const bb_argv_dash[] = { "-", NULL }; + const char *opt_complementary; +enum { + PARAM_STRING, + PARAM_LIST, + PARAM_INT, +}; + typedef struct { - int opt; - int list_flg; + unsigned char opt_char; + smallint param_type; unsigned switch_on; unsigned switch_off; unsigned incongruously; unsigned requires; - void **optarg; /* char **optarg or llist_t **optarg */ + void **optarg; /* char**, llist_t** or int *. */ int *counter; } t_complementary; /* You can set applet_long_options for parse called long options */ -#if ENABLE_GETOPT_LONG -static const struct option bb_default_long_options[] = { -/* { "help", 0, NULL, '?' }, */ +#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG +static const struct option bb_null_long_options[1] = { { 0, 0, 0, 0 } }; - -const struct option *applet_long_options = bb_default_long_options; +const char *applet_long_options; #endif uint32_t option_mask32; -uint32_t -getopt32(int argc, char **argv, const char *applet_opts, ...) +uint32_t FAST_FUNC +getopt32(char **argv, const char *applet_opts, ...) { + int argc; unsigned flags = 0; unsigned requires = 0; - t_complementary complementary[33]; + t_complementary complementary[33]; /* last stays zero-filled */ + char first_char; int c; const unsigned char *s; t_complementary *on_off; va_list p; -#if ENABLE_GETOPT_LONG +#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG const struct option *l_o; + struct option *long_options = (struct option *) &bb_null_long_options; #endif unsigned trigger; - char **pargv = NULL; + char **pargv; int min_arg = 0; int max_arg = -1; #define SHOW_USAGE_IF_ERROR 1 #define ALL_ARGV_IS_OPTS 2 #define FIRST_ARGV_IS_OPT 4 -#define FREE_FIRST_ARGV_IS_OPT 8 + int spec_flgs = 0; + /* skip 0: some applets cheat: they do not actually HAVE argv[0] */ + argc = 1; + while (argv[argc]) + argc++; + va_start(p, applet_opts); c = 0; on_off = complementary; memset(on_off, 0, sizeof(complementary)); + /* skip bbox extension */ + first_char = applet_opts[0]; + if (first_char == '!') + applet_opts++; + /* skip GNU extension */ s = (const unsigned char *)applet_opts; if (*s == '+' || *s == '-') s++; while (*s) { - if (c >= 32) break; - on_off->opt = *s; + if (c >= 32) + break; + on_off->opt_char = *s; on_off->switch_on = (1 << c); if (*++s == ':') { on_off->optarg = va_arg(p, void **); - while (*++s == ':') /* skip */; + while (*++s == ':') + continue; } on_off++; c++; } -#if ENABLE_GETOPT_LONG - for (l_o = applet_long_options; l_o->name; l_o++) { - if (l_o->flag) - continue; - for (on_off = complementary; on_off->opt != 0; on_off++) - if (on_off->opt == l_o->val) - goto next_long; - if (c >= 32) break; - on_off->opt = l_o->val; - on_off->switch_on = (1 << c); - if (l_o->has_arg != no_argument) - on_off->optarg = va_arg(p, void **); - c++; +#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG + if (applet_long_options) { + const char *optstr; + unsigned i, count; + + count = 1; + optstr = applet_long_options; + while (optstr[0]) { + optstr += strlen(optstr) + 3; /* skip NUL, has_arg, val */ + count++; + } + /* count == no. of longopts + 1 */ + long_options = alloca(count * sizeof(*long_options)); + memset(long_options, 0, count * sizeof(*long_options)); + i = 0; + optstr = applet_long_options; + while (--count) { + long_options[i].name = optstr; + optstr += strlen(optstr) + 1; + long_options[i].has_arg = (unsigned char)(*optstr++); + /* long_options[i].flag = NULL; */ + long_options[i].val = (unsigned char)(*optstr++); + i++; + } + for (l_o = long_options; l_o->name; l_o++) { + if (l_o->flag) + continue; + for (on_off = complementary; on_off->opt_char; on_off++) + if (on_off->opt_char == l_o->val) + goto next_long; + if (c >= 32) + break; + on_off->opt_char = l_o->val; + on_off->switch_on = (1 << c); + if (l_o->has_arg != no_argument) + on_off->optarg = va_arg(p, void **); + c++; next_long: ; + } + /* Make it unnecessary to clear applet_long_options + * by hand after each call to getopt32 + */ + applet_long_options = NULL; } -#endif /* ENABLE_GETOPT_LONG */ +#endif /* ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG */ for (s = (const unsigned char *)opt_complementary; s && *s; s++) { t_complementary *pair; unsigned *pair_switch; @@ -404,11 +465,19 @@ getopt32(int argc, char **argv, const char *applet_opts, ...) s++; continue; } - for (on_off = complementary; on_off->opt; on_off++) - if (on_off->opt == *s) - break; + for (on_off = complementary; on_off->opt_char; on_off++) + if (on_off->opt_char == *s) + goto found_opt; + /* Without this, diagnostic of such bugs is not easy */ + bb_error_msg_and_die("NO OPT %c!", *s); + found_opt: if (c == ':' && s[2] == ':') { - on_off->list_flg++; + on_off->param_type = PARAM_LIST; + continue; + } + if (c == '+' && (s[2] == ':' || s[2] == '\0')) { + on_off->param_type = PARAM_INT; + s++; continue; } if (c == ':' || c == '\0') { @@ -426,18 +495,18 @@ getopt32(int argc, char **argv, const char *applet_opts, ...) s++; } pair = on_off; - pair_switch = &(pair->switch_on); + pair_switch = &pair->switch_on; for (s++; *s && *s != ':'; s++) { if (*s == '?') { - pair_switch = &(pair->requires); + pair_switch = &pair->requires; } else if (*s == '-') { - if (pair_switch == &(pair->switch_off)) - pair_switch = &(pair->incongruously); + if (pair_switch == &pair->switch_off) + pair_switch = &pair->incongruously; else - pair_switch = &(pair->switch_off); + pair_switch = &pair->switch_off; } else { - for (on_off = complementary; on_off->opt; on_off++) - if (on_off->opt == *s) { + for (on_off = complementary; on_off->opt_char; on_off++) + if (on_off->opt_char == *s) { *pair_switch |= on_off->switch_on; break; } @@ -445,88 +514,102 @@ getopt32(int argc, char **argv, const char *applet_opts, ...) } s--; } - va_end (p); + opt_complementary = NULL; + va_end(p); - if (spec_flgs & FIRST_ARGV_IS_OPT) { - if (argv[1] && argv[1][0] != '-' && argv[1][0] != '\0') { - argv[1] = xasprintf("-%s", argv[1]); - if (ENABLE_FEATURE_CLEAN_UP) - spec_flgs |= FREE_FIRST_ARGV_IS_OPT; + if (spec_flgs & (FIRST_ARGV_IS_OPT | ALL_ARGV_IS_OPTS)) { + pargv = argv + 1; + while (*pargv) { + if (pargv[0][0] != '-' && pargv[0][0] != '\0') { + /* Can't use alloca: opts with params will + * return pointers to stack! + * NB: we leak these allocations... */ + char *pp = xmalloc(strlen(*pargv) + 2); + *pp = '-'; + strcpy(pp + 1, *pargv); + *pargv = pp; + } + if (!(spec_flgs & ALL_ARGV_IS_OPTS)) + break; + pargv++; } } - /* In case getopt32 was already called, reinit some state */ + /* In case getopt32 was already called: + * reset the libc getopt() function, which keeps internal state. + * run_nofork_applet() does this, but we might end up here + * also via gunzip_main() -> gzip_main(). Play safe. + */ +#ifdef __GLIBC__ + optind = 0; +#else /* BSD style */ optind = 1; - /* optarg = NULL; opterr = 0; optopt = 0; ?? */ + /* optreset = 1; */ +#endif + /* optarg = NULL; opterr = 0; optopt = 0; - do we need this?? */ - /* Note: just "getopt() <= 0" will not work good for + /* Note: just "getopt() <= 0" will not work well for * "fake" short options, like this one: * wget $'-\203' "Test: test" http://kernel.org/ * (supposed to act as --header, but doesn't) */ -#if ENABLE_GETOPT_LONG +#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG while ((c = getopt_long(argc, argv, applet_opts, - applet_long_options, NULL)) != -1) { + long_options, NULL)) != -1) { #else while ((c = getopt(argc, argv, applet_opts)) != -1) { #endif - c &= 0xff; /* fight libc's sign extends */ - loop_arg_is_opt: - for (on_off = complementary; on_off->opt != c; on_off++) { - /* c==0 if long opt have non NULL flag */ - if (on_off->opt == 0 && c != 0) - bb_show_usage(); - } - if (flags & on_off->incongruously) { - if ((spec_flgs & SHOW_USAGE_IF_ERROR)) - bb_show_usage(); - flags |= BB_GETOPT_ERROR; + /* getopt prints "option requires an argument -- X" + * and returns '?' if an option has no arg, but one is reqd */ + c &= 0xff; /* fight libc's sign extension */ + for (on_off = complementary; on_off->opt_char != c; on_off++) { + /* c can be NUL if long opt has non-NULL ->flag, + * but we construct long opts so that flag + * is always NULL (see above) */ + if (on_off->opt_char == '\0' /* && c != '\0' */) { + /* c is probably '?' - "bad option" */ + goto error; + } } + if (flags & on_off->incongruously) + goto error; trigger = on_off->switch_on & on_off->switch_off; flags &= ~(on_off->switch_off ^ trigger); flags |= on_off->switch_on ^ trigger; flags ^= trigger; if (on_off->counter) (*(on_off->counter))++; - if (on_off->list_flg) { - llist_add_to_end((llist_t **)(on_off->optarg), optarg); - } else if (on_off->optarg) { - *(char **)(on_off->optarg) = optarg; - } - if (pargv != NULL) - break; - } - - if (spec_flgs & ALL_ARGV_IS_OPTS) { - /* process argv is option, for example "ps" applet */ - if (pargv == NULL) - pargv = argv + optind; - while (*pargv) { - c = **pargv; - if (c == '\0') { - pargv++; - } else { - (*pargv)++; - goto loop_arg_is_opt; + if (optarg) { + if (on_off->param_type == PARAM_LIST) { + llist_add_to_end((llist_t **)(on_off->optarg), optarg); + } else if (on_off->param_type == PARAM_INT) { +//TODO: xatoi_positive indirectly pulls in printf machinery + *(unsigned*)(on_off->optarg) = xatoi_positive(optarg); + } else if (on_off->optarg) { + *(char **)(on_off->optarg) = optarg; } } } -#if (ENABLE_AR || ENABLE_TAR) && ENABLE_FEATURE_CLEAN_UP - if (spec_flgs & FREE_FIRST_ARGV_IS_OPT) - free(argv[1]); -#endif /* check depending requires for given options */ - for (on_off = complementary; on_off->opt; on_off++) { - if (on_off->requires && (flags & on_off->switch_on) && - (flags & on_off->requires) == 0) - bb_show_usage(); + for (on_off = complementary; on_off->opt_char; on_off++) { + if (on_off->requires + && (flags & on_off->switch_on) + && (flags & on_off->requires) == 0 + ) { + goto error; + } } if (requires && (flags & requires) == 0) - bb_show_usage(); + goto error; argc -= optind; if (argc < min_arg || (max_arg >= 0 && argc > max_arg)) - bb_show_usage(); + goto error; option_mask32 = flags; return flags; + + error: + if (first_char != '!') + bb_show_usage(); + return (int32_t)-1; }