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