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
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=longopts 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 longopts 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"
60 //usage:#define getopt_example_usage
61 //usage: "$ cat getopt.test\n"
62 //usage: "#!/bin/sh\n"
63 //usage: "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n"
64 //usage: " -n 'example.busybox' -- \"$@\"`\n"
65 //usage: "if [ $? != 0 ]; then exit 1; fi\n"
66 //usage: "eval set -- \"$GETOPT\"\n"
67 //usage: "while true; do\n"
68 //usage: " case $1 in\n"
69 //usage: " -a|--a-long) echo \"Option a\"; shift;;\n"
70 //usage: " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n"
71 //usage: " -c|--c-long)\n"
72 //usage: " case \"$2\" in\n"
73 //usage: " \"\") echo \"Option c, no argument\"; shift 2;;\n"
74 //usage: " *) echo \"Option c, argument '$2'\"; shift 2;;\n"
76 //usage: " --) shift; break;;\n"
77 //usage: " *) echo \"Internal error!\"; exit 1;;\n"
81 #if ENABLE_FEATURE_GETOPT_LONG
86 /* NON_OPT is the code that is returned when a non-option is found in '+'
90 #if ENABLE_FEATURE_GETOPT_LONG
91 /* LONG_OPT is the code that is returned when a long option is found. */
96 /* For finding activated option flags. Must match getopt32 call! */
105 #if ENABLE_FEATURE_GETOPT_LONG
109 SHELL_IS_TCSH = 0x8000, /* hijack this bit for other purposes */
112 /* 0 is getopt_long, 1 is getopt_long_only */
113 #define alternative (option_mask32 & OPT_a)
115 #define quiet_errors (option_mask32 & OPT_q)
116 #define quiet_output (option_mask32 & OPT_Q)
117 #define quote (!(option_mask32 & OPT_u))
118 #define shell_TCSH (option_mask32 & SHELL_IS_TCSH)
121 * This function 'normalizes' a single argument: it puts single quotes around
122 * it and escapes other special characters. If quote is false, it just
123 * returns its argument.
124 * Bash only needs special treatment for single quotes; tcsh also recognizes
125 * exclamation marks within single quotes, and nukes whitespace.
126 * This function returns a pointer to a buffer that is overwritten by
129 static const char *normalize(const char *arg)
132 #if ENABLE_FEATURE_CLEAN_UP
133 static char *BUFFER = NULL;
139 if (!quote) { /* Just copy arg */
140 BUFFER = xstrdup(arg);
144 /* Each character in arg may take up to four characters in the result:
145 For a quote we need a closing quote, a backslash, a quote and an
146 opening quote! We need also the global opening and closing quote,
147 and one extra character for '\0'. */
148 BUFFER = xmalloc(strlen(arg)*4 + 3);
155 /* Quote: replace it with: '\'' */
160 } else if (shell_TCSH && *arg == '!') {
161 /* Exclamation mark: replace it with: \! */
166 } else if (shell_TCSH && *arg == '\n') {
167 /* Newline: replace it with: \n */
170 } else if (shell_TCSH && isspace(*arg)) {
171 /* Non-newline whitespace: replace it with \<ws> */
187 * Generate the output. argv[0] is the program name (used for reporting errors).
188 * argv[1..] contains the options to be parsed. argc must be the number of
189 * elements in argv (ie. 1 if there are no options, only the program name),
190 * optstr must contain the short options, and longopts the long options.
191 * Other settings are found in global variables.
193 #if !ENABLE_FEATURE_GETOPT_LONG
194 #define generate_output(argv,argc,optstr,longopts) \
195 generate_output(argv,argc,optstr)
197 static int generate_output(char **argv, int argc, const char *optstr, const struct option *longopts)
199 int exit_code = 0; /* We assume everything will be OK */
201 #if ENABLE_FEATURE_GETOPT_LONG
206 if (quiet_errors) /* No error reporting from getopt(3) */
209 /* We used it already in main() in getopt32(),
210 * we *must* reset getopt(3): */
213 #else /* BSD style */
220 #if ENABLE_FEATURE_GETOPT_LONG
222 getopt_long_only(argc, argv, optstr, longopts, &longindex) :
223 getopt_long(argc, argv, optstr, longopts, &longindex);
225 getopt(argc, argv, optstr);
229 if (opt == '?' || opt == ':' )
231 else if (!quiet_output) {
232 #if ENABLE_FEATURE_GETOPT_LONG
233 if (opt == LONG_OPT) {
234 printf(" --%s", longopts[longindex].name);
235 if (longopts[longindex].has_arg)
237 normalize(optarg ? optarg : ""));
241 printf(" %s", normalize(optarg));
244 charptr = strchr(optstr, opt);
245 if (charptr != NULL && *++charptr == ':')
247 normalize(optarg ? optarg : ""));
254 while (optind < argc)
255 printf(" %s", normalize(argv[optind++]));
261 #if ENABLE_FEATURE_GETOPT_LONG
263 * Register several long options. options is a string of long options,
264 * separated by commas or whitespace.
265 * This nukes options!
267 static struct option *add_long_options(struct option *long_options, char *options)
271 char *tokptr = strtok(options, ", \t\n");
274 while (long_options[long_nr].name)
278 arg_opt = no_argument;
279 tlen = strlen(tokptr);
282 if (tokptr[tlen] == ':') {
283 arg_opt = required_argument;
284 if (tlen && tokptr[tlen-1] == ':') {
286 arg_opt = optional_argument;
290 bb_error_msg_and_die("empty long option specified");
292 long_options = xrealloc_vector(long_options, 4, long_nr);
293 long_options[long_nr].has_arg = arg_opt;
294 /*long_options[long_nr].flag = NULL; - xrealloc_vector did it */
295 long_options[long_nr].val = LONG_OPT;
296 long_options[long_nr].name = xstrdup(tokptr);
298 /*memset(&long_options[long_nr], 0, sizeof(long_options[0])); - xrealloc_vector did it */
300 tokptr = strtok(NULL, ", \t\n");
306 static void set_shell(const char *new_shell)
308 if (!strcmp(new_shell, "bash") || !strcmp(new_shell, "sh"))
310 if (!strcmp(new_shell, "tcsh") || !strcmp(new_shell, "csh"))
311 option_mask32 |= SHELL_IS_TCSH;
313 bb_error_msg("unknown shell '%s', assuming bash", new_shell);
318 * 0) No errors, successful operation.
319 * 1) getopt(3) returned an error.
320 * 2) A problem with parameter parsing for getopt(1).
321 * 3) Internal error, out of memory
325 #if ENABLE_FEATURE_GETOPT_LONG
326 static const char getopt_longopts[] ALIGN1 =
327 "options\0" Required_argument "o"
328 "longoptions\0" Required_argument "l"
329 "quiet\0" No_argument "q"
330 "quiet-output\0" No_argument "Q"
331 "shell\0" Required_argument "s"
332 "test\0" No_argument "T"
333 "unquoted\0" No_argument "u"
334 "alternative\0" No_argument "a"
335 "name\0" Required_argument "n"
339 int getopt_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
340 int getopt_main(int argc, char **argv)
345 const char *compatible;
347 #if ENABLE_FEATURE_GETOPT_LONG
348 struct option *long_options = NULL;
349 llist_t *l_arg = NULL;
352 compatible = getenv("GETOPT_COMPATIBLE"); /* used as yes/no flag */
356 /* For some reason, the original getopt gave no error
357 when there were no arguments. */
361 bb_error_msg_and_die("missing optstring argument");
364 if (argv[1][0] != '-' || compatible) {
367 option_mask32 |= OPT_u; /* quoting off */
368 s = xstrdup(argv[1] + strspn(argv[1], "-+"));
370 return generate_output(argv+1, argc-1, s, long_options);
373 #if !ENABLE_FEATURE_GETOPT_LONG
374 opt = getopt32(argv, "+o:n:qQs:Tu", &optstr, &name, &s_arg);
376 applet_long_options = getopt_longopts;
377 opt_complementary = "l::";
378 opt = getopt32(argv, "+o:n:qQs:Tual:",
379 &optstr, &name, &s_arg, &l_arg);
380 /* Effectuate the read options for the applet itself */
382 long_options = add_long_options(long_options, llist_pop(&l_arg));
394 /* All options controlling the applet have now been parsed */
397 bb_error_msg_and_die("missing optstring argument");
398 optstr = argv[optind++];
401 argv[optind-1] = name ? name : argv[0];
402 return generate_output(argv+optind-1, argc-optind+1, optstr, long_options);