/[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 319 - (show annotations)
Sat Jul 14 19:20:46 2012 UTC (7 years, 2 months ago) by frodo
Original Path: getopt/trunk/getopt.c
File MIME type: text/plain
File size: 13721 byte(s)
(Frodo) Sync with util-linux 2.21: use a pointer to alternative getopt functions

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

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