*
* Copyright (C) 2003-2005 Vladimir Oleynik <dzo@simtreas.ru>
*
- * 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.
*/
-
-#include <getopt.h>
+#if ENABLE_LONG_OPTS
+# include <getopt.h>
+#endif
#include "libbb.h"
+//kbuild:lib-y += getopt32.o
+
/* Documentation
uint32_t
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(argv, "rnug");
+ The command line options are passed as the applet_opts string.
If one of the given options is found, a flag value is added to
- the return value (an unsigned long).
+ the return value.
The flag value is determined by the position of the char in
- applet_opts string. For example, in the above case:
+ applet_opts string. For example:
flags = getopt32(argv, "rnug");
- "r" will add 1 (bit 0)
- "n" will add 2 (bit 1)
- "u will add 4 (bit 2)
- "g" will add 8 (bit 3)
+ "r" will set 1 (bit 0)
+ "n" will set 2 (bit 1)
+ "u" will set 4 (bit 2)
+ "g" will set 8 (bit 3)
and so on. You can also look at the return value as a bit
field and each option sets one bit.
(options and their parameters will be moved into argv[]
positions prior to argv[optind]).
- ":" If one of the options requires an argument, then add a ":"
+ "o:" If one of the options requires an argument, then add a ":"
after the char in applet_opts and provide a pointer to store
the argument. For example:
&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
- opt_complementary (see below for more info).
+ The type of the pointer may be controlled by "o::" or "o+" in
+ the external string opt_complementary (see below for more info).
- "::" If option can have an *optional* argument, then add a "::"
+ "o::" If option can have an *optional* argument, then add a "::"
after its char in applet_opts and provide a pointer to store
the argument. Note that optional arguments _must_
immediately follow the option: -oparam, not -o param.
+ "o:+" This 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
+ getopt32(argv, "p:+", ¶m);
+
+ "o:*" This means that the option can occur multiple times. Each occurrence
+ will be saved as a llist_t element instead of char*.
+
+ For example:
+ The grep applet can have one or more "-e pattern" arguments.
+ In this case you should use getopt32() as follows:
+
+ llist_t *patterns = NULL;
+
+ (this pointer must be initializated to NULL if the list is empty
+ as required by llist_add_to_end(llist_t **old_head, char *new_item).)
+
+ 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
+
"+" If the first character in the applet_opts string is a plus,
then option processing will stop as soon as a non-option is
encountered in the argv array. Useful for applets like env
env -i ls -d /
Here we want env to process just the '-i', not the '-d'.
-const char *applet_long_options
+ "!" Report bad options, missing required options,
+ inconsistent options with all-ones return value (instead of abort).
+
+ "^" options string is "^optchars""\0""opt_complementary".
+
+uint32_t
+getopt32long(char **argv, const char *applet_opts, const char *logopts...)
- This struct allows you to define long options:
+ This allows you to define long options:
static const char applet_longopts[] ALIGN1 =
- //"name\0" has_arg val
- "verbose\0" No_argument "v"
- ;
- applet_long_options = applet_longopts;
+ //"name\0" has_arg val
+ "verbose\0" No_argument "v"
+ ;
+ opt = getopt32long(argv, applet_opts, applet_longopts, ...);
- The last member of struct option (val) typically is set to
+ The last element (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
+ - return bit has next position after short options
- if has_arg is not "No_argument", use ptr for arg also
- opt_complementary affects it too
config process and not a required feature. The current standard
is to name the config option CONFIG_FEATURE_<applet>_LONG_OPTIONS.
-const char *opt_complementary
+opt_complementary - option modifiers.
":" The colon (":") is used to separate groups of two or more chars
and/or groups of chars and special characters (stating some
"abc" If groups of two or more chars are specified, the first char
is the main option and the other chars are secondary options.
Their flags will be turned on if the main option is found even
- if they are not specifed on the command line. For example:
+ if they are not specified on the command line. For example:
- opt_complementary = "abc";
- flags = getopt32(argv, "abcd")
+ flags = getopt32(argv, "^abcd""\0""abc")
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;
- opt_complementary = "ww";
- getopt32(argv, "w", &w_counter);
+ int w_counter = 0; // must be initialized!
+ getopt32(argv, "^w""\0""ww", &w_counter);
if (w_counter)
width = (w_counter == 1) ? 132 : INT_MAX;
else
llist_t *my_b = NULL;
int verbose_level = 0;
- opt_complementary = "vv:b::b-c:c-b";
- f = getopt32(argv, "vb:c", &my_b, &verbose_level);
+ f = getopt32(argv, "^vb:*c"
+ "\0""vv:b-c:c-b"
+ , &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);
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:
-
- opt_complementary = "-:w-x:x-w";
- getopt32(argv, "wx");
-
- Allows any arguments to be given without a dash (./program w x)
- as well as with a dash (./program -x).
-
- "--" 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
-
"-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
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.
getopt32 finds -s, then -d is unset or if it finds -d
then -s is unset. (Note: busybox implements the GNU
"--max-depth" option as "-d".) To obtain this behavior, you
- set opt_complementary = "s-d:d-s". Only one flag value is
+ set opt_complementary to "s-d:d-s". Only one flag value is
added to getopt32's return value depending on the
position of the options on the command line. If one of the
two options requires an argument pointer (":" in applet_opts
char *smax_print_depth;
- opt_complementary = "s-d:d-s:x-x";
- opt = getopt32(argv, "sd:x", &smax_print_depth);
+ opt = getopt32(argv, "^sd:x""\0""s-d:d-s:x-x", &smax_print_depth);
if (opt & 2)
max_print_depth = atoi(smax_print_depth);
The cut applet must have only one type of list specified, so
-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
+ opt_complementary to "b--cf:c--bf:f--bc". If two of the
mutually exclusive options are found, getopt32 will call
- bb_show_usage() and die.
+ bb_show_usage() and die.
"x--x" Variation of the above, it means that -x option should occur
at most once.
- "a::" A double colon after a char in opt_complementary means that the
+ "o+" 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
+ getopt32(argv, "^p:""\0""p+", ¶m);
+
+ "o::" 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*.
(this pointer must be initializated to NULL if the list is empty
as required by llist_add_to_end(llist_t **old_head, char *new_item).)
- opt_complementary = "e::";
+ getopt32(argv, "^e:""\0""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
+ "o+" and "o::" can be handled by "o:+" and "o:*" specifiers
+ in option string (and it is preferred), but this does not work
+ for "long options only" cases, such as tar --exclude=PATTERN,
+ wget --header=HDR cases.
+
"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(argv, "rnug");
+ flags = getopt32(argv, "^rnug""\0""r?ug:n?ug:u--g:g--u");
This example allowed only:
$ id; id -u; id -g; id -ru; id -nu; id -rg; id -ng; id -rnu; id -rng
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(argv, "KS...);
+ flags = getopt32(argv, "^KS...""\0""K:S:K--S:S--K");
Don't forget to use ':'. For example, "?322-22-23X-x-a"
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.
+ But it's far too obfuscated. Use ':' to separate groups.
*/
/* Code here assumes that 'unsigned' is at least 32 bits wide */
-const char *opt_complementary;
+const char *const bb_argv_dash[] = { "-", NULL };
+
+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
+uint32_t option_mask32;
+
+#if ENABLE_LONG_OPTS
static const struct option bb_null_long_options[1] = {
{ 0, 0, 0, 0 }
};
-const char *applet_long_options;
+#else
+#define vgetopt32(argv,applet_opts,applet_long_options,p) \
+ vgetopt32(argv,applet_opts,p)
#endif
-uint32_t option_mask32;
+/* Please keep getopt32 free from xmalloc */
-uint32_t
-getopt32(char **argv, const char *applet_opts, ...)
+static uint32_t
+vgetopt32(char **argv, const char *applet_opts, const char *applet_long_options, va_list p)
{
int argc;
unsigned flags = 0;
unsigned requires = 0;
- t_complementary complementary[33];
+ unsigned len;
+ t_complementary complementary[33]; /* last stays zero-filled */
+ char dont_die_flag;
int c;
const unsigned char *s;
+ const char *opt_complementary;
t_complementary *on_off;
- va_list p;
-#if ENABLE_GETOPT_LONG
+#if ENABLE_LONG_OPTS
const struct option *l_o;
struct option *long_options = (struct option *) &bb_null_long_options;
#endif
unsigned trigger;
- char **pargv = NULL;
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;
- argc = 0;
- while (argv[argc])
- argc++;
-
- va_start(p, applet_opts);
+#define SHOW_USAGE_IF_ERROR 1
- c = 0;
on_off = complementary;
memset(on_off, 0, sizeof(complementary));
+ len = strlen(applet_opts);
+
+ /* skip bbox extension */
+ opt_complementary = NULL;
+ if (applet_opts[0] == '^') {
+ applet_opts++;
+ /* point it past terminating NUL */
+ opt_complementary = applet_opts + len;
+ }
+
+ /* skip another bbox extension */
+ dont_die_flag = applet_opts[0];
+ if (dont_die_flag == '!')
+ applet_opts++;
+
+ applet_opts = strcpy(alloca(len + 1), applet_opts);
+
/* skip GNU extension */
s = (const unsigned char *)applet_opts;
if (*s == '+' || *s == '-')
s++;
+ c = 0;
while (*s) {
- if (c >= 32) break;
- on_off->opt = *s;
- on_off->switch_on = (1 << c);
+ if (c >= 32)
+ break;
+ on_off->opt_char = *s;
+ on_off->switch_on = (1U << c);
if (*++s == ':') {
on_off->optarg = va_arg(p, void **);
- while (*++s == ':') /* skip */;
+ if (s[1] == '+' || s[1] == '*') {
+ /* 'o:+' or 'o:*' */
+ on_off->param_type = (s[1] == '+') ?
+ PARAM_INT : PARAM_LIST;
+ overlapping_strcpy((char*)s + 1, (char*)s + 2);
+ }
+ /* skip possible 'o::' (or 'o:+:' !) */
+ while (*++s == ':')
+ continue;
}
on_off++;
c++;
}
-#if ENABLE_GETOPT_LONG
+#if ENABLE_LONG_OPTS
if (applet_long_options) {
const char *optstr;
unsigned i, count;
for (l_o = 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)
+ 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 = l_o->val;
- on_off->switch_on = (1 << c);
+ if (c >= 32)
+ break;
+ on_off->opt_char = l_o->val;
+ on_off->switch_on = (1U << c);
if (l_o->has_arg != no_argument)
on_off->optarg = va_arg(p, void **);
c++;
next_long: ;
}
}
-#endif /* ENABLE_GETOPT_LONG */
- for (s = (const unsigned char *)opt_complementary; s && *s; s++) {
+#endif /* ENABLE_LONG_OPTS */
+
+ s = (const unsigned char *)opt_complementary;
+ if (s) for (; *s; s++) {
t_complementary *pair;
unsigned *pair_switch;
continue;
}
if (*s == '-') {
- if (c < '0' || c > '9') {
- if (c == '-') {
- spec_flgs |= FIRST_ARGV_IS_OPT;
- s++;
- } else
- spec_flgs |= ALL_ARGV_IS_OPTS;
- } else {
+ if (c >= '0' && c <= '9') {
min_arg = c - '0';
s++;
}
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') {
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;
}
}
s--;
}
- 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;
- }
- }
+ /* In case getopt32 was already called:
+ * reset libc getopt() internal state.
+ * run_nofork_applet() does this, but we might end up here
+ * also via gunzip_main() -> gzip_main(). Play safe.
+ */
+ GETOPT_RESET();
- /* In case getopt32 was already called, reinit some state */
- optind = 1;
- /* optarg = NULL; opterr = 0; optopt = 0; ?? */
+ /* skip 0: some applets cheat: they do not actually HAVE argv[0] */
+ argc = 1 + string_array_len(argv + 1);
- /* 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
while ((c = getopt_long(argc, argv, applet_opts,
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();
+ /* 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)
- bb_show_usage();
+ 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 (dont_die_flag != '!')
+ bb_show_usage();
+ return (int32_t)-1;
}
+
+uint32_t FAST_FUNC
+getopt32(char **argv, const char *applet_opts, ...)
+{
+ uint32_t opt;
+ va_list p;
+
+ va_start(p, applet_opts);
+ opt = vgetopt32(argv, applet_opts, NULL, p);
+ va_end(p);
+ return opt;
+}
+
+#if ENABLE_LONG_OPTS
+uint32_t FAST_FUNC
+getopt32long(char **argv, const char *applet_opts, const char *longopts, ...)
+{
+ uint32_t opt;
+ va_list p;
+
+ va_start(p, longopts);
+ opt = vgetopt32(argv, applet_opts, longopts, p);
+ va_end(p);
+ return opt;
+}
+#endif
projects / oweals / busybox.git / blobdiff