util-linux/getopt.c

   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 in
  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]"
  36 //usage:#define getopt_full_usage "\n\n"
  37 //usage:       "Options:"
  38 //usage:        IF_LONG_OPTS(
  39 //usage:     "\n        -a,--alternative                Allow long options starting with single -"
  40 //usage:     "\n        -l,--longoptions=longopts       Long options to be recognized"
  41 //usage:     "\n        -n,--name=progname              The name under which errors are reported"
  42 //usage:     "\n        -o,--options=optstring          Short options to be recognized"
  43 //usage:     "\n        -q,--quiet                      Disable error reporting by getopt(3)"
  44 //usage:     "\n        -Q,--quiet-output               No normal output"
  45 //usage:     "\n        -s,--shell=shell                Set shell quoting conventions"
  46 //usage:     "\n        -T,--test                       Test for getopt(1) version"
  47 //usage:     "\n        -u,--unquoted                   Don't quote the output"
  48 //usage:        )
  49 //usage:        IF_NOT_LONG_OPTS(
  50 //usage:     "\n        -a              Allow long options starting with single -"
  51 //usage:     "\n        -l longopts     Long options to be recognized"
  52 //usage:     "\n        -n progname     The name under which errors are reported"
  53 //usage:     "\n        -o optstring    Short options to be recognized"
  54 //usage:     "\n        -q              Disable error reporting by getopt(3)"
  55 //usage:     "\n        -Q              No normal output"
  56 //usage:     "\n        -s shell        Set shell quoting conventions"
  57 //usage:     "\n        -T              Test for getopt(1) version"
  58 //usage:     "\n        -u              Don't quote the output"
  59 //usage:        )
  60 //usage:
  61 //usage:#define getopt_example_usage
  62 //usage:       "$ cat getopt.test\n"
  63 //usage:       "#!/bin/sh\n"
  64 //usage:       "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n"
  65 //usage:       "       -n 'example.busybox' -- \"$@\"`\n"
  66 //usage:       "if [ $? != 0 ]; then exit 1; fi\n"
  67 //usage:       "eval set -- \"$GETOPT\"\n"
  68 //usage:       "while true; do\n"
  69 //usage:       " case $1 in\n"
  70 //usage:       "   -a|--a-long) echo \"Option a\"; shift;;\n"
  71 //usage:       "   -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n"
  72 //usage:       "   -c|--c-long)\n"
  73 //usage:       "     case \"$2\" in\n"
  74 //usage:       "       \"\") echo \"Option c, no argument\"; shift 2;;\n"
  75 //usage:       "       *)  echo \"Option c, argument '$2'\"; shift 2;;\n"
  76 //usage:       "     esac;;\n"
  77 //usage:       "   --) shift; break;;\n"
  78 //usage:       "   *) echo \"Internal error!\"; exit 1;;\n"
  79 //usage:       " esac\n"
  80 //usage:       "done\n"
  81
  82 #include <getopt.h>
  83 #include "libbb.h"
  84
  85 /* NON_OPT is the code that is returned when a non-option is found in '+'
  86    mode */
  87 enum {
  88         NON_OPT = 1,
  89 #if ENABLE_FEATURE_GETOPT_LONG
  90 /* LONG_OPT is the code that is returned when a long option is found. */
  91         LONG_OPT = 2
  92 #endif
  93 };
  94
  95 /* For finding activated option flags. Must match getopt32 call! */
  96 enum {
  97         OPT_o   = 0x1,  // -o
  98         OPT_n   = 0x2,  // -n
  99         OPT_q   = 0x4,  // -q
 100         OPT_Q   = 0x8,  // -Q
 101         OPT_s   = 0x10, // -s
 102         OPT_T   = 0x20, // -T
 103         OPT_u   = 0x40, // -u
 104 #if ENABLE_FEATURE_GETOPT_LONG
 105         OPT_a   = 0x80, // -a
 106         OPT_l   = 0x100, // -l
 107 #endif
 108         SHELL_IS_TCSH = 0x8000, /* hijack this bit for other purposes */
 109 };
 110
 111 /* 0 is getopt_long, 1 is getopt_long_only */
 112 #define alternative  (option_mask32 & OPT_a)
 113
 114 #define quiet_errors (option_mask32 & OPT_q)
 115 #define quiet_output (option_mask32 & OPT_Q)
 116 #define quote        (!(option_mask32 & OPT_u))
 117 #define shell_TCSH   (option_mask32 & SHELL_IS_TCSH)
 118
 119 /*
 120  * This function 'normalizes' a single argument: it puts single quotes around
 121  * it and escapes other special characters. If quote is false, it just
 122  * returns its argument.
 123  * Bash only needs special treatment for single quotes; tcsh also recognizes
 124  * exclamation marks within single quotes, and nukes whitespace.
 125  * This function returns a pointer to a buffer that is overwritten by
 126  * each call.
 127  */
 128 static const char *normalize(const char *arg)
 129 {
 130         char *bufptr;
 131 #if ENABLE_FEATURE_CLEAN_UP
 132         static char *BUFFER = NULL;
 133         free(BUFFER);
 134 #else
 135         char *BUFFER;
 136 #endif
 137
 138         if (!quote) { /* Just copy arg */
 139                 BUFFER = xstrdup(arg);
 140                 return BUFFER;
 141         }
 142
 143         /* Each character in arg may take up to four characters in the result:
 144            For a quote we need a closing quote, a backslash, a quote and an
 145            opening quote! We need also the global opening and closing quote,
 146            and one extra character for '\0'. */
 147         BUFFER = xmalloc(strlen(arg)*4 + 3);
 148
 149         bufptr = BUFFER;
 150         *bufptr ++= '\'';
 151
 152         while (*arg) {
 153                 if (*arg == '\'') {
 154                         /* Quote: replace it with: '\'' */
 155                         *bufptr ++= '\'';
 156                         *bufptr ++= '\\';
 157                         *bufptr ++= '\'';
 158                         *bufptr ++= '\'';
 159                 } else if (shell_TCSH && *arg == '!') {
 160                         /* Exclamation mark: replace it with: \! */
 161                         *bufptr ++= '\'';
 162                         *bufptr ++= '\\';
 163                         *bufptr ++= '!';
 164                         *bufptr ++= '\'';
 165                 } else if (shell_TCSH && *arg == '\n') {
 166                         /* Newline: replace it with: \n */
 167                         *bufptr ++= '\\';
 168                         *bufptr ++= 'n';
 169                 } else if (shell_TCSH && isspace(*arg)) {
 170                         /* Non-newline whitespace: replace it with \<ws> */
 171                         *bufptr ++= '\'';
 172                         *bufptr ++= '\\';
 173                         *bufptr ++= *arg;
 174                         *bufptr ++= '\'';
 175                 } else
 176                         /* Just copy */
 177                         *bufptr ++= *arg;
 178                 arg++;
 179         }
 180         *bufptr ++= '\'';
 181         *bufptr ++= '\0';
 182         return BUFFER;
 183 }
 184
 185 /*
 186  * Generate the output. argv[0] is the program name (used for reporting errors).
 187  * argv[1..] contains the options to be parsed. argc must be the number of
 188  * elements in argv (ie. 1 if there are no options, only the program name),
 189  * optstr must contain the short options, and longopts the long options.
 190  * Other settings are found in global variables.
 191  */
 192 #if !ENABLE_FEATURE_GETOPT_LONG
 193 #define generate_output(argv,argc,optstr,longopts) \
 194         generate_output(argv,argc,optstr)
 195 #endif
 196 static int generate_output(char **argv, int argc, const char *optstr, const struct option *longopts)
 197 {
 198         int exit_code = 0; /* We assume everything will be OK */
 199         int opt;
 200 #if ENABLE_FEATURE_GETOPT_LONG
 201         int longindex;
 202 #endif
 203         const char *charptr;
 204
 205         if (quiet_errors) /* No error reporting from getopt(3) */
 206                 opterr = 0;
 207
 208         /* We used it already in main() in getopt32(),
 209          * we *must* reset getopt(3): */
 210 #ifdef __GLIBC__
 211         optind = 0;
 212 #else /* BSD style */
 213         optind = 1;
 214         /* optreset = 1; */
 215 #endif
 216
 217         while (1) {
 218                 opt =
 219 #if ENABLE_FEATURE_GETOPT_LONG
 220                         alternative ?
 221                         getopt_long_only(argc, argv, optstr, longopts, &longindex) :
 222                         getopt_long(argc, argv, optstr, longopts, &longindex);
 223 #else
 224                         getopt(argc, argv, optstr);
 225 #endif
 226                 if (opt == -1)
 227                         break;
 228                 if (opt == '?' || opt == ':' )
 229                         exit_code = 1;
 230                 else if (!quiet_output) {
 231 #if ENABLE_FEATURE_GETOPT_LONG
 232                         if (opt == LONG_OPT) {
 233                                 printf(" --%s", longopts[longindex].name);
 234                                 if (longopts[longindex].has_arg)
 235                                         printf(" %s",
 236                                                 normalize(optarg ? optarg : ""));
 237                         } else
 238 #endif
 239                         if (opt == NON_OPT)
 240                                 printf(" %s", normalize(optarg));
 241                         else {
 242                                 printf(" -%c", opt);
 243                                 charptr = strchr(optstr, opt);
 244                                 if (charptr != NULL && *++charptr == ':')
 245                                         printf(" %s",
 246                                                 normalize(optarg ? optarg : ""));
 247                         }
 248                 }
 249         }
 250
 251         if (!quiet_output) {
 252                 printf(" --");
 253                 while (optind < argc)
 254                         printf(" %s", normalize(argv[optind++]));
 255                 bb_putchar('\n');
 256         }
 257         return exit_code;
 258 }
 259
 260 #if ENABLE_FEATURE_GETOPT_LONG
 261 /*
 262  * Register several long options. options is a string of long options,
 263  * separated by commas or whitespace.
 264  * This nukes options!
 265  */
 266 static struct option *add_long_options(struct option *long_options, char *options)
 267 {
 268         int long_nr = 0;
 269         int arg_opt, tlen;
 270         char *tokptr = strtok(options, ", \t\n");
 271
 272         if (long_options)
 273                 while (long_options[long_nr].name)
 274                         long_nr++;
 275
 276         while (tokptr) {
 277                 arg_opt = no_argument;
 278                 tlen = strlen(tokptr);
 279                 if (tlen) {
 280                         tlen--;
 281                         if (tokptr[tlen] == ':') {
 282                                 arg_opt = required_argument;
 283                                 if (tlen && tokptr[tlen-1] == ':') {
 284                                         tlen--;
 285                                         arg_opt = optional_argument;
 286                                 }
 287                                 tokptr[tlen] = '\0';
 288                                 if (tlen == 0)
 289                                         bb_error_msg_and_die("empty long option specified");
 290                         }
 291                         long_options = xrealloc_vector(long_options, 4, long_nr);
 292                         long_options[long_nr].has_arg = arg_opt;
 293                         /*long_options[long_nr].flag = NULL; - xrealloc_vector did it */
 294                         long_options[long_nr].val = LONG_OPT;
 295                         long_options[long_nr].name = xstrdup(tokptr);
 296                         long_nr++;
 297                         /*memset(&long_options[long_nr], 0, sizeof(long_options[0])); - xrealloc_vector did it */
 298                 }
 299                 tokptr = strtok(NULL, ", \t\n");
 300         }
 301         return long_options;
 302 }
 303 #endif
 304
 305 static void set_shell(const char *new_shell)
 306 {
 307         if (!strcmp(new_shell, "bash") || !strcmp(new_shell, "sh"))
 308                 return;
 309         if (!strcmp(new_shell, "tcsh") || !strcmp(new_shell, "csh"))
 310                 option_mask32 |= SHELL_IS_TCSH;
 311         else
 312                 bb_error_msg("unknown shell '%s', assuming bash", new_shell);
 313 }
 314
 315
 316 /* Exit codes:
 317  *   0) No errors, successful operation.
 318  *   1) getopt(3) returned an error.
 319  *   2) A problem with parameter parsing for getopt(1).
 320  *   3) Internal error, out of memory
 321  *   4) Returned for -T
 322  */
 323
 324 #if ENABLE_FEATURE_GETOPT_LONG
 325 static const char getopt_longopts[] ALIGN1 =
 326         "options\0"      Required_argument "o"
 327         "longoptions\0"  Required_argument "l"
 328         "quiet\0"        No_argument       "q"
 329         "quiet-output\0" No_argument       "Q"
 330         "shell\0"        Required_argument "s"
 331         "test\0"         No_argument       "T"
 332         "unquoted\0"     No_argument       "u"
 333         "alternative\0"  No_argument       "a"
 334         "name\0"         Required_argument "n"
 335         ;
 336 #endif
 337
 338 int getopt_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 339 int getopt_main(int argc, char **argv)
 340 {
 341         char *optstr = NULL;
 342         char *name = NULL;
 343         unsigned opt;
 344         const char *compatible;
 345         char *s_arg;
 346 #if ENABLE_FEATURE_GETOPT_LONG
 347         struct option *long_options = NULL;
 348         llist_t *l_arg = NULL;
 349 #endif
 350
 351         compatible = getenv("GETOPT_COMPATIBLE"); /* used as yes/no flag */
 352
 353         if (argc == 1) {
 354                 if (compatible) {
 355                         /* For some reason, the original getopt gave no error
 356                            when there were no arguments. */
 357                         printf(" --\n");
 358                         return 0;
 359                 }
 360                 bb_error_msg_and_die("missing optstring argument");
 361         }
 362
 363         if (argv[1][0] != '-' || compatible) {
 364                 char *s;
 365
 366                 option_mask32 |= OPT_u; /* quoting off */
 367                 s = xstrdup(argv[1] + strspn(argv[1], "-+"));
 368                 argv[1] = argv[0];
 369                 return generate_output(argv+1, argc-1, s, long_options);
 370         }
 371
 372 #if !ENABLE_FEATURE_GETOPT_LONG
 373         opt = getopt32(argv, "+o:n:qQs:Tu", &optstr, &name, &s_arg);
 374 #else
 375         applet_long_options = getopt_longopts;
 376         opt_complementary = "l::";
 377         opt = getopt32(argv, "+o:n:qQs:Tual:",
 378                                         &optstr, &name, &s_arg, &l_arg);
 379         /* Effectuate the read options for the applet itself */
 380         while (l_arg) {
 381                 long_options = add_long_options(long_options, llist_pop(&l_arg));
 382         }
 383 #endif
 384
 385         if (opt & OPT_s) {
 386                 set_shell(s_arg);
 387         }
 388
 389         if (opt & OPT_T) {
 390                 return 4;
 391         }
 392
 393         /* All options controlling the applet have now been parsed */
 394         if (!optstr) {
 395                 if (optind >= argc)
 396                         bb_error_msg_and_die("missing optstring argument");
 397                 optstr = argv[optind++];
 398         }
 399
 400         argv[optind-1] = name ? name : argv[0];
 401         return generate_output(argv+optind-1, argc-optind+1, optstr, long_options);
 402 }