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

Contents of /getopt/trunk/getopt.c

Parent Directory Parent Directory | Revision Log Revision Log


Revision 320 - (show annotations)
Sat Jul 14 22:22:44 2012 UTC (7 years, 4 months ago) by frodo
File MIME type: text/plain
File size: 13511 byte(s)
(Frodo) Fix spacing to get closer to the util_linux 2.21 release

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

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