1 /* vi: set sw=4 ts=4: */
3 * universal getopt_ulflags implementation for busybox
5 * Copyright (C) 2003-2005 Vladimir Oleynik <dzo@simtreas.ru>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
32 bb_getopt_ulflags (int argc, char **argv, const char *applet_opts, ...)
34 The command line options must be declared in const char
35 *applet_opts as a string of chars, for example:
37 flags = bb_getopt_ulflags(argc, argv, "rnug");
39 If one of the given options is found, a flag value is added to
40 the return value (an unsigned long).
42 The flag value is determined by the position of the char in
43 applet_opts string. For example, in the above case:
45 flags = bb_getopt_ulflags(argc, argv, "rnug");
47 "r" will add 1 (bit 1 : 0x01)
48 "n" will add 2 (bit 2 : 0x02)
49 "u will add 4 (bit 3 : 0x03)
50 "g" will add 8 (bit 4 : 0x04)
52 and so on. You can also look at the return value as a bit
53 field and each option sets one of bits.
55 ":" If one of the options requires an argument, then add a ":"
56 after the char in applet_opts and provide a pointer to store
57 the argument. For example:
59 char *pointer_to_arg_for_a;
60 char *pointer_to_arg_for_b;
61 char *pointer_to_arg_for_c;
62 char *pointer_to_arg_for_d;
64 flags = bb_getopt_ulflags(argc, argv, "a:b:c:d:",
65 &pointer_to_arg_for_a, &pointer_to_arg_for_b,
66 &pointer_to_arg_for_c, &pointer_to_arg_for_d);
68 The type of the pointer (char* or llist_t *) may be controlled
69 by the "::" special separator that is set in the external string
70 bb_opt_complementally (see below for more info).
72 static const struct option bb_default_long_options[]
74 This struct allows you to define long options. The syntax for
75 declaring the array is just like that of getopt's longopts.
78 static const struct option applet_long_options[] = {
79 { "verbose", 0, 0, v },
82 bb_applet_long_options = applet_long_options;
84 The last argument (val) can undefined from applet_opts.
85 If you use this, then:
86 - return bit have next position after short options
87 - if has_arg is not "no_argument", use ptr for arg also
88 - bb_opt_complementally have effects for this too
90 Note: a good applet will make long options configurable via the
91 config process and not a required feature. The current standard
92 is to name the config option CONFIG_FEATURE_<applet>_LONG_OPTIONS.
94 const char *bb_opt_complementally
96 ":" The colon (":") is used to separate groups of two or more chars
97 and/or groups of chars and special characters (stating some
98 conditions to be checked).
100 "abc" If groups of two or more chars are specified, the first char
101 is the main option and the other chars are secondary options.
102 Their flags will be turned on if the main option is found even
103 if they are not specifed on the command line. For example:
105 bb_opt_complementally = "abc";
107 flags = bb_getopt_ulflags(argc, argv, "abcd")
109 If getopt() finds "-a" on the command line, then
110 bb_getopt_ulflags's return value will be as if "-a -b -c" were
113 "ww" Adjacent double options have a counter associated which indicates
114 the number of occurances of the option.
115 For example the ps applet needs:
116 if w is given once, GNU ps sets the width to 132,
117 if w is given more than once, it is "unlimited"
120 bb_opt_complementally = "ww";
121 bb_getopt_ulflags(argc, argv, "w", &w_counter);
124 width = (w_counter == 1) ? 132 : INT_MAX;
126 get_terminal_width(...&width...);
128 w_counter is a pointer to an integer. It has to be passed to
129 bb_getopt_ulflags() after all other option argument sinks.
130 For example: accept multiple -v to indicate the level of verbosity
131 and for each -b optarg, add optarg to my_b. Finally, if b is given,
132 turn off c and vice versa:
134 llist_t *my_b = NULL;
135 int verbose_level = 0;
136 bb_opt_complementally = "vv:b::b-c:c-b";
137 f = bb_getopt_ulflags(argc, argv, "vb:c", &my_b, &verbose_level);
138 if((f & 2)) // -c after -b unset this -b flag
139 while (my_b) { dosomething_with(my_b->data) ; my_b = my_b->link; }
140 if(my_b) // but llist stored always if -b found
142 if (verbose_level) bb_printf("verbose level is %d\n", verbose_level);
146 "-" A dash between two options causes the second of the two
147 to be unset (and ignored or triggered) if it is given on
151 The du applet has the options "-s" and "-d depth". If
152 bb_getopt_ulflags finds -s, then -d is unset or if it finds -d
153 then -s is unset. (Note: busybox implements the GNU
154 "--max-depth" option as "-d".) To obtain this behavior, you
155 set bb_opt_complementally = "s-d:d-s". Only one flag value is
156 added to bb_getopt_ulflags's return value depending on the
157 position of the options on the command line. If one of the
158 two options requires an argument pointer (":" in applet_opts
159 as in "d:") optarg is set accordingly.
161 char *smax_print_depth;
163 bb_opt_complementally = "s-d:d-s:x-x";
164 opt = bb_getopt_ulflags(argc, argv, "sd:x", &smax_print_depth);
167 max_print_depth = atoi(smax_print_depth);
170 printf("Detected odd -x usaging\n");
172 "-" A dash as the first char in a bb_opt_complementally group means to
173 convert the arguments as option. Next char for this case can`t set
174 [0-9], recomended use ':' or end of line. For example:
176 bb_opt_complementally = "-:w-x:x-w";
177 bb_getopt_ulflags(argc, argv, "wx");
179 Allows any arguments to be given without a dash (./program w x)
180 as well as with a dash (./program -x). Why unset -w see above.
182 "-N" A dash as the first char in a bb_opt_complementally group with
183 number 0-9 as one char is means check minimal arguments required.
185 "--" A double dash between two options, or between an option and a group
186 of options, means that they are mutually exclusive. Unlike
187 the "-" case above, an error will be forced if the options
191 The cut applet must have only one type of list specified, so
192 -b, -c and -f are mutally exclusive and should raise an error
193 if specified together. In this case you must set
194 bb_opt_complementally = "b--cf:c--bf:f--bc". If two of the
195 mutually exclusive options are found, bb_getopt_ulflags's
196 return value will have the error flag set (BB_GETOPT_ERROR) so
197 that we can check for it:
199 if (flags & BB_GETOPT_ERROR)
202 "?" A "ask" as the first char in a bb_opt_complementally group give:
203 if previous point set BB_GETOPT_ERROR, don`t return and
204 call previous example internally. Next char for this case can`t
205 set to [0-9], recomended use ':' or end of line.
207 "?N" A "ask" as the first char in a bb_opt_complementally group with
208 number 0-9 as one char is means check maximal arguments possible.
210 "::" A double colon after a char in bb_opt_complementally means that the
211 option can occur multiple times:
214 The grep applet can have one or more "-e pattern" arguments.
215 In this case you should use bb_getopt_ulflags() as follows:
217 llist_t *patterns = NULL;
219 (this pointer must be initializated to NULL if the list is empty
220 as required by *llist_add_to(llist_t *old_head, char *new_item).)
222 bb_opt_complementally = "e::";
224 bb_getopt_ulflags(argc, argv, "e:", &patterns);
225 $ grep -e user -e root /etc/passwd
226 root:x:0:0:root:/root:/bin/bash
227 user:x:500:500::/home/user:/bin/bash
229 "--" A double dash as the first char in a bb_opt_complementally group
230 means make first argv[1] as option always as may be added -, special
231 for "ar" and "tar" applets.
233 "?" A "ask" between main and group options causes the second of the two
234 to be depending required as or if first is given on the command line.
235 For example from "id" applet:
237 // Don't allow -n -r -rn -ug -rug -nug -rnug
238 bb_opt_complementally = "r?ug:n?ug:?u--g:g--u";
239 flags = bb_getopt_ulflags(argc, argv, "rnug");
241 This example allowed only:
242 $ id; id -u; id -g; id -ru; id -nu; id -rg; id -ng; id -rnu; id -rng
244 "X" A one options in bb_opt_complementally group means
245 requires this option always with "or" logic if more one specified,
246 checked after switch off from complementally logic.
247 For example from "start-stop-daemon" applet:
249 // Don't allow -KS -SK, but -S or -K required
250 bb_opt_complementally = "K:S:?K--S:S--K";
251 flags = bb_getopt_ulflags(argc, argv, "KS...);
254 "x--x" give error if double or more used -x option
256 Don`t forget ':' store. For example "?322-22-23X-x-a" interpretet as
257 "?3:22:-2:2-2:2-3Xa:2--x": max args is 3, count -2 usaged, min args is 2,
258 -2 option triggered, unset -3 and -X and -a if -2 any usaged, give error if
259 after -2 the -x option usaged.
263 const char *bb_opt_complementally;
268 unsigned long switch_on;
269 unsigned long switch_off;
270 unsigned long incongruously;
271 unsigned long requires;
272 void **optarg; /* char **optarg or llist_t **optarg */
276 /* You can set bb_applet_long_options for parse called long options */
278 static const struct option bb_default_long_options[] = {
279 /* { "help", 0, NULL, '?' }, */
283 const struct option *bb_applet_long_options = bb_default_long_options;
286 bb_getopt_ulflags (int argc, char **argv, const char *applet_opts, ...)
288 unsigned long flags = 0;
289 unsigned long requires = 0;
290 t_complementally complementally[sizeof(flags) * 8 + 1];
292 const unsigned char *s;
293 t_complementally *on_off;
295 const struct option *l_o;
296 unsigned long trigger;
303 #define SHOW_USAGE_IF_ERROR 1
304 #define ALL_ARGV_IS_OPTS 2
305 #define FIRST_ARGV_IS_OPT 4
306 #define FREE_FIRST_ARGV_IS_OPT 8
309 va_start (p, applet_opts);
312 on_off = complementally;
313 memset(on_off, 0, sizeof(complementally));
315 /* skip GNU extension */
316 s = (const unsigned char *)applet_opts;
317 if(*s == '+' || *s == '-')
320 if(c >= (int)(sizeof(flags)*8))
323 on_off->switch_on = (1 << c);
325 on_off->optarg = va_arg (p, void **);
334 for(l_o = bb_applet_long_options; l_o->name; l_o++) {
337 for(on_off = complementally; on_off->opt != 0; on_off++)
338 if(on_off->opt == l_o->val)
340 if(on_off->opt == 0) {
341 if(c >= (int)(sizeof(flags)*8))
343 on_off->opt = l_o->val;
344 on_off->switch_on = (1 << c);
345 if(l_o->has_arg != no_argument)
346 on_off->optarg = va_arg (p, void **);
350 for (s = (const unsigned char *)bb_opt_complementally; s && *s; s++) {
351 t_complementally *pair;
352 unsigned long *pair_switch;
358 if(c < '0' || c > '9') {
359 spec_flgs |= SHOW_USAGE_IF_ERROR;
367 if(c < '0' || c > '9') {
369 spec_flgs |= FIRST_ARGV_IS_OPT;
372 spec_flgs |= ALL_ARGV_IS_OPTS;
379 for (on_off = complementally; on_off->opt; on_off++)
380 if (on_off->opt == *s)
382 if(c == ':' && s[2] == ':') {
386 if(c == ':' || c == '\0') {
387 requires |= on_off->switch_on;
391 on_off->counter = va_arg (p, int *);
395 pair_switch = &(pair->switch_on);
396 for(s++; *s && *s != ':'; s++) {
398 pair_switch = &(pair->requires);
399 } else if (*s == '-') {
400 if(pair_switch == &(pair->switch_off))
401 pair_switch = &(pair->incongruously);
403 pair_switch = &(pair->switch_off);
405 for (on_off = complementally; on_off->opt; on_off++)
406 if (on_off->opt == *s) {
407 *pair_switch |= on_off->switch_on;
416 #if defined(CONFIG_AR) || defined(CONFIG_TAR)
417 if((spec_flgs & FIRST_ARGV_IS_OPT)) {
418 if(argv[1] && argv[1][0] != '-' && argv[1][0] != '\0') {
419 argv[1] = bb_xasprintf("-%s", argv[1]);
420 if(ENABLE_FEATURE_CLEAN_UP)
421 spec_flgs |= FREE_FIRST_ARGV_IS_OPT;
425 while ((c = getopt_long (argc, argv, applet_opts,
426 bb_applet_long_options, NULL)) >= 0) {
430 for (on_off = complementally; on_off->opt != c; on_off++) {
431 /* c==0 if long opt have non NULL flag */
432 if(on_off->opt == 0 && c != 0)
435 if(flags & on_off->incongruously) {
436 if((spec_flgs & SHOW_USAGE_IF_ERROR))
438 flags |= BB_GETOPT_ERROR;
440 trigger = on_off->switch_on & on_off->switch_off;
441 flags &= ~(on_off->switch_off ^ trigger);
442 flags |= on_off->switch_on ^ trigger;
445 (*(on_off->counter))++;
446 if(on_off->list_flg) {
447 *(llist_t **)(on_off->optarg) =
448 llist_add_to(*(llist_t **)(on_off->optarg), optarg);
449 } else if (on_off->optarg) {
450 *(char **)(on_off->optarg) = optarg;
459 if((spec_flgs & ALL_ARGV_IS_OPTS)) {
460 /* process argv is option, for example "ps" applet */
462 pargv = argv + optind;
469 goto loop_arg_is_opt;
475 #if (defined(CONFIG_AR) || defined(CONFIG_TAR)) && \
476 defined(CONFIG_FEATURE_CLEAN_UP)
477 if((spec_flgs & FREE_FIRST_ARGV_IS_OPT))
480 /* check depending requires for given options */
481 for (on_off = complementally; on_off->opt; on_off++) {
482 if(on_off->requires && (flags & on_off->switch_on) &&
483 (flags & on_off->requires) == 0)
486 if(requires && (flags & requires) == 0)
489 if(argc < min_arg || (max_arg >= 0 && argc > max_arg))