/[public]/getopt/tags/VERSION_1_1_6/getopt.c
ViewVC logotype

Contents of /getopt/tags/VERSION_1_1_6/getopt.c

Parent Directory Parent Directory | Revision Log Revision Log


Revision 321 - (show annotations)
Mon Jul 16 20:36:18 2012 UTC (7 years, 2 months ago) by frodo
Original Path: getopt/trunk/getopt.c
File MIME type: text/plain
File size: 13615 byte(s)
(Frodo) Add 'static' definitions to get closer to util-linux 2.21

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

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