blob: 2f2f0b9e9afa57459684f6228a4b970a7c9f8961 [file] [log] [blame]
Manuel Novoa III cad53642003-03-19 09:13:01 +00001/* vi: set sw=4 ts=4: */
2/*
Denis Vlasenko67b23e62006-10-03 21:00:06 +00003 * universal getopt32 implementation for busybox
Manuel Novoa III cad53642003-03-19 09:13:01 +00004 *
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +00005 * Copyright (C) 2003-2005 Vladimir Oleynik <dzo@simtreas.ru>
Manuel Novoa III cad53642003-03-19 09:13:01 +00006 *
"Robert P. J. Day"5d8843e2006-07-10 11:41:19 +00007 * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
Manuel Novoa III cad53642003-03-19 09:13:01 +00008 */
9
Manuel Novoa III cad53642003-03-19 09:13:01 +000010#include "libbb.h"
Rob Landleyd921b2e2006-08-03 15:41:12 +000011#include <getopt.h>
Manuel Novoa III cad53642003-03-19 09:13:01 +000012
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000013/* Documentation
Mike Frysinger2bf88a82005-04-18 22:42:58 +000014
Denis Vlasenko67b23e62006-10-03 21:00:06 +000015uint32_t
16getopt32(int argc, char **argv, const char *applet_opts, ...)
Mike Frysinger2bf88a82005-04-18 22:42:58 +000017
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000018 The command line options must be declared in const char
19 *applet_opts as a string of chars, for example:
Mike Frysinger2bf88a82005-04-18 22:42:58 +000020
Denis Vlasenko67b23e62006-10-03 21:00:06 +000021 flags = getopt32(argc, argv, "rnug");
Mike Frysinger2bf88a82005-04-18 22:42:58 +000022
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000023 If one of the given options is found, a flag value is added to
24 the return value (an unsigned long).
Mike Frysinger2bf88a82005-04-18 22:42:58 +000025
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000026 The flag value is determined by the position of the char in
27 applet_opts string. For example, in the above case:
Mike Frysinger2bf88a82005-04-18 22:42:58 +000028
Denis Vlasenko67b23e62006-10-03 21:00:06 +000029 flags = getopt32(argc, argv, "rnug");
Mike Frysinger2bf88a82005-04-18 22:42:58 +000030
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000031 "r" will add 1 (bit 0)
32 "n" will add 2 (bit 1)
33 "u will add 4 (bit 2)
34 "g" will add 8 (bit 3)
Mike Frysinger2bf88a82005-04-18 22:42:58 +000035
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000036 and so on. You can also look at the return value as a bit
37 field and each option sets one bit.
Mike Frysinger2bf88a82005-04-18 22:42:58 +000038
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000039 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]).
Denis Vlasenko65dbd872006-09-03 12:27:25 +000045
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +000046 ":" If one of the options requires an argument, then add a ":"
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000047 after the char in applet_opts and provide a pointer to store
48 the argument. For example:
Mike Frysinger2bf88a82005-04-18 22:42:58 +000049
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000050 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;
Mike Frysinger2bf88a82005-04-18 22:42:58 +000054
Denis Vlasenko67b23e62006-10-03 21:00:06 +000055 flags = getopt32(argc, argv, "a:b:c:d:",
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000056 &pointer_to_arg_for_a, &pointer_to_arg_for_b,
57 &pointer_to_arg_for_c, &pointer_to_arg_for_d);
Mike Frysinger2bf88a82005-04-18 22:42:58 +000058
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000059 The type of the pointer (char* or llist_t*) may be controlled
60 by the "::" special separator that is set in the external string
Denis Vlasenko67b23e62006-10-03 21:00:06 +000061 opt_complementary (see below for more info).
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000062
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.
Mike Frysingere5d0bde2005-05-10 23:48:35 +000067
Mike Frysinger992a58c2006-02-22 22:56:30 +000068 "+" If the first character in the applet_opts string is a plus,
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000069 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:
72 env -i ls -d /
73 Here we want env to process just the '-i', not the '-d'.
Mike Frysinger992a58c2006-02-22 22:56:30 +000074
Denis Vlasenko67b23e62006-10-03 21:00:06 +000075const struct option *applet_long_options
Mike Frysingere5d0bde2005-05-10 23:48:35 +000076
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000077 This struct allows you to define long options. The syntax for
78 declaring the array is just like that of getopt's longopts.
79 (see getopt(3))
Mike Frysingere5d0bde2005-05-10 23:48:35 +000080
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000081 static const struct option applet_long_options[] = {
82 //name,has_arg,flag,val
83 { "verbose", 0, 0, 'v' },
84 { 0, 0, 0, 0 }
85 };
Denis Vlasenko67b23e62006-10-03 21:00:06 +000086 applet_long_options = applet_long_options;
Mike Frysingere5d0bde2005-05-10 23:48:35 +000087
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000088 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
Denis Vlasenko67b23e62006-10-03 21:00:06 +000093 - opt_complementary affects it too
Mike Frysingerfb6d22c2005-05-11 00:02:39 +000094
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000095 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.
Mike Frysingerfb6d22c2005-05-11 00:02:39 +000098
Denis Vlasenko67b23e62006-10-03 21:00:06 +000099const char *opt_complementary
Mike Frysingerfb6d22c2005-05-11 00:02:39 +0000100
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000101 ":" The colon (":") is used to separate groups of two or more chars
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000102 and/or groups of chars and special characters (stating some
103 conditions to be checked).
Mike Frysingere5d0bde2005-05-10 23:48:35 +0000104
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000105 "abc" If groups of two or more chars are specified, the first char
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000106 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:
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000109
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000110 opt_complementary = "abc";
111 flags = getopt32(argc, argv, "abcd")
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000112
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000113 If getopt() finds "-a" on the command line, then
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000114 getopt32's return value will be as if "-a -b -c" were
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000115 found.
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000116
Bernhard Reutner-Fischer43fb3fc2005-10-05 12:23:13 +0000117 "ww" Adjacent double options have a counter associated which indicates
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000118 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"
"Vladimir N. Oleynik"be0ed3d2005-10-04 16:48:26 +0000122
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000123 int w_counter = 0;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000124 opt_complementary = "ww";
125 getopt32(argc, argv, "w", &w_counter);
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000126 if (w_counter)
127 width = (w_counter == 1) ? 132 : INT_MAX;
128 else
129 get_terminal_width(...&width...);
"Vladimir N. Oleynik"be0ed3d2005-10-04 16:48:26 +0000130
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000131 w_counter is a pointer to an integer. It has to be passed to
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000132 getopt32() after all other option argument sinks.
Denis Vlasenko6429aab2006-09-23 12:22:11 +0000133
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000134 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:
Bernhard Reutner-Fischer43fb3fc2005-10-05 12:23:13 +0000137
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000138 llist_t *my_b = NULL;
139 int verbose_level = 0;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000140 opt_complementary = "vv:b::b-c:c-b";
141 f = getopt32(argc, argv, "vb:c", &my_b, &verbose_level);
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000142 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
145 free_llist(my_b);
146 if (verbose_level) bb_printf("verbose level is %d\n", verbose_level);
"Vladimir N. Oleynik"be0ed3d2005-10-04 16:48:26 +0000147
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000148Special characters:
149
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000150 "-" A dash between two options causes the second of the two
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000151 to be unset (and ignored) if it is given on the command line.
Rob Landleyf76cd962006-05-03 21:23:15 +0000152
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000153 [FIXME: what if they are the same? like "x-x"? Is it ever useful?]
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000154
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000155 For example:
156 The du applet has the options "-s" and "-d depth". If
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000157 getopt32 finds -s, then -d is unset or if it finds -d
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000158 then -s is unset. (Note: busybox implements the GNU
159 "--max-depth" option as "-d".) To obtain this behavior, you
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000160 set opt_complementary = "s-d:d-s". Only one flag value is
161 added to getopt32's return value depending on the
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000162 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.
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000165
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000166 char *smax_print_depth;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000167
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000168 opt_complementary = "s-d:d-s:x-x";
169 opt = getopt32(argc, argv, "sd:x", &smax_print_depth);
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000170
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000171 if (opt & 2)
172 max_print_depth = atoi(smax_print_depth);
173 if (opt & 4)
174 printf("Detected odd -x usage\n");
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000175
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000176 "-" A dash as the first char in a opt_complementary group forces
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000177 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:
Bernhard Reutner-Fischer43fb3fc2005-10-05 12:23:13 +0000180
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000181 opt_complementary = "-:w-x:x-w";
182 getopt32(argc, argv, "wx");
Bernhard Reutner-Fischer43fb3fc2005-10-05 12:23:13 +0000183
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000184 Allows any arguments to be given without a dash (./program w x)
185 as well as with a dash (./program -x).
Bernhard Reutner-Fischer43fb3fc2005-10-05 12:23:13 +0000186
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000187 "-N" A dash as the first char in a opt_complementary group followed
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000188 by a single digit (0-9) means that at least N non-option
189 arguments must be present on the command line
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000190
Rob Landleyf76cd962006-05-03 21:23:15 +0000191 "V-" An option with dash before colon or end-of-line results in
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000192 bb_show_usage being called if this option is encountered.
193 This is typically used to implement "print verbose usage message
194 and exit" option.
"Vladimir N. Oleynik"4fc92202006-02-02 14:48:54 +0000195
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000196 "--" A double dash between two options, or between an option and a group
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000197 of options, means that they are mutually exclusive. Unlike
198 the "-" case above, an error will be forced if the options
199 are used together.
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000200
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000201 For example:
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
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000205 opt_complementary = "b--cf:c--bf:f--bc". If two of the
206 mutually exclusive options are found, getopt32's
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000207 return value will have the error flag set (BB_GETOPT_ERROR) so
208 that we can check for it:
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000209
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000210 if (flags & BB_GETOPT_ERROR)
211 bb_show_usage();
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000212
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000213 "x--x" Variation of the above, it means that -x option should occur
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000214 at most once.
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000215
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000216 "?" A "?" as the first char in a opt_complementary group means:
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000217 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.
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000219
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000220 "?N" A "?" as the first char in a opt_complementary group followed
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000221 by a single digit (0-9) means that at most N arguments must be present
222 on the command line.
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000223
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000224 "::" A double colon after a char in opt_complementary means that the
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000225 option can occur multiple times. Each occurrence will be saved as
226 a llist_t element instead of char*.
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000227
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000228 For example:
229 The grep applet can have one or more "-e pattern" arguments.
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000230 In this case you should use getopt32() as follows:
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000231
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000232 llist_t *patterns = NULL;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000233
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000234 (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).)
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000236
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000237 opt_complementary = "e::";
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000238
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000239 getopt32(argc, argv, "e:", &patterns);
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000240 $ 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
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000243
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000244 "--" A double dash at the beginning of opt_complementary means the
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000245 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":
248 tar xvf foo.tar
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000249
Rob Landleyf76cd962006-05-03 21:23:15 +0000250 "?" An "?" between an option and a group of options means that
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000251 at least one of them is required to occur if the first option
252 occurs in preceding command line arguments.
Rob Landleyf76cd962006-05-03 21:23:15 +0000253
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000254 For example from "id" applet:
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000255
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000256 // Don't allow -n -r -rn -ug -rug -nug -rnug
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000257 opt_complementary = "r?ug:n?ug:?u--g:g--u";
258 flags = getopt32(argc, argv, "rnug");
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000259
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000260 This example allowed only:
261 $ id; id -u; id -g; id -ru; id -nu; id -rg; id -ng; id -rnu; id -rng
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000262
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000263 "X" A opt_complementary group with just a single letter means
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000264 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:
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000267
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000268 // Don't allow -KS -SK, but -S or -K is required
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000269 opt_complementary = "K:S:?K--S:S--K";
270 flags = getopt32(argc, argv, "KS...);
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000271
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000272
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000273 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.
Eric Andersen8876fb22003-06-20 09:01:58 +0000278*/
279
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000280/* Code here assumes that 'unsigned' is at least 32 bits wide */
281
282const char *opt_complementary;
Eric Andersen8876fb22003-06-20 09:01:58 +0000283
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000284typedef struct {
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000285 int opt;
286 int list_flg;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000287 unsigned switch_on;
288 unsigned switch_off;
289 unsigned incongruously;
290 unsigned requires;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000291 void **optarg; /* char **optarg or llist_t **optarg */
"Vladimir N. Oleynik"be0ed3d2005-10-04 16:48:26 +0000292 int *counter;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000293} t_complementary;
Eric Andersen8876fb22003-06-20 09:01:58 +0000294
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000295/* You can set applet_long_options for parse called long options */
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000296#if ENABLE_GETOPT_LONG
Eric Andersen8876fb22003-06-20 09:01:58 +0000297static const struct option bb_default_long_options[] = {
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000298/* { "help", 0, NULL, '?' }, */
Eric Andersen8876fb22003-06-20 09:01:58 +0000299 { 0, 0, 0, 0 }
300};
301
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000302const struct option *applet_long_options = bb_default_long_options;
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000303#endif
Eric Andersen8876fb22003-06-20 09:01:58 +0000304
Denis Vlasenkoc12f5302006-10-06 09:49:47 +0000305uint32_t option_mask32;
306
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000307uint32_t
308getopt32(int argc, char **argv, const char *applet_opts, ...)
Manuel Novoa III cad53642003-03-19 09:13:01 +0000309{
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000310 unsigned flags = 0;
311 unsigned requires = 0;
312 t_complementary complementary[sizeof(flags) * 8 + 1];
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000313 int c;
314 const unsigned char *s;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000315 t_complementary *on_off;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000316 va_list p;
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000317#if ENABLE_GETOPT_LONG
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000318 const struct option *l_o;
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000319#endif
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000320 unsigned trigger;
"Vladimir N. Oleynik"35939d92005-10-05 10:52:47 +0000321 char **pargv = NULL;
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000322 int min_arg = 0;
323 int max_arg = -1;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000324
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000325#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
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000329 int spec_flgs = 0;
330
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000331 va_start(p, applet_opts);
Eric Andersen8876fb22003-06-20 09:01:58 +0000332
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000333 c = 0;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000334 on_off = complementary;
335 memset(on_off, 0, sizeof(complementary));
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000336
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000337 /* skip GNU extension */
"Vladimir N. Oleynik"bf968f72005-12-02 10:10:28 +0000338 s = (const unsigned char *)applet_opts;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000339 if (*s == '+' || *s == '-')
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000340 s++;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000341 for (; *s; s++) {
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000342 if (c >= (int)(sizeof(flags)*8))
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000343 break;
344 on_off->opt = *s;
345 on_off->switch_on = (1 << c);
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000346 if (s[1] == ':') {
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000347 on_off->optarg = va_arg(p, void **);
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000348 do
349 s++;
350 while (s[1] == ':');
351 }
352 on_off++;
353 c++;
Eric Andersen8876fb22003-06-20 09:01:58 +0000354 }
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000355
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000356#if ENABLE_GETOPT_LONG
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000357 for (l_o = applet_long_options; l_o->name; l_o++) {
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000358 if (l_o->flag)
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000359 continue;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000360 for (on_off = complementary; on_off->opt != 0; on_off++)
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000361 if (on_off->opt == l_o->val)
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000362 break;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000363 if (on_off->opt == 0) {
364 if (c >= (int)(sizeof(flags)*8))
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000365 break;
366 on_off->opt = l_o->val;
367 on_off->switch_on = (1 << c);
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000368 if (l_o->has_arg != no_argument)
369 on_off->optarg = va_arg(p, void **);
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000370 c++;
371 }
372 }
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000373#endif /* ENABLE_GETOPT_LONG */
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000374 for (s = (const unsigned char *)opt_complementary; s && *s; s++) {
375 t_complementary *pair;
376 unsigned *pair_switch;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000377
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000378 if (*s == ':')
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000379 continue;
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000380 c = s[1];
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000381 if (*s == '?') {
382 if (c < '0' || c > '9') {
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000383 spec_flgs |= SHOW_USAGE_IF_ERROR;
384 } else {
385 max_arg = c - '0';
386 s++;
387 }
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000388 continue;
389 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000390 if (*s == '-') {
391 if (c < '0' || c > '9') {
392 if (c == '-') {
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000393 spec_flgs |= FIRST_ARGV_IS_OPT;
394 s++;
395 } else
396 spec_flgs |= ALL_ARGV_IS_OPTS;
397 } else {
398 min_arg = c - '0';
399 s++;
400 }
"Vladimir N. Oleynik"35939d92005-10-05 10:52:47 +0000401 continue;
402 }
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000403 for (on_off = complementary; on_off->opt; on_off++)
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000404 if (on_off->opt == *s)
405 break;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000406 if (c == ':' && s[2] == ':') {
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000407 on_off->list_flg++;
408 continue;
409 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000410 if (c == ':' || c == '\0') {
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000411 requires |= on_off->switch_on;
412 continue;
413 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000414 if (c == '-' && (s[2] == ':' || s[2] == '\0')) {
"Vladimir N. Oleynik"4fc92202006-02-02 14:48:54 +0000415 flags |= on_off->switch_on;
416 on_off->incongruously |= on_off->switch_on;
417 s++;
418 continue;
419 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000420 if (c == *s) {
421 on_off->counter = va_arg(p, int *);
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000422 s++;
423 }
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000424 pair = on_off;
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000425 pair_switch = &(pair->switch_on);
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000426 for (s++; *s && *s != ':'; s++) {
427 if (*s == '?') {
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000428 pair_switch = &(pair->requires);
429 } else if (*s == '-') {
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000430 if (pair_switch == &(pair->switch_off))
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000431 pair_switch = &(pair->incongruously);
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000432 else
433 pair_switch = &(pair->switch_off);
434 } else {
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000435 for (on_off = complementary; on_off->opt; on_off++)
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000436 if (on_off->opt == *s) {
437 *pair_switch |= on_off->switch_on;
438 break;
439 }
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000440 }
441 }
442 s--;
Eric Andersen8876fb22003-06-20 09:01:58 +0000443 }
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000444 va_end (p);
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000445
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000446#if ENABLE_AR || ENABLE_TAR
447 if (spec_flgs & FIRST_ARGV_IS_OPT) {
448 if (argv[1] && argv[1][0] != '-' && argv[1][0] != '\0') {
Rob Landleyd921b2e2006-08-03 15:41:12 +0000449 argv[1] = xasprintf("-%s", argv[1]);
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000450 if (ENABLE_FEATURE_CLEAN_UP)
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000451 spec_flgs |= FREE_FIRST_ARGV_IS_OPT;
452 }
453 }
454#endif
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000455#if ENABLE_GETOPT_LONG
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000456 while ((c = getopt_long(argc, argv, applet_opts,
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000457 applet_long_options, NULL)) >= 0) {
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000458#else
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000459 while ((c = getopt(argc, argv, applet_opts)) >= 0) {
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000460#endif /* ENABLE_GETOPT_LONG */
"Vladimir N. Oleynik"35939d92005-10-05 10:52:47 +0000461loop_arg_is_opt:
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000462 for (on_off = complementary; on_off->opt != c; on_off++) {
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000463 /* c==0 if long opt have non NULL flag */
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000464 if (on_off->opt == 0 && c != 0)
465 bb_show_usage();
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000466 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000467 if (flags & on_off->incongruously) {
468 if ((spec_flgs & SHOW_USAGE_IF_ERROR))
469 bb_show_usage();
Mike Frysinger348e84c2005-05-11 00:39:03 +0000470 flags |= BB_GETOPT_ERROR;
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000471 }
"Vladimir N. Oleynik"45a8ed82005-09-06 16:08:33 +0000472 trigger = on_off->switch_on & on_off->switch_off;
473 flags &= ~(on_off->switch_off ^ trigger);
474 flags |= on_off->switch_on ^ trigger;
475 flags ^= trigger;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000476 if (on_off->counter)
"Vladimir N. Oleynik"be0ed3d2005-10-04 16:48:26 +0000477 (*(on_off->counter))++;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000478 if (on_off->list_flg) {
Rob Landley8bb50782006-05-26 23:44:51 +0000479 llist_add_to((llist_t **)(on_off->optarg), optarg);
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000480 } else if (on_off->optarg) {
481 *(char **)(on_off->optarg) = optarg;
482 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000483 if (pargv != NULL)
"Vladimir N. Oleynik"35939d92005-10-05 10:52:47 +0000484 break;
485 }
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000486
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000487 if (spec_flgs & ALL_ARGV_IS_OPTS) {
"Vladimir N. Oleynik"35939d92005-10-05 10:52:47 +0000488 /* process argv is option, for example "ps" applet */
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000489 if (pargv == NULL)
"Vladimir N. Oleynik"35939d92005-10-05 10:52:47 +0000490 pargv = argv + optind;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000491 while (*pargv) {
"Vladimir N. Oleynik"35939d92005-10-05 10:52:47 +0000492 c = **pargv;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000493 if (c == '\0') {
"Vladimir N. Oleynik"35939d92005-10-05 10:52:47 +0000494 pargv++;
495 } else {
496 (*pargv)++;
497 goto loop_arg_is_opt;
498 }
499 }
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000500 }
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000501
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000502#if (ENABLE_AR || ENABLE_TAR) && ENABLE_FEATURE_CLEAN_UP
503 if (spec_flgs & FREE_FIRST_ARGV_IS_OPT)
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000504 free(argv[1]);
505#endif
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000506 /* check depending requires for given options */
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000507 for (on_off = complementary; on_off->opt; on_off++) {
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000508 if (on_off->requires && (flags & on_off->switch_on) &&
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000509 (flags & on_off->requires) == 0)
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000510 bb_show_usage();
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000511 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000512 if (requires && (flags & requires) == 0)
513 bb_show_usage();
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000514 argc -= optind;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000515 if (argc < min_arg || (max_arg >= 0 && argc > max_arg))
516 bb_show_usage();
Denis Vlasenkoc12f5302006-10-06 09:49:47 +0000517
518 option_mask32 = flags;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000519 return flags;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000520}