blob: 25bae319ebbb9891bf0ba3334817d99c6d3847c5 [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 *
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +02007 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
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 Vlasenko28e67962009-04-26 23:22:40 +000075 "!" Report bad option, missing required options,
76 inconsistent options with all-ones return value (instead of abort).
77
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +000078const char *applet_long_options
Mike Frysingere5d0bde2005-05-10 23:48:35 +000079
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +000080 This struct allows you to define long options:
Mike Frysingere5d0bde2005-05-10 23:48:35 +000081
Denis Vlasenko6ca409e2007-08-12 20:58:27 +000082 static const char applet_longopts[] ALIGN1 =
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +000083 //"name\0" has_arg val
84 "verbose\0" No_argument "v"
Denis Vlasenko990d0f62007-07-24 15:54:42 +000085 ;
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +000086 applet_long_options = applet_longopts;
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
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +000092 - 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";
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000111 flags = getopt32(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
Denys Vlasenko29ca1592010-11-22 18:13:15 +0100118 the number of occurrences of the option.
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000119 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 Vlasenko1d426652008-03-17 09:09:09 +0000123 int w_counter = 0; // must be initialized!
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000124 opt_complementary = "ww";
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000125 getopt32(argv, "w", &w_counter);
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000126 if (w_counter)
Denis Vlasenko6a2f7f42007-08-16 10:35:17 +0000127 width = (w_counter == 1) ? 132 : INT_MAX;
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000128 else
Denis Vlasenko6a2f7f42007-08-16 10:35:17 +0000129 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";
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000141 f = getopt32(argv, "vb:c", &my_b, &verbose_level);
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000142 if (f & 2) // -c after -b unsets -b flag
Denis Vlasenkod50dda82008-06-15 05:40:56 +0000143 while (my_b) dosomething_with(llist_pop(&my_b));
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000144 if (my_b) // but llist is stored if -b is specified
Denis Vlasenko6a2f7f42007-08-16 10:35:17 +0000145 free_llist(my_b);
Denis Vlasenkof0ed3762006-10-26 23:21:47 +0000146 if (verbose_level) 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
Denys Vlasenko00528822009-09-11 23:26:42 +0200150 "-" A group consisting of just a dash forces all arguments
151 to be treated as options, even if they have no leading dashes.
152 Next char in this case can't be a digit (0-9), use ':' or end of line.
153 Example:
Denis Vlasenkod031ffa2006-11-24 21:54:44 +0000154
Denys Vlasenko00528822009-09-11 23:26:42 +0200155 opt_complementary = "-:w-x:x-w"; // "-w-x:x-w" would also work,
156 getopt32(argv, "wx"); // but is less readable
Denis Vlasenkod031ffa2006-11-24 21:54:44 +0000157
Denys Vlasenko00528822009-09-11 23:26:42 +0200158 This makes it possible to use options without a dash (./program w x)
Denis Vlasenkod031ffa2006-11-24 21:54:44 +0000159 as well as with a dash (./program -x).
160
Denis Vlasenkofd5a3d22008-11-12 22:06:46 +0000161 NB: getopt32() will leak a small amount of memory if you use
162 this option! Do not use it if there is a possibility of recursive
163 getopt32() calls.
Denis Vlasenkoe417be62008-08-20 23:03:38 +0000164
Denis Vlasenkod031ffa2006-11-24 21:54:44 +0000165 "--" A double dash at the beginning of opt_complementary means the
166 argv[1] string should always be treated as options, even if it isn't
167 prefixed with a "-". This is useful for special syntax in applets
168 such as "ar" and "tar":
169 tar xvf foo.tar
170
Denis Vlasenkofd5a3d22008-11-12 22:06:46 +0000171 NB: getopt32() will leak a small amount of memory if you use
172 this option! Do not use it if there is a possibility of recursive
173 getopt32() calls.
Denis Vlasenkoe417be62008-08-20 23:03:38 +0000174
Denis Vlasenkod031ffa2006-11-24 21:54:44 +0000175 "-N" A dash as the first char in a opt_complementary group followed
176 by a single digit (0-9) means that at least N non-option
177 arguments must be present on the command line
178
179 "=N" An equal sign as the first char in a opt_complementary group followed
180 by a single digit (0-9) means that exactly N non-option
181 arguments must be present on the command line
182
183 "?N" A "?" as the first char in a opt_complementary group followed
184 by a single digit (0-9) means that at most N arguments must be present
185 on the command line.
186
187 "V-" An option with dash before colon or end-of-line results in
Denis Vlasenko1c45a502008-08-20 00:12:22 +0000188 bb_show_usage() being called if this option is encountered.
Denis Vlasenkod031ffa2006-11-24 21:54:44 +0000189 This is typically used to implement "print verbose usage message
190 and exit" option.
191
Denis Vlasenko6666ac42007-08-24 21:46:24 +0000192 "a-b" A dash between two options causes the second of the two
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000193 to be unset (and ignored) if it is given on the command line.
Rob Landleyf76cd962006-05-03 21:23:15 +0000194
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000195 [FIXME: what if they are the same? like "x-x"? Is it ever useful?]
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000196
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000197 For example:
198 The du applet has the options "-s" and "-d depth". If
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000199 getopt32 finds -s, then -d is unset or if it finds -d
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000200 then -s is unset. (Note: busybox implements the GNU
201 "--max-depth" option as "-d".) To obtain this behavior, you
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000202 set opt_complementary = "s-d:d-s". Only one flag value is
203 added to getopt32's return value depending on the
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000204 position of the options on the command line. If one of the
205 two options requires an argument pointer (":" in applet_opts
206 as in "d:") optarg is set accordingly.
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000207
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000208 char *smax_print_depth;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000209
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000210 opt_complementary = "s-d:d-s:x-x";
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000211 opt = getopt32(argv, "sd:x", &smax_print_depth);
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000212
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000213 if (opt & 2)
Denis Vlasenko6a2f7f42007-08-16 10:35:17 +0000214 max_print_depth = atoi(smax_print_depth);
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000215 if (opt & 4)
Denis Vlasenko6a2f7f42007-08-16 10:35:17 +0000216 printf("Detected odd -x usage\n");
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000217
Denis Vlasenko6666ac42007-08-24 21:46:24 +0000218 "a--b" A double dash between two options, or between an option and a group
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000219 of options, means that they are mutually exclusive. Unlike
220 the "-" case above, an error will be forced if the options
221 are used together.
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000222
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000223 For example:
224 The cut applet must have only one type of list specified, so
Denis Vlasenkoa0319ba2007-08-16 10:37:49 +0000225 -b, -c and -f are mutually exclusive and should raise an error
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000226 if specified together. In this case you must set
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000227 opt_complementary = "b--cf:c--bf:f--bc". If two of the
Denis Vlasenko09196572007-07-21 13:27:44 +0000228 mutually exclusive options are found, getopt32 will call
229 bb_show_usage() and die.
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000230
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000231 "x--x" Variation of the above, it means that -x option should occur
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000232 at most once.
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000233
Denis Vlasenko1d426652008-03-17 09:09:09 +0000234 "a+" A plus after a char in opt_complementary means that the parameter
Denis Vlasenko04e11c92008-02-10 19:44:20 +0000235 for this option is a nonnegative integer. It will be processed
Denys Vlasenko77832482010-08-12 14:14:45 +0200236 with xatoi_positive() - allowed range is 0..INT_MAX.
Denis Vlasenko04e11c92008-02-10 19:44:20 +0000237
238 int param; // "unsigned param;" will also work
239 opt_complementary = "p+";
240 getopt32(argv, "p:", &param);
241
Denis Vlasenko6666ac42007-08-24 21:46:24 +0000242 "a::" A double colon after a char in opt_complementary means that the
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000243 option can occur multiple times. Each occurrence will be saved as
244 a llist_t element instead of char*.
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000245
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000246 For example:
247 The grep applet can have one or more "-e pattern" arguments.
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000248 In this case you should use getopt32() as follows:
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000249
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000250 llist_t *patterns = NULL;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000251
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000252 (this pointer must be initializated to NULL if the list is empty
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000253 as required by llist_add_to_end(llist_t **old_head, char *new_item).)
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000254
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000255 opt_complementary = "e::";
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000256
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000257 getopt32(argv, "e:", &patterns);
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000258 $ grep -e user -e root /etc/passwd
259 root:x:0:0:root:/root:/bin/bash
260 user:x:500:500::/home/user:/bin/bash
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000261
Denis Vlasenko6666ac42007-08-24 21:46:24 +0000262 "a?b" A "?" between an option and a group of options means that
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000263 at least one of them is required to occur if the first option
264 occurs in preceding command line arguments.
Rob Landleyf76cd962006-05-03 21:23:15 +0000265
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000266 For example from "id" applet:
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000267
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000268 // Don't allow -n -r -rn -ug -rug -nug -rnug
Denis Vlasenko1d426652008-03-17 09:09:09 +0000269 opt_complementary = "r?ug:n?ug:u--g:g--u";
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000270 flags = getopt32(argv, "rnug");
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000271
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000272 This example allowed only:
273 $ 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 +0000274
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000275 "X" A opt_complementary group with just a single letter means
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000276 that this option is required. If more than one such group exists,
277 at least one option is required to occur (not all of them).
278 For example from "start-stop-daemon" applet:
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000279
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000280 // Don't allow -KS -SK, but -S or -K is required
Denis Vlasenko6666ac42007-08-24 21:46:24 +0000281 opt_complementary = "K:S:K--S:S--K";
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000282 flags = getopt32(argv, "KS...);
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000283
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000284
Denis Vlasenkof0d6cc82006-09-29 13:56:58 +0000285 Don't forget to use ':'. For example, "?322-22-23X-x-a"
286 is interpreted as "?3:22:-2:2-2:2-3Xa:2--x" -
287 max 3 args; count uses of '-2'; min 2 args; if there is
288 a '-2' option then unset '-3', '-X' and '-a'; if there is
289 a '-2' and after it a '-x' then error out.
Denis Vlasenko737d1312007-08-25 18:25:24 +0000290 But it's far too obfuscated. Use ':' to separate groups.
Eric Andersen8876fb22003-06-20 09:01:58 +0000291*/
292
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000293/* Code here assumes that 'unsigned' is at least 32 bits wide */
294
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000295const char *const bb_argv_dash[] = { "-", NULL };
296
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000297const char *opt_complementary;
Eric Andersen8876fb22003-06-20 09:01:58 +0000298
Denis Vlasenko04e11c92008-02-10 19:44:20 +0000299enum {
300 PARAM_STRING,
301 PARAM_LIST,
302 PARAM_INT,
303};
304
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000305typedef struct {
Denis Vlasenko04e11c92008-02-10 19:44:20 +0000306 unsigned char opt_char;
307 smallint param_type;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000308 unsigned switch_on;
309 unsigned switch_off;
310 unsigned incongruously;
311 unsigned requires;
Denis Vlasenko04e11c92008-02-10 19:44:20 +0000312 void **optarg; /* char**, llist_t** or int *. */
"Vladimir N. Oleynik"be0ed3d2005-10-04 16:48:26 +0000313 int *counter;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000314} t_complementary;
Eric Andersen8876fb22003-06-20 09:01:58 +0000315
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000316/* You can set applet_long_options for parse called long options */
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200317#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000318static const struct option bb_null_long_options[1] = {
Eric Andersen8876fb22003-06-20 09:01:58 +0000319 { 0, 0, 0, 0 }
320};
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000321const char *applet_long_options;
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000322#endif
Eric Andersen8876fb22003-06-20 09:01:58 +0000323
Denis Vlasenkoc12f5302006-10-06 09:49:47 +0000324uint32_t option_mask32;
325
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000326uint32_t FAST_FUNC
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000327getopt32(char **argv, const char *applet_opts, ...)
Manuel Novoa III cad53642003-03-19 09:13:01 +0000328{
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000329 int argc;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000330 unsigned flags = 0;
331 unsigned requires = 0;
Denis Vlasenko1c45a502008-08-20 00:12:22 +0000332 t_complementary complementary[33]; /* last stays zero-filled */
Denis Vlasenko28e67962009-04-26 23:22:40 +0000333 char first_char;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000334 int c;
335 const unsigned char *s;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000336 t_complementary *on_off;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000337 va_list p;
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200338#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000339 const struct option *l_o;
Denis Vlasenko5bfcb4d2007-07-23 17:40:35 +0000340 struct option *long_options = (struct option *) &bb_null_long_options;
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000341#endif
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000342 unsigned trigger;
Denis Vlasenko1c45a502008-08-20 00:12:22 +0000343 char **pargv;
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000344 int min_arg = 0;
345 int max_arg = -1;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000346
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000347#define SHOW_USAGE_IF_ERROR 1
348#define ALL_ARGV_IS_OPTS 2
349#define FIRST_ARGV_IS_OPT 4
Denis Vlasenko468aea22008-04-01 14:47:57 +0000350
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000351 int spec_flgs = 0;
352
Denis Vlasenko43016162008-08-20 00:15:42 +0000353 /* skip 0: some applets cheat: they do not actually HAVE argv[0] */
354 argc = 1;
Denis Vlasenkofe7cd642007-08-18 15:32:12 +0000355 while (argv[argc])
356 argc++;
357
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000358 va_start(p, applet_opts);
Eric Andersen8876fb22003-06-20 09:01:58 +0000359
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000360 c = 0;
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000361 on_off = complementary;
362 memset(on_off, 0, sizeof(complementary));
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000363
Denis Vlasenko28e67962009-04-26 23:22:40 +0000364 /* skip bbox extension */
365 first_char = applet_opts[0];
366 if (first_char == '!')
367 applet_opts++;
368
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000369 /* skip GNU extension */
"Vladimir N. Oleynik"bf968f72005-12-02 10:10:28 +0000370 s = (const unsigned char *)applet_opts;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000371 if (*s == '+' || *s == '-')
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000372 s++;
Denis Vlasenkoc8400a22006-10-25 00:33:44 +0000373 while (*s) {
Denis Vlasenko04e11c92008-02-10 19:44:20 +0000374 if (c >= 32)
375 break;
376 on_off->opt_char = *s;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000377 on_off->switch_on = (1 << c);
Denis Vlasenkoc8400a22006-10-25 00:33:44 +0000378 if (*++s == ':') {
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000379 on_off->optarg = va_arg(p, void **);
Denis Vlasenko04e11c92008-02-10 19:44:20 +0000380 while (*++s == ':')
381 continue;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000382 }
383 on_off++;
384 c++;
Eric Andersen8876fb22003-06-20 09:01:58 +0000385 }
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000386
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200387#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000388 if (applet_long_options) {
389 const char *optstr;
390 unsigned i, count;
391
392 count = 1;
393 optstr = applet_long_options;
394 while (optstr[0]) {
Denis Vlasenko5bfcb4d2007-07-23 17:40:35 +0000395 optstr += strlen(optstr) + 3; /* skip NUL, has_arg, val */
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000396 count++;
397 }
398 /* count == no. of longopts + 1 */
Denis Vlasenko5bfcb4d2007-07-23 17:40:35 +0000399 long_options = alloca(count * sizeof(*long_options));
Denis Vlasenkof4cee7a2007-07-25 17:18:06 +0000400 memset(long_options, 0, count * sizeof(*long_options));
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000401 i = 0;
402 optstr = applet_long_options;
403 while (--count) {
404 long_options[i].name = optstr;
405 optstr += strlen(optstr) + 1;
406 long_options[i].has_arg = (unsigned char)(*optstr++);
407 /* long_options[i].flag = NULL; */
408 long_options[i].val = (unsigned char)(*optstr++);
409 i++;
410 }
411 for (l_o = long_options; l_o->name; l_o++) {
412 if (l_o->flag)
413 continue;
Denis Vlasenko04e11c92008-02-10 19:44:20 +0000414 for (on_off = complementary; on_off->opt_char; on_off++)
415 if (on_off->opt_char == l_o->val)
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000416 goto next_long;
Denis Vlasenko04e11c92008-02-10 19:44:20 +0000417 if (c >= 32)
418 break;
419 on_off->opt_char = l_o->val;
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000420 on_off->switch_on = (1 << c);
421 if (l_o->has_arg != no_argument)
422 on_off->optarg = va_arg(p, void **);
423 c++;
Denis Vlasenkoc8400a22006-10-25 00:33:44 +0000424 next_long: ;
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000425 }
Denys Vlasenkod46c36c2010-03-16 17:57:53 +0100426 /* Make it unnecessary to clear applet_long_options
427 * by hand after each call to getopt32
428 */
429 applet_long_options = NULL;
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000430 }
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200431#endif /* ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG */
Denis Vlasenko67b23e62006-10-03 21:00:06 +0000432 for (s = (const unsigned char *)opt_complementary; s && *s; s++) {
433 t_complementary *pair;
434 unsigned *pair_switch;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000435
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000436 if (*s == ':')
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000437 continue;
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000438 c = s[1];
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000439 if (*s == '?') {
440 if (c < '0' || c > '9') {
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000441 spec_flgs |= SHOW_USAGE_IF_ERROR;
442 } else {
443 max_arg = c - '0';
444 s++;
445 }
"Vladimir N. Oleynik"27421a12005-09-05 14:46:07 +0000446 continue;
447 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000448 if (*s == '-') {
449 if (c < '0' || c > '9') {
450 if (c == '-') {
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000451 spec_flgs |= FIRST_ARGV_IS_OPT;
452 s++;
453 } else
454 spec_flgs |= ALL_ARGV_IS_OPTS;
455 } else {
456 min_arg = c - '0';
457 s++;
458 }
"Vladimir N. Oleynik"35939d92005-10-05 10:52:47 +0000459 continue;
460 }
Denis Vlasenko456fa6c2006-10-20 18:36:55 +0000461 if (*s == '=') {
462 min_arg = max_arg = c - '0';
463 s++;
464 continue;
465 }
Denis Vlasenko04e11c92008-02-10 19:44:20 +0000466 for (on_off = complementary; on_off->opt_char; on_off++)
467 if (on_off->opt_char == *s)
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000468 break;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000469 if (c == ':' && s[2] == ':') {
Denis Vlasenko04e11c92008-02-10 19:44:20 +0000470 on_off->param_type = PARAM_LIST;
471 continue;
472 }
473 if (c == '+' && (s[2] == ':' || s[2] == '\0')) {
474 on_off->param_type = PARAM_INT;
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000475 continue;
476 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000477 if (c == ':' || c == '\0') {
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000478 requires |= on_off->switch_on;
479 continue;
480 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000481 if (c == '-' && (s[2] == ':' || s[2] == '\0')) {
"Vladimir N. Oleynik"4fc92202006-02-02 14:48:54 +0000482 flags |= on_off->switch_on;
483 on_off->incongruously |= on_off->switch_on;
484 s++;
485 continue;
486 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000487 if (c == *s) {
488 on_off->counter = va_arg(p, int *);
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000489 s++;
490 }
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000491 pair = on_off;
Denys Vlasenkod46c36c2010-03-16 17:57:53 +0100492 pair_switch = &pair->switch_on;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000493 for (s++; *s && *s != ':'; s++) {
494 if (*s == '?') {
Denys Vlasenkod46c36c2010-03-16 17:57:53 +0100495 pair_switch = &pair->requires;
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000496 } else if (*s == '-') {
Denys Vlasenkod46c36c2010-03-16 17:57:53 +0100497 if (pair_switch == &pair->switch_off)
498 pair_switch = &pair->incongruously;
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000499 else
Denys Vlasenkod46c36c2010-03-16 17:57:53 +0100500 pair_switch = &pair->switch_off;
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000501 } else {
Denis Vlasenko04e11c92008-02-10 19:44:20 +0000502 for (on_off = complementary; on_off->opt_char; on_off++)
503 if (on_off->opt_char == *s) {
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000504 *pair_switch |= on_off->switch_on;
505 break;
506 }
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000507 }
508 }
509 s--;
Eric Andersen8876fb22003-06-20 09:01:58 +0000510 }
Denys Vlasenkod46c36c2010-03-16 17:57:53 +0100511 opt_complementary = NULL;
Denis Vlasenkoff131b92007-04-10 15:42:06 +0000512 va_end(p);
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000513
Denis Vlasenko1c45a502008-08-20 00:12:22 +0000514 if (spec_flgs & (FIRST_ARGV_IS_OPT | ALL_ARGV_IS_OPTS)) {
515 pargv = argv + 1;
516 while (*pargv) {
517 if (pargv[0][0] != '-' && pargv[0][0] != '\0') {
Denis Vlasenkoe417be62008-08-20 23:03:38 +0000518 /* Can't use alloca: opts with params will
519 * return pointers to stack!
520 * NB: we leak these allocations... */
521 char *pp = xmalloc(strlen(*pargv) + 2);
Denis Vlasenko1c45a502008-08-20 00:12:22 +0000522 *pp = '-';
523 strcpy(pp + 1, *pargv);
524 *pargv = pp;
525 }
526 if (!(spec_flgs & ALL_ARGV_IS_OPTS))
Denis Vlasenkoea7c9b32008-09-25 10:39:10 +0000527 break;
Denis Vlasenko1c45a502008-08-20 00:12:22 +0000528 pargv++;
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000529 }
530 }
Denis Vlasenko24af7202007-03-15 13:28:46 +0000531
Denis Vlasenkofd5a3d22008-11-12 22:06:46 +0000532 /* In case getopt32 was already called:
533 * reset the libc getopt() function, which keeps internal state.
534 * run_nofork_applet_prime() does this, but we might end up here
535 * also via gunzip_main() -> gzip_main(). Play safe.
536 */
537#ifdef __GLIBC__
538 optind = 0;
539#else /* BSD style */
540 optind = 1;
541 /* optreset = 1; */
542#endif
543 /* optarg = NULL; opterr = 0; optopt = 0; - do we need this?? */
544
Denis Vlasenko1c45a502008-08-20 00:12:22 +0000545 pargv = NULL;
Denis Vlasenko24af7202007-03-15 13:28:46 +0000546
Denis Vlasenko97728162008-01-28 22:57:10 +0000547 /* Note: just "getopt() <= 0" will not work well for
Denis Vlasenkoc8400a22006-10-25 00:33:44 +0000548 * "fake" short options, like this one:
549 * wget $'-\203' "Test: test" http://kernel.org/
550 * (supposed to act as --header, but doesn't) */
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200551#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000552 while ((c = getopt_long(argc, argv, applet_opts,
Denis Vlasenko5bfcb4d2007-07-23 17:40:35 +0000553 long_options, NULL)) != -1) {
Bernhard Reutner-Fischerf9437aa2006-05-31 14:12:51 +0000554#else
Denis Vlasenkoc8400a22006-10-25 00:33:44 +0000555 while ((c = getopt(argc, argv, applet_opts)) != -1) {
Denis Vlasenko24af7202007-03-15 13:28:46 +0000556#endif
Denis Vlasenko1c45a502008-08-20 00:12:22 +0000557 /* getopt prints "option requires an argument -- X"
558 * and returns '?' if an option has no arg, but one is reqd */
Denis Vlasenko97728162008-01-28 22:57:10 +0000559 c &= 0xff; /* fight libc's sign extension */
Denis Vlasenko04e11c92008-02-10 19:44:20 +0000560 for (on_off = complementary; on_off->opt_char != c; on_off++) {
Denis Vlasenko1c45a502008-08-20 00:12:22 +0000561 /* c can be NUL if long opt has non-NULL ->flag,
562 * but we construct long opts so that flag
563 * is always NULL (see above) */
564 if (on_off->opt_char == '\0' /* && c != '\0' */) {
565 /* c is probably '?' - "bad option" */
Denis Vlasenko28e67962009-04-26 23:22:40 +0000566 goto error;
Denis Vlasenko1c45a502008-08-20 00:12:22 +0000567 }
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000568 }
Denis Vlasenko09196572007-07-21 13:27:44 +0000569 if (flags & on_off->incongruously)
Denis Vlasenko28e67962009-04-26 23:22:40 +0000570 goto error;
"Vladimir N. Oleynik"45a8ed82005-09-06 16:08:33 +0000571 trigger = on_off->switch_on & on_off->switch_off;
572 flags &= ~(on_off->switch_off ^ trigger);
573 flags |= on_off->switch_on ^ trigger;
574 flags ^= trigger;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000575 if (on_off->counter)
"Vladimir N. Oleynik"be0ed3d2005-10-04 16:48:26 +0000576 (*(on_off->counter))++;
Denis Vlasenko04e11c92008-02-10 19:44:20 +0000577 if (on_off->param_type == PARAM_LIST) {
Denis Vlasenko1d426652008-03-17 09:09:09 +0000578 if (optarg)
579 llist_add_to_end((llist_t **)(on_off->optarg), optarg);
Denis Vlasenko04e11c92008-02-10 19:44:20 +0000580 } else if (on_off->param_type == PARAM_INT) {
Denis Vlasenko1d426652008-03-17 09:09:09 +0000581 if (optarg)
Denys Vlasenko77832482010-08-12 14:14:45 +0200582//TODO: xatoi_positive indirectly pulls in printf machinery
583 *(unsigned*)(on_off->optarg) = xatoi_positive(optarg);
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000584 } else if (on_off->optarg) {
Denis Vlasenko1d426652008-03-17 09:09:09 +0000585 if (optarg)
586 *(char **)(on_off->optarg) = optarg;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000587 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000588 if (pargv != NULL)
"Vladimir N. Oleynik"35939d92005-10-05 10:52:47 +0000589 break;
590 }
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000591
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000592 /* check depending requires for given options */
Denis Vlasenko04e11c92008-02-10 19:44:20 +0000593 for (on_off = complementary; on_off->opt_char; on_off++) {
Denis Vlasenko28e67962009-04-26 23:22:40 +0000594 if (on_off->requires
595 && (flags & on_off->switch_on)
596 && (flags & on_off->requires) == 0
597 ) {
598 goto error;
599 }
"Vladimir N. Oleynik"064f04e2005-10-11 14:38:01 +0000600 }
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000601 if (requires && (flags & requires) == 0)
Denis Vlasenko28e67962009-04-26 23:22:40 +0000602 goto error;
"Vladimir N. Oleynik"f704b272005-10-14 09:56:52 +0000603 argc -= optind;
Denis Vlasenkob02ef822006-09-29 08:23:42 +0000604 if (argc < min_arg || (max_arg >= 0 && argc > max_arg))
Denis Vlasenko28e67962009-04-26 23:22:40 +0000605 goto error;
Denis Vlasenkoc12f5302006-10-06 09:49:47 +0000606
607 option_mask32 = flags;
Mike Frysinger2bf88a82005-04-18 22:42:58 +0000608 return flags;
Denis Vlasenko28e67962009-04-26 23:22:40 +0000609
610 error:
611 if (first_char != '!')
612 bb_show_usage();
613 return (int32_t)-1;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000614}