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.
9 * Version 1.0-b4: Tue Sep 23 1997. First public release.
10 * Version 1.0: Wed Nov 19 1997.
11 * Bumped up the version number to 1.0
12 * Fixed minor typo (CSH instead of TCSH)
13 * Version 1.0.1: Tue Jun 3 1998
14 * Fixed sizeof instead of strlen bug
15 * Bumped up the version number to 1.0.1
16 * Version 1.0.2: Thu Jun 11 1998 (not present)
17 * Fixed gcc-2.8.1 warnings
18 * Fixed --version/-V option (not present)
19 * Version 1.0.5: Tue Jun 22 1999
20 * Make -u option work (not present)
21 * Version 1.0.6: Tue Jun 27 2000
22 * No important changes
23 * Version 1.1.0: Tue Jun 30 2000
24 * Added NLS support (partly written by Arkadiusz Mickiewicz
25 * <misiek@misiek.eu.org>)
26 * Ported to Busybox - Alfred M. Szmidt <ams@trillian.itslinux.org>
27 * Removed --version/-V and --help/-h
28 * Removed parse_error(), using bb_error_msg() from Busybox instead
29 * Replaced our_malloc with xmalloc and our_realloc with xrealloc
31 //config:config GETOPT
32 //config: bool "getopt (5.8 kb)"
35 //config: The getopt utility is used to break up (parse) options in command
36 //config: lines to make it easy to write complex shell scripts that also check
37 //config: for legal (and illegal) options. If you want to write horribly
38 //config: complex shell scripts, or use some horribly complex shell script
39 //config: written by others, this utility may be for you. Most people will
40 //config: wisely leave this disabled.
42 //config:config FEATURE_GETOPT_LONG
43 //config: bool "Support -l LONGOPTs"
45 //config: depends on GETOPT && LONG_OPTS
47 //config: Enable support for long options (option -l).
49 //applet:IF_GETOPT(APPLET_NOEXEC(getopt, getopt, BB_DIR_BIN, BB_SUID_DROP, getopt))
51 //kbuild:lib-$(CONFIG_GETOPT) += getopt.o
53 //usage:#define getopt_trivial_usage
54 //usage: "[OPTIONS] [--] OPTSTRING PARAMS"
55 //usage:#define getopt_full_usage "\n\n"
56 //usage: IF_FEATURE_GETOPT_LONG(
57 //usage: " -a Allow long options starting with single -\n"
58 //usage: " -l LOPT[,...] Long options to recognize\n"
60 //usage: " -n PROGNAME The name under which errors are reported"
61 //usage: "\n -o OPTSTRING Short options to recognize"
62 //usage: "\n -q No error messages on unrecognized options"
63 //usage: "\n -Q No normal output"
64 //usage: "\n -s SHELL Set shell quoting conventions"
65 //usage: "\n -T Version test (exits with 4)"
66 //usage: "\n -u Don't quote output"
67 //usage: IF_FEATURE_GETOPT_LONG( /* example uses -l, needs FEATURE_GETOPT_LONG */
71 //usage: "\nO=`getopt -l bb: -- ab:c:: \"$@\"` || exit 1"
72 //usage: "\neval set -- \"$O\""
73 //usage: "\nwhile true; do"
74 //usage: "\n case \"$1\" in"
75 //usage: "\n -a) echo A; shift;;"
76 //usage: "\n -b|--bb) echo \"B:'$2'\"; shift 2;;"
77 //usage: "\n -c) case \"$2\" in"
78 //usage: "\n \"\") echo C; shift 2;;"
79 //usage: "\n *) echo \"C:'$2'\"; shift 2;;"
81 //usage: "\n --) shift; break;;"
82 //usage: "\n *) echo Error; exit 1;;"
87 //usage:#define getopt_example_usage
88 //usage: "$ cat getopt.test\n"
89 //usage: "#!/bin/sh\n"
90 //usage: "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n"
91 //usage: " -n 'example.busybox' -- \"$@\"`\n"
92 //usage: "if [ $? != 0 ]; then exit 1; fi\n"
93 //usage: "eval set -- \"$GETOPT\"\n"
94 //usage: "while true; do\n"
95 //usage: " case $1 in\n"
96 //usage: " -a|--a-long) echo \"Option a\"; shift;;\n"
97 //usage: " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n"
98 //usage: " -c|--c-long)\n"
99 //usage: " case \"$2\" in\n"
100 //usage: " \"\") echo \"Option c, no argument\"; shift 2;;\n"
101 //usage: " *) echo \"Option c, argument '$2'\"; shift 2;;\n"
103 //usage: " --) shift; break;;\n"
104 //usage: " *) echo \"Internal error!\"; exit 1;;\n"
108 #if ENABLE_FEATURE_GETOPT_LONG
113 /* NON_OPT is the code that is returned when a non-option is found in '+'
117 #if ENABLE_FEATURE_GETOPT_LONG
118 /* LONG_OPT is the code that is returned when a long option is found. */
123 /* For finding activated option flags. Must match getopt32 call! */
132 #if ENABLE_FEATURE_GETOPT_LONG
136 SHELL_IS_TCSH = 0x8000, /* hijack this bit for other purposes */
139 /* 0 is getopt_long, 1 is getopt_long_only */
140 #define alternative (option_mask32 & OPT_a)
142 #define quiet_errors (option_mask32 & OPT_q)
143 #define quiet_output (option_mask32 & OPT_Q)
144 #define quote (!(option_mask32 & OPT_u))
145 #define shell_TCSH (option_mask32 & SHELL_IS_TCSH)
148 * This function 'normalizes' a single argument: it puts single quotes around
149 * it and escapes other special characters. If quote is false, it just
150 * returns its argument.
151 * Bash only needs special treatment for single quotes; tcsh also recognizes
152 * exclamation marks within single quotes, and nukes whitespace.
153 * This function returns a pointer to a buffer that is overwritten by
156 static const char *normalize(const char *arg)
159 #if ENABLE_FEATURE_CLEAN_UP
160 static char *BUFFER = NULL;
166 if (!quote) { /* Just copy arg */
167 BUFFER = xstrdup(arg);
171 /* Each character in arg may take up to four characters in the result:
172 For a quote we need a closing quote, a backslash, a quote and an
173 opening quote! We need also the global opening and closing quote,
174 and one extra character for '\0'. */
175 BUFFER = xmalloc(strlen(arg)*4 + 3);
182 /* Quote: replace it with: '\'' */
187 } else if (shell_TCSH && *arg == '!') {
188 /* Exclamation mark: replace it with: \! */
193 } else if (shell_TCSH && *arg == '\n') {
194 /* Newline: replace it with: \n */
197 } else if (shell_TCSH && isspace(*arg)) {
198 /* Non-newline whitespace: replace it with \<ws> */
214 * Generate the output. argv[0] is the program name (used for reporting errors).
215 * argv[1..] contains the options to be parsed. argc must be the number of
216 * elements in argv (ie. 1 if there are no options, only the program name),
217 * optstr must contain the short options, and longopts the long options.
218 * Other settings are found in global variables.
220 #if !ENABLE_FEATURE_GETOPT_LONG
221 #define generate_output(argv,argc,optstr,longopts) \
222 generate_output(argv,argc,optstr)
224 static int generate_output(char **argv, int argc, const char *optstr, const struct option *longopts)
226 int exit_code = 0; /* We assume everything will be OK */
228 if (quiet_errors) /* No error reporting from getopt(3) */
231 /* We used it already in main() in getopt32(),
232 * we *must* reset getopt(3): */
236 #if ENABLE_FEATURE_GETOPT_LONG
238 int opt = alternative
239 ? getopt_long_only(argc, argv, optstr, longopts, &longindex)
240 : getopt_long(argc, argv, optstr, longopts, &longindex)
243 int opt = getopt(argc, argv, optstr);
247 if (opt == '?' || opt == ':' )
249 else if (!quiet_output) {
250 #if ENABLE_FEATURE_GETOPT_LONG
251 if (opt == LONG_OPT) {
252 printf(" --%s", longopts[longindex].name);
253 if (longopts[longindex].has_arg)
255 normalize(optarg ? optarg : ""));
259 printf(" %s", normalize(optarg));
263 charptr = strchr(optstr, opt);
264 if (charptr && *++charptr == ':')
266 normalize(optarg ? optarg : ""));
276 printf(" %s", normalize(argv[idx++]));
282 #if ENABLE_FEATURE_GETOPT_LONG
284 * Register several long options. options is a string of long options,
285 * separated by commas or whitespace.
286 * This nukes options!
288 static struct option *add_long_options(struct option *long_options, char *options)
292 char *tokptr = strtok(options, ", \t\n");
295 while (long_options[long_nr].name)
299 arg_opt = no_argument;
300 tlen = strlen(tokptr);
303 if (tokptr[tlen] == ':') {
304 arg_opt = required_argument;
305 if (tlen && tokptr[tlen-1] == ':') {
307 arg_opt = optional_argument;
311 bb_simple_error_msg_and_die("empty long option specified");
313 long_options = xrealloc_vector(long_options, 4, long_nr);
314 long_options[long_nr].has_arg = arg_opt;
315 /*long_options[long_nr].flag = NULL; - xrealloc_vector did it */
316 long_options[long_nr].val = LONG_OPT;
317 long_options[long_nr].name = xstrdup(tokptr);
319 /*memset(&long_options[long_nr], 0, sizeof(long_options[0])); - xrealloc_vector did it */
321 tokptr = strtok(NULL, ", \t\n");
327 static void set_shell(const char *new_shell)
329 if (strcmp(new_shell, "bash") == 0 || strcmp(new_shell, "sh") == 0)
331 if (strcmp(new_shell, "tcsh") == 0 || strcmp(new_shell, "csh") == 0)
332 option_mask32 |= SHELL_IS_TCSH;
334 bb_error_msg("unknown shell '%s', assuming bash", new_shell);
339 * 0) No errors, successful operation.
340 * 1) getopt(3) returned an error.
341 * 2) A problem with parameter parsing for getopt(1).
342 * 3) Internal error, out of memory
346 #if ENABLE_FEATURE_GETOPT_LONG
347 static const char getopt_longopts[] ALIGN1 =
348 "options\0" Required_argument "o"
349 "longoptions\0" Required_argument "l"
350 "quiet\0" No_argument "q"
351 "quiet-output\0" No_argument "Q"
352 "shell\0" Required_argument "s"
353 "test\0" No_argument "T"
354 "unquoted\0" No_argument "u"
355 "alternative\0" No_argument "a"
356 "name\0" Required_argument "n"
360 int getopt_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
361 int getopt_main(int argc, char **argv)
367 const char *compatible;
369 #if ENABLE_FEATURE_GETOPT_LONG
370 struct option *long_options = NULL;
371 llist_t *l_arg = NULL;
374 compatible = getenv("GETOPT_COMPATIBLE"); /* used as yes/no flag */
378 /* For some reason, the original getopt gave no error
379 * when there were no arguments. */
383 bb_simple_error_msg_and_die("missing optstring argument");
386 if (argv[1][0] != '-' || compatible) {
389 option_mask32 |= OPT_u; /* quoting off */
390 s = xstrdup(s + strspn(s, "-+"));
392 return generate_output(argv+1, argc-1, s, long_options);
395 #if !ENABLE_FEATURE_GETOPT_LONG
396 opt = getopt32(argv, "+o:n:qQs:Tu", &optstr, &name, &s_arg);
398 opt = getopt32long(argv, "+o:n:qQs:Tual:*", getopt_longopts,
399 &optstr, &name, &s_arg, &l_arg);
400 /* Effectuate the read options for the applet itself */
402 long_options = add_long_options(long_options, llist_pop(&l_arg));
414 /* All options controlling the applet have now been parsed */
419 bb_simple_error_msg_and_die("missing optstring argument");
422 argv[n] = name ? name : argv[0];
423 return generate_output(argv + n, argc - n, optstr, long_options);