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ś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 |
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 | */ |
42 | */ |
43 | |
43 | |
44 | /* Exit codes: |
44 | /* Exit codes: |
45 | * 0) No errors, succesful operation. |
45 | * 0) No errors, successful operation. |
46 | * 1) getopt(3) returned an error. |
46 | * 1) getopt(3) returned an error. |
47 | * 2) A problem with parameter parsing for getopt(1). |
47 | * 2) A problem with parameter parsing for getopt(1). |
48 | * 3) Internal error, out of memory |
48 | * 3) Internal error, out of memory |
49 | * 4) Returned for -T |
49 | * 4) Returned for -T |
50 | */ |
50 | */ |
… | |
… | |
63 | #include <getopt.h> |
63 | #include <getopt.h> |
64 | #else |
64 | #else |
65 | #include "getopt.h" |
65 | #include "getopt.h" |
66 | #endif |
66 | #endif |
67 | |
67 | |
|
|
68 | #include "util-linux-compat.h" |
68 | #include "nls.h" |
69 | #include "nls.h" |
69 | #include "xalloc.h" |
70 | #include "xalloc.h" |
70 | |
71 | |
71 | /* 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 '+' |
72 | * mode */ |
73 | * mode */ |
73 | #define NON_OPT 1 |
74 | #define NON_OPT 1 |
74 | /* 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. */ |
75 | #define LONG_OPT 2 |
76 | #define LONG_OPT 2 |
76 | |
77 | |
… | |
… | |
90 | |
91 | |
91 | /* Function prototypes */ |
92 | /* Function prototypes */ |
92 | static const char *normalize(const char *arg); |
93 | static const char *normalize(const char *arg); |
93 | static int generate_output(char *argv[], int argc, const char *optstr, |
94 | static int generate_output(char *argv[], int argc, const char *optstr, |
94 | const struct option *longopts); |
95 | const struct option *longopts); |
95 | int main(int argc, char *argv[]); |
|
|
96 | static void parse_error(const char *message); |
96 | static void parse_error(const char *message); |
97 | static void add_long_options(char *options); |
97 | static void add_long_options(char *options); |
98 | static void add_longopt(const char *name, int has_arg); |
98 | static void add_longopt(const char *name, int has_arg); |
99 | static void print_help(void); |
99 | static void print_help(void); |
100 | static void set_shell(const char *new_shell); |
100 | static void set_shell(const char *new_shell); |
… | |
… | |
122 | strcpy(BUFFER, arg); |
122 | strcpy(BUFFER, arg); |
123 | return BUFFER; |
123 | return BUFFER; |
124 | } |
124 | } |
125 | |
125 | |
126 | /* |
126 | /* |
127 | * Each character in arg may take upto four characters in the |
127 | * 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 |
128 | * 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 |
129 | * and an opening quote! We need also the global opening and closing |
130 | * quote, and one extra character for '\0'. |
130 | * quote, and one extra character for '\0'. |
131 | */ |
131 | */ |
132 | BUFFER = xmalloc(strlen(arg) * 4 + 3); |
132 | BUFFER = xmalloc(strlen(arg) * 4 + 3); |
… | |
… | |
165 | *bufptr++ = '\''; |
165 | *bufptr++ = '\''; |
166 | *bufptr++ = '\0'; |
166 | *bufptr++ = '\0'; |
167 | return BUFFER; |
167 | return BUFFER; |
168 | } |
168 | } |
169 | |
169 | |
170 | /* |
170 | /* |
171 | * Generate the output. argv[0] is the program name (used for reporting errors). |
171 | * 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 |
172 | * 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), |
173 | * 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. |
174 | * optstr must contain the short options, and longopts the long options. |
175 | * Other settings are found in global variables. |
175 | * Other settings are found in global variables. |
… | |
… | |
222 | * we already sent a message, we just exit with a helpful hint. |
222 | * we already sent a message, we just exit with a helpful hint. |
223 | */ |
223 | */ |
224 | static void __attribute__ ((__noreturn__)) parse_error(const char *message) |
224 | static void __attribute__ ((__noreturn__)) parse_error(const char *message) |
225 | { |
225 | { |
226 | if (message) |
226 | if (message) |
227 | fprintf(stderr, "%s: %s\n", program_invocation_short_name, message); |
227 | warnx("%s", message); |
228 | fprintf(stderr, _("Try `%s --help' for more information.\n"), |
228 | fprintf(stderr, _("Try `%s --help' for more information.\n"), |
229 | program_invocation_short_name); |
229 | program_invocation_short_name); |
230 | exit(PARAMETER_EXIT_CODE); |
230 | exit(PARAMETER_EXIT_CODE); |
231 | } |
231 | } |
232 | |
232 | |
… | |
… | |
271 | } |
271 | } |
272 | long_options_nr++; |
272 | long_options_nr++; |
273 | } |
273 | } |
274 | |
274 | |
275 | |
275 | |
276 | /* |
276 | /* |
277 | * Register several long options. options is a string of long options, |
277 | * Register several long options. options is a string of long options, |
278 | * separated by commas or whitespace. This nukes options! |
278 | * separated by commas or whitespace. This nukes options! |
279 | */ |
279 | */ |
280 | static void add_long_options(char *options) |
280 | static void add_long_options(char *options) |
281 | { |
281 | { |
… | |
… | |
318 | ("unknown shell after -s or --shell argument")); |
318 | ("unknown shell after -s or --shell argument")); |
319 | } |
319 | } |
320 | |
320 | |
321 | static void __attribute__ ((__noreturn__)) print_help(void) |
321 | static void __attribute__ ((__noreturn__)) print_help(void) |
322 | { |
322 | { |
323 | fputs(_("Usage: getopt optstring parameters\n"), stderr); |
323 | fputs(USAGE_HEADER, stderr); |
324 | fputs(_(" getopt [options] [--] optstring parameters\n"), stderr); |
324 | fprintf(stderr, _( |
325 | fputs(_(" getopt [options] -o|--options optstring [options] [--]\n"), stderr); |
325 | " %1$s optstring parameters\n" |
326 | fputs(_(" parameters\n"), stderr); |
326 | " %1$s [options] [--] optstring parameters\n" |
327 | fputs(_("\nOptions:\n"), stderr); |
327 | " %1$s [options] -o|--options optstring [options] [--] parameters\n"), |
|
|
328 | program_invocation_short_name); |
|
|
329 | |
|
|
330 | fputs(USAGE_OPTIONS, stderr); |
328 | fputs(_(" -a, --alternative Allow long options starting with single -\n"), stderr); |
331 | 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); |
332 | 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); |
333 | 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); |
334 | fputs(_(" -o, --options <optstring> Short options to be recognized\n"), stderr); |
333 | fputs(_(" -q, --quiet Disable error reporting by getopt(3)\n"), stderr); |
335 | fputs(_(" -q, --quiet Disable error reporting by getopt(3)\n"), stderr); |
334 | fputs(_(" -Q, --quiet-output No normal output\n"), stderr); |
336 | fputs(_(" -Q, --quiet-output No normal output\n"), stderr); |
335 | fputs(_(" -s, --shell <shell> Set shell quoting conventions\n"), stderr); |
337 | fputs(_(" -s, --shell <shell> Set shell quoting conventions\n"), stderr); |
336 | fputs(_(" -T, --test Test for getopt(1) version\n"), stderr); |
338 | fputs(_(" -T, --test Test for getopt(1) version\n"), stderr); |
337 | fputs(_(" -u, --unquoted Do not quote the output\n"), stderr); |
339 | fputs(_(" -u, --unquoted Do not quote the output\n"), stderr); |
338 | fputs(_(" -V, --version Output version information\n"), stderr); |
340 | fputs(USAGE_SEPARATOR, stderr); |
339 | fputc('\n', stderr); |
341 | fputs(USAGE_HELP, stderr); |
340 | |
342 | fputs(USAGE_VERSION, stderr); |
|
|
343 | fprintf(stderr, USAGE_MAN_TAIL("getopt(1)")); |
341 | exit(PARAMETER_EXIT_CODE); |
344 | exit(PARAMETER_EXIT_CODE); |
342 | } |
345 | } |
343 | |
346 | |
344 | int main(int argc, char *argv[]) |
347 | int main(int argc, char *argv[]) |
345 | { |
348 | { |
… | |
… | |
362 | {"alternative", no_argument, NULL, 'a'}, |
365 | {"alternative", no_argument, NULL, 'a'}, |
363 | {"name", required_argument, NULL, 'n'}, |
366 | {"name", required_argument, NULL, 'n'}, |
364 | {"version", no_argument, NULL, 'V'}, |
367 | {"version", no_argument, NULL, 'V'}, |
365 | {NULL, 0, NULL, 0} |
368 | {NULL, 0, NULL, 0} |
366 | }; |
369 | }; |
|
|
370 | |
367 | setlocale(LC_ALL, ""); |
371 | setlocale(LC_ALL, ""); |
368 | bindtextdomain(PACKAGE, LOCALEDIR); |
372 | bindtextdomain(PACKAGE, LOCALEDIR); |
369 | textdomain(PACKAGE); |
373 | textdomain(PACKAGE); |
370 | |
374 | |
371 | init_longopt(); |
375 | init_longopt(); |
… | |
… | |
384 | return EXIT_SUCCESS; |
388 | return EXIT_SUCCESS; |
385 | } else |
389 | } else |
386 | parse_error(_("missing optstring argument")); |
390 | parse_error(_("missing optstring argument")); |
387 | } |
391 | } |
388 | |
392 | |
389 | |
|
|
390 | if (argv[1][0] != '-' || compatible) { |
393 | if (argv[1][0] != '-' || compatible) { |
391 | quote = 0; |
394 | quote = 0; |
392 | optstr = xmalloc(strlen(argv[1]) + 1); |
395 | optstr = xmalloc(strlen(argv[1]) + 1); |
393 | strcpy(optstr, argv[1] + strspn(argv[1], "-+")); |
396 | strcpy(optstr, argv[1] + strspn(argv[1], "-+")); |
394 | argv[1] = argv[0]; |
397 | argv[1] = argv[0]; |
… | |
… | |
430 | return TEST_EXIT_CODE; |
433 | return TEST_EXIT_CODE; |
431 | case 'u': |
434 | case 'u': |
432 | quote = 0; |
435 | quote = 0; |
433 | break; |
436 | break; |
434 | case 'V': |
437 | case 'V': |
435 | printf(_("%s (enhanced) %s\n"), program_invocation_short_name, program_version); |
438 | printf(UTIL_LINUX_VERSION); |
436 | return EXIT_SUCCESS; |
439 | return EXIT_SUCCESS; |
437 | case '?': |
440 | case '?': |
438 | case ':': |
441 | case ':': |
439 | parse_error(NULL); |
442 | parse_error(NULL); |
440 | default: |
443 | default: |
441 | parse_error(_("internal error, contact the author.")); |
444 | parse_error(_("internal error, contact the author.")); |
442 | } |
445 | } |
443 | |
446 | |
444 | if (!optstr) { |
447 | if (!optstr) { |
445 | if (optind >= argc) |
448 | if (optind >= argc) |
446 | parse_error(_("missing optstring argument")); |
449 | parse_error(_("missing optstring argument")); |
447 | else { |
450 | else { |
448 | optstr = xmalloc(strlen(argv[optind]) + 1); |
451 | optstr = xmalloc(strlen(argv[optind]) + 1); |
… | |
… | |
452 | } |
455 | } |
453 | if (name) |
456 | if (name) |
454 | argv[optind - 1] = name; |
457 | argv[optind - 1] = name; |
455 | else |
458 | else |
456 | argv[optind - 1] = argv[0]; |
459 | argv[optind - 1] = argv[0]; |
|
|
460 | |
457 | return generate_output(argv + optind - 1, argc-optind + 1, |
461 | return generate_output(argv + optind - 1, argc-optind + 1, |
458 | optstr, long_options); |
462 | optstr, long_options); |
459 | } |
463 | } |