Rework option handling to save space.
[oweals/busybox.git] / 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 prase_error(), using 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         if (BUFFER != NULL)
96                 free(BUFFER);
97
98         if (!quote) { /* Just copy arg */
99                 BUFFER=xmalloc(strlen(arg)+1);
100
101                 strcpy(BUFFER,arg);
102                 return BUFFER;
103         }
104
105         /* Each character in arg may take upto four characters in the result:
106            For a quote we need a closing quote, a backslash, a quote and an
107            opening quote! We need also the global opening and closing quote,
108            and one extra character for '\0'. */
109         BUFFER=xmalloc(strlen(arg)*4+3);
110
111         bufptr=BUFFER;
112         *bufptr++='\'';
113
114         while (*argptr) {
115                 if (*argptr == '\'') {
116                         /* Quote: replace it with: '\'' */
117                         *bufptr++='\'';
118                         *bufptr++='\\';
119                         *bufptr++='\'';
120                         *bufptr++='\'';
121                 } else if (shell==TCSH && *argptr=='!') {
122                         /* Exclamation mark: replace it with: \! */
123                         *bufptr++='\'';
124                         *bufptr++='\\';
125                         *bufptr++='!';
126                         *bufptr++='\'';
127                 } else if (shell==TCSH && *argptr=='\n') {
128                         /* Newline: replace it with: \n */
129                         *bufptr++='\\';
130                         *bufptr++='n';
131                 } else if (shell==TCSH && isspace(*argptr)) {
132                         /* Non-newline whitespace: replace it with \<ws> */
133                         *bufptr++='\'';
134                         *bufptr++='\\';
135                         *bufptr++=*argptr;
136                         *bufptr++='\'';
137                 } else
138                         /* Just copy */
139                         *bufptr++=*argptr;
140                 argptr++;
141         }
142         *bufptr++='\'';
143         *bufptr++='\0';
144         return BUFFER;
145 }
146
147 /*
148  * Generate the output. argv[0] is the program name (used for reporting errors).
149  * argv[1..] contains the options to be parsed. argc must be the number of
150  * elements in argv (ie. 1 if there are no options, only the program name),
151  * optstr must contain the short options, and longopts the long options.
152  * Other settings are found in global variables.
153  */
154 int generate_output(char * argv[],int argc,const char *optstr,
155                     const struct option *longopts)
156 {
157         int exit_code = 0; /* We assume everything will be OK */
158         int opt;
159         int longindex;
160         const char *charptr;
161
162         if (quiet_errors) /* No error reporting from getopt(3) */
163                 opterr=0;
164         optind=0; /* Reset getopt(3) */
165
166         while ((opt = (alternative?
167                        getopt_long_only(argc,argv,optstr,longopts,&longindex):
168                        getopt_long(argc,argv,optstr,longopts,&longindex)))
169                != EOF)
170                 if (opt == '?' || opt == ':' )
171                         exit_code = 1;
172                 else if (!quiet_output) {
173                         if (opt == LONG_OPT) {
174                                 printf(" --%s",longopts[longindex].name);
175                                 if (longopts[longindex].has_arg)
176                                         printf(" %s",
177                                                normalize(optarg?optarg:""));
178                         } else if (opt == NON_OPT)
179                                 printf(" %s",normalize(optarg));
180                         else {
181                                 printf(" -%c",opt);
182                                 charptr = strchr(optstr,opt);
183                                 if (charptr != NULL && *++charptr == ':')
184                                         printf(" %s",
185                                                normalize(optarg?optarg:""));
186                         }
187                 }
188
189         if (! quiet_output) {
190                 printf(" --");
191                 while (optind < argc)
192                         printf(" %s",normalize(argv[optind++]));
193                 printf("\n");
194         }
195         return exit_code;
196 }
197
198 static struct option *long_options=NULL;
199 static int long_options_length=0; /* Length of array */
200 static int long_options_nr=0; /* Nr of used elements in array */
201 static const int LONG_OPTIONS_INCR = 10;
202 #define init_longopt() add_longopt(NULL,0)
203
204 /* Register a long option. The contents of name is copied. */
205 void add_longopt(const char *name,int has_arg)
206 {
207         char *tmp;
208         if (!name) { /* init */
209                 free(long_options);
210                 long_options=NULL;
211                 long_options_length=0;
212                 long_options_nr=0;
213         }
214
215         if (long_options_nr == long_options_length) {
216                 long_options_length += LONG_OPTIONS_INCR;
217                 long_options=xrealloc(long_options,
218                                          sizeof(struct option) *
219                                          long_options_length);
220         }
221
222         long_options[long_options_nr].name=NULL;
223         long_options[long_options_nr].has_arg=0;
224         long_options[long_options_nr].flag=NULL;
225         long_options[long_options_nr].val=0;
226
227         if (long_options_nr) { /* Not for init! */
228                 long_options[long_options_nr-1].has_arg=has_arg;
229                 long_options[long_options_nr-1].flag=NULL;
230                 long_options[long_options_nr-1].val=LONG_OPT;
231                 tmp = xmalloc(strlen(name)+1);
232                 strcpy(tmp,name);
233                 long_options[long_options_nr-1].name=tmp;
234         }
235         long_options_nr++;
236 }
237
238
239 /*
240  * Register several long options. options is a string of long options,
241  * separated by commas or whitespace.
242  * This nukes options!
243  */
244 void add_long_options(char *options)
245 {
246         int arg_opt, tlen;
247         char *tokptr=strtok(options,", \t\n");
248         while (tokptr) {
249                 arg_opt=no_argument;
250                 tlen=strlen(tokptr);
251                 if (tlen > 0) {
252                         if (tokptr[tlen-1] == ':') {
253                                 if (tlen > 1 && tokptr[tlen-2] == ':') {
254                                         tokptr[tlen-2]='\0';
255                                         tlen -= 2;
256                                         arg_opt=optional_argument;
257                                 } else {
258                                         tokptr[tlen-1]='\0';
259                                         tlen -= 1;
260                                         arg_opt=required_argument;
261                                 }
262                                 if (tlen == 0)
263                                         error_msg("empty long option after -l or --long argument");
264                         }
265                         add_longopt(tokptr,arg_opt);
266                 }
267                 tokptr=strtok(NULL,", \t\n");
268         }
269 }
270
271 void set_shell(const char *new_shell)
272 {
273         if (!strcmp(new_shell,"bash"))
274                 shell=BASH;
275         else if (!strcmp(new_shell,"tcsh"))
276                 shell=TCSH;
277         else if (!strcmp(new_shell,"sh"))
278                 shell=BASH;
279         else if (!strcmp(new_shell,"csh"))
280                 shell=TCSH;
281         else
282                 error_msg("unknown shell after -s or --shell argument");
283 }
284
285
286 /* Exit codes:
287  *   0) No errors, succesful operation.
288  *   1) getopt(3) returned an error.
289  *   2) A problem with parameter parsing for getopt(1).
290  *   3) Internal error, out of memory
291  *   4) Returned for -T
292  */
293
294 static struct option longopts[]=
295 {
296         {"options",required_argument,NULL,'o'},
297         {"longoptions",required_argument,NULL,'l'},
298         {"quiet",no_argument,NULL,'q'},
299         {"quiet-output",no_argument,NULL,'Q'},
300         {"shell",required_argument,NULL,'s'},
301         {"test",no_argument,NULL,'T'},
302         {"unquoted",no_argument,NULL,'u'},
303         {"alternative",no_argument,NULL,'a'},
304         {"name",required_argument,NULL,'n'},
305         {NULL,0,NULL,0}
306 };
307
308 /* Stop scanning as soon as a non-option argument is found! */
309 static const char *shortopts="+ao:l:n:qQs:Tu";
310
311
312 int getopt_main(int argc, char *argv[])
313 {
314         char *optstr=NULL;
315         char *name=NULL;
316         int opt;
317         int compatible=0;
318
319         init_longopt();
320
321         if (getenv("GETOPT_COMPATIBLE"))
322                 compatible=1;
323
324         if (argc == 1) {
325                 if (compatible) {
326                         /* For some reason, the original getopt gave no error
327                            when there were no arguments. */
328                         printf(" --\n");
329                         exit(0);
330                 } else
331                         error_msg_and_die("missing optstring argument");
332         }
333
334         if (argv[1][0] != '-' || compatible) {
335                 quote=0;
336                 optstr=xmalloc(strlen(argv[1])+1);
337                 strcpy(optstr,argv[1]+strspn(argv[1],"-+"));
338                 argv[1]=argv[0];
339                 exit(generate_output(argv+1,argc-1,optstr,long_options));
340         }
341
342         while ((opt=getopt_long(argc,argv,shortopts,longopts,NULL)) != EOF)
343                 switch (opt) {
344                 case 'a':
345                         alternative=1;
346                         break;
347                 case 'o':
348                         if (optstr)
349                                 free(optstr);
350                         optstr=xmalloc(strlen(optarg)+1);
351                         strcpy(optstr,optarg);
352                         break;
353                 case 'l':
354                         add_long_options(optarg);
355                         break;
356                 case 'n':
357                         if (name)
358                                 free(name);
359                         name=xmalloc(strlen(optarg)+1);
360                         strcpy(name,optarg);
361                         break;
362                 case 'q':
363                         quiet_errors=1;
364                         break;
365                 case 'Q':
366                         quiet_output=1;
367                         break;
368                 case 's':
369                         set_shell(optarg);
370                         break;
371                 case 'T':
372                         exit(4);
373                 case 'u':
374                         quote=0;
375                         break;
376                 default:
377                         show_usage();
378                 }
379
380         if (!optstr) {
381                 if (optind >= argc)
382                         error_msg_and_die("missing optstring argument");
383                 else {
384                         optstr=xmalloc(strlen(argv[optind])+1);
385                         strcpy(optstr,argv[optind]);
386                         optind++;
387                 }
388         }
389         if (name)
390                 argv[optind-1]=name;
391         else
392                 argv[optind-1]=argv[0];
393         exit(generate_output(argv+optind-1,argc-optind+1,optstr,long_options));
394 }
395
396 /*
397   Local Variables:
398   c-file-style: "linux"
399   c-basic-offset: 4
400   tab-width: 4
401   End:
402 */