1 /* vi: set sw=4 ts=4: */
3 * getopt.c - Enhanced implementation of BSD getopt(1)
4 * Copyright (c) 1997, 1998, 1999, 2000 Frodo Looijaard <frodol@dds.nl>
6 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
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
34 //usage:#define getopt_trivial_usage
35 //usage: "[OPTIONS] [--] OPTSTRING PARAMS"
36 //usage:#define getopt_full_usage "\n\n"
37 //usage: IF_LONG_OPTS(
38 //usage: " -a,--alternative Allow long options starting with single -"
39 //usage: "\n -l,--longoptions=LOPT[,...] Long options to be recognized"
40 //usage: "\n -n,--name=PROGNAME The name under which errors are reported"
41 //usage: "\n -o,--options=OPTSTRING Short options to be recognized"
42 //usage: "\n -q,--quiet Disable error reporting by getopt(3)"
43 //usage: "\n -Q,--quiet-output No normal output"
44 //usage: "\n -s,--shell=SHELL Set shell quoting conventions"
45 //usage: "\n -T,--test Test for getopt(1) version"
46 //usage: "\n -u,--unquoted Don't quote the output"
48 //usage: IF_NOT_LONG_OPTS(
49 //usage: " -a Allow long options starting with single -"
50 //usage: "\n -l LOPT[,...] Long options to be recognized"
51 //usage: "\n -n PROGNAME The name under which errors are reported"
52 //usage: "\n -o OPTSTRING Short options to be recognized"
53 //usage: "\n -q Disable error reporting by getopt(3)"
54 //usage: "\n -Q No normal output"
55 //usage: "\n -s SHELL Set shell quoting conventions"
56 //usage: "\n -T Test for getopt(1) version"
57 //usage: "\n -u Don't quote the output"
62 //usage: "\nO=`getopt -l bb: -- ab:c:: \"$@\"` || exit 1"
63 //usage: "\neval set -- \"$O\""
64 //usage: "\nwhile true; do"
65 //usage: "\n case \"$1\" in"
66 //usage: "\n -a) echo A; shift;;"
67 //usage: "\n -b|--bb) echo \"B:'$2'\"; shift 2;;"
68 //usage: "\n -c) case \"$2\" in"
69 //usage: "\n \"\") echo C; shift 2;;"
70 //usage: "\n *) echo \"C:'$2'\"; shift 2;;"
72 //usage: "\n --) shift; break;;"
73 //usage: "\n *) echo Error; exit 1;;"
77 //usage:#define getopt_example_usage
78 //usage: "$ cat getopt.test\n"
79 //usage: "#!/bin/sh\n"
80 //usage: "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n"
81 //usage: " -n 'example.busybox' -- \"$@\"`\n"
82 //usage: "if [ $? != 0 ]; then exit 1; fi\n"
83 //usage: "eval set -- \"$GETOPT\"\n"
84 //usage: "while true; do\n"
85 //usage: " case $1 in\n"
86 //usage: " -a|--a-long) echo \"Option a\"; shift;;\n"
87 //usage: " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n"
88 //usage: " -c|--c-long)\n"
89 //usage: " case \"$2\" in\n"
90 //usage: " \"\") echo \"Option c, no argument\"; shift 2;;\n"
91 //usage: " *) echo \"Option c, argument '$2'\"; shift 2;;\n"
93 //usage: " --) shift; break;;\n"
94 //usage: " *) echo \"Internal error!\"; exit 1;;\n"
98 #if ENABLE_FEATURE_GETOPT_LONG
103 /* NON_OPT is the code that is returned when a non-option is found in '+'
107 #if ENABLE_FEATURE_GETOPT_LONG
108 /* LONG_OPT is the code that is returned when a long option is found. */
113 /* For finding activated option flags. Must match getopt32 call! */
122 #if ENABLE_FEATURE_GETOPT_LONG
126 SHELL_IS_TCSH = 0x8000, /* hijack this bit for other purposes */
129 /* 0 is getopt_long, 1 is getopt_long_only */
130 #define alternative (option_mask32 & OPT_a)
132 #define quiet_errors (option_mask32 & OPT_q)
133 #define quiet_output (option_mask32 & OPT_Q)
134 #define quote (!(option_mask32 & OPT_u))
135 #define shell_TCSH (option_mask32 & SHELL_IS_TCSH)
138 * This function 'normalizes' a single argument: it puts single quotes around
139 * it and escapes other special characters. If quote is false, it just
140 * returns its argument.
141 * Bash only needs special treatment for single quotes; tcsh also recognizes
142 * exclamation marks within single quotes, and nukes whitespace.
143 * This function returns a pointer to a buffer that is overwritten by
146 static const char *normalize(const char *arg)
149 #if ENABLE_FEATURE_CLEAN_UP
150 static char *BUFFER = NULL;
156 if (!quote) { /* Just copy arg */
157 BUFFER = xstrdup(arg);
161 /* Each character in arg may take up to four characters in the result:
162 For a quote we need a closing quote, a backslash, a quote and an
163 opening quote! We need also the global opening and closing quote,
164 and one extra character for '\0'. */
165 BUFFER = xmalloc(strlen(arg)*4 + 3);
172 /* Quote: replace it with: '\'' */
177 } else if (shell_TCSH && *arg == '!') {
178 /* Exclamation mark: replace it with: \! */
183 } else if (shell_TCSH && *arg == '\n') {
184 /* Newline: replace it with: \n */
187 } else if (shell_TCSH && isspace(*arg)) {
188 /* Non-newline whitespace: replace it with \<ws> */
204 * Generate the output. argv[0] is the program name (used for reporting errors).
205 * argv[1..] contains the options to be parsed. argc must be the number of
206 * elements in argv (ie. 1 if there are no options, only the program name),
207 * optstr must contain the short options, and longopts the long options.
208 * Other settings are found in global variables.
210 #if !ENABLE_FEATURE_GETOPT_LONG
211 #define generate_output(argv,argc,optstr,longopts) \
212 generate_output(argv,argc,optstr)
214 static int generate_output(char **argv, int argc, const char *optstr, const struct option *longopts)
216 int exit_code = 0; /* We assume everything will be OK */
218 #if ENABLE_FEATURE_GETOPT_LONG
223 if (quiet_errors) /* No error reporting from getopt(3) */
226 /* We used it already in main() in getopt32(),
227 * we *must* reset getopt(3): */
230 #else /* BSD style */
237 #if ENABLE_FEATURE_GETOPT_LONG
239 getopt_long_only(argc, argv, optstr, longopts, &longindex) :
240 getopt_long(argc, argv, optstr, longopts, &longindex);
242 getopt(argc, argv, optstr);
246 if (opt == '?' || opt == ':' )
248 else if (!quiet_output) {
249 #if ENABLE_FEATURE_GETOPT_LONG
250 if (opt == LONG_OPT) {
251 printf(" --%s", longopts[longindex].name);
252 if (longopts[longindex].has_arg)
254 normalize(optarg ? optarg : ""));
258 printf(" %s", normalize(optarg));
261 charptr = strchr(optstr, opt);
262 if (charptr != NULL && *++charptr == ':')
264 normalize(optarg ? optarg : ""));
271 while (optind < argc)
272 printf(" %s", normalize(argv[optind++]));
278 #if ENABLE_FEATURE_GETOPT_LONG
280 * Register several long options. options is a string of long options,
281 * separated by commas or whitespace.
282 * This nukes options!
284 static struct option *add_long_options(struct option *long_options, char *options)
288 char *tokptr = strtok(options, ", \t\n");
291 while (long_options[long_nr].name)
295 arg_opt = no_argument;
296 tlen = strlen(tokptr);
299 if (tokptr[tlen] == ':') {
300 arg_opt = required_argument;
301 if (tlen && tokptr[tlen-1] == ':') {
303 arg_opt = optional_argument;
307 bb_error_msg_and_die("empty long option specified");
309 long_options = xrealloc_vector(long_options, 4, long_nr);
310 long_options[long_nr].has_arg = arg_opt;
311 /*long_options[long_nr].flag = NULL; - xrealloc_vector did it */
312 long_options[long_nr].val = LONG_OPT;
313 long_options[long_nr].name = xstrdup(tokptr);
315 /*memset(&long_options[long_nr], 0, sizeof(long_options[0])); - xrealloc_vector did it */
317 tokptr = strtok(NULL, ", \t\n");
323 static void set_shell(const char *new_shell)
325 if (!strcmp(new_shell, "bash") || !strcmp(new_shell, "sh"))
327 if (!strcmp(new_shell, "tcsh") || !strcmp(new_shell, "csh"))
328 option_mask32 |= SHELL_IS_TCSH;
330 bb_error_msg("unknown shell '%s', assuming bash", new_shell);
335 * 0) No errors, successful operation.
336 * 1) getopt(3) returned an error.
337 * 2) A problem with parameter parsing for getopt(1).
338 * 3) Internal error, out of memory
342 #if ENABLE_FEATURE_GETOPT_LONG
343 static const char getopt_longopts[] ALIGN1 =
344 "options\0" Required_argument "o"
345 "longoptions\0" Required_argument "l"
346 "quiet\0" No_argument "q"
347 "quiet-output\0" No_argument "Q"
348 "shell\0" Required_argument "s"
349 "test\0" No_argument "T"
350 "unquoted\0" No_argument "u"
351 "alternative\0" No_argument "a"
352 "name\0" Required_argument "n"
356 int getopt_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
357 int getopt_main(int argc, char **argv)
363 const char *compatible;
365 #if ENABLE_FEATURE_GETOPT_LONG
366 struct option *long_options = NULL;
367 llist_t *l_arg = NULL;
370 compatible = getenv("GETOPT_COMPATIBLE"); /* used as yes/no flag */
374 /* For some reason, the original getopt gave no error
375 * when there were no arguments. */
379 bb_error_msg_and_die("missing optstring argument");
382 if (argv[1][0] != '-' || compatible) {
385 option_mask32 |= OPT_u; /* quoting off */
386 s = xstrdup(s + strspn(s, "-+"));
388 return generate_output(argv+1, argc-1, s, long_options);
391 #if !ENABLE_FEATURE_GETOPT_LONG
392 opt = getopt32(argv, "+o:n:qQs:Tu", &optstr, &name, &s_arg);
394 applet_long_options = getopt_longopts;
395 opt_complementary = "l::";
396 opt = getopt32(argv, "+o:n:qQs:Tual:",
397 &optstr, &name, &s_arg, &l_arg);
398 /* Effectuate the read options for the applet itself */
400 long_options = add_long_options(long_options, llist_pop(&l_arg));
412 /* All options controlling the applet have now been parsed */
417 bb_error_msg_and_die("missing optstring argument");
420 argv[n] = name ? name : argv[0];
421 return generate_output(argv + n, argc - n, optstr, long_options);