source: branches/3.2/mindi-busybox/util-linux/getopt.c @ 3232

Last change on this file since 3232 was 3232, checked in by bruno, 5 years ago
  • Update mindi-busybox to 1.21.1
File size: 12.2 KB
Line 
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 */
33
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"
47//usage:    )
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"
58//usage:    )
59//usage:     "\n"
60//usage:     "\nExample:"
61//usage:     "\n"
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;;"
71//usage:     "\n        esac;;"
72//usage:     "\n    --) shift; break;;"
73//usage:     "\n    *)  echo Error; exit 1;;"
74//usage:     "\n    esac"
75//usage:     "\ndone"
76//usage:
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"
92//usage:       "     esac;;\n"
93//usage:       "   --) shift; break;;\n"
94//usage:       "   *) echo \"Internal error!\"; exit 1;;\n"
95//usage:       " esac\n"
96//usage:       "done\n"
97
98#if ENABLE_FEATURE_GETOPT_LONG
99# include <getopt.h>
100#endif
101#include "libbb.h"
102
103/* NON_OPT is the code that is returned when a non-option is found in '+'
104   mode */
105enum {
106    NON_OPT = 1,
107#if ENABLE_FEATURE_GETOPT_LONG
108/* LONG_OPT is the code that is returned when a long option is found. */
109    LONG_OPT = 2
110#endif
111};
112
113/* For finding activated option flags. Must match getopt32 call! */
114enum {
115    OPT_o   = 0x1,  // -o
116    OPT_n   = 0x2,  // -n
117    OPT_q   = 0x4,  // -q
118    OPT_Q   = 0x8,  // -Q
119    OPT_s   = 0x10, // -s
120    OPT_T   = 0x20, // -T
121    OPT_u   = 0x40, // -u
122#if ENABLE_FEATURE_GETOPT_LONG
123    OPT_a   = 0x80, // -a
124    OPT_l   = 0x100, // -l
125#endif
126    SHELL_IS_TCSH = 0x8000, /* hijack this bit for other purposes */
127};
128
129/* 0 is getopt_long, 1 is getopt_long_only */
130#define alternative  (option_mask32 & OPT_a)
131
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)
136
137/*
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
144 * each call.
145 */
146static const char *normalize(const char *arg)
147{
148    char *bufptr;
149#if ENABLE_FEATURE_CLEAN_UP
150    static char *BUFFER = NULL;
151    free(BUFFER);
152#else
153    char *BUFFER;
154#endif
155
156    if (!quote) { /* Just copy arg */
157        BUFFER = xstrdup(arg);
158        return BUFFER;
159    }
160
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);
166
167    bufptr = BUFFER;
168    *bufptr ++= '\'';
169
170    while (*arg) {
171        if (*arg == '\'') {
172            /* Quote: replace it with: '\'' */
173            *bufptr ++= '\'';
174            *bufptr ++= '\\';
175            *bufptr ++= '\'';
176            *bufptr ++= '\'';
177        } else if (shell_TCSH && *arg == '!') {
178            /* Exclamation mark: replace it with: \! */
179            *bufptr ++= '\'';
180            *bufptr ++= '\\';
181            *bufptr ++= '!';
182            *bufptr ++= '\'';
183        } else if (shell_TCSH && *arg == '\n') {
184            /* Newline: replace it with: \n */
185            *bufptr ++= '\\';
186            *bufptr ++= 'n';
187        } else if (shell_TCSH && isspace(*arg)) {
188            /* Non-newline whitespace: replace it with \<ws> */
189            *bufptr ++= '\'';
190            *bufptr ++= '\\';
191            *bufptr ++= *arg;
192            *bufptr ++= '\'';
193        } else
194            /* Just copy */
195            *bufptr ++= *arg;
196        arg++;
197    }
198    *bufptr ++= '\'';
199    *bufptr ++= '\0';
200    return BUFFER;
201}
202
203/*
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.
209 */
210#if !ENABLE_FEATURE_GETOPT_LONG
211#define generate_output(argv,argc,optstr,longopts) \
212    generate_output(argv,argc,optstr)
213#endif
214static int generate_output(char **argv, int argc, const char *optstr, const struct option *longopts)
215{
216    int exit_code = 0; /* We assume everything will be OK */
217    int opt;
218#if ENABLE_FEATURE_GETOPT_LONG
219    int longindex;
220#endif
221    const char *charptr;
222
223    if (quiet_errors) /* No error reporting from getopt(3) */
224        opterr = 0;
225
226    /* We used it already in main() in getopt32(),
227     * we *must* reset getopt(3): */
228#ifdef __GLIBC__
229    optind = 0;
230#else /* BSD style */
231    optind = 1;
232    /* optreset = 1; */
233#endif
234
235    while (1) {
236        opt =
237#if ENABLE_FEATURE_GETOPT_LONG
238            alternative ?
239            getopt_long_only(argc, argv, optstr, longopts, &longindex) :
240            getopt_long(argc, argv, optstr, longopts, &longindex);
241#else
242            getopt(argc, argv, optstr);
243#endif
244        if (opt == -1)
245            break;
246        if (opt == '?' || opt == ':' )
247            exit_code = 1;
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)
253                    printf(" %s",
254                        normalize(optarg ? optarg : ""));
255            } else
256#endif
257            if (opt == NON_OPT)
258                printf(" %s", normalize(optarg));
259            else {
260                printf(" -%c", opt);
261                charptr = strchr(optstr, opt);
262                if (charptr != NULL && *++charptr == ':')
263                    printf(" %s",
264                        normalize(optarg ? optarg : ""));
265            }
266        }
267    }
268
269    if (!quiet_output) {
270        printf(" --");
271        while (optind < argc)
272            printf(" %s", normalize(argv[optind++]));
273        bb_putchar('\n');
274    }
275    return exit_code;
276}
277
278#if ENABLE_FEATURE_GETOPT_LONG
279/*
280 * Register several long options. options is a string of long options,
281 * separated by commas or whitespace.
282 * This nukes options!
283 */
284static struct option *add_long_options(struct option *long_options, char *options)
285{
286    int long_nr = 0;
287    int arg_opt, tlen;
288    char *tokptr = strtok(options, ", \t\n");
289
290    if (long_options)
291        while (long_options[long_nr].name)
292            long_nr++;
293
294    while (tokptr) {
295        arg_opt = no_argument;
296        tlen = strlen(tokptr);
297        if (tlen) {
298            tlen--;
299            if (tokptr[tlen] == ':') {
300                arg_opt = required_argument;
301                if (tlen && tokptr[tlen-1] == ':') {
302                    tlen--;
303                    arg_opt = optional_argument;
304                }
305                tokptr[tlen] = '\0';
306                if (tlen == 0)
307                    bb_error_msg_and_die("empty long option specified");
308            }
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);
314            long_nr++;
315            /*memset(&long_options[long_nr], 0, sizeof(long_options[0])); - xrealloc_vector did it */
316        }
317        tokptr = strtok(NULL, ", \t\n");
318    }
319    return long_options;
320}
321#endif
322
323static void set_shell(const char *new_shell)
324{
325    if (!strcmp(new_shell, "bash") || !strcmp(new_shell, "sh"))
326        return;
327    if (!strcmp(new_shell, "tcsh") || !strcmp(new_shell, "csh"))
328        option_mask32 |= SHELL_IS_TCSH;
329    else
330        bb_error_msg("unknown shell '%s', assuming bash", new_shell);
331}
332
333
334/* Exit codes:
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
339 *   4) Returned for -T
340 */
341
342#if ENABLE_FEATURE_GETOPT_LONG
343static 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"
353    ;
354#endif
355
356int getopt_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
357int getopt_main(int argc, char **argv)
358{
359    int n;
360    char *optstr = NULL;
361    char *name = NULL;
362    unsigned opt;
363    const char *compatible;
364    char *s_arg;
365#if ENABLE_FEATURE_GETOPT_LONG
366    struct option *long_options = NULL;
367    llist_t *l_arg = NULL;
368#endif
369
370    compatible = getenv("GETOPT_COMPATIBLE"); /* used as yes/no flag */
371
372    if (!argv[1]) {
373        if (compatible) {
374            /* For some reason, the original getopt gave no error
375             * when there were no arguments. */
376            printf(" --\n");
377            return 0;
378        }
379        bb_error_msg_and_die("missing optstring argument");
380    }
381
382    if (argv[1][0] != '-' || compatible) {
383        char *s = argv[1];
384
385        option_mask32 |= OPT_u; /* quoting off */
386        s = xstrdup(s + strspn(s, "-+"));
387        argv[1] = argv[0];
388        return generate_output(argv+1, argc-1, s, long_options);
389    }
390
391#if !ENABLE_FEATURE_GETOPT_LONG
392    opt = getopt32(argv, "+o:n:qQs:Tu", &optstr, &name, &s_arg);
393#else
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 */
399    while (l_arg) {
400        long_options = add_long_options(long_options, llist_pop(&l_arg));
401    }
402#endif
403
404    if (opt & OPT_s) {
405        set_shell(s_arg);
406    }
407
408    if (opt & OPT_T) {
409        return 4;
410    }
411
412    /* All options controlling the applet have now been parsed */
413    n = optind - 1;
414    if (!optstr) {
415        optstr = argv[++n];
416        if (!optstr)
417            bb_error_msg_and_die("missing optstring argument");
418    }
419
420    argv[n] = name ? name : argv[0];
421    return generate_output(argv + n, argc - n, optstr, long_options);
422}
Note: See TracBrowser for help on using the repository browser.