blob: f6ecc3dded97270ddbefb6498bf168fe0a835b09
1 | /* vi: set sw=4 ts=4: */ |
2 | /* |
3 | * getopt.c - Enhanced implementation of BSD getopt(1) |
4 | * Copyright (c) 1997, 1998, 1999, 2000 Frodo Looijaard <frodol@dds.nl> |
5 | * |
6 | * Licensed under GPLv2 or later, see file LICENSE in this source tree. |
7 | */ |
8 | |
9 | /* |
10 | * Version 1.0-b4: Tue Sep 23 1997. First public release. |
11 | * Version 1.0: Wed Nov 19 1997. |
12 | * Bumped up the version number to 1.0 |
13 | * Fixed minor typo (CSH instead of TCSH) |
14 | * Version 1.0.1: Tue Jun 3 1998 |
15 | * Fixed sizeof instead of strlen bug |
16 | * Bumped up the version number to 1.0.1 |
17 | * Version 1.0.2: Thu Jun 11 1998 (not present) |
18 | * Fixed gcc-2.8.1 warnings |
19 | * Fixed --version/-V option (not present) |
20 | * Version 1.0.5: Tue Jun 22 1999 |
21 | * Make -u option work (not present) |
22 | * Version 1.0.6: Tue Jun 27 2000 |
23 | * No important changes |
24 | * Version 1.1.0: Tue Jun 30 2000 |
25 | * Added NLS support (partly written by Arkadiusz Mickiewicz |
26 | * <misiek@misiek.eu.org>) |
27 | * Ported to Busybox - Alfred M. Szmidt <ams@trillian.itslinux.org> |
28 | * Removed --version/-V and --help/-h |
29 | * Removed parse_error(), using bb_error_msg() from Busybox instead |
30 | * Replaced our_malloc with xmalloc and our_realloc with xrealloc |
31 | */ |
32 | //config:config GETOPT |
33 | //config: bool "getopt" |
34 | //config: default y |
35 | //config: help |
36 | //config: The getopt utility is used to break up (parse) options in command |
37 | //config: lines to make it easy to write complex shell scripts that also check |
38 | //config: for legal (and illegal) options. If you want to write horribly |
39 | //config: complex shell scripts, or use some horribly complex shell script |
40 | //config: written by others, this utility may be for you. Most people will |
41 | //config: wisely leave this disabled. |
42 | //config: |
43 | //config:config FEATURE_GETOPT_LONG |
44 | //config: bool "Support option -l" |
45 | //config: default y if LONG_OPTS |
46 | //config: depends on GETOPT |
47 | //config: help |
48 | //config: Enable support for long options (option -l). |
49 | |
50 | //applet:IF_GETOPT(APPLET(getopt, BB_DIR_BIN, BB_SUID_DROP)) |
51 | |
52 | //kbuild:lib-$(CONFIG_GETOPT) += getopt.o |
53 | |
54 | //usage:#define getopt_trivial_usage |
55 | //usage: "[OPTIONS] [--] OPTSTRING PARAMS" |
56 | //usage:#define getopt_full_usage "\n\n" |
57 | //usage: IF_LONG_OPTS( |
58 | //usage: IF_FEATURE_GETOPT_LONG( |
59 | //usage: " -a,--alternative Allow long options starting with single -\n" |
60 | //usage: " -l,--longoptions=LOPT[,...] Long options to recognize\n" |
61 | //usage: ) |
62 | //usage: " -n,--name=PROGNAME The name under which errors are reported" |
63 | //usage: "\n -o,--options=OPTSTRING Short options to recognize" |
64 | //usage: "\n -q,--quiet No error messages on unrecognized options" |
65 | //usage: "\n -Q,--quiet-output No normal output" |
66 | //usage: "\n -s,--shell=SHELL Set shell quoting conventions" |
67 | //usage: "\n -T,--test Version test (exits with 4)" |
68 | //usage: "\n -u,--unquoted Don't quote output" |
69 | //usage: ) |
70 | //usage: IF_NOT_LONG_OPTS( |
71 | //usage: IF_FEATURE_GETOPT_LONG( |
72 | //usage: " -a Allow long options starting with single -\n" |
73 | //usage: " -l LOPT[,...] Long options to recognize\n" |
74 | //usage: ) |
75 | //usage: " -n PROGNAME The name under which errors are reported" |
76 | //usage: "\n -o OPTSTRING Short options to recognize" |
77 | //usage: "\n -q No error messages on unrecognized options" |
78 | //usage: "\n -Q No normal output" |
79 | //usage: "\n -s SHELL Set shell quoting conventions" |
80 | //usage: "\n -T Version test (exits with 4)" |
81 | //usage: "\n -u Don't quote output" |
82 | //usage: ) |
83 | //usage: IF_FEATURE_GETOPT_LONG( /* example uses -l, needs FEATURE_GETOPT_LONG */ |
84 | //usage: "\n" |
85 | //usage: "\nExample:" |
86 | //usage: "\n" |
87 | //usage: "\nO=`getopt -l bb: -- ab:c:: \"$@\"` || exit 1" |
88 | //usage: "\neval set -- \"$O\"" |
89 | //usage: "\nwhile true; do" |
90 | //usage: "\n case \"$1\" in" |
91 | //usage: "\n -a) echo A; shift;;" |
92 | //usage: "\n -b|--bb) echo \"B:'$2'\"; shift 2;;" |
93 | //usage: "\n -c) case \"$2\" in" |
94 | //usage: "\n \"\") echo C; shift 2;;" |
95 | //usage: "\n *) echo \"C:'$2'\"; shift 2;;" |
96 | //usage: "\n esac;;" |
97 | //usage: "\n --) shift; break;;" |
98 | //usage: "\n *) echo Error; exit 1;;" |
99 | //usage: "\n esac" |
100 | //usage: "\ndone" |
101 | //usage: ) |
102 | //usage: |
103 | //usage:#define getopt_example_usage |
104 | //usage: "$ cat getopt.test\n" |
105 | //usage: "#!/bin/sh\n" |
106 | //usage: "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" |
107 | //usage: " -n 'example.busybox' -- \"$@\"`\n" |
108 | //usage: "if [ $? != 0 ]; then exit 1; fi\n" |
109 | //usage: "eval set -- \"$GETOPT\"\n" |
110 | //usage: "while true; do\n" |
111 | //usage: " case $1 in\n" |
112 | //usage: " -a|--a-long) echo \"Option a\"; shift;;\n" |
113 | //usage: " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" |
114 | //usage: " -c|--c-long)\n" |
115 | //usage: " case \"$2\" in\n" |
116 | //usage: " \"\") echo \"Option c, no argument\"; shift 2;;\n" |
117 | //usage: " *) echo \"Option c, argument '$2'\"; shift 2;;\n" |
118 | //usage: " esac;;\n" |
119 | //usage: " --) shift; break;;\n" |
120 | //usage: " *) echo \"Internal error!\"; exit 1;;\n" |
121 | //usage: " esac\n" |
122 | //usage: "done\n" |
123 | |
124 | #if ENABLE_FEATURE_GETOPT_LONG |
125 | # include <getopt.h> |
126 | #endif |
127 | #include "libbb.h" |
128 | |
129 | /* NON_OPT is the code that is returned when a non-option is found in '+' |
130 | mode */ |
131 | enum { |
132 | NON_OPT = 1, |
133 | #if ENABLE_FEATURE_GETOPT_LONG |
134 | /* LONG_OPT is the code that is returned when a long option is found. */ |
135 | LONG_OPT = 2 |
136 | #endif |
137 | }; |
138 | |
139 | /* For finding activated option flags. Must match getopt32 call! */ |
140 | enum { |
141 | OPT_o = 0x1, // -o |
142 | OPT_n = 0x2, // -n |
143 | OPT_q = 0x4, // -q |
144 | OPT_Q = 0x8, // -Q |
145 | OPT_s = 0x10, // -s |
146 | OPT_T = 0x20, // -T |
147 | OPT_u = 0x40, // -u |
148 | #if ENABLE_FEATURE_GETOPT_LONG |
149 | OPT_a = 0x80, // -a |
150 | OPT_l = 0x100, // -l |
151 | #endif |
152 | SHELL_IS_TCSH = 0x8000, /* hijack this bit for other purposes */ |
153 | }; |
154 | |
155 | /* 0 is getopt_long, 1 is getopt_long_only */ |
156 | #define alternative (option_mask32 & OPT_a) |
157 | |
158 | #define quiet_errors (option_mask32 & OPT_q) |
159 | #define quiet_output (option_mask32 & OPT_Q) |
160 | #define quote (!(option_mask32 & OPT_u)) |
161 | #define shell_TCSH (option_mask32 & SHELL_IS_TCSH) |
162 | |
163 | /* |
164 | * This function 'normalizes' a single argument: it puts single quotes around |
165 | * it and escapes other special characters. If quote is false, it just |
166 | * returns its argument. |
167 | * Bash only needs special treatment for single quotes; tcsh also recognizes |
168 | * exclamation marks within single quotes, and nukes whitespace. |
169 | * This function returns a pointer to a buffer that is overwritten by |
170 | * each call. |
171 | */ |
172 | static const char *normalize(const char *arg) |
173 | { |
174 | char *bufptr; |
175 | #if ENABLE_FEATURE_CLEAN_UP |
176 | static char *BUFFER = NULL; |
177 | free(BUFFER); |
178 | #else |
179 | char *BUFFER; |
180 | #endif |
181 | |
182 | if (!quote) { /* Just copy arg */ |
183 | BUFFER = xstrdup(arg); |
184 | return BUFFER; |
185 | } |
186 | |
187 | /* Each character in arg may take up to four characters in the result: |
188 | For a quote we need a closing quote, a backslash, a quote and an |
189 | opening quote! We need also the global opening and closing quote, |
190 | and one extra character for '\0'. */ |
191 | BUFFER = xmalloc(strlen(arg)*4 + 3); |
192 | |
193 | bufptr = BUFFER; |
194 | *bufptr ++= '\''; |
195 | |
196 | while (*arg) { |
197 | if (*arg == '\'') { |
198 | /* Quote: replace it with: '\'' */ |
199 | *bufptr ++= '\''; |
200 | *bufptr ++= '\\'; |
201 | *bufptr ++= '\''; |
202 | *bufptr ++= '\''; |
203 | } else if (shell_TCSH && *arg == '!') { |
204 | /* Exclamation mark: replace it with: \! */ |
205 | *bufptr ++= '\''; |
206 | *bufptr ++= '\\'; |
207 | *bufptr ++= '!'; |
208 | *bufptr ++= '\''; |
209 | } else if (shell_TCSH && *arg == '\n') { |
210 | /* Newline: replace it with: \n */ |
211 | *bufptr ++= '\\'; |
212 | *bufptr ++= 'n'; |
213 | } else if (shell_TCSH && isspace(*arg)) { |
214 | /* Non-newline whitespace: replace it with \<ws> */ |
215 | *bufptr ++= '\''; |
216 | *bufptr ++= '\\'; |
217 | *bufptr ++= *arg; |
218 | *bufptr ++= '\''; |
219 | } else |
220 | /* Just copy */ |
221 | *bufptr ++= *arg; |
222 | arg++; |
223 | } |
224 | *bufptr ++= '\''; |
225 | *bufptr ++= '\0'; |
226 | return BUFFER; |
227 | } |
228 | |
229 | /* |
230 | * Generate the output. argv[0] is the program name (used for reporting errors). |
231 | * argv[1..] contains the options to be parsed. argc must be the number of |
232 | * elements in argv (ie. 1 if there are no options, only the program name), |
233 | * optstr must contain the short options, and longopts the long options. |
234 | * Other settings are found in global variables. |
235 | */ |
236 | #if !ENABLE_FEATURE_GETOPT_LONG |
237 | #define generate_output(argv,argc,optstr,longopts) \ |
238 | generate_output(argv,argc,optstr) |
239 | #endif |
240 | static int generate_output(char **argv, int argc, const char *optstr, const struct option *longopts) |
241 | { |
242 | int exit_code = 0; /* We assume everything will be OK */ |
243 | |
244 | if (quiet_errors) /* No error reporting from getopt(3) */ |
245 | opterr = 0; |
246 | |
247 | /* We used it already in main() in getopt32(), |
248 | * we *must* reset getopt(3): */ |
249 | #ifdef __GLIBC__ |
250 | optind = 0; |
251 | #else /* BSD style */ |
252 | optind = 1; |
253 | /* optreset = 1; */ |
254 | #endif |
255 | |
256 | while (1) { |
257 | #if ENABLE_FEATURE_GETOPT_LONG |
258 | int longindex; |
259 | int opt = alternative |
260 | ? getopt_long_only(argc, argv, optstr, longopts, &longindex) |
261 | : getopt_long(argc, argv, optstr, longopts, &longindex) |
262 | ; |
263 | #else |
264 | int opt = getopt(argc, argv, optstr); |
265 | #endif |
266 | if (opt == -1) |
267 | break; |
268 | if (opt == '?' || opt == ':' ) |
269 | exit_code = 1; |
270 | else if (!quiet_output) { |
271 | #if ENABLE_FEATURE_GETOPT_LONG |
272 | if (opt == LONG_OPT) { |
273 | printf(" --%s", longopts[longindex].name); |
274 | if (longopts[longindex].has_arg) |
275 | printf(" %s", |
276 | normalize(optarg ? optarg : "")); |
277 | } else |
278 | #endif |
279 | if (opt == NON_OPT) |
280 | printf(" %s", normalize(optarg)); |
281 | else { |
282 | const char *charptr; |
283 | printf(" -%c", opt); |
284 | charptr = strchr(optstr, opt); |
285 | if (charptr && *++charptr == ':') |
286 | printf(" %s", |
287 | normalize(optarg ? optarg : "")); |
288 | } |
289 | } |
290 | } |
291 | |
292 | if (!quiet_output) { |
293 | unsigned idx; |
294 | printf(" --"); |
295 | idx = optind; |
296 | while (argv[idx]) |
297 | printf(" %s", normalize(argv[idx++])); |
298 | bb_putchar('\n'); |
299 | } |
300 | return exit_code; |
301 | } |
302 | |
303 | #if ENABLE_FEATURE_GETOPT_LONG |
304 | /* |
305 | * Register several long options. options is a string of long options, |
306 | * separated by commas or whitespace. |
307 | * This nukes options! |
308 | */ |
309 | static struct option *add_long_options(struct option *long_options, char *options) |
310 | { |
311 | int long_nr = 0; |
312 | int arg_opt, tlen; |
313 | char *tokptr = strtok(options, ", \t\n"); |
314 | |
315 | if (long_options) |
316 | while (long_options[long_nr].name) |
317 | long_nr++; |
318 | |
319 | while (tokptr) { |
320 | arg_opt = no_argument; |
321 | tlen = strlen(tokptr); |
322 | if (tlen) { |
323 | tlen--; |
324 | if (tokptr[tlen] == ':') { |
325 | arg_opt = required_argument; |
326 | if (tlen && tokptr[tlen-1] == ':') { |
327 | tlen--; |
328 | arg_opt = optional_argument; |
329 | } |
330 | tokptr[tlen] = '\0'; |
331 | if (tlen == 0) |
332 | bb_error_msg_and_die("empty long option specified"); |
333 | } |
334 | long_options = xrealloc_vector(long_options, 4, long_nr); |
335 | long_options[long_nr].has_arg = arg_opt; |
336 | /*long_options[long_nr].flag = NULL; - xrealloc_vector did it */ |
337 | long_options[long_nr].val = LONG_OPT; |
338 | long_options[long_nr].name = xstrdup(tokptr); |
339 | long_nr++; |
340 | /*memset(&long_options[long_nr], 0, sizeof(long_options[0])); - xrealloc_vector did it */ |
341 | } |
342 | tokptr = strtok(NULL, ", \t\n"); |
343 | } |
344 | return long_options; |
345 | } |
346 | #endif |
347 | |
348 | static void set_shell(const char *new_shell) |
349 | { |
350 | if (strcmp(new_shell, "bash") == 0 || strcmp(new_shell, "sh") == 0) |
351 | return; |
352 | if (strcmp(new_shell, "tcsh") == 0 || strcmp(new_shell, "csh") == 0) |
353 | option_mask32 |= SHELL_IS_TCSH; |
354 | else |
355 | bb_error_msg("unknown shell '%s', assuming bash", new_shell); |
356 | } |
357 | |
358 | |
359 | /* Exit codes: |
360 | * 0) No errors, successful operation. |
361 | * 1) getopt(3) returned an error. |
362 | * 2) A problem with parameter parsing for getopt(1). |
363 | * 3) Internal error, out of memory |
364 | * 4) Returned for -T |
365 | */ |
366 | |
367 | #if ENABLE_FEATURE_GETOPT_LONG |
368 | static const char getopt_longopts[] ALIGN1 = |
369 | "options\0" Required_argument "o" |
370 | "longoptions\0" Required_argument "l" |
371 | "quiet\0" No_argument "q" |
372 | "quiet-output\0" No_argument "Q" |
373 | "shell\0" Required_argument "s" |
374 | "test\0" No_argument "T" |
375 | "unquoted\0" No_argument "u" |
376 | "alternative\0" No_argument "a" |
377 | "name\0" Required_argument "n" |
378 | ; |
379 | #endif |
380 | |
381 | int getopt_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; |
382 | int getopt_main(int argc, char **argv) |
383 | { |
384 | int n; |
385 | char *optstr = NULL; |
386 | char *name = NULL; |
387 | unsigned opt; |
388 | const char *compatible; |
389 | char *s_arg; |
390 | #if ENABLE_FEATURE_GETOPT_LONG |
391 | struct option *long_options = NULL; |
392 | llist_t *l_arg = NULL; |
393 | #endif |
394 | |
395 | compatible = getenv("GETOPT_COMPATIBLE"); /* used as yes/no flag */ |
396 | |
397 | if (!argv[1]) { |
398 | if (compatible) { |
399 | /* For some reason, the original getopt gave no error |
400 | * when there were no arguments. */ |
401 | puts(" --"); |
402 | return 0; |
403 | } |
404 | bb_error_msg_and_die("missing optstring argument"); |
405 | } |
406 | |
407 | if (argv[1][0] != '-' || compatible) { |
408 | char *s = argv[1]; |
409 | |
410 | option_mask32 |= OPT_u; /* quoting off */ |
411 | s = xstrdup(s + strspn(s, "-+")); |
412 | argv[1] = argv[0]; |
413 | return generate_output(argv+1, argc-1, s, long_options); |
414 | } |
415 | |
416 | #if !ENABLE_FEATURE_GETOPT_LONG |
417 | opt = getopt32(argv, "+o:n:qQs:Tu", &optstr, &name, &s_arg); |
418 | #else |
419 | applet_long_options = getopt_longopts; |
420 | opt = getopt32(argv, "+o:n:qQs:Tual:*", |
421 | &optstr, &name, &s_arg, &l_arg); |
422 | /* Effectuate the read options for the applet itself */ |
423 | while (l_arg) { |
424 | long_options = add_long_options(long_options, llist_pop(&l_arg)); |
425 | } |
426 | #endif |
427 | |
428 | if (opt & OPT_s) { |
429 | set_shell(s_arg); |
430 | } |
431 | |
432 | if (opt & OPT_T) { |
433 | return 4; |
434 | } |
435 | |
436 | /* All options controlling the applet have now been parsed */ |
437 | n = optind - 1; |
438 | if (!optstr) { |
439 | optstr = argv[++n]; |
440 | if (!optstr) |
441 | bb_error_msg_and_die("missing optstring argument"); |
442 | } |
443 | |
444 | argv[n] = name ? name : argv[0]; |
445 | return generate_output(argv + n, argc - n, optstr, long_options); |
446 | } |
447 |