busybox/util-linux/getopt.c

   1 /*
   2  * getopt.c - Enhanced implementation of BSD getopt(1)
   3  *   Copyright (c) 1997, 1998, 1999, 2000  Frodo Looijaard <frodol@dds.nl>
   4  *
   5  *   This program is free software; you can redistribute it and/or modify
   6  *   it under the terms of the GNU General Public License as published by
   7  *   the Free Software Foundation; either version 2 of the License, or
   8  *   (at your option) any later version.
   9  *
  10  *   This program is distributed in the hope that it will be useful,
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *   GNU General Public License for more details.
  14  *
  15  *   You should have received a copy of the GNU General Public License
  16  *   along with this program; if not, write to the Free Software
  17  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18  */
  19
  20 /*
  21  * Version 1.0-b4: Tue Sep 23 1997. First public release.
  22  * Version 1.0: Wed Nov 19 1997.
  23  *   Bumped up the version number to 1.0
  24  *   Fixed minor typo (CSH instead of TCSH)
  25  * Version 1.0.1: Tue Jun 3 1998
  26  *   Fixed sizeof instead of strlen bug
  27  *   Bumped up the version number to 1.0.1
  28  * Version 1.0.2: Thu Jun 11 1998 (not present)
  29  *   Fixed gcc-2.8.1 warnings
  30  *   Fixed --version/-V option (not present)
  31  * Version 1.0.5: Tue Jun 22 1999
  32  *   Make -u option work (not present)
  33  * Version 1.0.6: Tue Jun 27 2000
  34  *   No important changes
  35  * Version 1.1.0: Tue Jun 30 2000
  36  *   Added NLS support (partly written by Arkadiusz Mi<B6>kiewicz
  37  *     <misiek@misiek.eu.org>)
  38  * Ported to Busybox - Alfred M. Szmidt <ams@trillian.itslinux.org>
  39  *  Removed --version/-V and --help/-h in
  40  *  Removed parse_error(), using bb_error_msg() from Busybox instead
  41  *  Replaced our_malloc with xmalloc and our_realloc with xrealloc
  42  *
  43  */
  44
  45 #include <stdio.h>
  46 #include <stdlib.h>
  47 #include <string.h>
  48 #include <unistd.h>
  49 #include <ctype.h>
  50 #include <getopt.h>
  51
  52 #include "busybox.h"
  53
  54 /* NON_OPT is the code that is returned when a non-option is found in '+'
  55    mode */
  56 static const int NON_OPT = 1;
  57 /* LONG_OPT is the code that is returned when a long option is found. */
  58 static const int LONG_OPT = 2;
  59
  60 /* The shells recognized. */
  61 typedef enum {BASH,TCSH} shell_t;
  62
  63
  64 /* Some global variables that tells us how to parse. */
  65 static shell_t shell=BASH; /* The shell we generate output for. */
  66 static int quiet_errors=0; /* 0 is not quiet. */
  67 static int quiet_output=0; /* 0 is not quiet. */
  68 static int quote=1; /* 1 is do quote. */
  69 static int alternative=0; /* 0 is getopt_long, 1 is getopt_long_only */
  70
  71 /* Function prototypes */
  72 static const char *normalize(const char *arg);
  73 static int generate_output(char * argv[],int argc,const char *optstr,
  74                     const struct option *longopts);
  75 static void add_long_options(char *options);
  76 static void add_longopt(const char *name,int has_arg);
  77 static void set_shell(const char *new_shell);
  78
  79
  80 /*
  81  * This function 'normalizes' a single argument: it puts single quotes around
  82  * it and escapes other special characters. If quote is false, it just
  83  * returns its argument.
  84  * Bash only needs special treatment for single quotes; tcsh also recognizes
  85  * exclamation marks within single quotes, and nukes whitespace.
  86  * This function returns a pointer to a buffer that is overwritten by
  87  * each call.
  88  */
  89 const char *normalize(const char *arg)
  90 {
  91         static char *BUFFER=NULL;
  92         const char *argptr=arg;
  93         char *bufptr;
  94
  95         free(BUFFER);
  96
  97         if (!quote) { /* Just copy arg */
  98                BUFFER=bb_xstrdup(arg);
  99                 return BUFFER;
 100         }
 101
 102         /* Each character in arg may take up to four characters in the result:
 103            For a quote we need a closing quote, a backslash, a quote and an
 104            opening quote! We need also the global opening and closing quote,
 105            and one extra character for '\0'. */
 106         BUFFER=xmalloc(strlen(arg)*4+3);
 107
 108         bufptr=BUFFER;
 109         *bufptr++='\'';
 110
 111         while (*argptr) {
 112                 if (*argptr == '\'') {
 113                         /* Quote: replace it with: '\'' */
 114                         *bufptr++='\'';
 115                         *bufptr++='\\';
 116                         *bufptr++='\'';
 117                         *bufptr++='\'';
 118                 } else if (shell==TCSH && *argptr=='!') {
 119                         /* Exclamation mark: replace it with: \! */
 120                         *bufptr++='\'';
 121                         *bufptr++='\\';
 122                         *bufptr++='!';
 123                         *bufptr++='\'';
 124                 } else if (shell==TCSH && *argptr=='\n') {
 125                         /* Newline: replace it with: \n */
 126                         *bufptr++='\\';
 127                         *bufptr++='n';
 128                 } else if (shell==TCSH && isspace(*argptr)) {
 129                         /* Non-newline whitespace: replace it with \<ws> */
 130                         *bufptr++='\'';
 131                         *bufptr++='\\';
 132                         *bufptr++=*argptr;
 133                         *bufptr++='\'';
 134                 } else
 135                         /* Just copy */
 136                         *bufptr++=*argptr;
 137                 argptr++;
 138         }
 139         *bufptr++='\'';
 140         *bufptr++='\0';
 141         return BUFFER;
 142 }
 143
 144 /*
 145  * Generate the output. argv[0] is the program name (used for reporting errors).
 146  * argv[1..] contains the options to be parsed. argc must be the number of
 147  * elements in argv (ie. 1 if there are no options, only the program name),
 148  * optstr must contain the short options, and longopts the long options.
 149  * Other settings are found in global variables.
 150  */
 151 int generate_output(char * argv[],int argc,const char *optstr,
 152                     const struct option *longopts)
 153 {
 154         int exit_code = 0; /* We assume everything will be OK */
 155         int opt;
 156         int longindex;
 157         const char *charptr;
 158
 159         if (quiet_errors) /* No error reporting from getopt(3) */
 160                 opterr=0;
 161         optind=0; /* Reset getopt(3) */
 162
 163         while ((opt = (alternative?
 164                        getopt_long_only(argc,argv,optstr,longopts,&longindex):
 165                        getopt_long(argc,argv,optstr,longopts,&longindex)))
 166                != EOF)
 167                 if (opt == '?' || opt == ':' )
 168                         exit_code = 1;
 169                 else if (!quiet_output) {
 170                         if (opt == LONG_OPT) {
 171                                 printf(" --%s",longopts[longindex].name);
 172                                 if (longopts[longindex].has_arg)
 173                                         printf(" %s",
 174                                                normalize(optarg?optarg:""));
 175                         } else if (opt == NON_OPT)
 176                                 printf(" %s",normalize(optarg));
 177                         else {
 178                                 printf(" -%c",opt);
 179                                 charptr = strchr(optstr,opt);
 180                                 if (charptr != NULL && *++charptr == ':')
 181                                         printf(" %s",
 182                                                normalize(optarg?optarg:""));
 183                         }
 184                 }
 185
 186         if (! quiet_output) {
 187                 printf(" --");
 188                 while (optind < argc)
 189                         printf(" %s",normalize(argv[optind++]));
 190                 printf("\n");
 191         }
 192         return exit_code;
 193 }
 194
 195 static struct option *long_options=NULL;
 196 static int long_options_length=0; /* Length of array */
 197 static int long_options_nr=0; /* Nr of used elements in array */
 198 static const int LONG_OPTIONS_INCR = 10;
 199 #define init_longopt() add_longopt(NULL,0)
 200
 201 /* Register a long option. The contents of name is copied. */
 202 void add_longopt(const char *name,int has_arg)
 203 {
 204         if (!name) { /* init */
 205                 free(long_options);
 206                 long_options=NULL;
 207                 long_options_length=0;
 208                 long_options_nr=0;
 209         }
 210
 211         if (long_options_nr == long_options_length) {
 212                 long_options_length += LONG_OPTIONS_INCR;
 213                 long_options=xrealloc(long_options,
 214                                          sizeof(struct option) *
 215                                          long_options_length);
 216         }
 217
 218         long_options[long_options_nr].name=NULL;
 219         long_options[long_options_nr].has_arg=0;
 220         long_options[long_options_nr].flag=NULL;
 221         long_options[long_options_nr].val=0;
 222
 223         if (long_options_nr) { /* Not for init! */
 224                 long_options[long_options_nr-1].has_arg=has_arg;
 225                 long_options[long_options_nr-1].flag=NULL;
 226                 long_options[long_options_nr-1].val=LONG_OPT;
 227                long_options[long_options_nr-1].name=bb_xstrdup(name);
 228         }
 229         long_options_nr++;
 230 }
 231
 232
 233 /*
 234  * Register several long options. options is a string of long options,
 235  * separated by commas or whitespace.
 236  * This nukes options!
 237  */
 238 void add_long_options(char *options)
 239 {
 240         int arg_opt, tlen;
 241         char *tokptr=strtok(options,", \t\n");
 242         while (tokptr) {
 243                 arg_opt=no_argument;
 244                 tlen=strlen(tokptr);
 245                 if (tlen > 0) {
 246                         if (tokptr[tlen-1] == ':') {
 247                                 if (tlen > 1 && tokptr[tlen-2] == ':') {
 248                                         tokptr[tlen-2]='\0';
 249                                         tlen -= 2;
 250                                         arg_opt=optional_argument;
 251                                 } else {
 252                                         tokptr[tlen-1]='\0';
 253                                         tlen -= 1;
 254                                         arg_opt=required_argument;
 255                                 }
 256                                 if (tlen == 0)
 257                                         bb_error_msg("empty long option after -l or --long argument");
 258                         }
 259                         add_longopt(tokptr,arg_opt);
 260                 }
 261                 tokptr=strtok(NULL,", \t\n");
 262         }
 263 }
 264
 265 void set_shell(const char *new_shell)
 266 {
 267         if (!strcmp(new_shell,"bash"))
 268                 shell=BASH;
 269         else if (!strcmp(new_shell,"tcsh"))
 270                 shell=TCSH;
 271         else if (!strcmp(new_shell,"sh"))
 272                 shell=BASH;
 273         else if (!strcmp(new_shell,"csh"))
 274                 shell=TCSH;
 275         else
 276                 bb_error_msg("unknown shell after -s or --shell argument");
 277 }
 278
 279
 280 /* Exit codes:
 281  *   0) No errors, successful operation.
 282  *   1) getopt(3) returned an error.
 283  *   2) A problem with parameter parsing for getopt(1).
 284  *   3) Internal error, out of memory
 285  *   4) Returned for -T
 286  */
 287
 288 static struct option longopts[]=
 289 {
 290         {"options",required_argument,NULL,'o'},
 291         {"longoptions",required_argument,NULL,'l'},
 292         {"quiet",no_argument,NULL,'q'},
 293         {"quiet-output",no_argument,NULL,'Q'},
 294         {"shell",required_argument,NULL,'s'},
 295         {"test",no_argument,NULL,'T'},
 296         {"unquoted",no_argument,NULL,'u'},
 297         {"alternative",no_argument,NULL,'a'},
 298         {"name",required_argument,NULL,'n'},
 299         {NULL,0,NULL,0}
 300 };
 301
 302 /* Stop scanning as soon as a non-option argument is found! */
 303 static const char *shortopts="+ao:l:n:qQs:Tu";
 304
 305
 306 int getopt_main(int argc, char *argv[])
 307 {
 308         const char *optstr = NULL;
 309         const char *name = NULL;
 310         int opt;
 311         int compatible=0;
 312
 313         init_longopt();
 314
 315         if (getenv("GETOPT_COMPATIBLE"))
 316                 compatible=1;
 317
 318         if (argc == 1) {
 319                 if (compatible) {
 320                         /* For some reason, the original getopt gave no error
 321                            when there were no arguments. */
 322                         printf(" --\n");
 323                        return 0;
 324                 } else
 325                         bb_error_msg_and_die("missing optstring argument");
 326         }
 327
 328         if (argv[1][0] != '-' || compatible) {
 329                 quote=0;
 330                 optstr=xmalloc(strlen(argv[1])+1);
 331                 strcpy(optstr,argv[1]+strspn(argv[1],"-+"));
 332                 argv[1]=argv[0];
 333                return (generate_output(argv+1,argc-1,optstr,long_options));
 334         }
 335
 336         while ((opt=getopt_long(argc,argv,shortopts,longopts,NULL)) != EOF)
 337                 switch (opt) {
 338                 case 'a':
 339                         alternative=1;
 340                         break;
 341                 case 'o':
 342                        free(optstr);
 343                        optstr = optarg;
 344                         break;
 345                 case 'l':
 346                         add_long_options(optarg);
 347                         break;
 348                 case 'n':
 349                        free(name);
 350                        name = optarg;
 351                         break;
 352                 case 'q':
 353                         quiet_errors=1;
 354                         break;
 355                 case 'Q':
 356                         quiet_output=1;
 357                         break;
 358                 case 's':
 359                         set_shell(optarg);
 360                         break;
 361                 case 'T':
 362                        return 4;
 363                 case 'u':
 364                         quote=0;
 365                         break;
 366                 default:
 367                         bb_show_usage();
 368                 }
 369
 370         if (!optstr) {
 371                 if (optind >= argc)
 372                         bb_error_msg_and_die("missing optstring argument");
 373                 else {
 374                        optstr=bb_xstrdup(argv[optind]);
 375                         optind++;
 376                 }
 377         }
 378         if (name)
 379                 argv[optind-1]=name;
 380         else
 381                 argv[optind-1]=argv[0];
 382        return (generate_output(argv+optind-1,argc-optind+1,optstr,long_options));
 383 }
 384
 385 /*
 386   Local Variables:
 387   c-file-style: "linux"
 388   c-basic-offset: 4
 389   tab-width: 4
 390   End:
 391 */