/[public]/getopt/trunk/getopt.c
ViewVC logotype

Contents of /getopt/trunk/getopt.c

Parent Directory Parent Directory | Revision Log Revision Log


Revision 317 - (show annotations)
Sat Jul 14 18:51:30 2012 UTC (7 years, 5 months ago) by frodo
File MIME type: text/plain
File size: 13450 byte(s)
(Frodo) Update comments to get them more in line with util-linux 2.21

1 /*
2 * getopt.c - Enhanced implementation of BSD getopt(1)
3 * Copyright (c) 1997-2005 Frodo Looijaard <frodo@frodo.looijaard.name>
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@pld.org.pl>)
38 * Version 1.1.4: Mon Nov 7 2005
39 * Fixed a few type's in the manpage
40 */
41
42 #include <stdio.h>
43 #include <stdlib.h>
44 #include <string.h>
45 #include <unistd.h>
46 #include <ctype.h>
47
48 #if LIBCGETOPT
49 #include <getopt.h>
50 #else
51 #include "getopt.h"
52 #endif
53
54 #include "nls.h"
55
56 /* NON_OPT is the code that is returned when a non-option is found in '+'
57 * mode */
58 #define NON_OPT 1
59 /* LONG_OPT is the code that is returned when a long option is found. */
60 #define LONG_OPT 2
61
62 /* The shells recognized. */
63 typedef enum {BASH,TCSH} shell_t;
64
65
66 /* Some global variables that tells us how to parse. */
67 shell_t shell=BASH; /* The shell we generate output for. */
68 int quiet_errors=0; /* 0 is not quiet. */
69 int quiet_output=0; /* 0 is not quiet. */
70 int quote=1; /* 1 is do quote. */
71 int alternative=0; /* 0 is getopt_long, 1 is getopt_long_only */
72
73 /* Function prototypes */
74 void *our_malloc(size_t size);
75 void *our_realloc(void *ptr, size_t size);
76 const char *normalize(const char *arg);
77 int generate_output(char * argv[],int argc,const char *optstr,
78 const struct option *longopts);
79 int main(int argc, char *argv[]);
80 void parse_error(const char *message);
81 void add_long_options(char *options);
82 void add_longopt(const char *name,int has_arg);
83 void print_help(void);
84 void set_shell(const char *new_shell);
85 void set_initial_shell(void);
86
87 void *our_malloc(size_t size)
88 {
89 void *ret=malloc(size);
90 if (! ret) {
91 fprintf(stderr,_("%s: Out of memory!\n"),"getopt");
92 exit(3);
93 }
94 return(ret);
95 }
96
97 void *our_realloc(void *ptr, size_t size)
98 {
99 void *ret=realloc(ptr,size);
100 if (! ret && size) {
101 fprintf(stderr,_("%s: Out of memory!\n"),"getopt");
102 exit(3);
103 }
104 return(ret);
105 }
106
107 /*
108 * This function 'normalizes' a single argument: it puts single quotes
109 * around it and escapes other special characters. If quote is false, it
110 * just returns its argument.
111 *
112 * Bash only needs special treatment for single quotes; tcsh also recognizes
113 * exclamation marks within single quotes, and nukes whitespace. This
114 * function returns a pointer to a buffer that is overwritten by each call.
115 */
116 const char *normalize(const char *arg)
117 {
118 static char *BUFFER=NULL;
119 const char *argptr=arg;
120 char *bufptr;
121
122 if (BUFFER != NULL)
123 free(BUFFER);
124
125 if (!quote) {
126 /* Just copy arg */
127 BUFFER=our_malloc(strlen(arg)+1);
128
129 strcpy(BUFFER,arg);
130 return BUFFER;
131 }
132
133 /*
134 * Each character in arg may take upto four characters in the
135 * result: For a quote we need a closing quote, a backslash, a quote
136 * and an opening quote! We need also the global opening and closing
137 * quote, and one extra character for '\0'.
138 */
139 BUFFER=our_malloc(strlen(arg)*4+3);
140
141 bufptr=BUFFER;
142 *bufptr++='\'';
143
144 while (*argptr) {
145 if (*argptr == '\'') {
146 /* Quote: replace it with: '\'' */
147 *bufptr++='\'';
148 *bufptr++='\\';
149 *bufptr++='\'';
150 *bufptr++='\'';
151 } else if (shell==TCSH && *argptr=='!') {
152 /* Exclamation mark: replace it with: \! */
153 *bufptr++='\'';
154 *bufptr++='\\';
155 *bufptr++='!';
156 *bufptr++='\'';
157 } else if (shell==TCSH && *argptr=='\n') {
158 /* Newline: replace it with: \n */
159 *bufptr++='\\';
160 *bufptr++='n';
161 } else if (shell==TCSH && isspace(*argptr)) {
162 /* Non-newline whitespace: replace it with \<ws> */
163 *bufptr++='\'';
164 *bufptr++='\\';
165 *bufptr++=*argptr;
166 *bufptr++='\'';
167 } else
168 /* Just copy */
169 *bufptr++=*argptr;
170 argptr++;
171 }
172 *bufptr++='\'';
173 *bufptr++='\0';
174 return BUFFER;
175 }
176
177 /*
178 * Generate the output. argv[0] is the program name (used for reporting errors).
179 * argv[1..] contains the options to be parsed. argc must be the number of
180 * elements in argv (ie. 1 if there are no options, only the program name),
181 * optstr must contain the short options, and longopts the long options.
182 * Other settings are found in global variables.
183 */
184 int generate_output(char * argv[],int argc,const char *optstr,
185 const struct option *longopts)
186 {
187 int exit_code = 0; /* Assume everything will be OK */
188 int opt;
189 int longindex;
190 const char *charptr;
191
192 if (quiet_errors)
193 /* No error reporting from getopt(3) */
194 opterr=0;
195 /* Reset getopt(3) */
196 optind=0;
197
198 while ((opt = (alternative?
199 getopt_long_only(argc,argv,optstr,longopts,&longindex):
200 getopt_long(argc,argv,optstr,longopts,&longindex)))
201 != EOF)
202 if (opt == '?' || opt == ':' )
203 exit_code = 1;
204 else if (!quiet_output)
205 {
206 if (opt == LONG_OPT) {
207 printf(" --%s",longopts[longindex].name);
208 if (longopts[longindex].has_arg)
209 printf(" %s",
210 normalize(optarg?optarg:""));
211 } else if (opt == NON_OPT)
212 printf(" %s",normalize(optarg));
213 else {
214 printf(" -%c",opt);
215 charptr = strchr(optstr,opt);
216 if (charptr != NULL && *++charptr == ':')
217 printf(" %s",
218 normalize(optarg?optarg:""));
219 }
220 }
221
222 if (! quiet_output) {
223 printf(" --");
224 while (optind < argc)
225 printf(" %s",normalize(argv[optind++]));
226 printf("\n");
227 }
228 return exit_code;
229 }
230
231 /*
232 * Report an error when parsing getopt's own arguments. If message is NULL,
233 * we already sent a message, we just exit with a helpful hint.
234 */
235 void parse_error(const char *message)
236 {
237 if (message)
238 fprintf(stderr,"getopt: %s\n",message);
239 fputs(_("Try `getopt --help' for more information.\n"),stderr);
240 exit(2);
241 }
242
243 static struct option *long_options=NULL;
244 static int long_options_length=0; /* Length of array */
245 static int long_options_nr=0; /* Nr of used elements in array */
246 #define LONG_OPTIONS_INCR 10
247 #define init_longopt() add_longopt(NULL,0)
248
249 /* Register a long option. The contents of name is copied. */
250 void add_longopt(const char *name,int has_arg)
251 {
252 char *tmp;
253 if (!name) {
254 /* init */
255 free(long_options);
256 long_options=NULL;
257 long_options_length=0;
258 long_options_nr=0;
259 }
260
261 if (long_options_nr == long_options_length) {
262 long_options_length += LONG_OPTIONS_INCR;
263 long_options=our_realloc(long_options,
264 sizeof(struct option) *
265 long_options_length);
266 }
267
268 long_options[long_options_nr].name=NULL;
269 long_options[long_options_nr].has_arg=0;
270 long_options[long_options_nr].flag=NULL;
271 long_options[long_options_nr].val=0;
272
273 if (long_options_nr) {
274 /* Not for init! */
275 long_options[long_options_nr-1].has_arg=has_arg;
276 long_options[long_options_nr-1].flag=NULL;
277 long_options[long_options_nr-1].val=LONG_OPT;
278 tmp = our_malloc(strlen(name)+1);
279 strcpy(tmp,name);
280 long_options[long_options_nr-1].name=tmp;
281 }
282 long_options_nr++;
283 }
284
285
286 /*
287 * Register several long options. options is a string of long options,
288 * separated by commas or whitespace. This nukes options!
289 */
290 void add_long_options(char *options)
291 {
292 int arg_opt;
293 char *tokptr=strtok(options,", \t\n");
294 while (tokptr) {
295 arg_opt=no_argument;
296 if (strlen(tokptr) > 0) {
297 if (tokptr[strlen(tokptr)-1] == ':') {
298 if (tokptr[strlen(tokptr)-2] == ':') {
299 tokptr[strlen(tokptr)-2]='\0';
300 arg_opt=optional_argument;
301 } else {
302 tokptr[strlen(tokptr)-1]='\0';
303 arg_opt=required_argument;
304 }
305 if (strlen(tokptr) == 0)
306 parse_error(_("empty long option after "
307 "-l or --long argument"));
308 }
309 add_longopt(tokptr,arg_opt);
310 }
311 tokptr=strtok(NULL,", \t\n");
312 }
313 }
314
315 void set_shell(const char *new_shell)
316 {
317 if (!strcmp(new_shell,"bash"))
318 shell=BASH;
319 else if (!strcmp(new_shell,"tcsh"))
320 shell=TCSH;
321 else if (!strcmp(new_shell,"sh"))
322 shell=BASH;
323 else if (!strcmp(new_shell,"csh"))
324 shell=TCSH;
325 else
326 parse_error(_("unknown shell after -s or --shell argument"));
327 }
328
329 void print_help(void)
330 {
331 fputs(_("Usage: getopt optstring parameters\n"),stderr);
332 fputs(_(" getopt [options] [--] optstring parameters\n"),stderr);
333 fputs(_(" getopt [options] -o|--options optstring [options] [--]\n"),stderr);
334 fputs(_(" parameters\n"),stderr);
335 fputs(_(" -a, --alternative Allow long options starting with single -\n"),stderr);
336 fputs(_(" -h, --help This small usage guide\n"),stderr);
337 fputs(_(" -l, --longoptions=longopts Long options to be recognized\n"),stderr);
338 fputs(_(" -n, --name=progname The name under which errors are reported\n"),stderr);
339 fputs(_(" -o, --options=optstring Short options to be recognized\n"),stderr);
340 fputs(_(" -q, --quiet Disable error reporting by getopt(3)\n"),stderr);
341 fputs(_(" -Q, --quiet-output No normal output\n"),stderr);
342 fputs(_(" -s, --shell=shell Set shell quoting conventions\n"),stderr);
343 fputs(_(" -T, --test Test for getopt(1) version\n"),stderr);
344 fputs(_(" -u, --unqote Do not quote the output\n"),stderr);
345 fputs(_(" -V, --version Output version information\n"),stderr);
346 exit(2);
347 }
348
349 /* Exit codes:
350 * 0) No errors, succesful operation.
351 * 1) getopt(3) returned an error.
352 * 2) A problem with parameter parsing for getopt(1).
353 * 3) Internal error, out of memory
354 * 4) Returned for -T
355 */
356
357 static struct option longopts[]={ {"options",required_argument,NULL,'o'},
358 {"longoptions",required_argument,NULL,'l'},
359 {"quiet",no_argument,NULL,'q'},
360 {"quiet-output",no_argument,NULL,'Q'},
361 {"shell",required_argument,NULL,'s'},
362 {"test",no_argument,NULL,'T'},
363 {"unquoted",no_argument,NULL,'u'},
364 {"help",no_argument,NULL,'h'},
365 {"alternative",no_argument,NULL,'a'},
366 {"name",required_argument,NULL,'n'},
367 {"version",no_argument,NULL,'V'},
368 {NULL,0,NULL,0}
369 };
370
371 /* Stop scanning as soon as a non-option argument is found! */
372 static const char *shortopts="+ao:l:n:qQs:TuhV";
373
374 int main(int argc, char *argv[])
375 {
376 char *optstr=NULL;
377 char *name=NULL;
378 int opt;
379 int compatible=0;
380
381 #if WITHOUT_GETTEXT
382 #else
383 setlocale(LC_ALL,"");
384 bindtextdomain(PACKAGE, LOCALEDIR);
385 textdomain(PACKAGE);
386 #endif
387
388 init_longopt();
389
390 if (getenv("GETOPT_COMPATIBLE"))
391 compatible=1;
392
393 if (argc == 1)
394 {
395 if (compatible) {
396 /*
397 * For some reason, the original getopt gave no error
398 * when there were no arguments.
399 */
400 printf(" --\n");
401 exit(0);
402 }
403 else
404 parse_error(_("missing optstring argument"));
405 }
406
407 if (argv[1][0] != '-' || compatible) {
408 quote=0;
409 optstr=our_malloc(strlen(argv[1])+1);
410 strcpy(optstr,argv[1]+strspn(argv[1],"-+"));
411 argv[1]=argv[0];
412 exit(generate_output(argv+1,argc-1,optstr,long_options));
413 }
414
415 while ((opt=getopt_long(argc,argv,shortopts,longopts,NULL)) != EOF)
416 switch (opt) {
417 case 'a':
418 alternative=1;
419 break;
420 case 'h':
421 print_help();
422 exit(0);
423 case 'o':
424 if (optstr)
425 free(optstr);
426 optstr=our_malloc(strlen(optarg)+1);
427 strcpy(optstr,optarg);
428 break;
429 case 'l':
430 add_long_options(optarg);
431 break;
432 case 'n':
433 if (name)
434 free(name);
435 name=our_malloc(strlen(optarg)+1);
436 strcpy(name,optarg);
437 break;
438 case 'q':
439 quiet_errors=1;
440 break;
441 case 'Q':
442 quiet_output=1;
443 break;
444 case 's':
445 set_shell(optarg);
446 break;
447 case 'T':
448 exit(4);
449 case 'u':
450 quote=0;
451 break;
452 case 'V':
453 printf(_("getopt (enhanced) 1.1.4\n"));
454 exit(0);
455 case '?':
456 case ':':
457 parse_error(NULL);
458 default:
459 parse_error(_("internal error, contact the author."));
460 }
461
462 if (!optstr)
463 {
464 if (optind >= argc)
465 parse_error(_("missing optstring argument"));
466 else {
467 optstr=our_malloc(strlen(argv[optind])+1);
468 strcpy(optstr,argv[optind]);
469 optind++;
470 }
471 }
472 if (name)
473 argv[optind-1]=name;
474 else
475 argv[optind-1]=argv[0];
476 exit(generate_output(argv+optind-1,argc-optind+1,optstr,long_options));
477 }

frodo@frodo.looijaard.name
ViewVC Help
Powered by ViewVC 1.1.26