1 /* vi: set sw=4 ts=4: */
3 * universal getopt32 implementation for busybox
5 * Copyright (C) 2003-2005 Vladimir Oleynik <dzo@simtreas.ru>
7 * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
16 getopt32(int argc, char **argv, const char *applet_opts, ...)
18 The command line options must be declared in const char
19 *applet_opts as a string of chars, for example:
21 flags = getopt32(argc, argv, "rnug");
23 If one of the given options is found, a flag value is added to
24 the return value (an unsigned long).
26 The flag value is determined by the position of the char in
27 applet_opts string. For example, in the above case:
29 flags = getopt32(argc, argv, "rnug");
31 "r" will add 1 (bit 0)
32 "n" will add 2 (bit 1)
34 "g" will add 8 (bit 3)
36 and so on. You can also look at the return value as a bit
37 field and each option sets one bit.
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]).
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:
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;
55 flags = getopt32(argc, 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);
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).
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.
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:
73 Here we want env to process just the '-i', not the '-d'.
75 const struct option *applet_long_options
77 This struct allows you to define long options. The syntax for
78 declaring the array is just like that of getopt's longopts.
81 static const struct option applet_long_options[] = {
82 //name,has_arg,flag,val
83 { "verbose", 0, 0, 'v' },
86 applet_long_options = applet_long_options;
88 The last member of struct option (val) typically is set to
89 matching short option from applet_opts. If there is no matching
90 char in applet_opts, then:
91 - return bit have next position after short options
92 - if has_arg is not "no_argument", use ptr for arg also
93 - opt_complementary affects it too
95 Note: a good applet will make long options configurable via the
96 config process and not a required feature. The current standard
97 is to name the config option CONFIG_FEATURE_<applet>_LONG_OPTIONS.
99 const char *opt_complementary
101 ":" The colon (":") is used to separate groups of two or more chars
102 and/or groups of chars and special characters (stating some
103 conditions to be checked).
105 "abc" If groups of two or more chars are specified, the first char
106 is the main option and the other chars are secondary options.
107 Their flags will be turned on if the main option is found even
108 if they are not specifed on the command line. For example:
110 opt_complementary = "abc";
111 flags = getopt32(argc, argv, "abcd")
113 If getopt() finds "-a" on the command line, then
114 getopt32's return value will be as if "-a -b -c" were
117 "ww" Adjacent double options have a counter associated which indicates
118 the number of occurences of the option.
119 For example the ps applet needs:
120 if w is given once, GNU ps sets the width to 132,
121 if w is given more than once, it is "unlimited"
124 opt_complementary = "ww";
125 getopt32(argc, argv, "w", &w_counter);
127 width = (w_counter == 1) ? 132 : INT_MAX;
129 get_terminal_width(...&width...);
131 w_counter is a pointer to an integer. It has to be passed to
132 getopt32() after all other option argument sinks.
134 For example: accept multiple -v to indicate the level of verbosity
135 and for each -b optarg, add optarg to my_b. Finally, if b is given,
136 turn off c and vice versa:
138 llist_t *my_b = NULL;
139 int verbose_level = 0;
140 opt_complementary = "vv:b::b-c:c-b";
141 f = getopt32(argc, argv, "vb:c", &my_b, &verbose_level);
142 if (f & 2) // -c after -b unsets -b flag
143 while (my_b) { dosomething_with(my_b->data); my_b = my_b->link; }
144 if (my_b) // but llist is stored if -b is specified
146 if (verbose_level) bb_printf("verbose level is %d\n", verbose_level);
150 "-" A dash between two options causes the second of the two
151 to be unset (and ignored) if it is given on the command line.
153 [FIXME: what if they are the same? like "x-x"? Is it ever useful?]
156 The du applet has the options "-s" and "-d depth". If
157 getopt32 finds -s, then -d is unset or if it finds -d
158 then -s is unset. (Note: busybox implements the GNU
159 "--max-depth" option as "-d".) To obtain this behavior, you
160 set opt_complementary = "s-d:d-s". Only one flag value is
161 added to getopt32's return value depending on the
162 position of the options on the command line. If one of the
163 two options requires an argument pointer (":" in applet_opts
164 as in "d:") optarg is set accordingly.
166 char *smax_print_depth;
168 opt_complementary = "s-d:d-s:x-x";
169 opt = getopt32(argc, argv, "sd:x", &smax_print_depth);
172 max_print_depth = atoi(smax_print_depth);
174 printf("Detected odd -x usage\n");
176 "-" A dash as the first char in a opt_complementary group forces
177 all arguments to be treated as options, even if they have
178 no leading dashes. Next char in this case can't be a digit (0-9),
179 use ':' or end of line. For example:
181 opt_complementary = "-:w-x:x-w";
182 getopt32(argc, argv, "wx");
184 Allows any arguments to be given without a dash (./program w x)
185 as well as with a dash (./program -x).
187 "-N" A dash as the first char in a opt_complementary group followed
188 by a single digit (0-9) means that at least N non-option
189 arguments must be present on the command line
191 "V-" An option with dash before colon or end-of-line results in
192 bb_show_usage being called if this option is encountered.
193 This is typically used to implement "print verbose usage message
196 "--" A double dash between two options, or between an option and a group
197 of options, means that they are mutually exclusive. Unlike
198 the "-" case above, an error will be forced if the options
202 The cut applet must have only one type of list specified, so
203 -b, -c and -f are mutally exclusive and should raise an error
204 if specified together. In this case you must set
205 opt_complementary = "b--cf:c--bf:f--bc". If two of the
206 mutually exclusive options are found, getopt32's
207 return value will have the error flag set (BB_GETOPT_ERROR) so
208 that we can check for it:
210 if (flags & BB_GETOPT_ERROR)
213 "x--x" Variation of the above, it means that -x option should occur
216 "?" A "?" as the first char in a opt_complementary group means:
217 if BB_GETOPT_ERROR is detected, don't return, call bb_show_usage
218 and exit instead. Next char after '?' can't be a digit.
220 "?N" A "?" as the first char in a opt_complementary group followed
221 by a single digit (0-9) means that at most N arguments must be present
224 "::" A double colon after a char in opt_complementary means that the
225 option can occur multiple times. Each occurrence will be saved as
226 a llist_t element instead of char*.
229 The grep applet can have one or more "-e pattern" arguments.
230 In this case you should use getopt32() as follows:
232 llist_t *patterns = NULL;
234 (this pointer must be initializated to NULL if the list is empty
235 as required by *llist_add_to(llist_t *old_head, char *new_item).)
237 opt_complementary = "e::";
239 getopt32(argc, argv, "e:", &patterns);
240 $ grep -e user -e root /etc/passwd
241 root:x:0:0:root:/root:/bin/bash
242 user:x:500:500::/home/user:/bin/bash
244 "--" A double dash at the beginning of opt_complementary means the
245 argv[1] string should always be treated as options, even if it isn't
246 prefixed with a "-". This is useful for special syntax in applets
247 such as "ar" and "tar":
250 "?" An "?" between an option and a group of options means that
251 at least one of them is required to occur if the first option
252 occurs in preceding command line arguments.
254 For example from "id" applet:
256 // Don't allow -n -r -rn -ug -rug -nug -rnug
257 opt_complementary = "r?ug:n?ug:?u--g:g--u";
258 flags = getopt32(argc, argv, "rnug");
260 This example allowed only:
261 $ id; id -u; id -g; id -ru; id -nu; id -rg; id -ng; id -rnu; id -rng
263 "X" A opt_complementary group with just a single letter means
264 that this option is required. If more than one such group exists,
265 at least one option is required to occur (not all of them).
266 For example from "start-stop-daemon" applet:
268 // Don't allow -KS -SK, but -S or -K is required
269 opt_complementary = "K:S:?K--S:S--K";
270 flags = getopt32(argc, argv, "KS...);
273 Don't forget to use ':'. For example, "?322-22-23X-x-a"
274 is interpreted as "?3:22:-2:2-2:2-3Xa:2--x" -
275 max 3 args; count uses of '-2'; min 2 args; if there is
276 a '-2' option then unset '-3', '-X' and '-a'; if there is
277 a '-2' and after it a '-x' then error out.
280 /* Code here assumes that 'unsigned' is at least 32 bits wide */
282 const char *opt_complementary;
289 unsigned incongruously;
291 void **optarg; /* char **optarg or llist_t **optarg */
295 /* You can set applet_long_options for parse called long options */
296 #if ENABLE_GETOPT_LONG
297 static const struct option bb_default_long_options[] = {
298 /* { "help", 0, NULL, '?' }, */
302 const struct option *applet_long_options = bb_default_long_options;
305 uint32_t option_mask32;
308 getopt32(int argc, char **argv, const char *applet_opts, ...)
311 unsigned requires = 0;
312 t_complementary complementary[sizeof(flags) * 8 + 1];
314 const unsigned char *s;
315 t_complementary *on_off;
317 #if ENABLE_GETOPT_LONG
318 const struct option *l_o;
325 #define SHOW_USAGE_IF_ERROR 1
326 #define ALL_ARGV_IS_OPTS 2
327 #define FIRST_ARGV_IS_OPT 4
328 #define FREE_FIRST_ARGV_IS_OPT 8
331 va_start(p, applet_opts);
334 on_off = complementary;
335 memset(on_off, 0, sizeof(complementary));
337 /* skip GNU extension */
338 s = (const unsigned char *)applet_opts;
339 if (*s == '+' || *s == '-')
342 if (c >= (int)(sizeof(flags)*8))
345 on_off->switch_on = (1 << c);
347 on_off->optarg = va_arg(p, void **);
356 #if ENABLE_GETOPT_LONG
357 for (l_o = applet_long_options; l_o->name; l_o++) {
360 for (on_off = complementary; on_off->opt != 0; on_off++)
361 if (on_off->opt == l_o->val)
363 if (on_off->opt == 0) {
364 if (c >= (int)(sizeof(flags)*8))
366 on_off->opt = l_o->val;
367 on_off->switch_on = (1 << c);
368 if (l_o->has_arg != no_argument)
369 on_off->optarg = va_arg(p, void **);
373 #endif /* ENABLE_GETOPT_LONG */
374 for (s = (const unsigned char *)opt_complementary; s && *s; s++) {
375 t_complementary *pair;
376 unsigned *pair_switch;
382 if (c < '0' || c > '9') {
383 spec_flgs |= SHOW_USAGE_IF_ERROR;
391 if (c < '0' || c > '9') {
393 spec_flgs |= FIRST_ARGV_IS_OPT;
396 spec_flgs |= ALL_ARGV_IS_OPTS;
403 for (on_off = complementary; on_off->opt; on_off++)
404 if (on_off->opt == *s)
406 if (c == ':' && s[2] == ':') {
410 if (c == ':' || c == '\0') {
411 requires |= on_off->switch_on;
414 if (c == '-' && (s[2] == ':' || s[2] == '\0')) {
415 flags |= on_off->switch_on;
416 on_off->incongruously |= on_off->switch_on;
421 on_off->counter = va_arg(p, int *);
425 pair_switch = &(pair->switch_on);
426 for (s++; *s && *s != ':'; s++) {
428 pair_switch = &(pair->requires);
429 } else if (*s == '-') {
430 if (pair_switch == &(pair->switch_off))
431 pair_switch = &(pair->incongruously);
433 pair_switch = &(pair->switch_off);
435 for (on_off = complementary; on_off->opt; on_off++)
436 if (on_off->opt == *s) {
437 *pair_switch |= on_off->switch_on;
446 #if ENABLE_AR || ENABLE_TAR
447 if (spec_flgs & FIRST_ARGV_IS_OPT) {
448 if (argv[1] && argv[1][0] != '-' && argv[1][0] != '\0') {
449 argv[1] = xasprintf("-%s", argv[1]);
450 if (ENABLE_FEATURE_CLEAN_UP)
451 spec_flgs |= FREE_FIRST_ARGV_IS_OPT;
455 #if ENABLE_GETOPT_LONG
456 while ((c = getopt_long(argc, argv, applet_opts,
457 applet_long_options, NULL)) >= 0) {
459 while ((c = getopt(argc, argv, applet_opts)) >= 0) {
460 #endif /* ENABLE_GETOPT_LONG */
462 for (on_off = complementary; on_off->opt != c; on_off++) {
463 /* c==0 if long opt have non NULL flag */
464 if (on_off->opt == 0 && c != 0)
467 if (flags & on_off->incongruously) {
468 if ((spec_flgs & SHOW_USAGE_IF_ERROR))
470 flags |= BB_GETOPT_ERROR;
472 trigger = on_off->switch_on & on_off->switch_off;
473 flags &= ~(on_off->switch_off ^ trigger);
474 flags |= on_off->switch_on ^ trigger;
477 (*(on_off->counter))++;
478 if (on_off->list_flg) {
479 llist_add_to((llist_t **)(on_off->optarg), optarg);
480 } else if (on_off->optarg) {
481 *(char **)(on_off->optarg) = optarg;
487 if (spec_flgs & ALL_ARGV_IS_OPTS) {
488 /* process argv is option, for example "ps" applet */
490 pargv = argv + optind;
497 goto loop_arg_is_opt;
502 #if (ENABLE_AR || ENABLE_TAR) && ENABLE_FEATURE_CLEAN_UP
503 if (spec_flgs & FREE_FIRST_ARGV_IS_OPT)
506 /* check depending requires for given options */
507 for (on_off = complementary; on_off->opt; on_off++) {
508 if (on_off->requires && (flags & on_off->switch_on) &&
509 (flags & on_off->requires) == 0)
512 if (requires && (flags & requires) == 0)
515 if (argc < min_arg || (max_arg >= 0 && argc > max_arg))
518 option_mask32 = flags;