blob: ff55a3e3ce23a6810522aca3f4f36edb7d7273e5 [file] [log] [blame]
Eric Andersena1f16bb2000-08-21 22:02:34 +00001/*
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
Mark Whitleyf57c9442000-12-07 19:56:48 +000040 * Removed prase_error(), using error_msg() from Busybox instead
Eric Andersena1f16bb2000-08-21 22:02:34 +000041 * 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
Eric Andersen3570a342000-09-25 21:45:58 +000052#include "busybox.h"
Eric Andersena1f16bb2000-08-21 22:02:34 +000053
54/* NON_OPT is the code that is returned when a non-option is found in '+'
55 mode */
Mark Whitley59ab0252001-01-23 22:30:04 +000056static const int NON_OPT = 1;
Eric Andersena1f16bb2000-08-21 22:02:34 +000057/* LONG_OPT is the code that is returned when a long option is found. */
Mark Whitley59ab0252001-01-23 22:30:04 +000058static const int LONG_OPT = 2;
Eric Andersena1f16bb2000-08-21 22:02:34 +000059
60/* The shells recognized. */
61typedef enum {BASH,TCSH} shell_t;
62
63
64/* Some global variables that tells us how to parse. */
65shell_t shell=BASH; /* The shell we generate output for. */
66int quiet_errors=0; /* 0 is not quiet. */
67int quiet_output=0; /* 0 is not quiet. */
68int quote=1; /* 1 is do quote. */
69int alternative=0; /* 0 is getopt_long, 1 is getopt_long_only */
70
71/* Function prototypes */
72const char *normalize(const char *arg);
73int generate_output(char * argv[],int argc,const char *optstr,
74 const struct option *longopts);
75void add_long_options(char *options);
76void add_longopt(const char *name,int has_arg);
77void set_shell(const char *new_shell);
78void set_initial_shell(void);
79
80
81/*
82 * This function 'normalizes' a single argument: it puts single quotes around
83 * it and escapes other special characters. If quote is false, it just
84 * returns its argument.
85 * Bash only needs special treatment for single quotes; tcsh also recognizes
86 * exclamation marks within single quotes, and nukes whitespace.
87 * This function returns a pointer to a buffer that is overwritten by
88 * each call.
89 */
90const char *normalize(const char *arg)
91{
92 static char *BUFFER=NULL;
93 const char *argptr=arg;
94 char *bufptr;
95
96 if (BUFFER != NULL)
97 free(BUFFER);
98
99 if (!quote) { /* Just copy arg */
100 BUFFER=xmalloc(strlen(arg)+1);
101
102 strcpy(BUFFER,arg);
103 return BUFFER;
104 }
105
106 /* Each character in arg may take upto four characters in the result:
107 For a quote we need a closing quote, a backslash, a quote and an
108 opening quote! We need also the global opening and closing quote,
109 and one extra character for '\0'. */
110 BUFFER=xmalloc(strlen(arg)*4+3);
111
112 bufptr=BUFFER;
113 *bufptr++='\'';
114
115 while (*argptr) {
116 if (*argptr == '\'') {
117 /* Quote: replace it with: '\'' */
118 *bufptr++='\'';
119 *bufptr++='\\';
120 *bufptr++='\'';
121 *bufptr++='\'';
122 } else if (shell==TCSH && *argptr=='!') {
123 /* Exclamation mark: replace it with: \! */
124 *bufptr++='\'';
125 *bufptr++='\\';
126 *bufptr++='!';
127 *bufptr++='\'';
128 } else if (shell==TCSH && *argptr=='\n') {
129 /* Newline: replace it with: \n */
130 *bufptr++='\\';
131 *bufptr++='n';
132 } else if (shell==TCSH && isspace(*argptr)) {
133 /* Non-newline whitespace: replace it with \<ws> */
134 *bufptr++='\'';
135 *bufptr++='\\';
136 *bufptr++=*argptr;
137 *bufptr++='\'';
138 } else
139 /* Just copy */
140 *bufptr++=*argptr;
141 argptr++;
142 }
143 *bufptr++='\'';
144 *bufptr++='\0';
145 return BUFFER;
146}
147
148/*
149 * Generate the output. argv[0] is the program name (used for reporting errors).
150 * argv[1..] contains the options to be parsed. argc must be the number of
151 * elements in argv (ie. 1 if there are no options, only the program name),
152 * optstr must contain the short options, and longopts the long options.
153 * Other settings are found in global variables.
154 */
155int generate_output(char * argv[],int argc,const char *optstr,
156 const struct option *longopts)
157{
158 int exit_code = 0; /* We assume everything will be OK */
159 int opt;
160 int longindex;
161 const char *charptr;
162
163 if (quiet_errors) /* No error reporting from getopt(3) */
164 opterr=0;
165 optind=0; /* Reset getopt(3) */
166
167 while ((opt = (alternative?
168 getopt_long_only(argc,argv,optstr,longopts,&longindex):
169 getopt_long(argc,argv,optstr,longopts,&longindex)))
170 != EOF)
171 if (opt == '?' || opt == ':' )
172 exit_code = 1;
173 else if (!quiet_output) {
174 if (opt == LONG_OPT) {
175 printf(" --%s",longopts[longindex].name);
176 if (longopts[longindex].has_arg)
177 printf(" %s",
178 normalize(optarg?optarg:""));
179 } else if (opt == NON_OPT)
180 printf(" %s",normalize(optarg));
181 else {
182 printf(" -%c",opt);
183 charptr = strchr(optstr,opt);
184 if (charptr != NULL && *++charptr == ':')
185 printf(" %s",
186 normalize(optarg?optarg:""));
187 }
188 }
189
190 if (! quiet_output) {
191 printf(" --");
192 while (optind < argc)
193 printf(" %s",normalize(argv[optind++]));
194 printf("\n");
195 }
196 return exit_code;
197}
198
199static struct option *long_options=NULL;
200static int long_options_length=0; /* Length of array */
201static int long_options_nr=0; /* Nr of used elements in array */
Mark Whitley59ab0252001-01-23 22:30:04 +0000202static const int LONG_OPTIONS_INCR = 10;
Eric Andersena1f16bb2000-08-21 22:02:34 +0000203#define init_longopt() add_longopt(NULL,0)
204
205/* Register a long option. The contents of name is copied. */
206void add_longopt(const char *name,int has_arg)
207{
208 char *tmp;
209 if (!name) { /* init */
210 free(long_options);
211 long_options=NULL;
212 long_options_length=0;
213 long_options_nr=0;
214 }
215
216 if (long_options_nr == long_options_length) {
217 long_options_length += LONG_OPTIONS_INCR;
218 long_options=xrealloc(long_options,
219 sizeof(struct option) *
220 long_options_length);
221 }
222
223 long_options[long_options_nr].name=NULL;
224 long_options[long_options_nr].has_arg=0;
225 long_options[long_options_nr].flag=NULL;
226 long_options[long_options_nr].val=0;
227
228 if (long_options_nr) { /* Not for init! */
229 long_options[long_options_nr-1].has_arg=has_arg;
230 long_options[long_options_nr-1].flag=NULL;
231 long_options[long_options_nr-1].val=LONG_OPT;
232 tmp = xmalloc(strlen(name)+1);
233 strcpy(tmp,name);
234 long_options[long_options_nr-1].name=tmp;
235 }
236 long_options_nr++;
237}
238
239
240/*
241 * Register several long options. options is a string of long options,
242 * separated by commas or whitespace.
243 * This nukes options!
244 */
245void add_long_options(char *options)
246{
247 int arg_opt;
248 char *tokptr=strtok(options,", \t\n");
249 while (tokptr) {
250 arg_opt=no_argument;
251 if (strlen(tokptr) > 0) {
252 if (tokptr[strlen(tokptr)-1] == ':') {
253 if (tokptr[strlen(tokptr)-2] == ':') {
254 tokptr[strlen(tokptr)-2]='\0';
255 arg_opt=optional_argument;
256 } else {
257 tokptr[strlen(tokptr)-1]='\0';
258 arg_opt=required_argument;
259 }
260 if (strlen(tokptr) == 0)
Mark Whitleyf57c9442000-12-07 19:56:48 +0000261 error_msg("empty long option after -l or --long argument\n");
Eric Andersena1f16bb2000-08-21 22:02:34 +0000262 }
263 add_longopt(tokptr,arg_opt);
264 }
265 tokptr=strtok(NULL,", \t\n");
266 }
267}
268
269void set_shell(const char *new_shell)
270{
271 if (!strcmp(new_shell,"bash"))
272 shell=BASH;
273 else if (!strcmp(new_shell,"tcsh"))
274 shell=TCSH;
275 else if (!strcmp(new_shell,"sh"))
276 shell=BASH;
277 else if (!strcmp(new_shell,"csh"))
278 shell=TCSH;
279 else
Mark Whitleyf57c9442000-12-07 19:56:48 +0000280 error_msg("unknown shell after -s or --shell argument\n");
Eric Andersena1f16bb2000-08-21 22:02:34 +0000281}
282
283
284/* Exit codes:
285 * 0) No errors, succesful operation.
286 * 1) getopt(3) returned an error.
287 * 2) A problem with parameter parsing for getopt(1).
288 * 3) Internal error, out of memory
289 * 4) Returned for -T
290 */
291
292static struct option longopts[]=
293{
294 {"options",required_argument,NULL,'o'},
295 {"longoptions",required_argument,NULL,'l'},
296 {"quiet",no_argument,NULL,'q'},
297 {"quiet-output",no_argument,NULL,'Q'},
298 {"shell",required_argument,NULL,'s'},
299 {"test",no_argument,NULL,'T'},
300 {"unquoted",no_argument,NULL,'u'},
301 {"alternative",no_argument,NULL,'a'},
302 {"name",required_argument,NULL,'n'},
303 {NULL,0,NULL,0}
304};
305
306/* Stop scanning as soon as a non-option argument is found! */
307static const char *shortopts="+ao:l:n:qQs:Tu";
308
Eric Andersena1f16bb2000-08-21 22:02:34 +0000309
310int getopt_main(int argc, char *argv[])
311{
312 char *optstr=NULL;
313 char *name=NULL;
314 int opt;
315 int compatible=0;
316
317 init_longopt();
318
319 if (getenv("GETOPT_COMPATIBLE"))
320 compatible=1;
321
322 if (argc == 1) {
323 if (compatible) {
324 /* For some reason, the original getopt gave no error
325 when there were no arguments. */
326 printf(" --\n");
327 exit(0);
328 } else
Mark Whitleyf57c9442000-12-07 19:56:48 +0000329 error_msg_and_die("missing optstring argument\n");
Eric Andersena1f16bb2000-08-21 22:02:34 +0000330 }
331
332 if (argv[1][0] != '-' || compatible) {
333 quote=0;
334 optstr=xmalloc(strlen(argv[1])+1);
335 strcpy(optstr,argv[1]+strspn(argv[1],"-+"));
336 argv[1]=argv[0];
337 exit(generate_output(argv+1,argc-1,optstr,long_options));
338 }
339
340 while ((opt=getopt_long(argc,argv,shortopts,longopts,NULL)) != EOF)
341 switch (opt) {
342 case 'a':
343 alternative=1;
344 break;
345 case 'o':
346 if (optstr)
347 free(optstr);
348 optstr=xmalloc(strlen(optarg)+1);
349 strcpy(optstr,optarg);
350 break;
351 case 'l':
352 add_long_options(optarg);
353 break;
354 case 'n':
355 if (name)
356 free(name);
357 name=xmalloc(strlen(optarg)+1);
358 strcpy(name,optarg);
359 break;
360 case 'q':
361 quiet_errors=1;
362 break;
363 case 'Q':
364 quiet_output=1;
365 break;
366 case 's':
367 set_shell(optarg);
368 break;
369 case 'T':
370 exit(4);
371 case 'u':
372 quote=0;
373 break;
374 default:
375 usage(getopt_usage);
376 }
377
378 if (!optstr) {
379 if (optind >= argc)
Mark Whitleyf57c9442000-12-07 19:56:48 +0000380 error_msg_and_die("missing optstring argument\n");
Eric Andersena1f16bb2000-08-21 22:02:34 +0000381 else {
382 optstr=xmalloc(strlen(argv[optind])+1);
383 strcpy(optstr,argv[optind]);
384 optind++;
385 }
386 }
387 if (name)
388 argv[optind-1]=name;
389 else
390 argv[optind-1]=argv[0];
391 exit(generate_output(argv+optind-1,argc-optind+1,optstr,long_options));
392}
393
394/*
395 Local Variables:
396 c-file-style: "linux"
397 c-basic-offset: 4
398 tab-width: 4
399 End:
400*/