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

Diff of /getopt/trunk/getopt.c

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 259 Revision 318
1/* 1/*
2 getopt.c - Enhanced implementation of BSD getopt(1) 2 * getopt.c - Enhanced implementation of BSD getopt(1)
3 Copyright (c) 1997, 1998, 1999, 2000 Frodo Looijaard <frodol@dds.nl> 3 * Copyright (c) 1997-2005 Frodo Looijaard <frodo@frodo.looijaard.name>
4 4 *
5 This program is free software; you can redistribute it and/or modify 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 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 7 * the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version. 8 * (at your option) any later version.
9 9 *
10 This program is distributed in the hope that it will be useful, 10 * This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details. 13 * GNU General Public License for more details.
14 14 *
15 You should have received a copy of the GNU General Public License 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 16 * along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18*/ 18 */
19 19
20/* 20/*
21 * Version 1.0-b4: Tue Sep 23 1997. First public release. 21 * Version 1.0-b4: Tue Sep 23 1997. First public release.
22 * Version 1.0: Wed Nov 19 1997. 22 * Version 1.0: Wed Nov 19 1997.
23 * Bumped up the version number to 1.0 23 * Bumped up the version number to 1.0
… …
33 * Version 1.0.6: Tue Jun 27 2000 33 * Version 1.0.6: Tue Jun 27 2000
34 * No important changes 34 * No important changes
35 * Version 1.1.0: Tue Jun 30 2000 35 * Version 1.1.0: Tue Jun 30 2000
36 * Added NLS support (partly written by Arkadiusz Mi<B6>kiewicz 36 * Added NLS support (partly written by Arkadiusz Mi<B6>kiewicz
37 * <misiek@pld.org.pl>) 37 * <misiek@pld.org.pl>)
38 * Version 1.1.4: Mon Nov 7 2005
39 * Fixed a few type's in the manpage
38 */ 40 */
41
42/* Exit codes:
43 * 0) No errors, succesful operation.
44 * 1) getopt(3) returned an error.
45 * 2) A problem with parameter parsing for getopt(1).
46 * 3) Internal error, out of memory
47 * 4) Returned for -T
48 */
49#define GETOPT_EXIT_CODE 1
50#define PARAMETER_EXIT_CODE 2
51#define XALLOC_EXIT_CODE 3
52#define TEST_EXIT_CODE 4
53
39 54
40#include <stdio.h> 55#include <stdio.h>
41#include <stdlib.h> 56#include <stdlib.h>
42#include <string.h> 57#include <string.h>
43#include <unistd.h> 58#include <unistd.h>
… …
50#endif 65#endif
51 66
52#include "nls.h" 67#include "nls.h"
53 68
54/* NON_OPT is the code that is returned when a non-option is found in '+' 69/* NON_OPT is the code that is returned when a non-option is found in '+'
55 mode */ 70 * mode */
56#define NON_OPT 1 71#define NON_OPT 1
57/* LONG_OPT is the code that is returned when a long option is found. */ 72/* LONG_OPT is the code that is returned when a long option is found. */
58#define LONG_OPT 2 73#define LONG_OPT 2
59 74
60/* The shells recognized. */ 75/* The shells recognized. */
61typedef enum {BASH,TCSH} shell_t; 76typedef enum {BASH,TCSH} shell_t;
62 77
63 78
64/* Some global variables that tells us how to parse. */ 79/* Some global variables that tells us how to parse. */
65shell_t shell=BASH; /* The shell we generate output for. */ 80shell_t shell=BASH; /* The shell we generate output for. */
66int quiet_errors=0; /* 0 is not quiet. */ 81int quiet_errors=0; /* 0 is not quiet. */
67int quiet_output=0; /* 0 is not quiet. */ 82int quiet_output=0; /* 0 is not quiet. */
68int quote=1; /* 1 is do quote. */ 83int quote=1; /* 1 is do quote. */
69int alternative=0; /* 0 is getopt_long, 1 is getopt_long_only */ 84int alternative=0; /* 0 is getopt_long, 1 is getopt_long_only */
70 85
71/* Function prototypes */ 86/* Function prototypes */
72void *our_malloc(size_t size); 87void *our_malloc(size_t size);
73void *our_realloc(void *ptr, size_t size); 88void *our_realloc(void *ptr, size_t size);
74const char *normalize(const char *arg); 89const char *normalize(const char *arg);
… …
85void *our_malloc(size_t size) 100void *our_malloc(size_t size)
86{ 101{
87 void *ret=malloc(size); 102 void *ret=malloc(size);
88 if (! ret) { 103 if (! ret) {
89 fprintf(stderr,_("%s: Out of memory!\n"),"getopt"); 104 fprintf(stderr,_("%s: Out of memory!\n"),"getopt");
90 exit(3); 105 exit(XALLOC_EXIT_CODE);
91 } 106 }
92 return(ret); 107 return(ret);
93} 108}
94 109
95void *our_realloc(void *ptr, size_t size) 110void *our_realloc(void *ptr, size_t size)
96{ 111{
97 void *ret=realloc(ptr,size); 112 void *ret=realloc(ptr,size);
98 if (! ret && size) { 113 if (! ret && size) {
99 fprintf(stderr,_("%s: Out of memory!\n"),"getopt"); 114 fprintf(stderr,_("%s: Out of memory!\n"),"getopt");
100 exit(3); 115 exit(XALLOC_EXIT_CODE);
101 } 116 }
102 return(ret); 117 return(ret);
103} 118}
104 119
105/* 120/*
106 * This function 'normalizes' a single argument: it puts single quotes around 121 * This function 'normalizes' a single argument: it puts single quotes
107 * it and escapes other special characters. If quote is false, it just 122 * around it and escapes other special characters. If quote is false, it
108 * returns its argument. 123 * just returns its argument.
124 *
109 * Bash only needs special treatment for single quotes; tcsh also recognizes 125 * Bash only needs special treatment for single quotes; tcsh also recognizes
110 * exclamation marks within single quotes, and nukes whitespace. 126 * exclamation marks within single quotes, and nukes whitespace. This
111 * This function returns a pointer to a buffer that is overwritten by 127 * function returns a pointer to a buffer that is overwritten by each call.
112 * each call.
113 */ 128 */
114const char *normalize(const char *arg) 129const char *normalize(const char *arg)
115{ 130{
116 static char *BUFFER=NULL; 131 static char *BUFFER=NULL;
117 const char *argptr=arg; 132 const char *argptr=arg;
118 char *bufptr; 133 char *bufptr;
119 134
120 if (BUFFER != NULL) 135 if (BUFFER != NULL)
121 free(BUFFER); 136 free(BUFFER);
122 137
123 if (!quote) { /* Just copy arg */ 138 if (!quote) {
139 /* Just copy arg */
124 BUFFER=our_malloc(strlen(arg)+1); 140 BUFFER=our_malloc(strlen(arg)+1);
125 141
126 strcpy(BUFFER,arg); 142 strcpy(BUFFER,arg);
127 return BUFFER; 143 return BUFFER;
128 } 144 }
129 145
146 /*
130 /* Each character in arg may take upto four characters in the result: 147 * Each character in arg may take upto four characters in the
131 For a quote we need a closing quote, a backslash, a quote and an 148 * result: For a quote we need a closing quote, a backslash, a quote
132 opening quote! We need also the global opening and closing quote, 149 * and an opening quote! We need also the global opening and closing
133 and one extra character for '\0'. */ 150 * quote, and one extra character for '\0'.
151 */
134 BUFFER=our_malloc(strlen(arg)*4+3); 152 BUFFER=our_malloc(strlen(arg)*4+3);
135 153
136 bufptr=BUFFER; 154 bufptr=BUFFER;
137 *bufptr++='\''; 155 *bufptr++='\'';
138 156
… …
177 * Other settings are found in global variables. 195 * Other settings are found in global variables.
178 */ 196 */
179int generate_output(char * argv[],int argc,const char *optstr, 197int generate_output(char * argv[],int argc,const char *optstr,
180 const struct option *longopts) 198 const struct option *longopts)
181{ 199{
182 int exit_code = 0; /* We assume everything will be OK */ 200 int exit_code = EXIT_SUCCESS; /* Assume everything will be OK */
183 int opt; 201 int opt;
184 int longindex; 202 int longindex;
185 const char *charptr; 203 const char *charptr;
186 204
187 if (quiet_errors) /* No error reporting from getopt(3) */ 205 if (quiet_errors)
206 /* No error reporting from getopt(3) */
188 opterr=0; 207 opterr=0;
189 optind=0; /* Reset getopt(3) */ 208 /* Reset getopt(3) */
209 optind=0;
190 210
191 while ((opt = (alternative? 211 while ((opt = (alternative?
192 getopt_long_only(argc,argv,optstr,longopts,&longindex): 212 getopt_long_only(argc,argv,optstr,longopts,&longindex):
193 getopt_long(argc,argv,optstr,longopts,&longindex))) 213 getopt_long(argc,argv,optstr,longopts,&longindex)))
194 != EOF) 214 != EOF)
195 if (opt == '?' || opt == ':' ) 215 if (opt == '?' || opt == ':' )
196 exit_code = 1; 216 exit_code = GETOPT_EXIT_CODE;
197 else if (!quiet_output) 217 else if (!quiet_output)
198 { 218 {
199 if (opt == LONG_OPT) { 219 if (opt == LONG_OPT) {
200 printf(" --%s",longopts[longindex].name); 220 printf(" --%s",longopts[longindex].name);
201 if (longopts[longindex].has_arg) 221 if (longopts[longindex].has_arg)
… …
220 } 240 }
221 return exit_code; 241 return exit_code;
222} 242}
223 243
224/* 244/*
225 * Report an error when parsing getopt's own arguments. 245 * Report an error when parsing getopt's own arguments. If message is NULL,
226 * If message is NULL, we already sent a message, we just exit with a helpful 246 * we already sent a message, we just exit with a helpful hint.
227 * hint.
228 */ 247 */
229void parse_error(const char *message) 248void parse_error(const char *message)
230{ 249{
231 if (message) 250 if (message)
232 fprintf(stderr,"getopt: %s\n",message); 251 fprintf(stderr,"getopt: %s\n",message);
233 fputs(_("Try `getopt --help' for more information.\n"),stderr); 252 fputs(_("Try `getopt --help' for more information.\n"),stderr);
234 exit(2); 253 exit(PARAMETER_EXIT_CODE);
235} 254}
236 255
237static struct option *long_options=NULL; 256static struct option *long_options=NULL;
238static int long_options_length=0; /* Length of array */ 257static int long_options_length=0; /* Length of array */
239static int long_options_nr=0; /* Nr of used elements in array */ 258static int long_options_nr=0; /* Nr of used elements in array */
… …
242 261
243/* Register a long option. The contents of name is copied. */ 262/* Register a long option. The contents of name is copied. */
244void add_longopt(const char *name,int has_arg) 263void add_longopt(const char *name,int has_arg)
245{ 264{
246 char *tmp; 265 char *tmp;
247 if (!name) { /* init */ 266 if (!name) {
267 /* init */
248 free(long_options); 268 free(long_options);
249 long_options=NULL; 269 long_options=NULL;
250 long_options_length=0; 270 long_options_length=0;
251 long_options_nr=0; 271 long_options_nr=0;
252 } 272 }
… …
261 long_options[long_options_nr].name=NULL; 281 long_options[long_options_nr].name=NULL;
262 long_options[long_options_nr].has_arg=0; 282 long_options[long_options_nr].has_arg=0;
263 long_options[long_options_nr].flag=NULL; 283 long_options[long_options_nr].flag=NULL;
264 long_options[long_options_nr].val=0; 284 long_options[long_options_nr].val=0;
265 285
266 if (long_options_nr) { /* Not for init! */ 286 if (long_options_nr) {
287 /* Not for init! */
267 long_options[long_options_nr-1].has_arg=has_arg; 288 long_options[long_options_nr-1].has_arg=has_arg;
268 long_options[long_options_nr-1].flag=NULL; 289 long_options[long_options_nr-1].flag=NULL;
269 long_options[long_options_nr-1].val=LONG_OPT; 290 long_options[long_options_nr-1].val=LONG_OPT;
270 tmp = our_malloc(strlen(name)+1); 291 tmp = our_malloc(strlen(name)+1);
271 strcpy(tmp,name); 292 strcpy(tmp,name);
… …
274 long_options_nr++; 295 long_options_nr++;
275} 296}
276 297
277 298
278/* 299/*
279 * Register several long options. options is a string of long options, 300 * Register several long options. options is a string of long options,
280 * separated by commas or whitespace. 301 * separated by commas or whitespace. This nukes options!
281 * This nukes options!
282 */ 302 */
283void add_long_options(char *options) 303void add_long_options(char *options)
284{ 304{
285 int arg_opt; 305 int arg_opt;
286 char *tokptr=strtok(options,", \t\n"); 306 char *tokptr=strtok(options,", \t\n");
… …
334 fputs(_(" -Q, --quiet-output No normal output\n"),stderr); 354 fputs(_(" -Q, --quiet-output No normal output\n"),stderr);
335 fputs(_(" -s, --shell=shell Set shell quoting conventions\n"),stderr); 355 fputs(_(" -s, --shell=shell Set shell quoting conventions\n"),stderr);
336 fputs(_(" -T, --test Test for getopt(1) version\n"),stderr); 356 fputs(_(" -T, --test Test for getopt(1) version\n"),stderr);
337 fputs(_(" -u, --unqote Do not quote the output\n"),stderr); 357 fputs(_(" -u, --unqote Do not quote the output\n"),stderr);
338 fputs(_(" -V, --version Output version information\n"),stderr); 358 fputs(_(" -V, --version Output version information\n"),stderr);
339 exit(2); 359 exit(PARAMETER_EXIT_CODE);
340} 360}
341 361
342/* Exit codes:
343 * 0) No errors, succesful operation.
344 * 1) getopt(3) returned an error.
345 * 2) A problem with parameter parsing for getopt(1).
346 * 3) Internal error, out of memory
347 * 4) Returned for -T
348 */
349
350static struct option longopts[]={ {"options",required_argument,NULL,'o'}, 362static struct option longopts[]={ {"options",required_argument,NULL,'o'},
351 {"longoptions",required_argument,NULL,'l'}, 363 {"longoptions",required_argument,NULL,'l'},
352 {"quiet",no_argument,NULL,'q'}, 364 {"quiet",no_argument,NULL,'q'},
353 {"quiet-output",no_argument,NULL,'Q'}, 365 {"quiet-output",no_argument,NULL,'Q'},
354 {"shell",required_argument,NULL,'s'}, 366 {"shell",required_argument,NULL,'s'},
… …
384 compatible=1; 396 compatible=1;
385 397
386 if (argc == 1) 398 if (argc == 1)
387 { 399 {
388 if (compatible) { 400 if (compatible) {
401 /*
389 /* For some reason, the original getopt gave no error 402 * For some reason, the original getopt gave no error
390 when there were no arguments. */ 403 * when there were no arguments.
404 */
391 printf(" --\n"); 405 printf(" --\n");
392 exit(0); 406 return EXIT_SUCCESS;
393 } 407 }
394 else 408 else
395 parse_error(_("missing optstring argument")); 409 parse_error(_("missing optstring argument"));
396 } 410
397 411
398 if (argv[1][0] != '-' || compatible) { 412 if (argv[1][0] != '-' || compatible) {
399 quote=0; 413 quote=0;
400 optstr=our_malloc(strlen(argv[1])+1); 414 optstr=our_malloc(strlen(argv[1])+1);
401 strcpy(optstr,argv[1]+strspn(argv[1],"-+")); 415 strcpy(optstr,argv[1]+strspn(argv[1],"-+"));
402 argv[1]=argv[0]; 416 argv[1]=argv[0];
403 exit(generate_output(argv+1,argc-1,optstr,long_options)); 417 return generate_output(argv+1,argc-1,optstr,long_options);
404 } 418 }
405 419
406 while ((opt=getopt_long(argc,argv,shortopts,longopts,NULL)) != EOF) 420 while ((opt=getopt_long(argc,argv,shortopts,longopts,NULL)) != EOF)
407 switch (opt) { 421 switch (opt) {
408 case 'a': 422 case 'a':
409 alternative=1; 423 alternative=1;
410 break; 424 break;
411 case 'h': 425 case 'h':
412 print_help(); 426 print_help();
413 exit(0);
414 case 'o': 427 case 'o':
415 if (optstr) 428 if (optstr)
416 free(optstr); 429 free(optstr);
417 optstr=our_malloc(strlen(optarg)+1); 430 optstr=our_malloc(strlen(optarg)+1);
418 strcpy(optstr,optarg); 431 strcpy(optstr,optarg);
… …
434 break; 447 break;
435 case 's': 448 case 's':
436 set_shell(optarg); 449 set_shell(optarg);
437 break; 450 break;
438 case 'T': 451 case 'T':
439 exit(4); 452 return TEST_EXIT_CODE;
440 case 'u': 453 case 'u':
441 quote=0; 454 quote=0;
442 break; 455 break;
443 case 'V': 456 case 'V':
444 printf(_("getopt (enhanced) 1.1.3\n")); 457 printf(_("getopt (enhanced) 1.1.4\n"));
445 exit(0); 458 return EXIT_SUCCESS;
446 case '?': 459 case '?':
447 case ':': 460 case ':':
448 parse_error(NULL); 461 parse_error(NULL);
449 default: 462 default:
450 parse_error(_("internal error, contact the author.")); 463 parse_error(_("internal error, contact the author."));
… …
462 } 475 }
463 if (name) 476 if (name)
464 argv[optind-1]=name; 477 argv[optind-1]=name;
465 else 478 else
466 argv[optind-1]=argv[0]; 479 argv[optind-1]=argv[0];
467 exit(generate_output(argv+optind-1,argc-optind+1,optstr,long_options)); 480 return generate_output(argv+optind-1,argc-optind+1,optstr,long_options);
468} 481}
Legend:
Removed from v.259  
changed lines
  Added in v.318
frodo@frodo.looijaard.name
 ViewVC Help
Powered by ViewVC 1.1.26