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

Annotation of /getopt/trunk/getopt.c

Parent Directory Parent Directory | Revision Log Revision Log


Revision 318 - (hide annotations)
Sat Jul 14 19:02:43 2012 UTC (11 years, 8 months ago) by frodo
File MIME type: text/plain
File size: 13680 byte(s)
(Frodo) Sync exits with util-linux 2.21
* Introduce defines for exit codes
* Use return instead of exit from main()

1 frodo 259 /*
2 frodo 317 * 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 frodo 259
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 frodo 263 * Version 1.1.4: Mon Nov 7 2005
39     * Fixed a few type's in the manpage
40 frodo 259 */
41    
42 frodo 318 /* 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 frodo 259 #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 frodo 317 * mode */
71 frodo 259 #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 frodo 317 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     int alternative=0; /* 0 is getopt_long, 1 is getopt_long_only */
85 frodo 259
86     /* Function prototypes */
87     void *our_malloc(size_t size);
88     void *our_realloc(void *ptr, size_t size);
89     const char *normalize(const char *arg);
90     int generate_output(char * argv[],int argc,const char *optstr,
91     const struct option *longopts);
92     int main(int argc, char *argv[]);
93     void parse_error(const char *message);
94     void add_long_options(char *options);
95     void add_longopt(const char *name,int has_arg);
96     void print_help(void);
97     void set_shell(const char *new_shell);
98     void set_initial_shell(void);
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 frodo 318 exit(XALLOC_EXIT_CODE);
106 frodo 259 }
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 frodo 318 exit(XALLOC_EXIT_CODE);
116 frodo 259 }
117     return(ret);
118     }
119    
120     /*
121 frodo 317 * 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 frodo 259 * Bash only needs special treatment for single quotes; tcsh also recognizes
126 frodo 317 * exclamation marks within single quotes, and nukes whitespace. This
127     * function returns a pointer to a buffer that is overwritten by each call.
128 frodo 259 */
129     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 frodo 317 if (!quote) {
139     /* Just copy arg */
140 frodo 259 BUFFER=our_malloc(strlen(arg)+1);
141    
142     strcpy(BUFFER,arg);
143     return BUFFER;
144     }
145    
146 frodo 317 /*
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 frodo 259 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     int generate_output(char * argv[],int argc,const char *optstr,
198     const struct option *longopts)
199     {
200 frodo 318 int exit_code = EXIT_SUCCESS; /* Assume everything will be OK */
201 frodo 259 int opt;
202     int longindex;
203     const char *charptr;
204    
205 frodo 317 if (quiet_errors)
206     /* No error reporting from getopt(3) */
207 frodo 259 opterr=0;
208 frodo 317 /* Reset getopt(3) */
209     optind=0;
210 frodo 259
211     while ((opt = (alternative?
212     getopt_long_only(argc,argv,optstr,longopts,&longindex):
213     getopt_long(argc,argv,optstr,longopts,&longindex)))
214     != EOF)
215     if (opt == '?' || opt == ':' )
216 frodo 318 exit_code = GETOPT_EXIT_CODE;
217 frodo 259 else if (!quiet_output)
218     {
219     if (opt == LONG_OPT) {
220     printf(" --%s",longopts[longindex].name);
221     if (longopts[longindex].has_arg)
222     printf(" %s",
223     normalize(optarg?optarg:""));
224     } else if (opt == NON_OPT)
225     printf(" %s",normalize(optarg));
226     else {
227     printf(" -%c",opt);
228     charptr = strchr(optstr,opt);
229     if (charptr != NULL && *++charptr == ':')
230     printf(" %s",
231     normalize(optarg?optarg:""));
232     }
233     }
234    
235     if (! quiet_output) {
236     printf(" --");
237     while (optind < argc)
238     printf(" %s",normalize(argv[optind++]));
239     printf("\n");
240     }
241     return exit_code;
242     }
243    
244     /*
245 frodo 317 * Report an error when parsing getopt's own arguments. If message is NULL,
246     * we already sent a message, we just exit with a helpful hint.
247 frodo 259 */
248     void parse_error(const char *message)
249     {
250     if (message)
251     fprintf(stderr,"getopt: %s\n",message);
252     fputs(_("Try `getopt --help' for more information.\n"),stderr);
253 frodo 318 exit(PARAMETER_EXIT_CODE);
254 frodo 259 }
255    
256     static struct option *long_options=NULL;
257     static int long_options_length=0; /* Length of array */
258     static int long_options_nr=0; /* Nr of used elements in array */
259     #define LONG_OPTIONS_INCR 10
260     #define init_longopt() add_longopt(NULL,0)
261    
262     /* Register a long option. The contents of name is copied. */
263     void add_longopt(const char *name,int has_arg)
264     {
265     char *tmp;
266 frodo 317 if (!name) {
267     /* init */
268 frodo 259 free(long_options);
269     long_options=NULL;
270     long_options_length=0;
271     long_options_nr=0;
272     }
273    
274     if (long_options_nr == long_options_length) {
275     long_options_length += LONG_OPTIONS_INCR;
276     long_options=our_realloc(long_options,
277     sizeof(struct option) *
278     long_options_length);
279     }
280    
281     long_options[long_options_nr].name=NULL;
282     long_options[long_options_nr].has_arg=0;
283     long_options[long_options_nr].flag=NULL;
284     long_options[long_options_nr].val=0;
285    
286 frodo 317 if (long_options_nr) {
287     /* Not for init! */
288 frodo 259 long_options[long_options_nr-1].has_arg=has_arg;
289     long_options[long_options_nr-1].flag=NULL;
290     long_options[long_options_nr-1].val=LONG_OPT;
291     tmp = our_malloc(strlen(name)+1);
292     strcpy(tmp,name);
293     long_options[long_options_nr-1].name=tmp;
294     }
295     long_options_nr++;
296     }
297    
298    
299     /*
300 frodo 317 * Register several long options. options is a string of long options,
301     * separated by commas or whitespace. This nukes options!
302 frodo 259 */
303     void add_long_options(char *options)
304     {
305     int arg_opt;
306     char *tokptr=strtok(options,", \t\n");
307     while (tokptr) {
308     arg_opt=no_argument;
309     if (strlen(tokptr) > 0) {
310     if (tokptr[strlen(tokptr)-1] == ':') {
311     if (tokptr[strlen(tokptr)-2] == ':') {
312     tokptr[strlen(tokptr)-2]='\0';
313     arg_opt=optional_argument;
314     } else {
315     tokptr[strlen(tokptr)-1]='\0';
316     arg_opt=required_argument;
317     }
318     if (strlen(tokptr) == 0)
319     parse_error(_("empty long option after "
320     "-l or --long argument"));
321     }
322     add_longopt(tokptr,arg_opt);
323     }
324     tokptr=strtok(NULL,", \t\n");
325     }
326     }
327    
328     void set_shell(const char *new_shell)
329     {
330     if (!strcmp(new_shell,"bash"))
331     shell=BASH;
332     else if (!strcmp(new_shell,"tcsh"))
333     shell=TCSH;
334     else if (!strcmp(new_shell,"sh"))
335     shell=BASH;
336     else if (!strcmp(new_shell,"csh"))
337     shell=TCSH;
338     else
339     parse_error(_("unknown shell after -s or --shell argument"));
340     }
341    
342     void print_help(void)
343     {
344     fputs(_("Usage: getopt optstring parameters\n"),stderr);
345     fputs(_(" getopt [options] [--] optstring parameters\n"),stderr);
346     fputs(_(" getopt [options] -o|--options optstring [options] [--]\n"),stderr);
347     fputs(_(" parameters\n"),stderr);
348     fputs(_(" -a, --alternative Allow long options starting with single -\n"),stderr);
349     fputs(_(" -h, --help This small usage guide\n"),stderr);
350     fputs(_(" -l, --longoptions=longopts Long options to be recognized\n"),stderr);
351     fputs(_(" -n, --name=progname The name under which errors are reported\n"),stderr);
352     fputs(_(" -o, --options=optstring Short options to be recognized\n"),stderr);
353     fputs(_(" -q, --quiet Disable error reporting by getopt(3)\n"),stderr);
354     fputs(_(" -Q, --quiet-output No normal output\n"),stderr);
355     fputs(_(" -s, --shell=shell Set shell quoting conventions\n"),stderr);
356     fputs(_(" -T, --test Test for getopt(1) version\n"),stderr);
357     fputs(_(" -u, --unqote Do not quote the output\n"),stderr);
358     fputs(_(" -V, --version Output version information\n"),stderr);
359 frodo 318 exit(PARAMETER_EXIT_CODE);
360 frodo 259 }
361    
362     static struct option longopts[]={ {"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    
395     if (getenv("GETOPT_COMPATIBLE"))
396     compatible=1;
397    
398     if (argc == 1)
399     {
400     if (compatible) {
401 frodo 317 /*
402     * For some reason, the original getopt gave no error
403     * when there were no arguments.
404     */
405 frodo 259 printf(" --\n");
406 frodo 318 return EXIT_SUCCESS;
407 frodo 259 }
408     else
409     parse_error(_("missing optstring argument"));
410    
411 frodo 318
412 frodo 259 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 frodo 318 return generate_output(argv+1,argc-1,optstr,long_options);
418 frodo 259 }
419    
420     while ((opt=getopt_long(argc,argv,shortopts,longopts,NULL)) != EOF)
421     switch (opt) {
422     case 'a':
423     alternative=1;
424     break;
425     case 'h':
426     print_help();
427     case 'o':
428     if (optstr)
429     free(optstr);
430     optstr=our_malloc(strlen(optarg)+1);
431     strcpy(optstr,optarg);
432     break;
433     case 'l':
434     add_long_options(optarg);
435     break;
436     case 'n':
437     if (name)
438     free(name);
439     name=our_malloc(strlen(optarg)+1);
440     strcpy(name,optarg);
441     break;
442     case 'q':
443     quiet_errors=1;
444     break;
445     case 'Q':
446     quiet_output=1;
447     break;
448     case 's':
449     set_shell(optarg);
450     break;
451     case 'T':
452 frodo 318 return TEST_EXIT_CODE;
453 frodo 259 case 'u':
454     quote=0;
455     break;
456     case 'V':
457 frodo 263 printf(_("getopt (enhanced) 1.1.4\n"));
458 frodo 318 return EXIT_SUCCESS;
459 frodo 259 case '?':
460     case ':':
461     parse_error(NULL);
462     default:
463     parse_error(_("internal error, contact the author."));
464     }
465    
466     if (!optstr)
467     {
468     if (optind >= argc)
469     parse_error(_("missing optstring argument"));
470     else {
471     optstr=our_malloc(strlen(argv[optind])+1);
472     strcpy(optstr,argv[optind]);
473     optind++;
474     }
475     }
476     if (name)
477     argv[optind-1]=name;
478     else
479     argv[optind-1]=argv[0];
480 frodo 318 return generate_output(argv+optind-1,argc-optind+1,optstr,long_options);
481 frodo 259 }

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