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