--- getopt/trunk/getopt.c 2005/11/07 22:19:13 263 +++ getopt/trunk/getopt.c 2012/07/14 19:02:43 318 @@ -1,21 +1,21 @@ /* - getopt.c - Enhanced implementation of BSD getopt(1) - Copyright (c) 1997-2005 Frodo Looijaard - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. -*/ + * getopt.c - Enhanced implementation of BSD getopt(1) + * Copyright (c) 1997-2005 Frodo Looijaard + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ /* * Version 1.0-b4: Tue Sep 23 1997. First public release. @@ -39,6 +39,19 @@ * Fixed a few type's in the manpage */ +/* Exit codes: + * 0) No errors, succesful operation. + * 1) getopt(3) returned an error. + * 2) A problem with parameter parsing for getopt(1). + * 3) Internal error, out of memory + * 4) Returned for -T + */ +#define GETOPT_EXIT_CODE 1 +#define PARAMETER_EXIT_CODE 2 +#define XALLOC_EXIT_CODE 3 +#define TEST_EXIT_CODE 4 + + #include #include #include @@ -54,7 +67,7 @@ #include "nls.h" /* NON_OPT is the code that is returned when a non-option is found in '+' - mode */ + * mode */ #define NON_OPT 1 /* LONG_OPT is the code that is returned when a long option is found. */ #define LONG_OPT 2 @@ -64,11 +77,11 @@ /* Some global variables that tells us how to parse. */ -shell_t shell=BASH; /* The shell we generate output for. */ -int quiet_errors=0; /* 0 is not quiet. */ -int quiet_output=0; /* 0 is not quiet. */ -int quote=1; /* 1 is do quote. */ -int alternative=0; /* 0 is getopt_long, 1 is getopt_long_only */ +shell_t shell=BASH; /* The shell we generate output for. */ +int quiet_errors=0; /* 0 is not quiet. */ +int quiet_output=0; /* 0 is not quiet. */ +int quote=1; /* 1 is do quote. */ +int alternative=0; /* 0 is getopt_long, 1 is getopt_long_only */ /* Function prototypes */ void *our_malloc(size_t size); @@ -89,7 +102,7 @@ void *ret=malloc(size); if (! ret) { fprintf(stderr,_("%s: Out of memory!\n"),"getopt"); - exit(3); + exit(XALLOC_EXIT_CODE); } return(ret); } @@ -99,19 +112,19 @@ void *ret=realloc(ptr,size); if (! ret && size) { fprintf(stderr,_("%s: Out of memory!\n"),"getopt"); - exit(3); + exit(XALLOC_EXIT_CODE); } return(ret); } /* - * This function 'normalizes' a single argument: it puts single quotes around - * it and escapes other special characters. If quote is false, it just - * returns its argument. + * This function 'normalizes' a single argument: it puts single quotes + * around it and escapes other special characters. If quote is false, it + * just returns its argument. + * * Bash only needs special treatment for single quotes; tcsh also recognizes - * exclamation marks within single quotes, and nukes whitespace. - * This function returns a pointer to a buffer that is overwritten by - * each call. + * exclamation marks within single quotes, and nukes whitespace. This + * function returns a pointer to a buffer that is overwritten by each call. */ const char *normalize(const char *arg) { @@ -122,17 +135,20 @@ if (BUFFER != NULL) free(BUFFER); - if (!quote) { /* Just copy arg */ + if (!quote) { + /* Just copy arg */ BUFFER=our_malloc(strlen(arg)+1); strcpy(BUFFER,arg); return BUFFER; } - /* Each character in arg may take upto four characters in the result: - For a quote we need a closing quote, a backslash, a quote and an - opening quote! We need also the global opening and closing quote, - and one extra character for '\0'. */ + /* + * Each character in arg may take upto four characters in the + * result: For a quote we need a closing quote, a backslash, a quote + * and an opening quote! We need also the global opening and closing + * quote, and one extra character for '\0'. + */ BUFFER=our_malloc(strlen(arg)*4+3); bufptr=BUFFER; @@ -181,21 +197,23 @@ int generate_output(char * argv[],int argc,const char *optstr, const struct option *longopts) { - int exit_code = 0; /* We assume everything will be OK */ + int exit_code = EXIT_SUCCESS; /* Assume everything will be OK */ int opt; int longindex; const char *charptr; - if (quiet_errors) /* No error reporting from getopt(3) */ + if (quiet_errors) + /* No error reporting from getopt(3) */ opterr=0; - optind=0; /* Reset getopt(3) */ + /* Reset getopt(3) */ + optind=0; while ((opt = (alternative? getopt_long_only(argc,argv,optstr,longopts,&longindex): getopt_long(argc,argv,optstr,longopts,&longindex))) != EOF) if (opt == '?' || opt == ':' ) - exit_code = 1; + exit_code = GETOPT_EXIT_CODE; else if (!quiet_output) { if (opt == LONG_OPT) { @@ -224,16 +242,15 @@ } /* - * Report an error when parsing getopt's own arguments. - * If message is NULL, we already sent a message, we just exit with a helpful - * hint. + * Report an error when parsing getopt's own arguments. If message is NULL, + * we already sent a message, we just exit with a helpful hint. */ void parse_error(const char *message) { if (message) fprintf(stderr,"getopt: %s\n",message); fputs(_("Try `getopt --help' for more information.\n"),stderr); - exit(2); + exit(PARAMETER_EXIT_CODE); } static struct option *long_options=NULL; @@ -246,7 +263,8 @@ void add_longopt(const char *name,int has_arg) { char *tmp; - if (!name) { /* init */ + if (!name) { + /* init */ free(long_options); long_options=NULL; long_options_length=0; @@ -265,7 +283,8 @@ long_options[long_options_nr].flag=NULL; long_options[long_options_nr].val=0; - if (long_options_nr) { /* Not for init! */ + if (long_options_nr) { + /* Not for init! */ long_options[long_options_nr-1].has_arg=has_arg; long_options[long_options_nr-1].flag=NULL; long_options[long_options_nr-1].val=LONG_OPT; @@ -278,9 +297,8 @@ /* - * Register several long options. options is a string of long options, - * separated by commas or whitespace. - * This nukes options! + * Register several long options. options is a string of long options, + * separated by commas or whitespace. This nukes options! */ void add_long_options(char *options) { @@ -338,17 +356,9 @@ fputs(_(" -T, --test Test for getopt(1) version\n"),stderr); fputs(_(" -u, --unqote Do not quote the output\n"),stderr); fputs(_(" -V, --version Output version information\n"),stderr); - exit(2); + exit(PARAMETER_EXIT_CODE); } -/* Exit codes: - * 0) No errors, succesful operation. - * 1) getopt(3) returned an error. - * 2) A problem with parameter parsing for getopt(1). - * 3) Internal error, out of memory - * 4) Returned for -T - */ - static struct option longopts[]={ {"options",required_argument,NULL,'o'}, {"longoptions",required_argument,NULL,'l'}, {"quiet",no_argument,NULL,'q'}, @@ -388,21 +398,23 @@ if (argc == 1) { if (compatible) { - /* For some reason, the original getopt gave no error - when there were no arguments. */ + /* + * For some reason, the original getopt gave no error + * when there were no arguments. + */ printf(" --\n"); - exit(0); + return EXIT_SUCCESS; } else parse_error(_("missing optstring argument")); - } + if (argv[1][0] != '-' || compatible) { quote=0; optstr=our_malloc(strlen(argv[1])+1); strcpy(optstr,argv[1]+strspn(argv[1],"-+")); argv[1]=argv[0]; - exit(generate_output(argv+1,argc-1,optstr,long_options)); + return generate_output(argv+1,argc-1,optstr,long_options); } while ((opt=getopt_long(argc,argv,shortopts,longopts,NULL)) != EOF) @@ -412,7 +424,6 @@ break; case 'h': print_help(); - exit(0); case 'o': if (optstr) free(optstr); @@ -438,13 +449,13 @@ set_shell(optarg); break; case 'T': - exit(4); + return TEST_EXIT_CODE; case 'u': quote=0; break; case 'V': printf(_("getopt (enhanced) 1.1.4\n")); - exit(0); + return EXIT_SUCCESS; case '?': case ':': parse_error(NULL); @@ -466,5 +477,5 @@ argv[optind-1]=name; else argv[optind-1]=argv[0]; - exit(generate_output(argv+optind-1,argc-optind+1,optstr,long_options)); + return generate_output(argv+optind-1,argc-optind+1,optstr,long_options); }