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