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

Contents of /getopt/trunk/getopt.c

Parent Directory Parent Directory | Revision Log Revision Log


Revision 362 - (show annotations)
Thu Nov 20 11:27:07 2014 UTC (5 years ago) by frodo
File MIME type: text/plain
File size: 13441 byte(s)
(Frodo) Fix typo in help output

Sync with util-linux: git commit 3706db7c085fccdcaa26e6fddcaeb47e6e5c1c6c

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

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