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
  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:        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"
  47 //usage:        )
  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"
  58 //usage:        )
  59 //usage:
  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"
  75 //usage:       "     esac;;\n"
  76 //usage:       "   --) shift; break;;\n"
  77 //usage:       "   *) echo \"Internal error!\"; exit 1;;\n"
  78 //usage:       " esac\n"
  79 //usage:       "done\n"
  80
  81 #if ENABLE_FEATURE_GETOPT_LONG
  82 # include <getopt.h>
  83 #endif
  84 #include "libbb.h"
  85
  86 /* NON_OPT is the code that is returned when a non-option is found in '+'
  87    mode */
  88 enum {
  89         NON_OPT = 1,
  90 #if ENABLE_FEATURE_GETOPT_LONG
  91 /* LONG_OPT is the code that is returned when a long option is found. */
  92         LONG_OPT = 2
  93 #endif
  94 };
  95
  96 /* For finding activated option flags. Must match getopt32 call! */
  97 enum {
  98         OPT_o   = 0x1,  // -o
  99         OPT_n   = 0x2,  // -n
 100         OPT_q   = 0x4,  // -q
 101         OPT_Q   = 0x8,  // -Q
 102         OPT_s   = 0x10, // -s
 103         OPT_T   = 0x20, // -T
 104         OPT_u   = 0x40, // -u
 105 #if ENABLE_FEATURE_GETOPT_LONG
 106         OPT_a   = 0x80, // -a
 107         OPT_l   = 0x100, // -l
 108 #endif
 109         SHELL_IS_TCSH = 0x8000, /* hijack this bit for other purposes */
 110 };
 111
 112 /* 0 is getopt_long, 1 is getopt_long_only */
 113 #define alternative  (option_mask32 & OPT_a)
 114
 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)
 119
 120 /*
 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
 127  * each call.
 128  */
 129 static const char *normalize(const char *arg)
 130 {
 131         char *bufptr;
 132 #if ENABLE_FEATURE_CLEAN_UP
 133         static char *BUFFER = NULL;
 134         free(BUFFER);
 135 #else
 136         char *BUFFER;
 137 #endif
 138
 139         if (!quote) { /* Just copy arg */
 140                 BUFFER = xstrdup(arg);
 141                 return BUFFER;
 142         }
 143
 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);
 149
 150         bufptr = BUFFER;
 151         *bufptr ++= '\'';
 152
 153         while (*arg) {
 154                 if (*arg == '\'') {
 155                         /* Quote: replace it with: '\'' */
 156                         *bufptr ++= '\'';
 157                         *bufptr ++= '\\';
 158                         *bufptr ++= '\'';
 159                         *bufptr ++= '\'';
 160                 } else if (shell_TCSH && *arg == '!') {
 161                         /* Exclamation mark: replace it with: \! */
 162                         *bufptr ++= '\'';
 163                         *bufptr ++= '\\';
 164                         *bufptr ++= '!';
 165                         *bufptr ++= '\'';
 166                 } else if (shell_TCSH && *arg == '\n') {
 167                         /* Newline: replace it with: \n */
 168                         *bufptr ++= '\\';
 169                         *bufptr ++= 'n';
 170                 } else if (shell_TCSH && isspace(*arg)) {
 171                         /* Non-newline whitespace: replace it with \<ws> */
 172                         *bufptr ++= '\'';
 173                         *bufptr ++= '\\';
 174                         *bufptr ++= *arg;
 175                         *bufptr ++= '\'';
 176                 } else
 177                         /* Just copy */
 178                         *bufptr ++= *arg;
 179                 arg++;
 180         }
 181         *bufptr ++= '\'';
 182         *bufptr ++= '\0';
 183         return BUFFER;
 184 }
 185
 186 /*
 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.
 192  */
 193 #if !ENABLE_FEATURE_GETOPT_LONG
 194 #define generate_output(argv,argc,optstr,longopts) \
 195         generate_output(argv,argc,optstr)
 196 #endif
 197 static int generate_output(char **argv, int argc, const char *optstr, const struct option *longopts)
 198 {
 199         int exit_code = 0; /* We assume everything will be OK */
 200         int opt;
 201 #if ENABLE_FEATURE_GETOPT_LONG
 202         int longindex;
 203 #endif
 204         const char *charptr;
 205
 206         if (quiet_errors) /* No error reporting from getopt(3) */
 207                 opterr = 0;
 208
 209         /* We used it already in main() in getopt32(),
 210          * we *must* reset getopt(3): */
 211 #ifdef __GLIBC__
 212         optind = 0;
 213 #else /* BSD style */
 214         optind = 1;
 215         /* optreset = 1; */
 216 #endif
 217
 218         while (1) {
 219                 opt =
 220 #if ENABLE_FEATURE_GETOPT_LONG
 221                         alternative ?
 222                         getopt_long_only(argc, argv, optstr, longopts, &longindex) :
 223                         getopt_long(argc, argv, optstr, longopts, &longindex);
 224 #else
 225                         getopt(argc, argv, optstr);
 226 #endif
 227                 if (opt == -1)
 228                         break;
 229                 if (opt == '?' || opt == ':' )
 230                         exit_code = 1;
 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)
 236                                         printf(" %s",
 237                                                 normalize(optarg ? optarg : ""));
 238                         } else
 239 #endif
 240                         if (opt == NON_OPT)
 241                                 printf(" %s", normalize(optarg));
 242                         else {
 243                                 printf(" -%c", opt);
 244                                 charptr = strchr(optstr, opt);
 245                                 if (charptr != NULL && *++charptr == ':')
 246                                         printf(" %s",
 247                                                 normalize(optarg ? optarg : ""));
 248                         }
 249                 }
 250         }
 251
 252         if (!quiet_output) {
 253                 printf(" --");
 254                 while (optind < argc)
 255                         printf(" %s", normalize(argv[optind++]));
 256                 bb_putchar('\n');
 257         }
 258         return exit_code;
 259 }
 260
 261 #if ENABLE_FEATURE_GETOPT_LONG
 262 /*
 263  * Register several long options. options is a string of long options,
 264  * separated by commas or whitespace.
 265  * This nukes options!
 266  */
 267 static struct option *add_long_options(struct option *long_options, char *options)
 268 {
 269         int long_nr = 0;
 270         int arg_opt, tlen;
 271         char *tokptr = strtok(options, ", \t\n");
 272
 273         if (long_options)
 274                 while (long_options[long_nr].name)
 275                         long_nr++;
 276
 277         while (tokptr) {
 278                 arg_opt = no_argument;
 279                 tlen = strlen(tokptr);
 280                 if (tlen) {
 281                         tlen--;
 282                         if (tokptr[tlen] == ':') {
 283                                 arg_opt = required_argument;
 284                                 if (tlen && tokptr[tlen-1] == ':') {
 285                                         tlen--;
 286                                         arg_opt = optional_argument;
 287                                 }
 288                                 tokptr[tlen] = '\0';
 289                                 if (tlen == 0)
 290                                         bb_error_msg_and_die("empty long option specified");
 291                         }
 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);
 297                         long_nr++;
 298                         /*memset(&long_options[long_nr], 0, sizeof(long_options[0])); - xrealloc_vector did it */
 299                 }
 300                 tokptr = strtok(NULL, ", \t\n");
 301         }
 302         return long_options;
 303 }
 304 #endif
 305
 306 static void set_shell(const char *new_shell)
 307 {
 308         if (!strcmp(new_shell, "bash") || !strcmp(new_shell, "sh"))
 309                 return;
 310         if (!strcmp(new_shell, "tcsh") || !strcmp(new_shell, "csh"))
 311                 option_mask32 |= SHELL_IS_TCSH;
 312         else
 313                 bb_error_msg("unknown shell '%s', assuming bash", new_shell);
 314 }
 315
 316
 317 /* Exit codes:
 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
 322  *   4) Returned for -T
 323  */
 324
 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"
 336         ;
 337 #endif
 338
 339 int getopt_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 340 int getopt_main(int argc, char **argv)
 341 {
 342         char *optstr = NULL;
 343         char *name = NULL;
 344         unsigned opt;
 345         const char *compatible;
 346         char *s_arg;
 347 #if ENABLE_FEATURE_GETOPT_LONG
 348         struct option *long_options = NULL;
 349         llist_t *l_arg = NULL;
 350 #endif
 351
 352         compatible = getenv("GETOPT_COMPATIBLE"); /* used as yes/no flag */
 353
 354         if (argc == 1) {
 355                 if (compatible) {
 356                         /* For some reason, the original getopt gave no error
 357                            when there were no arguments. */
 358                         printf(" --\n");
 359                         return 0;
 360                 }
 361                 bb_error_msg_and_die("missing optstring argument");
 362         }
 363
 364         if (argv[1][0] != '-' || compatible) {
 365                 char *s;
 366
 367                 option_mask32 |= OPT_u; /* quoting off */
 368                 s = xstrdup(argv[1] + strspn(argv[1], "-+"));
 369                 argv[1] = argv[0];
 370                 return generate_output(argv+1, argc-1, s, long_options);
 371         }
 372
 373 #if !ENABLE_FEATURE_GETOPT_LONG
 374         opt = getopt32(argv, "+o:n:qQs:Tu", &optstr, &name, &s_arg);
 375 #else
 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 */
 381         while (l_arg) {
 382                 long_options = add_long_options(long_options, llist_pop(&l_arg));
 383         }
 384 #endif
 385
 386         if (opt & OPT_s) {
 387                 set_shell(s_arg);
 388         }
 389
 390         if (opt & OPT_T) {
 391                 return 4;
 392         }
 393
 394         /* All options controlling the applet have now been parsed */
 395         if (!optstr) {
 396                 if (optind >= argc)
 397                         bb_error_msg_and_die("missing optstring argument");
 398                 optstr = argv[optind++];
 399         }
 400
 401         argv[optind-1] = name ? name : argv[0];
 402         return generate_output(argv+optind-1, argc-optind+1, optstr, long_options);
 403 }