/[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 359 Revision 374
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: Mon Nov 7 2005 40 * Version 1.1.5: Sun Aug 12 2012
41 * Sync with util-linux-2.21, fixed build problems, many new translations 41 * Sync with util-linux-2.21, fixed build problems, many new translations
42 * Version 1.1.6: ??? 2014
43 * Sync with util-linux git 20141120, detect ambiguous long options, fix
44 * backslash problem in tcsh
42 */ 45 */
43 46
44/* Exit codes: 47/* Exit codes:
45 * 0) No errors, succesful operation. 48 * 0) No errors, successful operation.
46 * 1) getopt(3) returned an error. 49 * 1) getopt(3) returned an error.
47 * 2) A problem with parameter parsing for getopt(1). 50 * 2) A problem with parameter parsing for getopt(1).
48 * 3) Internal error, out of memory 51 * 3) Internal error, out of memory
49 * 4) Returned for -T 52 * 4) Returned for -T
50 */ 53 */
… …
63#include <getopt.h> 66#include <getopt.h>
64#else 67#else
65#include "getopt.h" 68#include "getopt.h"
66#endif 69#endif
67 70
71#include "util-linux-compat.h"
68#include "nls.h" 72#include "nls.h"
69#include "xalloc.h" 73#include "xalloc.h"
70 74
71/* 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 '+'
72 * mode */ 76 * mode */
73#define NON_OPT 1 77#define NON_OPT 1
74/* 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. */
75#define LONG_OPT 2 79#define LONG_OPT 0
76 80
77/* The shells recognized. */ 81/* The shells recognized. */
78typedef enum { BASH, TCSH } shell_t; 82typedef enum { BASH, TCSH } shell_t;
79 83
80 84
… …
90 94
91/* Function prototypes */ 95/* Function prototypes */
92static const char *normalize(const char *arg); 96static const char *normalize(const char *arg);
93static int generate_output(char *argv[], int argc, const char *optstr, 97static int generate_output(char *argv[], int argc, const char *optstr,
94 const struct option *longopts); 98 const struct option *longopts);
95int main(int argc, char *argv[]);
96static void parse_error(const char *message); 99static void parse_error(const char *message);
97static void add_long_options(char *options); 100static void add_long_options(char *options);
98static void add_longopt(const char *name, int has_arg); 101static void add_longopt(const char *name, int has_arg);
99static void print_help(void); 102static void print_help(void);
100static void set_shell(const char *new_shell); 103static void set_shell(const char *new_shell);
… …
122 strcpy(BUFFER, arg); 125 strcpy(BUFFER, arg);
123 return BUFFER; 126 return BUFFER;
124 } 127 }
125 128
126 /* 129 /*
127 * Each character in arg may take upto four characters in the 130 * Each character in arg may take up to four characters in the
128 * 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
129 * 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
130 * quote, and one extra character for '\0'. 133 * quote, and one extra character for '\0'.
131 */ 134 */
132 BUFFER = xmalloc(strlen(arg) * 4 + 3); 135 BUFFER = xmalloc(strlen(arg) * 4 + 3);
… …
139 /* Quote: replace it with: '\'' */ 142 /* Quote: replace it with: '\'' */
140 *bufptr++ = '\''; 143 *bufptr++ = '\'';
141 *bufptr++ = '\\'; 144 *bufptr++ = '\\';
142 *bufptr++ = '\''; 145 *bufptr++ = '\'';
143 *bufptr++ = '\''; 146 *bufptr++ = '\'';
147 } else if (shell == TCSH && *argptr == '\\') {
148 /* Backslash: replace it with: '\\' */
149 *bufptr++ = '\\';
150 *bufptr++ = '\\';
144 } else if (shell == TCSH && *argptr == '!') { 151 } else if (shell == TCSH && *argptr == '!') {
145 /* Exclamation mark: replace it with: \! */ 152 /* Exclamation mark: replace it with: \! */
146 *bufptr++ = '\''; 153 *bufptr++ = '\'';
147 *bufptr++ = '\\'; 154 *bufptr++ = '\\';
148 *bufptr++ = '!'; 155 *bufptr++ = '!';
… …
165 *bufptr++ = '\''; 172 *bufptr++ = '\'';
166 *bufptr++ = '\0'; 173 *bufptr++ = '\0';
167 return BUFFER; 174 return BUFFER;
168} 175}
169 176
170/* 177/*
171 * 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).
172 * 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
173 * 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),
174 * optstr must contain the short options, and longopts the long options. 181 * optstr must contain the short options, and longopts the long options.
175 * Other settings are found in global variables. 182 * Other settings are found in global variables.
… …
222 * 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.
223 */ 230 */
224static void __attribute__ ((__noreturn__)) parse_error(const char *message) 231static void __attribute__ ((__noreturn__)) parse_error(const char *message)
225{ 232{
226 if (message) 233 if (message)
227 fprintf(stderr, "%s: %s\n", program_invocation_short_name, message); 234 warnx("%s", message);
228 fprintf(stderr, _("Try `%s --help' for more information.\n"), 235 fprintf(stderr, _("Try `%s --help' for more information.\n"),
229 program_invocation_short_name); 236 program_invocation_short_name);
230 exit(PARAMETER_EXIT_CODE); 237 exit(PARAMETER_EXIT_CODE);
231} 238}
232 239
… …
238 245
239/* Register a long option. The contents of name is copied. */ 246/* Register a long option. The contents of name is copied. */
240static void add_longopt(const char *name, int has_arg) 247static void add_longopt(const char *name, int has_arg)
241{ 248{
242 char *tmp; 249 char *tmp;
250 static int flag;
251
243 if (!name) { 252 if (!name) {
244 /* init */ 253 /* init */
245 free(long_options); 254 free(long_options);
246 long_options = NULL; 255 long_options = NULL;
247 long_options_length = 0; 256 long_options_length = 0;
… …
261 long_options[long_options_nr].val = 0; 270 long_options[long_options_nr].val = 0;
262 271
263 if (long_options_nr && name) { 272 if (long_options_nr && name) {
264 /* Not for init! */ 273 /* Not for init! */
265 long_options[long_options_nr - 1].has_arg = has_arg; 274 long_options[long_options_nr - 1].has_arg = has_arg;
266 long_options[long_options_nr - 1].flag = NULL; 275 long_options[long_options_nr - 1].flag = &flag;
267 long_options[long_options_nr - 1].val = LONG_OPT; 276 long_options[long_options_nr - 1].val = long_options_nr;
268 tmp = xmalloc(strlen(name) + 1); 277 tmp = xmalloc(strlen(name) + 1);
269 strcpy(tmp, name); 278 strcpy(tmp, name);
270 long_options[long_options_nr - 1].name = tmp; 279 long_options[long_options_nr - 1].name = tmp;
271 } 280 }
272 long_options_nr++; 281 long_options_nr++;
273} 282}
274 283
275 284
276/* 285/*
277 * Register several long options. options is a string of long options, 286 * Register several long options. options is a string of long options,
278 * separated by commas or whitespace. This nukes options! 287 * separated by commas or whitespace. This nukes options!
279 */ 288 */
280static void add_long_options(char *options) 289static void add_long_options(char *options)
281{ 290{
… …
318 ("unknown shell after -s or --shell argument")); 327 ("unknown shell after -s or --shell argument"));
319} 328}
320 329
321static void __attribute__ ((__noreturn__)) print_help(void) 330static void __attribute__ ((__noreturn__)) print_help(void)
322{ 331{
323 fputs(_("Usage: getopt optstring parameters\n"), stderr); 332 fputs(USAGE_HEADER, stderr);
324 fputs(_(" getopt [options] [--] optstring parameters\n"), stderr); 333 fprintf(stderr, _(
325 fputs(_(" getopt [options] -o|--options optstring [options] [--]\n"), stderr); 334 " %1$s optstring parameters\n"
326 fputs(_(" parameters\n"), stderr); 335 " %1$s [options] [--] optstring parameters\n"
327 fputs(_("\nOptions:\n"), stderr); 336 " %1$s [options] -o|--options optstring [options] [--] parameters\n"),
337 program_invocation_short_name);
338
339 fputs(USAGE_OPTIONS, stderr);
328 fputs(_(" -a, --alternative Allow long options starting with single -\n"), stderr); 340 fputs(_(" -a, --alternative Allow long options starting with single -\n"), stderr);
329 fputs(_(" -h, --help This small usage guide\n"), stderr);
330 fputs(_(" -l, --longoptions <longopts> Long options to be recognized\n"), stderr); 341 fputs(_(" -l, --longoptions <longopts> Long options to be recognized\n"), stderr);
331 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);
332 fputs(_(" -o, --options <optstring> Short options to be recognized\n"), stderr); 343 fputs(_(" -o, --options <optstring> Short options to be recognized\n"), stderr);
333 fputs(_(" -q, --quiet Disable error reporting by getopt(3)\n"), stderr); 344 fputs(_(" -q, --quiet Disable error reporting by getopt(3)\n"), stderr);
334 fputs(_(" -Q, --quiet-output No normal output\n"), stderr); 345 fputs(_(" -Q, --quiet-output No normal output\n"), stderr);
335 fputs(_(" -s, --shell <shell> Set shell quoting conventions\n"), stderr); 346 fputs(_(" -s, --shell <shell> Set shell quoting conventions\n"), stderr);
336 fputs(_(" -T, --test Test for getopt(1) version\n"), stderr); 347 fputs(_(" -T, --test Test for getopt(1) version\n"), stderr);
337 fputs(_(" -u, --unquote Do not quote the output\n"), stderr); 348 fputs(_(" -u, --unquoted Do not quote the output\n"), stderr);
338 fputs(_(" -V, --version Output version information\n"), stderr); 349 fputs(USAGE_SEPARATOR, stderr);
339 fputc('\n', stderr); 350 fputs(USAGE_HELP, stderr);
340 351 fputs(USAGE_VERSION, stderr);
352 fprintf(stderr, USAGE_MAN_TAIL("getopt(1)"));
341 exit(PARAMETER_EXIT_CODE); 353 exit(PARAMETER_EXIT_CODE);
342} 354}
343 355
344int main(int argc, char *argv[]) 356int main(int argc, char *argv[])
345{ 357{
… …
362 {"alternative", no_argument, NULL, 'a'}, 374 {"alternative", no_argument, NULL, 'a'},
363 {"name", required_argument, NULL, 'n'}, 375 {"name", required_argument, NULL, 'n'},
364 {"version", no_argument, NULL, 'V'}, 376 {"version", no_argument, NULL, 'V'},
365 {NULL, 0, NULL, 0} 377 {NULL, 0, NULL, 0}
366 }; 378 };
379
367 setlocale(LC_ALL, ""); 380 setlocale(LC_ALL, "");
368 bindtextdomain(PACKAGE, LOCALEDIR); 381 bindtextdomain(PACKAGE, LOCALEDIR);
369 textdomain(PACKAGE); 382 textdomain(PACKAGE);
370 383
371 init_longopt(); 384 init_longopt();
… …
384 return EXIT_SUCCESS; 397 return EXIT_SUCCESS;
385 } else 398 } else
386 parse_error(_("missing optstring argument")); 399 parse_error(_("missing optstring argument"));
387 } 400 }
388 401
389
390 if (argv[1][0] != '-' || compatible) { 402 if (argv[1][0] != '-' || compatible) {
391 quote = 0; 403 quote = 0;
392 optstr = xmalloc(strlen(argv[1]) + 1); 404 optstr = xmalloc(strlen(argv[1]) + 1);
393 strcpy(optstr, argv[1] + strspn(argv[1], "-+")); 405 strcpy(optstr, argv[1] + strspn(argv[1], "-+"));
394 argv[1] = argv[0]; 406 argv[1] = argv[0];
… …
430 return TEST_EXIT_CODE; 442 return TEST_EXIT_CODE;
431 case 'u': 443 case 'u':
432 quote = 0; 444 quote = 0;
433 break; 445 break;
434 case 'V': 446 case 'V':
435 printf(_("%s (enhanced) %s\n"), program_invocation_short_name, program_version); 447 printf(UTIL_LINUX_VERSION);
436 return EXIT_SUCCESS; 448 return EXIT_SUCCESS;
437 case '?': 449 case '?':
438 case ':': 450 case ':':
439 parse_error(NULL); 451 parse_error(NULL);
440 default: 452 default:
441 parse_error(_("internal error, contact the author.")); 453 parse_error(_("internal error, contact the author."));
442 } 454 }
443 455
444 if (!optstr) { 456 if (!optstr) {
445 if (optind >= argc) 457 if (optind >= argc)
446 parse_error(_("missing optstring argument")); 458 parse_error(_("missing optstring argument"));
447 else { 459 else {
448 optstr = xmalloc(strlen(argv[optind]) + 1); 460 optstr = xmalloc(strlen(argv[optind]) + 1);
… …
452 } 464 }
453 if (name) 465 if (name)
454 argv[optind - 1] = name; 466 argv[optind - 1] = name;
455 else 467 else
456 argv[optind - 1] = argv[0]; 468 argv[optind - 1] = argv[0];
469
457 return generate_output(argv + optind - 1, argc-optind + 1, 470 return generate_output(argv + optind - 1, argc-optind + 1,
458 optstr, long_options); 471 optstr, long_options);
459} 472}
Legend:
Removed from v.359  
changed lines
  Added in v.374
frodo@frodo.looijaard.name
 ViewVC Help
Powered by ViewVC 1.1.26