blob: 80d5d282252c53a1e95a78ff5db29a52e70a1c85 [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
Rob Landleyd921b2e2006-08-03 15:41:12 +000010#include <getopt.h>
Denis Vlasenkob6adbf12007-05-26 19:00:18 +000011#include "libbb.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
Denis Vlasenkofe7cd642007-08-18 15:32:12 +000016getopt32(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 Vlasenkofe7cd642007-08-18 15:32:12 +000021 flags = getopt32(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 Vlasenkofe7cd642007-08-18 15:32:12 +000029 flags = getopt32(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)
Denis Vlasenkoab8c9372007-09-28 22:13:55 +000033 "u" will add 4 (bit 2)
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000034 "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 Vlasenkofe7cd642007-08-18 15:32:12 +000055 flags = getopt32(argv, "a:b:c:d:",
Denis Vlasenko6a2f7f42007-08-16 10:35:17 +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 Vlasenkobdc88fd2007-07-23 17:14:14 +000075const char *applet_long_options
Mike Frysingere5d0bde2005-05-10 23:48:35 +000076
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +000077 This struct allows you to define long options:
Mike Frysingere5d0bde2005-05-10 23:48:35 +000078
Denis Vlasenko6ca409e2007-08-12 20:58:27 +000079 static const char applet_longopts[] ALIGN1 =
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +000080 //"name\0" has_arg val
81 "verbose\0" No_argument "v"
Denis Vlasenko990d0f62007-07-24 15:54:42 +000082 ;
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +000083 applet_long_options = applet_longopts;
Mike Frysingere5d0bde2005-05-10 23:48:35 +000084
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000085 The last member of struct option (val) typically is set to
86 matching short option from applet_opts. If there is no matching
87 char in applet_opts, then:
88 - return bit have next position after short options
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +000089 - if has_arg is not "No_argument", use ptr for arg also
Denis Vlasenko67b23e62006-10-03 21:00:06 +000090 - opt_complementary affects it too
Mike Frysingerfb6d22c2005-05-11 00:02:39 +000091
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000092 Note: a good applet will make long options configurable via the
93 config process and not a required feature. The current standard
94 is to name the config option CONFIG_FEATURE_<applet>_LONG_OPTIONS.
Mike Frysingerfb6d22c2005-05-11 00:02:39 +000095
Denis Vlasenko67b23e62006-10-03 21:00:06 +000096const char *opt_complementary
Mike Frysingerfb6d22c2005-05-11 00:02:39 +000097
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +000098 ":" The colon (":") is used to separate groups of two or more chars
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +000099 and/or groups of chars and special characters (stating some
100 conditions to be checked).
Mike Frysingere5d0bde2005-05-10 23:48:35 +0000101
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000102 "abc" If groups of two or more chars are specified, the first char
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000103 is the main option and the other chars are secondary options.
104 Their flags will be turned on if the main option is found even
105 if they are not specifed on the command line. For example:
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000106
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000107 opt_complementary = "abc";
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000108 flags = getopt32(argv, "abcd")
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000109
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000110 If getopt() finds "-a" on the command line, then
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000111 getopt32's return value will be as if "-a -b -c" were
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000112 found.
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000113
Bernhard Reutner-Fischer43fb3fc2005-10-05 12:23:13 +0000114 "ww" Adjacent double options have a counter associated which indicates
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000115 the number of occurences of the option.
116 For example the ps applet needs:
117 if w is given once, GNU ps sets the width to 132,
118 if w is given more than once, it is "unlimited"
"Vladimir N. Oleynik"be0ed3d2005-10-04 16:48:26 +0000119
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000120 int w_counter = 0;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000121 opt_complementary = "ww";
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000122 getopt32(argv, "w", &w_counter);
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000123 if (w_counter)
Denis Vlasenko6a2f7f42007-08-16 10:35:17 +0000124 width = (w_counter == 1) ? 132 : INT_MAX;
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000125 else
Denis Vlasenko6a2f7f42007-08-16 10:35:17 +0000126 get_terminal_width(...&width...);
"Vladimir N. Oleynik"be0ed3d2005-10-04 16:48:26 +0000127
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000128 w_counter is a pointer to an integer. It has to be passed to
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000129 getopt32() after all other option argument sinks.
Denis Vlasenko6429aab2006-09-23 12:22:11 +0000130
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000131 For example: accept multiple -v to indicate the level of verbosity
132 and for each -b optarg, add optarg to my_b. Finally, if b is given,
133 turn off c and vice versa:
Bernhard Reutner-Fischer43fb3fc2005-10-05 12:23:13 +0000134
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000135 llist_t *my_b = NULL;
136 int verbose_level = 0;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000137 opt_complementary = "vv:b::b-c:c-b";
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000138 f = getopt32(argv, "vb:c", &my_b, &verbose_level);
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000139 if (f & 2) // -c after -b unsets -b flag
Denis Vlasenko6a2f7f42007-08-16 10:35:17 +0000140 while (my_b) { dosomething_with(my_b->data); my_b = my_b->link; }
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000141 if (my_b) // but llist is stored if -b is specified
Denis Vlasenko6a2f7f42007-08-16 10:35:17 +0000142 free_llist(my_b);
Denis Vlasenkof0ed3762006-10-26 23:21:47 +0000143 if (verbose_level) printf("verbose level is %d\n", verbose_level);
"Vladimir N. Oleynik"be0ed3d2005-10-04 16:48:26 +0000144
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000145Special characters:
146
Denis Vlasenkod031ffa2006-11-24 21:54:44 +0000147 "-" A dash as the first char in a opt_complementary group forces
148 all arguments to be treated as options, even if they have
149 no leading dashes. Next char in this case can't be a digit (0-9),
150 use ':' or end of line. For example:
151
152 opt_complementary = "-:w-x:x-w";
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000153 getopt32(argv, "wx");
Denis Vlasenkod031ffa2006-11-24 21:54:44 +0000154
155 Allows any arguments to be given without a dash (./program w x)
156 as well as with a dash (./program -x).
157
158 "--" A double dash at the beginning of opt_complementary means the
159 argv[1] string should always be treated as options, even if it isn't
160 prefixed with a "-". This is useful for special syntax in applets
161 such as "ar" and "tar":
162 tar xvf foo.tar
163
164 "-N" A dash as the first char in a opt_complementary group followed
165 by a single digit (0-9) means that at least N non-option
166 arguments must be present on the command line
167
168 "=N" An equal sign as the first char in a opt_complementary group followed
169 by a single digit (0-9) means that exactly N non-option
170 arguments must be present on the command line
171
172 "?N" A "?" as the first char in a opt_complementary group followed
173 by a single digit (0-9) means that at most N arguments must be present
174 on the command line.
175
176 "V-" An option with dash before colon or end-of-line results in
177 bb_show_usage being called if this option is encountered.
178 This is typically used to implement "print verbose usage message
179 and exit" option.
180
Denis Vlasenko6666ac42007-08-24 21:46:24 +0000181 "a-b" A dash between two options causes the second of the two
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000182 to be unset (and ignored) if it is given on the command line.
Rob Landleyf76cd962006-05-03 21:23:15 +0000183
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000184 [FIXME: what if they are the same? like "x-x"? Is it ever useful?]
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000185
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000186 For example:
187 The du applet has the options "-s" and "-d depth". If
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000188 getopt32 finds -s, then -d is unset or if it finds -d
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000189 then -s is unset. (Note: busybox implements the GNU
190 "--max-depth" option as "-d".) To obtain this behavior, you
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000191 set opt_complementary = "s-d:d-s". Only one flag value is
192 added to getopt32's return value depending on the
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000193 position of the options on the command line. If one of the
194 two options requires an argument pointer (":" in applet_opts
195 as in "d:") optarg is set accordingly.
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000196
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000197 char *smax_print_depth;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000198
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000199 opt_complementary = "s-d:d-s:x-x";
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000200 opt = getopt32(argv, "sd:x", &smax_print_depth);
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000201
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000202 if (opt & 2)
Denis Vlasenko6a2f7f42007-08-16 10:35:17 +0000203 max_print_depth = atoi(smax_print_depth);
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000204 if (opt & 4)
Denis Vlasenko6a2f7f42007-08-16 10:35:17 +0000205 printf("Detected odd -x usage\n");
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000206
Denis Vlasenko6666ac42007-08-24 21:46:24 +0000207 "a--b" A double dash between two options, or between an option and a group
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000208 of options, means that they are mutually exclusive. Unlike
209 the "-" case above, an error will be forced if the options
210 are used together.
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000211
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000212 For example:
213 The cut applet must have only one type of list specified, so
Denis Vlasenkoa0319ba2007-08-16 10:37:49 +0000214 -b, -c and -f are mutually exclusive and should raise an error
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000215 if specified together. In this case you must set
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000216 opt_complementary = "b--cf:c--bf:f--bc". If two of the
Denis Vlasenko09196572007-07-21 13:27:44 +0000217 mutually exclusive options are found, getopt32 will call
218 bb_show_usage() and die.
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000219
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000220 "x--x" Variation of the above, it means that -x option should occur
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000221 at most once.
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000222
Denis Vlasenko6666ac42007-08-24 21:46:24 +0000223 "a::" A double colon after a char in opt_complementary means that the
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000224 option can occur multiple times. Each occurrence will be saved as
225 a llist_t element instead of char*.
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000226
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000227 For example:
228 The grep applet can have one or more "-e pattern" arguments.
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000229 In this case you should use getopt32() as follows:
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000230
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000231 llist_t *patterns = NULL;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000232
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000233 (this pointer must be initializated to NULL if the list is empty
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000234 as required by llist_add_to_end(llist_t **old_head, char *new_item).)
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000235
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000236 opt_complementary = "e::";
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000237
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000238 getopt32(argv, "e:", &patterns);
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000239 $ grep -e user -e root /etc/passwd
240 root:x:0:0:root:/root:/bin/bash
241 user:x:500:500::/home/user:/bin/bash
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000242
Denis Vlasenko6666ac42007-08-24 21:46:24 +0000243 "a?b" A "?" between an option and a group of options means that
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000244 at least one of them is required to occur if the first option
245 occurs in preceding command line arguments.
Rob Landleyf76cd962006-05-03 21:23:15 +0000246
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000247 For example from "id" applet:
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000248
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000249 // Don't allow -n -r -rn -ug -rug -nug -rnug
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000250 opt_complementary = "r?ug:n?ug:?u--g:g--u";
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000251 flags = getopt32(argv, "rnug");
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000252
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000253 This example allowed only:
254 $ 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 +0000255
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000256 "X" A opt_complementary group with just a single letter means
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000257 that this option is required. If more than one such group exists,
258 at least one option is required to occur (not all of them).
259 For example from "start-stop-daemon" applet:
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000260
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000261 // Don't allow -KS -SK, but -S or -K is required
Denis Vlasenko6666ac42007-08-24 21:46:24 +0000262 opt_complementary = "K:S:K--S:S--K";
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000263 flags = getopt32(argv, "KS...);
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000264
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000265
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000266 Don't forget to use ':'. For example, "?322-22-23X-x-a"
267 is interpreted as "?3:22:-2:2-2:2-3Xa:2--x" -
268 max 3 args; count uses of '-2'; min 2 args; if there is
269 a '-2' option then unset '-3', '-X' and '-a'; if there is
270 a '-2' and after it a '-x' then error out.
Denis Vlasenko737d1312007-08-25 18:25:24 +0000271 But it's far too obfuscated. Use ':' to separate groups.
Eric Andersen8876fb22003-06-20 09:01:58 +0000272*/
273
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000274/* Code here assumes that 'unsigned' is at least 32 bits wide */
275
276const char *opt_complementary;
Eric Andersen8876fb22003-06-20 09:01:58 +0000277
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000278typedef struct {
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000279 int opt;
280 int list_flg;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000281 unsigned switch_on;
282 unsigned switch_off;
283 unsigned incongruously;
284 unsigned requires;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000285 void **optarg; /* char **optarg or llist_t **optarg */
"Vladimir N. Oleynik"be0ed3d2005-10-04 16:48:26 +0000286 int *counter;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000287} t_complementary;
Eric Andersen8876fb22003-06-20 09:01:58 +0000288
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000289/* You can set applet_long_options for parse called long options */
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000290#if ENABLE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000291static const struct option bb_null_long_options[1] = {
Eric Andersen8876fb22003-06-20 09:01:58 +0000292 { 0, 0, 0, 0 }
293};
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000294const char *applet_long_options;
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000295#endif
Eric Andersen8876fb22003-06-20 09:01:58 +0000296
Denis Vlasenkoc12f5302006-10-06 09:49:47 +0000297uint32_t option_mask32;
298
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000299uint32_t
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000300getopt32(char **argv, const char *applet_opts, ...)
Manuel Novoa III cad53642003-03-19 09:13:01 +0000301{
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000302 int argc;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000303 unsigned flags = 0;
304 unsigned requires = 0;
Denis Vlasenkoc8400a22006-10-25 00:33:44 +0000305 t_complementary complementary[33];
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000306 int c;
307 const unsigned char *s;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000308 t_complementary *on_off;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000309 va_list p;
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000310#if ENABLE_GETOPT_LONG
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000311 const struct option *l_o;
Denis Vlasenko5bfcb4d2007-07-23 17:40:35 +0000312 struct option *long_options = (struct option *) &bb_null_long_options;
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000313#endif
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000314 unsigned trigger;
"Vladimir N. Oleynik"35939d92005-10-05 10:52:47 +0000315 char **pargv = NULL;
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000316 int min_arg = 0;
317 int max_arg = -1;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000318
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000319#define SHOW_USAGE_IF_ERROR 1
320#define ALL_ARGV_IS_OPTS 2
321#define FIRST_ARGV_IS_OPT 4
322#define FREE_FIRST_ARGV_IS_OPT 8
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000323 int spec_flgs = 0;
324
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000325 argc = 0;
326 while (argv[argc])
327 argc++;
328
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000329 va_start(p, applet_opts);
Eric Andersen8876fb22003-06-20 09:01:58 +0000330
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000331 c = 0;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000332 on_off = complementary;
333 memset(on_off, 0, sizeof(complementary));
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000334
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000335 /* skip GNU extension */
"Vladimir N. Oleynik"bf968f72005-12-02 10:10:28 +0000336 s = (const unsigned char *)applet_opts;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000337 if (*s == '+' || *s == '-')
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000338 s++;
Denis Vlasenkoc8400a22006-10-25 00:33:44 +0000339 while (*s) {
340 if (c >= 32) break;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000341 on_off->opt = *s;
342 on_off->switch_on = (1 << c);
Denis Vlasenkoc8400a22006-10-25 00:33:44 +0000343 if (*++s == ':') {
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000344 on_off->optarg = va_arg(p, void **);
Denis Vlasenkoc8400a22006-10-25 00:33:44 +0000345 while (*++s == ':') /* skip */;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000346 }
347 on_off++;
348 c++;
Eric Andersen8876fb22003-06-20 09:01:58 +0000349 }
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000350
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000351#if ENABLE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000352 if (applet_long_options) {
353 const char *optstr;
354 unsigned i, count;
355
356 count = 1;
357 optstr = applet_long_options;
358 while (optstr[0]) {
Denis Vlasenko5bfcb4d2007-07-23 17:40:35 +0000359 optstr += strlen(optstr) + 3; /* skip NUL, has_arg, val */
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000360 count++;
361 }
362 /* count == no. of longopts + 1 */
Denis Vlasenko5bfcb4d2007-07-23 17:40:35 +0000363 long_options = alloca(count * sizeof(*long_options));
Denis Vlasenkof4cee7a2007-07-25 17:18:06 +0000364 memset(long_options, 0, count * sizeof(*long_options));
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000365 i = 0;
366 optstr = applet_long_options;
367 while (--count) {
368 long_options[i].name = optstr;
369 optstr += strlen(optstr) + 1;
370 long_options[i].has_arg = (unsigned char)(*optstr++);
371 /* long_options[i].flag = NULL; */
372 long_options[i].val = (unsigned char)(*optstr++);
373 i++;
374 }
375 for (l_o = long_options; l_o->name; l_o++) {
376 if (l_o->flag)
377 continue;
378 for (on_off = complementary; on_off->opt != 0; on_off++)
379 if (on_off->opt == l_o->val)
380 goto next_long;
381 if (c >= 32) break;
382 on_off->opt = l_o->val;
383 on_off->switch_on = (1 << c);
384 if (l_o->has_arg != no_argument)
385 on_off->optarg = va_arg(p, void **);
386 c++;
Denis Vlasenkoc8400a22006-10-25 00:33:44 +0000387 next_long: ;
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000388 }
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000389 }
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000390#endif /* ENABLE_GETOPT_LONG */
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000391 for (s = (const unsigned char *)opt_complementary; s && *s; s++) {
392 t_complementary *pair;
393 unsigned *pair_switch;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000394
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000395 if (*s == ':')
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000396 continue;
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000397 c = s[1];
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000398 if (*s == '?') {
399 if (c < '0' || c > '9') {
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000400 spec_flgs |= SHOW_USAGE_IF_ERROR;
401 } else {
402 max_arg = c - '0';
403 s++;
404 }
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000405 continue;
406 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000407 if (*s == '-') {
408 if (c < '0' || c > '9') {
409 if (c == '-') {
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000410 spec_flgs |= FIRST_ARGV_IS_OPT;
411 s++;
412 } else
413 spec_flgs |= ALL_ARGV_IS_OPTS;
414 } else {
415 min_arg = c - '0';
416 s++;
417 }
"Vladimir N. Oleynik"35939d92005-10-05 10:52:47 +0000418 continue;
419 }
Denis Vlasenko456fa6c2006-10-20 18:36:55 +0000420 if (*s == '=') {
421 min_arg = max_arg = c - '0';
422 s++;
423 continue;
424 }
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000425 for (on_off = complementary; on_off->opt; on_off++)
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000426 if (on_off->opt == *s)
427 break;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000428 if (c == ':' && s[2] == ':') {
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000429 on_off->list_flg++;
430 continue;
431 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000432 if (c == ':' || c == '\0') {
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000433 requires |= on_off->switch_on;
434 continue;
435 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000436 if (c == '-' && (s[2] == ':' || s[2] == '\0')) {
"Vladimir N. Oleynik"4fc92202006-02-02 14:48:54 +0000437 flags |= on_off->switch_on;
438 on_off->incongruously |= on_off->switch_on;
439 s++;
440 continue;
441 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000442 if (c == *s) {
443 on_off->counter = va_arg(p, int *);
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000444 s++;
445 }
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000446 pair = on_off;
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000447 pair_switch = &(pair->switch_on);
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000448 for (s++; *s && *s != ':'; s++) {
449 if (*s == '?') {
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000450 pair_switch = &(pair->requires);
451 } else if (*s == '-') {
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000452 if (pair_switch == &(pair->switch_off))
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000453 pair_switch = &(pair->incongruously);
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000454 else
455 pair_switch = &(pair->switch_off);
456 } else {
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000457 for (on_off = complementary; on_off->opt; on_off++)
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000458 if (on_off->opt == *s) {
459 *pair_switch |= on_off->switch_on;
460 break;
461 }
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000462 }
463 }
464 s--;
Eric Andersen8876fb22003-06-20 09:01:58 +0000465 }
Denis Vlasenkoff131b92007-04-10 15:42:06 +0000466 va_end(p);
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000467
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000468 if (spec_flgs & FIRST_ARGV_IS_OPT) {
469 if (argv[1] && argv[1][0] != '-' && argv[1][0] != '\0') {
Rob Landleyd921b2e2006-08-03 15:41:12 +0000470 argv[1] = xasprintf("-%s", argv[1]);
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000471 if (ENABLE_FEATURE_CLEAN_UP)
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000472 spec_flgs |= FREE_FIRST_ARGV_IS_OPT;
473 }
474 }
Denis Vlasenko24af7202007-03-15 13:28:46 +0000475
Denis Vlasenko97728162008-01-28 22:57:10 +0000476 /* In case getopt32 was already called:
477 * reset the libc getopt() function, which keeps internal state.
478 *
479 * BSD-derived getopt() functions require that optind be set to 1 in
480 * order to reset getopt() state. This used to be generally accepted
481 * way of resetting getopt(). However, glibc's getopt()
482 * has additional getopt() state beyond optind, and requires that
483 * optind be set to zero to reset its state. So the unfortunate state of
484 * affairs is that BSD-derived versions of getopt() misbehave if
485 * optind is set to 0 in order to reset getopt(), and glibc's getopt()
486 * will core dump if optind is set 1 in order to reset getopt().
487 *
488 * More modern versions of BSD require that optreset be set to 1 in
489 * order to reset getopt(). Sigh. Standards, anyone?
490 */
491#ifdef __GLIBC__
492 optind = 0;
493#else /* BSD style */
Denis Vlasenko24af7202007-03-15 13:28:46 +0000494 optind = 1;
Denis Vlasenko97728162008-01-28 22:57:10 +0000495 /* optreset = 1; */
496#endif
497 /* optarg = NULL; opterr = 0; optopt = 0; - do we need this?? */
Denis Vlasenko24af7202007-03-15 13:28:46 +0000498
Denis Vlasenko97728162008-01-28 22:57:10 +0000499 /* Note: just "getopt() <= 0" will not work well for
Denis Vlasenkoc8400a22006-10-25 00:33:44 +0000500 * "fake" short options, like this one:
501 * wget $'-\203' "Test: test" http://kernel.org/
502 * (supposed to act as --header, but doesn't) */
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000503#if ENABLE_GETOPT_LONG
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000504 while ((c = getopt_long(argc, argv, applet_opts,
Denis Vlasenko5bfcb4d2007-07-23 17:40:35 +0000505 long_options, NULL)) != -1) {
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000506#else
Denis Vlasenkoc8400a22006-10-25 00:33:44 +0000507 while ((c = getopt(argc, argv, applet_opts)) != -1) {
Denis Vlasenko24af7202007-03-15 13:28:46 +0000508#endif
Denis Vlasenko97728162008-01-28 22:57:10 +0000509 c &= 0xff; /* fight libc's sign extension */
Denis Vlasenko24af7202007-03-15 13:28:46 +0000510 loop_arg_is_opt:
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000511 for (on_off = complementary; on_off->opt != c; on_off++) {
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000512 /* c==0 if long opt have non NULL flag */
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000513 if (on_off->opt == 0 && c != 0)
514 bb_show_usage();
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000515 }
Denis Vlasenko09196572007-07-21 13:27:44 +0000516 if (flags & on_off->incongruously)
517 bb_show_usage();
"Vladimir N. Oleynik"45a8ed82005-09-06 16:08:33 +0000518 trigger = on_off->switch_on & on_off->switch_off;
519 flags &= ~(on_off->switch_off ^ trigger);
520 flags |= on_off->switch_on ^ trigger;
521 flags ^= trigger;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000522 if (on_off->counter)
"Vladimir N. Oleynik"be0ed3d2005-10-04 16:48:26 +0000523 (*(on_off->counter))++;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000524 if (on_off->list_flg) {
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000525 llist_add_to_end((llist_t **)(on_off->optarg), optarg);
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000526 } else if (on_off->optarg) {
527 *(char **)(on_off->optarg) = optarg;
528 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000529 if (pargv != NULL)
"Vladimir N. Oleynik"35939d92005-10-05 10:52:47 +0000530 break;
531 }
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000532
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000533 if (spec_flgs & ALL_ARGV_IS_OPTS) {
"Vladimir N. Oleynik"35939d92005-10-05 10:52:47 +0000534 /* process argv is option, for example "ps" applet */
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000535 if (pargv == NULL)
"Vladimir N. Oleynik"35939d92005-10-05 10:52:47 +0000536 pargv = argv + optind;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000537 while (*pargv) {
"Vladimir N. Oleynik"35939d92005-10-05 10:52:47 +0000538 c = **pargv;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000539 if (c == '\0') {
"Vladimir N. Oleynik"35939d92005-10-05 10:52:47 +0000540 pargv++;
541 } else {
542 (*pargv)++;
543 goto loop_arg_is_opt;
544 }
545 }
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000546 }
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000547
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000548#if (ENABLE_AR || ENABLE_TAR) && ENABLE_FEATURE_CLEAN_UP
549 if (spec_flgs & FREE_FIRST_ARGV_IS_OPT)
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000550 free(argv[1]);
551#endif
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000552 /* check depending requires for given options */
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000553 for (on_off = complementary; on_off->opt; on_off++) {
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000554 if (on_off->requires && (flags & on_off->switch_on) &&
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000555 (flags & on_off->requires) == 0)
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000556 bb_show_usage();
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000557 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000558 if (requires && (flags & requires) == 0)
559 bb_show_usage();
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000560 argc -= optind;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000561 if (argc < min_arg || (max_arg >= 0 && argc > max_arg))
562 bb_show_usage();
Denis Vlasenkoc12f5302006-10-06 09:49:47 +0000563
564 option_mask32 = flags;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000565 return flags;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000566}