/* 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).
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
char *pointer_to_arg_for_c;
char *pointer_to_arg_for_d;
- flags = getopt32(argc, argv, "a:b:c: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);
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
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;
else
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);
if (verbose_level) printf("verbose level is %d\n", verbose_level);
use ':' or end of line. For example:
opt_complementary = "-:w-x:x-w";
- getopt32(argc, argv, "wx");
+ getopt32(argv, "wx");
Allows any arguments to be given without a dash (./program w x)
as well as with a dash (./program -x).
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?]
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);
if (opt & 4)
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.
"x--x" Variation of the above, it means that -x option should occur
at most once.
- "::" A double colon after a char in opt_complementary means that the
+ "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_u() - allowed range is 0..INT_MAX.
+
+ int param; // "unsigned param;" will also work
+ opt_complementary = "p+";
+ getopt32(argv, "p:", ¶m);
+
+ "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*.
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
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"
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;
+/* Many small applets don't want to suck in stdio.h only because
+ * they need to parse options by calling us */
+#define DONT_USE_PRINTF 1
+
+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;
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];
#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
+#define FREE_FIRST_ARGV_IS_OPT (8 * !DONT_USE_PRINTF)
+
int spec_flgs = 0;
+ argc = 0;
+ while (argv[argc])
+ argc++;
+
va_start(p, applet_opts);
c = 0;
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++;
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;
+ 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 **);
s++;
continue;
}
- 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)
break;
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;
continue;
}
if (c == ':' || c == '\0') {
else
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;
}
if (spec_flgs & FIRST_ARGV_IS_OPT) {
if (argv[1] && argv[1][0] != '-' && argv[1][0] != '\0') {
+#if DONT_USE_PRINTF
+ char *pp = alloca(strlen(argv[1]) + 2);
+ *pp = '-';
+ strcpy(pp + 1, argv[1]);
+ argv[1] = pp;
+#else
argv[1] = xasprintf("-%s", argv[1]);
- if (ENABLE_FEATURE_CLEAN_UP)
- spec_flgs |= FREE_FIRST_ARGV_IS_OPT;
+ spec_flgs |= FREE_FIRST_ARGV_IS_OPT;
+#endif
}
}
- /* In case getopt32 was already called, reinit some state */
+ /* In case getopt32 was already called:
+ * reset the libc getopt() function, which keeps internal state.
+ *
+ * BSD-derived getopt() functions require that optind be set to 1 in
+ * order to reset getopt() state. This used to be generally accepted
+ * way of resetting getopt(). However, glibc's getopt()
+ * has additional getopt() state beyond optind, and requires that
+ * optind be set to zero to reset its state. So the unfortunate state of
+ * affairs is that BSD-derived versions of getopt() misbehave if
+ * optind is set to 0 in order to reset getopt(), and glibc's getopt()
+ * will core dump if optind is set 1 in order to reset getopt().
+ *
+ * More modern versions of BSD require that optreset be set to 1 in
+ * order to reset getopt(). Sigh. Standards, anyone?
+ */
+#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) */
#else
while ((c = getopt(argc, argv, applet_opts)) != -1) {
#endif
- c &= 0xff; /* fight libc's sign extends */
+ c &= 0xff; /* fight libc's sign extension */
loop_arg_is_opt:
- for (on_off = complementary; on_off->opt != c; on_off++) {
+ for (on_off = complementary; on_off->opt_char != c; on_off++) {
/* c==0 if long opt have non NULL flag */
- if (on_off->opt == 0 && c != 0)
+ if (on_off->opt_char == '\0' && c != '\0')
bb_show_usage();
}
if (flags & on_off->incongruously)
flags ^= trigger;
if (on_off->counter)
(*(on_off->counter))++;
- if (on_off->list_flg) {
- llist_add_to_end((llist_t **)(on_off->optarg), optarg);
+ if (on_off->param_type == PARAM_LIST) {
+ if (optarg)
+ llist_add_to_end((llist_t **)(on_off->optarg), optarg);
+ } else if (on_off->param_type == PARAM_INT) {
+ if (optarg)
+//TODO: xatoi_u indirectly pulls in printf machinery
+ *(unsigned*)(on_off->optarg) = xatoi_u(optarg);
} else if (on_off->optarg) {
- *(char **)(on_off->optarg) = optarg;
+ if (optarg)
+ *(char **)(on_off->optarg) = optarg;
}
if (pargv != NULL)
break;
}
}
-#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++) {
+ for (on_off = complementary; on_off->opt_char; on_off++) {
if (on_off->requires && (flags & on_off->switch_on) &&
(flags & on_off->requires) == 0)
bb_show_usage();
projects / oweals / busybox.git / blobdiff