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

Annotation of /getopt/trunk/getopt.c

Parent Directory Parent Directory | Revision Log Revision Log


Revision 377 - (hide annotations)
Mon Nov 24 12:36:11 2014 UTC (5 years ago) by frodo
File MIME type: text/plain
File size: 13577 byte(s)
(Frodo) Update TODO list, bump version number to 1.1.6

1 frodo 259 /*
2 frodo 317 * getopt.c - Enhanced implementation of BSD getopt(1)
3 frodo 367 * Copyright (c) 1997-2014 Frodo Looijaard <frodo@frodo.looijaard.name>
4 frodo 317 *
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
7     * the Free Software Foundation; either version 2 of the License, or
8     * (at your option) any later version.
9     *
10     * This program is distributed in the hope that it will be useful,
11     * but WITHOUT ANY WARRANTY; without even the implied warranty of
12     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13     * GNU General Public License for more details.
14     *
15 frodo 364 * You should have received a copy of the GNU General Public License along
16     * with this program; if not, write to the Free Software Foundation, Inc.,
17     * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 frodo 317 */
19 frodo 259
20 frodo 364 /*
21 frodo 259 * Version 1.0-b4: Tue Sep 23 1997. First public release.
22 frodo 364 * Version 1.0: Wed Nov 19 1997.
23 frodo 259 * Bumped up the version number to 1.0
24     * Fixed minor typo (CSH instead of TCSH)
25     * Version 1.0.1: Tue Jun 3 1998
26     * Fixed sizeof instead of strlen bug
27     * Bumped up the version number to 1.0.1
28     * Version 1.0.2: Thu Jun 11 1998 (not present)
29     * Fixed gcc-2.8.1 warnings
30     * Fixed --version/-V option (not present)
31     * Version 1.0.5: Tue Jun 22 1999
32     * Make -u option work (not present)
33     * Version 1.0.6: Tue Jun 27 2000
34     * No important changes
35     * Version 1.1.0: Tue Jun 30 2000
36 frodo 364 * Added NLS support (partly written by Arkadiusz Miƛkiewicz
37 frodo 259 * <misiek@pld.org.pl>)
38 frodo 263 * Version 1.1.4: Mon Nov 7 2005
39     * Fixed a few type's in the manpage
40 frodo 361 * Version 1.1.5: Sun Aug 12 2012
41 frodo 327 * Sync with util-linux-2.21, fixed build problems, many new translations
42 frodo 377 * Version 1.1.6: Mon Nov 24 2014
43 frodo 374 * Sync with util-linux git 20141120, detect ambiguous long options, fix
44     * backslash problem in tcsh
45 frodo 259 */
46    
47 frodo 318 /* Exit codes:
48 frodo 364 * 0) No errors, successful operation.
49 frodo 318 * 1) getopt(3) returned an error.
50     * 2) A problem with parameter parsing for getopt(1).
51     * 3) Internal error, out of memory
52     * 4) Returned for -T
53     */
54     #define GETOPT_EXIT_CODE 1
55     #define PARAMETER_EXIT_CODE 2
56     #define XALLOC_EXIT_CODE 3
57     #define TEST_EXIT_CODE 4
58    
59 frodo 259 #include <stdio.h>
60     #include <stdlib.h>
61     #include <string.h>
62     #include <unistd.h>
63     #include <ctype.h>
64    
65     #if LIBCGETOPT
66     #include <getopt.h>
67     #else
68     #include "getopt.h"
69     #endif
70    
71 frodo 363 #include "util-linux-compat.h"
72 frodo 259 #include "nls.h"
73 frodo 322 #include "xalloc.h"
74 frodo 259
75 frodo 364 /* NON_OPT is the code that is returned when a non-option is found in '+'
76 frodo 317 * mode */
77 frodo 259 #define NON_OPT 1
78     /* LONG_OPT is the code that is returned when a long option is found. */
79 frodo 370 #define LONG_OPT 0
80 frodo 259
81     /* The shells recognized. */
82 frodo 320 typedef enum { BASH, TCSH } shell_t;
83 frodo 259
84    
85     /* Some global variables that tells us how to parse. */
86 frodo 321 static shell_t shell = BASH; /* The shell we generate output for. */
87     static int quiet_errors = 0; /* 0 is not quiet. */
88     static int quiet_output = 0; /* 0 is not quiet. */
89     static int quote = 1; /* 1 is do quote. */
90 frodo 259
91 frodo 322 /* Allow changing which getopt is in use with function pointer */
92 frodo 319 int (*getopt_long_fp) (int argc, char *const *argv, const char *optstr,
93 frodo 320 const struct option * longopts, int *longindex);
94 frodo 319
95 frodo 259 /* Function prototypes */
96 frodo 321 static const char *normalize(const char *arg);
97     static int generate_output(char *argv[], int argc, const char *optstr,
98     const struct option *longopts);
99     static void parse_error(const char *message);
100     static void add_long_options(char *options);
101     static void add_longopt(const char *name, int has_arg);
102     static void print_help(void);
103     static void set_shell(const char *new_shell);
104 frodo 259
105     /*
106 frodo 317 * This function 'normalizes' a single argument: it puts single quotes
107     * around it and escapes other special characters. If quote is false, it
108     * just returns its argument.
109     *
110 frodo 259 * Bash only needs special treatment for single quotes; tcsh also recognizes
111 frodo 317 * exclamation marks within single quotes, and nukes whitespace. This
112     * function returns a pointer to a buffer that is overwritten by each call.
113 frodo 259 */
114 frodo 321 static const char *normalize(const char *arg)
115 frodo 259 {
116 frodo 320 static char *BUFFER = NULL;
117     const char *argptr = arg;
118 frodo 259 char *bufptr;
119    
120 frodo 322 free(BUFFER);
121 frodo 259
122 frodo 320 if (!quote) {
123 frodo 317 /* Just copy arg */
124 frodo 322 BUFFER = xmalloc(strlen(arg) + 1);
125 frodo 320 strcpy(BUFFER, arg);
126 frodo 259 return BUFFER;
127     }
128    
129 frodo 317 /*
130 frodo 364 * Each character in arg may take up to four characters in the
131 frodo 317 * result: For a quote we need a closing quote, a backslash, a quote
132     * and an opening quote! We need also the global opening and closing
133     * quote, and one extra character for '\0'.
134     */
135 frodo 322 BUFFER = xmalloc(strlen(arg) * 4 + 3);
136 frodo 259
137 frodo 320 bufptr = BUFFER;
138     *bufptr++ = '\'';
139 frodo 259
140     while (*argptr) {
141     if (*argptr == '\'') {
142     /* Quote: replace it with: '\'' */
143 frodo 320 *bufptr++ = '\'';
144     *bufptr++ = '\\';
145     *bufptr++ = '\'';
146     *bufptr++ = '\'';
147 frodo 374 } else if (shell == TCSH && *argptr == '\\') {
148     /* Backslash: replace it with: '\\' */
149     *bufptr++ = '\\';
150     *bufptr++ = '\\';
151 frodo 320 } else if (shell == TCSH && *argptr == '!') {
152 frodo 259 /* Exclamation mark: replace it with: \! */
153 frodo 320 *bufptr++ = '\'';
154     *bufptr++ = '\\';
155     *bufptr++ = '!';
156     *bufptr++ = '\'';
157     } else if (shell == TCSH && *argptr == '\n') {
158 frodo 259 /* Newline: replace it with: \n */
159 frodo 320 *bufptr++ = '\\';
160     *bufptr++ = 'n';
161     } else if (shell == TCSH && isspace(*argptr)) {
162 frodo 259 /* Non-newline whitespace: replace it with \<ws> */
163 frodo 320 *bufptr++ = '\'';
164     *bufptr++ = '\\';
165     *bufptr++ = *argptr;
166     *bufptr++ = '\'';
167 frodo 259 } else
168     /* Just copy */
169 frodo 320 *bufptr++ = *argptr;
170 frodo 259 argptr++;
171     }
172 frodo 320 *bufptr++ = '\'';
173     *bufptr++ = '\0';
174 frodo 259 return BUFFER;
175     }
176    
177 frodo 364 /*
178 frodo 259 * Generate the output. argv[0] is the program name (used for reporting errors).
179     * argv[1..] contains the options to be parsed. argc must be the number of
180     * elements in argv (ie. 1 if there are no options, only the program name),
181     * optstr must contain the short options, and longopts the long options.
182     * Other settings are found in global variables.
183     */
184 frodo 321 static int generate_output(char *argv[], int argc, const char *optstr,
185     const struct option *longopts)
186 frodo 259 {
187 frodo 318 int exit_code = EXIT_SUCCESS; /* Assume everything will be OK */
188 frodo 259 int opt;
189     int longindex;
190     const char *charptr;
191    
192 frodo 320 if (quiet_errors)
193 frodo 317 /* No error reporting from getopt(3) */
194 frodo 320 opterr = 0;
195 frodo 317 /* Reset getopt(3) */
196 frodo 320 optind = 0;
197 frodo 259
198 frodo 320 while ((opt =
199 frodo 319 (getopt_long_fp(argc, argv, optstr, longopts, &longindex)))
200 frodo 320 != EOF)
201     if (opt == '?' || opt == ':')
202 frodo 318 exit_code = GETOPT_EXIT_CODE;
203 frodo 320 else if (!quiet_output) {
204 frodo 259 if (opt == LONG_OPT) {
205 frodo 320 printf(" --%s", longopts[longindex].name);
206     if (longopts[longindex].has_arg)
207     printf(" %s", normalize(optarg ? optarg : ""));
208     } else if (opt == NON_OPT)
209 frodo 359 printf(" %s", normalize(optarg ? optarg : ""));
210 frodo 259 else {
211 frodo 320 printf(" -%c", opt);
212     charptr = strchr(optstr, opt);
213 frodo 259 if (charptr != NULL && *++charptr == ':')
214 frodo 320 printf(" %s", normalize(optarg ? optarg : ""));
215 frodo 259 }
216     }
217 frodo 320
218     if (!quiet_output) {
219 frodo 259 printf(" --");
220 frodo 320 while (optind < argc)
221     printf(" %s", normalize(argv[optind++]));
222 frodo 259 printf("\n");
223     }
224     return exit_code;
225     }
226    
227     /*
228 frodo 317 * Report an error when parsing getopt's own arguments. If message is NULL,
229     * we already sent a message, we just exit with a helpful hint.
230 frodo 259 */
231 frodo 321 static void __attribute__ ((__noreturn__)) parse_error(const char *message)
232 frodo 259 {
233     if (message)
234 frodo 364 warnx("%s", message);
235 frodo 323 fprintf(stderr, _("Try `%s --help' for more information.\n"),
236     program_invocation_short_name);
237 frodo 318 exit(PARAMETER_EXIT_CODE);
238 frodo 259 }
239    
240 frodo 320 static struct option *long_options = NULL;
241     static int long_options_length = 0; /* Length of array */
242     static int long_options_nr = 0; /* Nr of used elements in array */
243 frodo 259 #define LONG_OPTIONS_INCR 10
244     #define init_longopt() add_longopt(NULL,0)
245    
246     /* Register a long option. The contents of name is copied. */
247 frodo 321 static void add_longopt(const char *name, int has_arg)
248 frodo 259 {
249     char *tmp;
250 frodo 370 static int flag;
251    
252 frodo 320 if (!name) {
253 frodo 317 /* init */
254 frodo 259 free(long_options);
255 frodo 320 long_options = NULL;
256     long_options_length = 0;
257     long_options_nr = 0;
258 frodo 259 }
259    
260     if (long_options_nr == long_options_length) {
261     long_options_length += LONG_OPTIONS_INCR;
262 frodo 322 long_options = xrealloc(long_options,
263     sizeof(struct option) *
264     long_options_length);
265 frodo 259 }
266    
267 frodo 320 long_options[long_options_nr].name = NULL;
268     long_options[long_options_nr].has_arg = 0;
269     long_options[long_options_nr].flag = NULL;
270     long_options[long_options_nr].val = 0;
271 frodo 259
272 frodo 359 if (long_options_nr && name) {
273 frodo 317 /* Not for init! */
274 frodo 320 long_options[long_options_nr - 1].has_arg = has_arg;
275 frodo 370 long_options[long_options_nr - 1].flag = &flag;
276     long_options[long_options_nr - 1].val = long_options_nr;
277 frodo 322 tmp = xmalloc(strlen(name) + 1);
278 frodo 320 strcpy(tmp, name);
279     long_options[long_options_nr - 1].name = tmp;
280 frodo 259 }
281     long_options_nr++;
282     }
283    
284 frodo 320
285 frodo 364 /*
286 frodo 317 * Register several long options. options is a string of long options,
287     * separated by commas or whitespace. This nukes options!
288 frodo 259 */
289 frodo 321 static void add_long_options(char *options)
290 frodo 259 {
291     int arg_opt;
292 frodo 320 char *tokptr = strtok(options, ", \t\n");
293 frodo 259 while (tokptr) {
294 frodo 320 arg_opt = no_argument;
295 frodo 259 if (strlen(tokptr) > 0) {
296 frodo 320 if (tokptr[strlen(tokptr) - 1] == ':') {
297     if (tokptr[strlen(tokptr) - 2] == ':') {
298     tokptr[strlen(tokptr) - 2] = '\0';
299     arg_opt = optional_argument;
300 frodo 259 } else {
301 frodo 320 tokptr[strlen(tokptr) - 1] = '\0';
302     arg_opt = required_argument;
303 frodo 259 }
304     if (strlen(tokptr) == 0)
305 frodo 320 parse_error(_
306     ("empty long option after "
307     "-l or --long argument"));
308 frodo 259 }
309 frodo 320 add_longopt(tokptr, arg_opt);
310 frodo 259 }
311 frodo 320 tokptr = strtok(NULL, ", \t\n");
312 frodo 259 }
313     }
314    
315 frodo 321 static void set_shell(const char *new_shell)
316 frodo 259 {
317 frodo 320 if (!strcmp(new_shell, "bash"))
318     shell = BASH;
319     else if (!strcmp(new_shell, "tcsh"))
320     shell = TCSH;
321     else if (!strcmp(new_shell, "sh"))
322     shell = BASH;
323     else if (!strcmp(new_shell, "csh"))
324     shell = TCSH;
325 frodo 259 else
326 frodo 320 parse_error(_
327     ("unknown shell after -s or --shell argument"));
328 frodo 259 }
329    
330 frodo 321 static void __attribute__ ((__noreturn__)) print_help(void)
331 frodo 259 {
332 frodo 363 fputs(USAGE_HEADER, stderr);
333     fprintf(stderr, _(
334     " %1$s optstring parameters\n"
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);
340 frodo 320 fputs(_(" -a, --alternative Allow long options starting with single -\n"), stderr);
341 frodo 323 fputs(_(" -l, --longoptions <longopts> Long options to be recognized\n"), stderr);
342     fputs(_(" -n, --name <progname> The name under which errors are reported\n"), stderr);
343     fputs(_(" -o, --options <optstring> Short options to be recognized\n"), stderr);
344 frodo 320 fputs(_(" -q, --quiet Disable error reporting by getopt(3)\n"), stderr);
345     fputs(_(" -Q, --quiet-output No normal output\n"), stderr);
346 frodo 323 fputs(_(" -s, --shell <shell> Set shell quoting conventions\n"), stderr);
347 frodo 320 fputs(_(" -T, --test Test for getopt(1) version\n"), stderr);
348 frodo 362 fputs(_(" -u, --unquoted Do not quote the output\n"), stderr);
349 frodo 363 fputs(USAGE_SEPARATOR, stderr);
350     fputs(USAGE_HELP, stderr);
351     fputs(USAGE_VERSION, stderr);
352     fprintf(stderr, USAGE_MAN_TAIL("getopt(1)"));
353 frodo 318 exit(PARAMETER_EXIT_CODE);
354 frodo 259 }
355    
356 frodo 321 int main(int argc, char *argv[])
357     {
358     char *optstr = NULL;
359     char *name = NULL;
360     int opt;
361     int compatible = 0;
362    
363     /* Stop scanning as soon as a non-option argument is found! */
364     static const char *shortopts = "+ao:l:n:qQs:TuhV";
365     static const struct option longopts[] = {
366 frodo 320 {"options", required_argument, NULL, 'o'},
367     {"longoptions", required_argument, NULL, 'l'},
368     {"quiet", no_argument, NULL, 'q'},
369     {"quiet-output", no_argument, NULL, 'Q'},
370     {"shell", required_argument, NULL, 's'},
371     {"test", no_argument, NULL, 'T'},
372     {"unquoted", no_argument, NULL, 'u'},
373     {"help", no_argument, NULL, 'h'},
374     {"alternative", no_argument, NULL, 'a'},
375     {"name", required_argument, NULL, 'n'},
376     {"version", no_argument, NULL, 'V'},
377     {NULL, 0, NULL, 0}
378     };
379 frodo 364
380 frodo 320 setlocale(LC_ALL, "");
381 frodo 259 bindtextdomain(PACKAGE, LOCALEDIR);
382     textdomain(PACKAGE);
383    
384     init_longopt();
385 frodo 319 getopt_long_fp = getopt_long;
386 frodo 259
387 frodo 320 if (getenv("GETOPT_COMPATIBLE"))
388     compatible = 1;
389 frodo 259
390 frodo 320 if (argc == 1) {
391 frodo 259 if (compatible) {
392 frodo 320 /*
393     * For some reason, the original getopt gave no
394     * error when there were no arguments.
395 frodo 317 */
396 frodo 259 printf(" --\n");
397 frodo 318 return EXIT_SUCCESS;
398 frodo 320 } else
399 frodo 259 parse_error(_("missing optstring argument"));
400 frodo 319 }
401 frodo 320
402 frodo 259 if (argv[1][0] != '-' || compatible) {
403 frodo 320 quote = 0;
404 frodo 322 optstr = xmalloc(strlen(argv[1]) + 1);
405 frodo 320 strcpy(optstr, argv[1] + strspn(argv[1], "-+"));
406     argv[1] = argv[0];
407     return generate_output(argv + 1, argc - 1, optstr,
408     long_options);
409 frodo 259 }
410 frodo 320
411     while ((opt =
412     getopt_long(argc, argv, shortopts, longopts, NULL)) != EOF)
413 frodo 259 switch (opt) {
414     case 'a':
415 frodo 319 getopt_long_fp = getopt_long_only;
416 frodo 259 break;
417     case 'h':
418     print_help();
419     case 'o':
420 frodo 322 free(optstr);
421     optstr = xmalloc(strlen(optarg) + 1);
422 frodo 320 strcpy(optstr, optarg);
423 frodo 259 break;
424     case 'l':
425     add_long_options(optarg);
426     break;
427     case 'n':
428 frodo 322 free(name);
429     name = xmalloc(strlen(optarg) + 1);
430 frodo 320 strcpy(name, optarg);
431 frodo 259 break;
432     case 'q':
433 frodo 320 quiet_errors = 1;
434 frodo 259 break;
435     case 'Q':
436 frodo 320 quiet_output = 1;
437 frodo 259 break;
438     case 's':
439     set_shell(optarg);
440     break;
441     case 'T':
442 frodo 318 return TEST_EXIT_CODE;
443 frodo 259 case 'u':
444 frodo 320 quote = 0;
445 frodo 259 break;
446     case 'V':
447 frodo 363 printf(UTIL_LINUX_VERSION);
448 frodo 318 return EXIT_SUCCESS;
449 frodo 259 case '?':
450     case ':':
451     parse_error(NULL);
452     default:
453     parse_error(_("internal error, contact the author."));
454     }
455 frodo 364
456 frodo 320 if (!optstr) {
457 frodo 259 if (optind >= argc)
458     parse_error(_("missing optstring argument"));
459     else {
460 frodo 322 optstr = xmalloc(strlen(argv[optind]) + 1);
461 frodo 320 strcpy(optstr, argv[optind]);
462 frodo 259 optind++;
463     }
464     }
465     if (name)
466 frodo 320 argv[optind - 1] = name;
467 frodo 259 else
468 frodo 320 argv[optind - 1] = argv[0];
469 frodo 364
470 frodo 320 return generate_output(argv + optind - 1, argc-optind + 1,
471     optstr, long_options);
472 frodo 259 }

frodo@frodo.looijaard.name
ViewVC Help
Powered by ViewVC 1.1.26