/[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 321 Revision 377
1/* 1/*
2 * getopt.c - Enhanced implementation of BSD getopt(1) 2 * getopt.c - Enhanced implementation of BSD getopt(1)
3 * Copyright (c) 1997-2005 Frodo Looijaard <frodo@frodo.looijaard.name> 3 * Copyright (c) 1997-2014 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.
… …
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 along
16 * along with this program; if not, write to the Free Software 16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
24 * Fixed minor typo (CSH instead of TCSH) 24 * Fixed minor typo (CSH instead of TCSH)
25 * Version 1.0.1: Tue Jun 3 1998 25 * Version 1.0.1: Tue Jun 3 1998
26 * Fixed sizeof instead of strlen bug 26 * Fixed sizeof instead of strlen bug
27 * Bumped up the version number to 1.0.1 27 * Bumped up the version number to 1.0.1
… …
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
42 * Version 1.1.6: Mon Nov 24 2014
43 * Sync with util-linux git 20141120, detect ambiguous long options, fix
44 * backslash problem in tcsh
40 */ 45 */
41 46
42/* Exit codes: 47/* Exit codes:
43 * 0) No errors, succesful operation. 48 * 0) No errors, successful operation.
44 * 1) getopt(3) returned an error. 49 * 1) getopt(3) returned an error.
45 * 2) A problem with parameter parsing for getopt(1). 50 * 2) A problem with parameter parsing for getopt(1).
46 * 3) Internal error, out of memory 51 * 3) Internal error, out of memory
47 * 4) Returned for -T 52 * 4) Returned for -T
48 */ 53 */
… …
61#include <getopt.h> 66#include <getopt.h>
62#else 67#else
63#include "getopt.h" 68#include "getopt.h"
64#endif 69#endif
65 70
71#include "util-linux-compat.h"
66#include "nls.h" 72#include "nls.h"
73#include "xalloc.h"
67 74
68/* NON_OPT is the code that is returned when a non-option is found in '+' 75/* NON_OPT is the code that is returned when a non-option is found in '+'
69 * mode */ 76 * mode */
70#define NON_OPT 1 77#define NON_OPT 1
71/* LONG_OPT is the code that is returned when a long option is found. */ 78/* LONG_OPT is the code that is returned when a long option is found. */
72#define LONG_OPT 2 79#define LONG_OPT 0
73 80
74/* The shells recognized. */ 81/* The shells recognized. */
75typedef enum { BASH, TCSH } shell_t; 82typedef enum { BASH, TCSH } shell_t;
76 83
77 84
… …
79static shell_t shell = BASH; /* The shell we generate output for. */ 86static shell_t shell = BASH; /* The shell we generate output for. */
80static int quiet_errors = 0; /* 0 is not quiet. */ 87static int quiet_errors = 0; /* 0 is not quiet. */
81static int quiet_output = 0; /* 0 is not quiet. */ 88static int quiet_output = 0; /* 0 is not quiet. */
82static int quote = 1; /* 1 is do quote. */ 89static int quote = 1; /* 1 is do quote. */
83 90
91/* Allow changing which getopt is in use with function pointer */
84int (*getopt_long_fp) (int argc, char *const *argv, const char *optstr, 92int (*getopt_long_fp) (int argc, char *const *argv, const char *optstr,
85 const struct option * longopts, int *longindex); 93 const struct option * longopts, int *longindex);
86 94
87/* Function prototypes */ 95/* Function prototypes */
88void *our_malloc(size_t size);
89void *our_realloc(void *ptr, size_t size);
90static const char *normalize(const char *arg); 96static const char *normalize(const char *arg);
91static int generate_output(char *argv[], int argc, const char *optstr, 97static int generate_output(char *argv[], int argc, const char *optstr,
92 const struct option *longopts); 98 const struct option *longopts);
93int main(int argc, char *argv[]);
94static void parse_error(const char *message); 99static void parse_error(const char *message);
95static void add_long_options(char *options); 100static void add_long_options(char *options);
96static void add_longopt(const char *name, int has_arg); 101static void add_longopt(const char *name, int has_arg);
97static void print_help(void); 102static void print_help(void);
98static void set_shell(const char *new_shell); 103static void set_shell(const char *new_shell);
99
100void *our_malloc(size_t size)
101{
102 void *ret=malloc(size);
103 if (! ret) {
104 fprintf(stderr, ("%s: Out of memory!\n"), "getopt");
105 exit(XALLOC_EXIT_CODE);
106 }
107 return(ret);
108}
109
110void *our_realloc(void *ptr, size_t size)
111{
112 void *ret=realloc(ptr, size);
113 if (! ret && size) {
114 fprintf(stderr, ("%s: Out of memory!\n"), "getopt");
115 exit(XALLOC_EXIT_CODE);
116 }
117 return(ret);
118}
119 104
120/* 105/*
121 * This function 'normalizes' a single argument: it puts single quotes 106 * This function 'normalizes' a single argument: it puts single quotes
122 * around it and escapes other special characters. If quote is false, it 107 * around it and escapes other special characters. If quote is false, it
123 * just returns its argument. 108 * just returns its argument.
… …
130{ 115{
131 static char *BUFFER = NULL; 116 static char *BUFFER = NULL;
132 const char *argptr = arg; 117 const char *argptr = arg;
133 char *bufptr; 118 char *bufptr;
134 119
135 if (BUFFER != NULL)
136 free(BUFFER); 120 free(BUFFER);
137 121
138 if (!quote) { 122 if (!quote) {
139 /* Just copy arg */ 123 /* Just copy arg */
140 BUFFER = our_malloc(strlen(arg)+1); 124 BUFFER = xmalloc(strlen(arg) + 1);
141
142 strcpy(BUFFER, arg); 125 strcpy(BUFFER, arg);
143 return BUFFER; 126 return BUFFER;
144 } 127 }
145 128
146 /* 129 /*
147 * Each character in arg may take upto four characters in the 130 * Each character in arg may take up to four characters in the
148 * result: For a quote we need a closing quote, a backslash, a quote 131 * result: For a quote we need a closing quote, a backslash, a quote
149 * and an opening quote! We need also the global opening and closing 132 * and an opening quote! We need also the global opening and closing
150 * quote, and one extra character for '\0'. 133 * quote, and one extra character for '\0'.
151 */ 134 */
152 BUFFER = our_malloc(strlen(arg)*4+3); 135 BUFFER = xmalloc(strlen(arg) * 4 + 3);
153 136
154 bufptr = BUFFER; 137 bufptr = BUFFER;
155 *bufptr++ = '\''; 138 *bufptr++ = '\'';
156 139
157 while (*argptr) { 140 while (*argptr) {
… …
159 /* Quote: replace it with: '\'' */ 142 /* Quote: replace it with: '\'' */
160 *bufptr++ = '\''; 143 *bufptr++ = '\'';
161 *bufptr++ = '\\'; 144 *bufptr++ = '\\';
162 *bufptr++ = '\''; 145 *bufptr++ = '\'';
163 *bufptr++ = '\''; 146 *bufptr++ = '\'';
147 } else if (shell == TCSH && *argptr == '\\') {
148 /* Backslash: replace it with: '\\' */
149 *bufptr++ = '\\';
150 *bufptr++ = '\\';
164 } else if (shell == TCSH && *argptr == '!') { 151 } else if (shell == TCSH && *argptr == '!') {
165 /* Exclamation mark: replace it with: \! */ 152 /* Exclamation mark: replace it with: \! */
166 *bufptr++ = '\''; 153 *bufptr++ = '\'';
167 *bufptr++ = '\\'; 154 *bufptr++ = '\\';
168 *bufptr++ = '!'; 155 *bufptr++ = '!';
… …
185 *bufptr++ = '\''; 172 *bufptr++ = '\'';
186 *bufptr++ = '\0'; 173 *bufptr++ = '\0';
187 return BUFFER; 174 return BUFFER;
188} 175}
189 176
190/* 177/*
191 * Generate the output. argv[0] is the program name (used for reporting errors). 178 * Generate the output. argv[0] is the program name (used for reporting errors).
192 * argv[1..] contains the options to be parsed. argc must be the number of 179 * argv[1..] contains the options to be parsed. argc must be the number of
193 * elements in argv (ie. 1 if there are no options, only the program name), 180 * elements in argv (ie. 1 if there are no options, only the program name),
194 * optstr must contain the short options, and longopts the long options. 181 * optstr must contain the short options, and longopts the long options.
195 * Other settings are found in global variables. 182 * Other settings are found in global variables.
… …
217 if (opt == LONG_OPT) { 204 if (opt == LONG_OPT) {
218 printf(" --%s", longopts[longindex].name); 205 printf(" --%s", longopts[longindex].name);
219 if (longopts[longindex].has_arg) 206 if (longopts[longindex].has_arg)
220 printf(" %s", normalize(optarg ? optarg : "")); 207 printf(" %s", normalize(optarg ? optarg : ""));
221 } else if (opt == NON_OPT) 208 } else if (opt == NON_OPT)
222 printf(" %s", normalize(optarg)); 209 printf(" %s", normalize(optarg ? optarg : ""));
223 else { 210 else {
224 printf(" -%c", opt); 211 printf(" -%c", opt);
225 charptr = strchr(optstr, opt); 212 charptr = strchr(optstr, opt);
226 if (charptr != NULL && *++charptr == ':') 213 if (charptr != NULL && *++charptr == ':')
227 printf(" %s", normalize(optarg ? optarg : "")); 214 printf(" %s", normalize(optarg ? optarg : ""));
… …
242 * we already sent a message, we just exit with a helpful hint. 229 * we already sent a message, we just exit with a helpful hint.
243 */ 230 */
244static void __attribute__ ((__noreturn__)) parse_error(const char *message) 231static void __attribute__ ((__noreturn__)) parse_error(const char *message)
245{ 232{
246 if (message) 233 if (message)
247 fprintf(stderr, "getopt: %s\n", message); 234 warnx("%s", message);
248 fputs(_("Try `getopt --help' for more information.\n"), stderr); 235 fprintf(stderr, _("Try `%s --help' for more information.\n"),
236 program_invocation_short_name);
249 exit(PARAMETER_EXIT_CODE); 237 exit(PARAMETER_EXIT_CODE);
250} 238}
251 239
252static struct option *long_options = NULL; 240static struct option *long_options = NULL;
253static int long_options_length = 0; /* Length of array */ 241static int long_options_length = 0; /* Length of array */
… …
257 245
258/* Register a long option. The contents of name is copied. */ 246/* Register a long option. The contents of name is copied. */
259static void add_longopt(const char *name, int has_arg) 247static void add_longopt(const char *name, int has_arg)
260{ 248{
261 char *tmp; 249 char *tmp;
250 static int flag;
251
262 if (!name) { 252 if (!name) {
263 /* init */ 253 /* init */
264 free(long_options); 254 free(long_options);
265 long_options = NULL; 255 long_options = NULL;
266 long_options_length = 0; 256 long_options_length = 0;
267 long_options_nr = 0; 257 long_options_nr = 0;
268 } 258 }
269 259
270 if (long_options_nr == long_options_length) { 260 if (long_options_nr == long_options_length) {
271 long_options_length += LONG_OPTIONS_INCR; 261 long_options_length += LONG_OPTIONS_INCR;
272 long_options = our_realloc(long_options, 262 long_options = xrealloc(long_options,
273 sizeof(struct option) * 263 sizeof(struct option) *
274 long_options_length); 264 long_options_length);
275 } 265 }
276 266
277 long_options[long_options_nr].name = NULL; 267 long_options[long_options_nr].name = NULL;
278 long_options[long_options_nr].has_arg = 0; 268 long_options[long_options_nr].has_arg = 0;
279 long_options[long_options_nr].flag = NULL; 269 long_options[long_options_nr].flag = NULL;
280 long_options[long_options_nr].val = 0; 270 long_options[long_options_nr].val = 0;
281 271
282 if (long_options_nr) { 272 if (long_options_nr && name) {
283 /* Not for init! */ 273 /* Not for init! */
284 long_options[long_options_nr - 1].has_arg = has_arg; 274 long_options[long_options_nr - 1].has_arg = has_arg;
285 long_options[long_options_nr - 1].flag = NULL; 275 long_options[long_options_nr - 1].flag = &flag;
286 long_options[long_options_nr - 1].val = LONG_OPT; 276 long_options[long_options_nr - 1].val = long_options_nr;
287 tmp = our_malloc(strlen(name) + 1); 277 tmp = xmalloc(strlen(name) + 1);
288 strcpy(tmp, name); 278 strcpy(tmp, name);
289 long_options[long_options_nr - 1].name = tmp; 279 long_options[long_options_nr - 1].name = tmp;
290 } 280 }
291 long_options_nr++; 281 long_options_nr++;
292} 282}
293 283
294 284
295/* 285/*
296 * Register several long options. options is a string of long options, 286 * Register several long options. options is a string of long options,
297 * separated by commas or whitespace. This nukes options! 287 * separated by commas or whitespace. This nukes options!
298 */ 288 */
299static void add_long_options(char *options) 289static void add_long_options(char *options)
300{ 290{
… …
337 ("unknown shell after -s or --shell argument")); 327 ("unknown shell after -s or --shell argument"));
338} 328}
339 329
340static void __attribute__ ((__noreturn__)) print_help(void) 330static void __attribute__ ((__noreturn__)) print_help(void)
341{ 331{
342 fputs(_("Usage: getopt optstring parameters\n"), stderr); 332 fputs(USAGE_HEADER, stderr);
343 fputs(_(" getopt [options] [--] optstring parameters\n"), stderr); 333 fprintf(stderr, _(
344 fputs(_(" getopt [options] -o|--options optstring [options] [--]\n"), stderr); 334 " %1$s optstring parameters\n"
345 fputs(_(" parameters\n"), stderr); 335 " %1$s [options] [--] optstring parameters\n"
336 " %1$s [options] -o|--options optstring [options] [--] parameters\n"),
337 program_invocation_short_name);
338
339 fputs(USAGE_OPTIONS, stderr);
346 fputs(_(" -a, --alternative Allow long options starting with single -\n"), stderr); 340 fputs(_(" -a, --alternative Allow long options starting with single -\n"), stderr);
347 fputs(_(" -h, --help This small usage guide\n"), stderr);
348 fputs(_(" -l, --longoptions=longopts Long options to be recognized\n"), stderr); 341 fputs(_(" -l, --longoptions <longopts> Long options to be recognized\n"), stderr);
349 fputs(_(" -n, --name=progname The name under which errors are reported\n"), stderr); 342 fputs(_(" -n, --name <progname> The name under which errors are reported\n"), stderr);
350 fputs(_(" -o, --options=optstring Short options to be recognized\n"), stderr); 343 fputs(_(" -o, --options <optstring> Short options to be recognized\n"), stderr);
351 fputs(_(" -q, --quiet Disable error reporting by getopt(3)\n"), stderr); 344 fputs(_(" -q, --quiet Disable error reporting by getopt(3)\n"), stderr);
352 fputs(_(" -Q, --quiet-output No normal output\n"), stderr); 345 fputs(_(" -Q, --quiet-output No normal output\n"), stderr);
353 fputs(_(" -s, --shell=shell Set shell quoting conventions\n"), stderr); 346 fputs(_(" -s, --shell <shell> Set shell quoting conventions\n"), stderr);
354 fputs(_(" -T, --test Test for getopt(1) version\n"), stderr); 347 fputs(_(" -T, --test Test for getopt(1) version\n"), stderr);
355 fputs(_(" -u, --unqote Do not quote the output\n"), stderr); 348 fputs(_(" -u, --unquoted Do not quote the output\n"), stderr);
356 fputs(_(" -V, --version Output version information\n"), stderr); 349 fputs(USAGE_SEPARATOR, stderr);
350 fputs(USAGE_HELP, stderr);
351 fputs(USAGE_VERSION, stderr);
352 fprintf(stderr, USAGE_MAN_TAIL("getopt(1)"));
357 exit(PARAMETER_EXIT_CODE); 353 exit(PARAMETER_EXIT_CODE);
358} 354}
359 355
360int main(int argc, char *argv[]) 356int main(int argc, char *argv[])
361{ 357{
… …
378 {"alternative", no_argument, NULL, 'a'}, 374 {"alternative", no_argument, NULL, 'a'},
379 {"name", required_argument, NULL, 'n'}, 375 {"name", required_argument, NULL, 'n'},
380 {"version", no_argument, NULL, 'V'}, 376 {"version", no_argument, NULL, 'V'},
381 {NULL, 0, NULL, 0} 377 {NULL, 0, NULL, 0}
382 }; 378 };
383#if WITHOUT_GETTEXT 379
384#else
385 setlocale(LC_ALL, ""); 380 setlocale(LC_ALL, "");
386 bindtextdomain(PACKAGE, LOCALEDIR); 381 bindtextdomain(PACKAGE, LOCALEDIR);
387 textdomain(PACKAGE); 382 textdomain(PACKAGE);
388#endif
389 383
390 init_longopt(); 384 init_longopt();
391 getopt_long_fp = getopt_long; 385 getopt_long_fp = getopt_long;
392 386
393 if (getenv("GETOPT_COMPATIBLE")) 387 if (getenv("GETOPT_COMPATIBLE"))
… …
403 return EXIT_SUCCESS; 397 return EXIT_SUCCESS;
404 } else 398 } else
405 parse_error(_("missing optstring argument")); 399 parse_error(_("missing optstring argument"));
406 } 400 }
407 401
408
409 if (argv[1][0] != '-' || compatible) { 402 if (argv[1][0] != '-' || compatible) {
410 quote = 0; 403 quote = 0;
411 optstr = our_malloc(strlen(argv[1]) + 1); 404 optstr = xmalloc(strlen(argv[1]) + 1);
412 strcpy(optstr, argv[1] + strspn(argv[1], "-+")); 405 strcpy(optstr, argv[1] + strspn(argv[1], "-+"));
413 argv[1] = argv[0]; 406 argv[1] = argv[0];
414 return generate_output(argv + 1, argc - 1, optstr, 407 return generate_output(argv + 1, argc - 1, optstr,
415 long_options); 408 long_options);
416 } 409 }
… …
422 getopt_long_fp = getopt_long_only; 415 getopt_long_fp = getopt_long_only;
423 break; 416 break;
424 case 'h': 417 case 'h':
425 print_help(); 418 print_help();
426 case 'o': 419 case 'o':
427 if (optstr)
428 free(optstr); 420 free(optstr);
429 optstr = our_malloc(strlen(optarg)+1); 421 optstr = xmalloc(strlen(optarg) + 1);
430 strcpy(optstr, optarg); 422 strcpy(optstr, optarg);
431 break; 423 break;
432 case 'l': 424 case 'l':
433 add_long_options(optarg); 425 add_long_options(optarg);
434 break; 426 break;
435 case 'n': 427 case 'n':
436 if (name)
437 free(name); 428 free(name);
438 name = our_malloc(strlen(optarg)+1); 429 name = xmalloc(strlen(optarg) + 1);
439 strcpy(name, optarg); 430 strcpy(name, optarg);
440 break; 431 break;
441 case 'q': 432 case 'q':
442 quiet_errors = 1; 433 quiet_errors = 1;
443 break; 434 break;
… …
451 return TEST_EXIT_CODE; 442 return TEST_EXIT_CODE;
452 case 'u': 443 case 'u':
453 quote = 0; 444 quote = 0;
454 break; 445 break;
455 case 'V': 446 case 'V':
456 printf(_("getopt (enhanced) 1.1.4\n")); 447 printf(UTIL_LINUX_VERSION);
457 return EXIT_SUCCESS; 448 return EXIT_SUCCESS;
458 case '?': 449 case '?':
459 case ':': 450 case ':':
460 parse_error(NULL); 451 parse_error(NULL);
461 default: 452 default:
462 parse_error(_("internal error, contact the author.")); 453 parse_error(_("internal error, contact the author."));
463 } 454 }
464 455
465 if (!optstr) { 456 if (!optstr) {
466 if (optind >= argc) 457 if (optind >= argc)
467 parse_error(_("missing optstring argument")); 458 parse_error(_("missing optstring argument"));
468 else { 459 else {
469 optstr=our_malloc(strlen(argv[optind])+1); 460 optstr = xmalloc(strlen(argv[optind]) + 1);
470 strcpy(optstr, argv[optind]); 461 strcpy(optstr, argv[optind]);
471 optind++; 462 optind++;
472 } 463 }
473 } 464 }
474 if (name) 465 if (name)
475 argv[optind - 1] = name; 466 argv[optind - 1] = name;
476 else 467 else
477 argv[optind - 1] = argv[0]; 468 argv[optind - 1] = argv[0];
469
478 return generate_output(argv + optind - 1, argc-optind + 1, 470 return generate_output(argv + optind - 1, argc-optind + 1,
479 optstr, long_options); 471 optstr, long_options);
480} 472}
Legend:
Removed from v.321  
changed lines
  Added in v.377
frodo@frodo.looijaard.name
 ViewVC Help
Powered by ViewVC 1.1.26