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 tarball for details.
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 Mi<B6>kiewicz
26 * <misiek@misiek.eu.org>)
27 * Ported to Busybox - Alfred M. Szmidt <ams@trillian.itslinux.org>
28 * Removed --version/-V and --help/-h in
29 * Removed parse_error(), using bb_error_msg() from Busybox instead
30 * Replaced our_malloc with xmalloc and our_realloc with xrealloc
37 /* NON_OPT is the code that is returned when a non-option is found in '+'
41 #if ENABLE_GETOPT_LONG
42 /* LONG_OPT is the code that is returned when a long option is found. */
47 /* For finding activated option flags. Must match getopt32 call! */
56 #if ENABLE_GETOPT_LONG
60 SHELL_IS_TCSH = 0x8000, /* hijack this bit for other purposes */
63 /* 0 is getopt_long, 1 is getopt_long_only */
64 #define alternative (option_mask32 & OPT_a)
66 #define quiet_errors (option_mask32 & OPT_q)
67 #define quiet_output (option_mask32 & OPT_Q)
68 #define quote (!(option_mask32 & OPT_u))
69 #define shell_TCSH (option_mask32 & SHELL_IS_TCSH)
72 * This function 'normalizes' a single argument: it puts single quotes around
73 * it and escapes other special characters. If quote is false, it just
74 * returns its argument.
75 * Bash only needs special treatment for single quotes; tcsh also recognizes
76 * exclamation marks within single quotes, and nukes whitespace.
77 * This function returns a pointer to a buffer that is overwritten by
80 static const char *normalize(const char *arg)
83 #if ENABLE_FEATURE_CLEAN_UP
84 static char *BUFFER = NULL;
90 if (!quote) { /* Just copy arg */
91 BUFFER = xstrdup(arg);
95 /* Each character in arg may take up to four characters in the result:
96 For a quote we need a closing quote, a backslash, a quote and an
97 opening quote! We need also the global opening and closing quote,
98 and one extra character for '\0'. */
99 BUFFER = xmalloc(strlen(arg)*4 + 3);
106 /* Quote: replace it with: '\'' */
111 } else if (shell_TCSH && *arg == '!') {
112 /* Exclamation mark: replace it with: \! */
117 } else if (shell_TCSH && *arg == '\n') {
118 /* Newline: replace it with: \n */
121 } else if (shell_TCSH && isspace(*arg)) {
122 /* Non-newline whitespace: replace it with \<ws> */
138 * Generate the output. argv[0] is the program name (used for reporting errors).
139 * argv[1..] contains the options to be parsed. argc must be the number of
140 * elements in argv (ie. 1 if there are no options, only the program name),
141 * optstr must contain the short options, and longopts the long options.
142 * Other settings are found in global variables.
144 #if !ENABLE_GETOPT_LONG
145 #define generate_output(argv,argc,optstr,longopts) generate_output(argv,argc,optstr)
147 static int generate_output(char **argv, int argc, const char *optstr, const struct option *longopts)
149 int exit_code = 0; /* We assume everything will be OK */
151 #if ENABLE_GETOPT_LONG
156 if (quiet_errors) /* No error reporting from getopt(3) */
158 optind = 0; /* Reset getopt(3) */
162 #if ENABLE_GETOPT_LONG
164 getopt_long_only(argc, argv, optstr, longopts, &longindex) :
165 getopt_long(argc, argv, optstr, longopts, &longindex);
167 getopt(argc, argv, optstr);
171 if (opt == '?' || opt == ':' )
173 else if (!quiet_output) {
174 #if ENABLE_GETOPT_LONG
175 if (opt == LONG_OPT) {
176 printf(" --%s", longopts[longindex].name);
177 if (longopts[longindex].has_arg)
179 normalize(optarg ? optarg : ""));
183 printf(" %s", normalize(optarg));
186 charptr = strchr(optstr,opt);
187 if (charptr != NULL && *++charptr == ':')
189 normalize(optarg ? optarg : ""));
196 while (optind < argc)
197 printf(" %s", normalize(argv[optind++]));
203 #if ENABLE_GETOPT_LONG
205 * Register several long options. options is a string of long options,
206 * separated by commas or whitespace.
207 * This nukes options!
209 static struct option *add_long_options(struct option *long_options, char *options)
213 char *tokptr = strtok(options, ", \t\n");
216 while (long_options[long_nr].name)
220 arg_opt = no_argument;
221 tlen = strlen(tokptr);
224 if (tokptr[tlen] == ':') {
225 arg_opt = required_argument;
226 if (tlen && tokptr[tlen-1] == ':') {
228 arg_opt = optional_argument;
232 bb_error_msg_and_die("empty long option specified");
234 long_options = xrealloc(long_options,
235 sizeof(long_options[0]) * (long_nr+2));
236 long_options[long_nr].has_arg = arg_opt;
237 long_options[long_nr].flag = NULL;
238 long_options[long_nr].val = LONG_OPT;
239 long_options[long_nr].name = xstrdup(tokptr);
241 memset(&long_options[long_nr], 0, sizeof(long_options[0]));
243 tokptr = strtok(NULL, ", \t\n");
249 static void set_shell(const char *new_shell)
251 if (!strcmp(new_shell,"bash") || !strcmp(new_shell,"sh"))
253 if (!strcmp(new_shell,"tcsh") || !strcmp(new_shell,"csh"))
254 option_mask32 |= SHELL_IS_TCSH;
256 bb_error_msg("unknown shell '%s', assuming bash", new_shell);
261 * 0) No errors, successful operation.
262 * 1) getopt(3) returned an error.
263 * 2) A problem with parameter parsing for getopt(1).
264 * 3) Internal error, out of memory
268 #if ENABLE_GETOPT_LONG
269 static const struct option longopts[] = {
270 { "options", required_argument, NULL, 'o' },
271 { "longoptions", required_argument, NULL, 'l' },
272 { "quiet", no_argument, NULL, 'q' },
273 { "quiet-output", no_argument, NULL, 'Q' },
274 { "shell", required_argument, NULL, 's' },
275 { "test", no_argument, NULL, 'T' },
276 { "unquoted", no_argument, NULL, 'u' },
277 { "alternative", no_argument, NULL, 'a' },
278 { "name", required_argument, NULL, 'n' },
283 int getopt_main(int argc, char *argv[]);
284 int getopt_main(int argc, char *argv[])
289 const char *compatible;
291 #if ENABLE_GETOPT_LONG
292 struct option *long_options = NULL;
293 llist_t *l_arg = NULL;
296 compatible = getenv("GETOPT_COMPATIBLE"); /* used as yes/no flag */
300 /* For some reason, the original getopt gave no error
301 when there were no arguments. */
305 bb_error_msg_and_die("missing optstring argument");
308 if (argv[1][0] != '-' || compatible) {
311 option_mask32 |= OPT_u; /* quoting off */
312 s = xstrdup(argv[1] + strspn(argv[1], "-+"));
314 return generate_output(argv+1, argc-1, s, long_options);
317 #if !ENABLE_GETOPT_LONG
318 opt = getopt32(argc, argv, "+o:n:qQs:Tu", &optstr, &name, &s_arg);
320 applet_long_options = longopts;
321 opt_complementary = "?:l::";
322 opt = getopt32(argc, argv, "+o:n:qQs:Tual:",
323 &optstr, &name, &s_arg, &l_arg);
324 /* Effectuate the read options for the applet itself */
326 long_options = add_long_options(long_options, l_arg->data);
339 /* All options controlling the applet have now been parsed */
342 bb_error_msg_and_die("missing optstring argument");
343 optstr = argv[optind++];
346 argv[optind-1] = name ? name : argv[0];
347 return generate_output(argv+optind-1, argc-optind+1, optstr, long_options);