Re: [PATCH 2/3] getopt: fixes to exit codes, free allocations at exit, progname and version output

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Mon, Jan 3, 2011 at 22:45, Karel Zak <kzak@xxxxxxxxxx> wrote:
[snip... here was helpful instructions]
>    Karel

I made another two patches to getopt. Let's hope they are better. The
first one will fix more pressing issues, like error codes etc. Second
one is fairly big coding style fix. And the last one is maintenance
clean up, which I realized is necessary due change in error code
behaviour.

 getopt/Makefile.am      |    3 +-
 getopt/getopt-test.bash |    6 -
 getopt/getopt-test.tcsh |    7 -
 getopt/getopt.1         |   20 +--
 getopt/getopt.c         |  522 +++++++++++++++++++++++------------------------
 5 files changed, 259 insertions(+), 299 deletions(-)

p.s. Sorry about not sending patches in-line. I don't know how to keep
threads intact with git send-email.

-- 
   Sami Kerola
   http://www.iki.fi/kerolasa/
From 66c9e3e15d2c0caf71935603853fa50bc57b9faf Mon Sep 17 00:00:00 2001
From: Sami Kerola <kerolasa@xxxxxx>
Date: Mon, 17 Jan 2011 19:21:41 +0100
Subject: [PATCH 1/2] getopt.c: use xmalloc, errx and consistent use of exit values

As a minor change command will use program_invocation_short_name
instead of static string constants.

Signed-off-by: Sami Kerola <kerolasa@xxxxxx>
---
 getopt/getopt.1 |   20 +++------
 getopt/getopt.c |  127 +++++++++++++++++++------------------------------------
 2 files changed, 50 insertions(+), 97 deletions(-)

diff --git a/getopt/getopt.1 b/getopt/getopt.1
index 2e6fbda..0b3ffb2 100644
--- a/getopt/getopt.1
+++ b/getopt/getopt.1
@@ -407,20 +407,14 @@ and
 characters in the short options string are ignored.
 .SH RETURN CODES
 .B getopt
-returns error code
+will return zero
 .B 0
-for successful parsing,
-.B 1
-if
-.BR getopt (3)
-returns errors,
-.B 2
-if it does not understand its own parameters,
-.B 3
-if an internal error occurs like out\-of\-memory, and
-.B 4
-if it is called with
-.BR \-T .
+for successful parsing, and non-zero valu in all other cases.
+Notice that option
+.BR \-T ,
+.BR \-\-test
+will make return value to be non-zero.
+
 .SH EXAMPLES
 Example scripts for (ba)sh and (t)csh are provided with the
 .BR getopt (1)
diff --git a/getopt/getopt.c b/getopt/getopt.c
index fbcfb05..4ac825f 100644
--- a/getopt/getopt.c
+++ b/getopt/getopt.c
@@ -45,8 +45,11 @@
 #include <unistd.h>
 #include <ctype.h>
 #include <getopt.h>
+#include <errno.h>
+#include <err.h>
 
 #include "nls.h"
+#include "xalloc.h"
 
 /* NON_OPT is the code that is returned when a non-option is found in '+' 
    mode */
@@ -66,39 +69,16 @@ 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);
-void *our_realloc(void *ptr, size_t size);
 const char *normalize(const char *arg);
 int generate_output(char * argv[],int argc,const char *optstr,
                     const struct option *longopts);
 int main(int argc, char *argv[]);
-void parse_error(const char *message);
 void add_long_options(char *options);
 void add_longopt(const char *name,int has_arg);
-void print_help(void);
+static void __attribute__((__noreturn__)) usage(FILE *out);
 void set_shell(const char *new_shell);
 void set_initial_shell(void);
 
-void *our_malloc(size_t size)
-{
-	void *ret=malloc(size);
-	if (! ret) {
-		fprintf(stderr,_("%s: Out of memory!\n"),"getopt");
-		exit(3);
-	}
-	return(ret);
-}
-
-void *our_realloc(void *ptr, size_t size)
-{
-	void *ret=realloc(ptr,size);
-	if (! ret && size) {
-		fprintf(stderr,_("%s: Out of memory!\n"),"getopt");
-		exit(3);
-	}
-	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
@@ -117,7 +97,7 @@ const char *normalize(const char *arg)
 	free(BUFFER);
 
 	if (!quote) { /* Just copy arg */
-		BUFFER=our_malloc(strlen(arg)+1);
+		BUFFER=xmalloc(strlen(arg)+1);
 			
 		strcpy(BUFFER,arg);
 		return BUFFER;
@@ -127,7 +107,7 @@ const char *normalize(const char *arg)
 	   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);
+	BUFFER=xmalloc(strlen(arg)*4+3);
 
 	bufptr=BUFFER;
 	*bufptr++='\'';
@@ -175,7 +155,7 @@ const char *normalize(const char *arg)
 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; /* We assume everything will be OK */
 	int opt;
 	int longindex;
 	const char *charptr;
@@ -189,7 +169,7 @@ int generate_output(char * argv[],int argc,const char *optstr,
 	              getopt_long(argc,argv,optstr,longopts,&longindex))) 
                != EOF) 
 		if (opt == '?' || opt == ':' )
-			exit_code = 1;
+			exit_code = EXIT_FAILURE;
 		else if (!quiet_output) 
 		{
 			if (opt == LONG_OPT) {
@@ -217,19 +197,6 @@ int generate_output(char * argv[],int argc,const char *optstr,
 	return exit_code;
 }
 
-/*
- * 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);
-}
-
 static struct option *long_options=NULL;
 static int long_options_length=0; /* Length of array */
 static int long_options_nr=0; /* Nr of used elements in array */
@@ -249,7 +216,7 @@ void add_longopt(const char *name,int has_arg)
 
 	if (long_options_nr == long_options_length) {
 		long_options_length += LONG_OPTIONS_INCR;
-		long_options=our_realloc(long_options,
+		long_options=xrealloc(long_options,
 		                         sizeof(struct option) * 
 		                           long_options_length);
 	}
@@ -263,7 +230,7 @@ void add_longopt(const char *name,int has_arg)
 		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;
-		tmp = our_malloc(strlen(name)+1);
+		tmp = xmalloc(strlen(name)+1);
 		strcpy(tmp,name);
 		long_options[long_options_nr-1].name=tmp;
 	}
@@ -292,7 +259,7 @@ void add_long_options(char *options)
 					arg_opt=required_argument;
 				}
 				if (strlen(tokptr) == 0)
-					parse_error(_("empty long option after "
+					errx(EXIT_FAILURE, _("empty long option after "
 					              "-l or --long argument"));
 			}
 			add_longopt(tokptr,arg_opt);
@@ -312,37 +279,30 @@ void set_shell(const char *new_shell)
 	else if (!strcmp(new_shell,"csh"))
 		shell=TCSH;
 	else
-		parse_error(_("unknown shell after -s or --shell argument"));
+		errx(EXIT_FAILURE, _("unknown shell after -s or --shell argument"));
 }
 
-void print_help(void)
+static void __attribute__((__noreturn__)) usage(FILE *out)
 {
-	fputs(_("Usage: getopt optstring parameters\n"),stderr);
-	fputs(_("       getopt [options] [--] optstring parameters\n"),stderr);
-	fputs(_("       getopt [options] -o|--options optstring [options] [--]\n"),stderr);
-	fputs(_("              parameters\n"),stderr);
-	fputs(_("  -a, --alternative            Allow long options starting with single -\n"),stderr);
-	fputs(_("  -h, --help                   This small usage guide\n"),stderr);
-	fputs(_("  -l, --longoptions=longopts   Long options to be recognized\n"),stderr);
-	fputs(_("  -n, --name=progname          The name under which errors are reported\n"),stderr);
-	fputs(_("  -o, --options=optstring      Short options to be recognized\n"),stderr);
-	fputs(_("  -q, --quiet                  Disable error reporting by getopt(3)\n"),stderr);
-	fputs(_("  -Q, --quiet-output           No normal output\n"),stderr);
-	fputs(_("  -s, --shell=shell            Set shell quoting conventions\n"),stderr);	
-	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);
+	fprintf(out, _("Usage: %s optstring parameters\n"), program_invocation_short_name);
+	fprintf(out, _("       %s [options] [--] optstring parameters\n"), program_invocation_short_name);
+	fprintf(out, _("       %s [options] -o|--options optstring [options] [--]\n"), program_invocation_short_name);
+	fprintf(out, _("              parameters\n"));
+	fprintf(out, _("  -a, --alternative            Allow long options starting with single -\n"));
+	fprintf(out, _("  -h, --help                   This small usage guide\n"));
+	fprintf(out, _("  -l, --longoptions=longopts   Long options to be recognized\n"));
+	fprintf(out, _("  -n, --name=progname          The name under which errors are reported\n"));
+	fprintf(out, _("  -o, --options=optstring      Short options to be recognized\n"));
+	fprintf(out, _("  -q, --quiet                  Disable error reporting by getopt(3)\n"));
+	fprintf(out, _("  -Q, --quiet-output           No normal output\n"));
+	fprintf(out, _("  -s, --shell=shell            Set shell quoting conventions\n"));	
+	fprintf(out, _("  -T, --test                   Test for getopt(1) version\n"));
+	fprintf(out, _("  -u, --unqote                 Do not quote the output\n"));
+	fprintf(out, _("  -V, --version                Output version information\n"));
+
+	exit(out == stderr ? EXIT_FAILURE : EXIT_SUCCESS);
 }
 	
-/* 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'},
@@ -382,15 +342,15 @@ int main(int argc, char *argv[])
 			/* For some reason, the original getopt gave no error
                            when there were no arguments. */
 			printf(" --\n");
-			exit(0);
+			exit(EXIT_SUCCESS);
 		}
 		else
-			parse_error(_("missing optstring argument"));
+			errx(EXIT_FAILURE, _("missing optstring argument"));
 	}
 	
 	if (argv[1][0] != '-' || compatible) {
 		quote=0;
-		optstr=our_malloc(strlen(argv[1])+1);
+		optstr=xmalloc(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));
@@ -402,11 +362,10 @@ int main(int argc, char *argv[])
 			alternative=1;
 			break;
 		case 'h':
-			print_help();
-			exit(0);
+			usage(stdout);
 		case 'o':
 			free(optstr);
-			optstr=our_malloc(strlen(optarg)+1);
+			optstr=xmalloc(strlen(optarg)+1);
 			strcpy(optstr,optarg);
 			break;
 		case 'l':
@@ -414,7 +373,7 @@ int main(int argc, char *argv[])
 			break;
 		case 'n':
 			free(name);
-			name=our_malloc(strlen(optarg)+1);
+			name=xmalloc(strlen(optarg)+1);
 			strcpy(name,optarg);
 			break;
 		case 'q':
@@ -427,26 +386,26 @@ int main(int argc, char *argv[])
 			set_shell(optarg);
 			break;
 		case 'T':
-			exit(4);
+			exit(EXIT_FAILURE);
 		case 'u':
 			quote=0;
 			break;
 		case 'V':
-			printf(_("getopt (enhanced) 1.1.4\n"));
-			exit(0);
+			printf(_("%s from %s\n"), program_invocation_short_name, PACKAGE_STRING);
+			exit(EXIT_SUCCESS);
 		case '?':
 		case ':':
-			parse_error(NULL);
+			usage(stderr);
 		default:
-			parse_error(_("internal error, contact the author."));
+			errx(EXIT_FAILURE, _("internal error, contact the author."));
 		}
 	
 	if (!optstr) 
 	{
 		if (optind >= argc)
-			parse_error(_("missing optstring argument"));
+			errx(EXIT_FAILURE, _("missing optstring argument"));
 		else {
-			optstr=our_malloc(strlen(argv[optind])+1);
+			optstr=xmalloc(strlen(argv[optind])+1);
 			strcpy(optstr,argv[optind]);
 			optind++;
 		}
-- 
1.7.3.5

From 0707d26b9b58bd026e2f1ef2464d40235c33b368 Mon Sep 17 00:00:00 2001
From: Sami Kerola <kerolasa@xxxxxx>
Date: Mon, 17 Jan 2011 20:59:41 +0100
Subject: [PATCH 2/2] getopt.c: coding style fix

Signed-off-by: Sami Kerola <kerolasa@xxxxxx>
---
 getopt/getopt.c |  431 +++++++++++++++++++++++++++++--------------------------
 1 files changed, 226 insertions(+), 205 deletions(-)

diff --git a/getopt/getopt.c b/getopt/getopt.c
index 4ac825f..2d17b4d 100644
--- a/getopt/getopt.c
+++ b/getopt/getopt.c
@@ -1,21 +1,21 @@
 /*
-    getopt.c - Enhanced implementation of BSD getopt(1)
-    Copyright (c) 1997-2005 Frodo Looijaard <frodo@xxxxxxxxxxxxxxxxxxxx>
-
-    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 <frodo@xxxxxxxxxxxxxxxxxxxx>
+ *
+ *  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.
@@ -51,238 +51,252 @@
 #include "nls.h"
 #include "xalloc.h"
 
-/* NON_OPT is the code that is returned when a non-option is found in '+' 
-   mode */
+/* NON_OPT is the code that is returned when a non-option is found in
+ * '+' mode */
 #define NON_OPT 1
 /* LONG_OPT is the code that is returned when a long option is found. */
 #define LONG_OPT 2
 
 /* The shells recognized. */
-typedef enum {BASH,TCSH} shell_t;
-
+typedef enum { BASH, TCSH } shell_t;
 
 /* 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 */
 const char *normalize(const char *arg);
-int generate_output(char * argv[],int argc,const char *optstr,
-                    const struct option *longopts);
+int generate_output(char *argv[], int argc, const char *optstr,
+		    const struct option *longopts);
 int main(int argc, char *argv[]);
 void add_long_options(char *options);
-void add_longopt(const char *name,int has_arg);
-static void __attribute__((__noreturn__)) usage(FILE *out);
+void add_longopt(const char *name, int has_arg);
+static void __attribute__ ((__noreturn__)) usage(FILE * out);
 void set_shell(const char *new_shell);
 void set_initial_shell(void);
 
 /*
  * 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.
+ * 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)
 {
-	static char *BUFFER=NULL;
-	const char *argptr=arg;
+	static char *BUFFER = NULL;
+	const char *argptr = arg;
 	char *bufptr;
 
 	free(BUFFER);
 
-	if (!quote) { /* Just copy arg */
-		BUFFER=xmalloc(strlen(arg)+1);
-			
-		strcpy(BUFFER,arg);
+	/* Just copy arg */
+	if (quote == 0) {
+		BUFFER = xmalloc(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'. */
-	BUFFER=xmalloc(strlen(arg)*4+3);
+	/*
+	 * 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 = xmalloc(strlen(arg) * 4 + 3);
 
-	bufptr=BUFFER;
-	*bufptr++='\'';
+	bufptr = BUFFER;
+	*bufptr++ = '\'';
 
 	while (*argptr) {
 		if (*argptr == '\'') {
 			/* Quote: replace it with: '\'' */
-			*bufptr++='\'';
-			*bufptr++='\\';
-			*bufptr++='\'';
-			*bufptr++='\'';
-		} else if (shell==TCSH && *argptr=='!') {
+			*bufptr++ = '\'';
+			*bufptr++ = '\\';
+			*bufptr++ = '\'';
+			*bufptr++ = '\'';
+		} else if (shell == TCSH && *argptr == '!') {
 			/* Exclamation mark: replace it with: \! */
-			*bufptr++='\'';
-			*bufptr++='\\';
-			*bufptr++='!';
-			*bufptr++='\'';
-		} else if (shell==TCSH && *argptr=='\n') {
+			*bufptr++ = '\'';
+			*bufptr++ = '\\';
+			*bufptr++ = '!';
+			*bufptr++ = '\'';
+		} else if (shell == TCSH && *argptr == '\n') {
 			/* Newline: replace it with: \n */
-			*bufptr++='\\';
-			*bufptr++='n';
-		} else if (shell==TCSH && isspace(*argptr)) {
+			*bufptr++ = '\\';
+			*bufptr++ = 'n';
+		} else if (shell == TCSH && isspace(*argptr)) {
 			/* Non-newline whitespace: replace it with \<ws> */
-			*bufptr++='\'';
-			*bufptr++='\\';
-			*bufptr++=*argptr;
-			*bufptr++='\'';
+			*bufptr++ = '\'';
+			*bufptr++ = '\\';
+			*bufptr++ = *argptr;
+			*bufptr++ = '\'';
 		} else
 			/* Just copy */
-			*bufptr++=*argptr;
+			*bufptr++ = *argptr;
 		argptr++;
 	}
-	*bufptr++='\'';
-	*bufptr++='\0';
+	*bufptr++ = '\'';
+	*bufptr++ = '\0';
 	return BUFFER;
 }
 
 /* 
- * Generate the output. argv[0] is the program name (used for reporting errors).
- * argv[1..] contains the options to be parsed. argc must be the number of
- * elements in argv (ie. 1 if there are no options, only the program name),
- * optstr must contain the short options, and longopts the long options.
+ * Generate the output. argv[0] is the program name (used for reporting
+ * errors). argv[1..] contains the options to be parsed. argc must be the
+ * number of elements in argv (ie. 1 if there are no options, only the program
+ * name), optstr must contain the short options, and longopts the long options.
  * Other settings are found in global variables.
  */
-int generate_output(char * argv[],int argc,const char *optstr,
-                    const struct option *longopts)
+int generate_output(char *argv[], int argc, const char *optstr,
+		    const struct option *longopts)
 {
-	int exit_code = EXIT_SUCCESS; /* We assume everything will be OK */
+	int exit_code = EXIT_SUCCESS;
 	int opt;
 	int longindex;
 	const char *charptr;
 
-	if (quiet_errors) /* No error reporting from getopt(3) */
-		opterr=0;
-	optind=0; /* Reset getopt(3) */
-
-	while ((opt = (alternative?
-	              getopt_long_only(argc,argv,optstr,longopts,&longindex):
-	              getopt_long(argc,argv,optstr,longopts,&longindex))) 
-               != EOF) 
-		if (opt == '?' || opt == ':' )
+	/* No error reporting from getopt(3) */
+	if (quiet_errors)
+		opterr = 0;
+
+	/* 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 = EXIT_FAILURE;
-		else if (!quiet_output) 
-		{
+		} else if (quiet_output == 0) {
 			if (opt == LONG_OPT) {
-				printf(" --%s",longopts[longindex].name);
-				if (longopts[longindex].has_arg) 
+				printf(" --%s", longopts[longindex].name);
+				if (0 < longopts[longindex].has_arg) {
 					printf(" %s",
-					       normalize(optarg?optarg:""));
-			} else if (opt == NON_OPT) 
-				printf(" %s",normalize(optarg)); 
-			else {
-				printf(" -%c",opt);
-				charptr = strchr(optstr,opt);
-				if (charptr != NULL && *++charptr == ':')
+					       normalize(optarg ? optarg : ""));
+				}
+			} else if (opt == NON_OPT) {
+				printf(" %s", normalize(optarg));
+			} else {
+				printf(" -%c", opt);
+				charptr = strchr(optstr, opt);
+				if (charptr != NULL && *++charptr == ':') {
 					printf(" %s",
-					       normalize(optarg?optarg:""));
+					       normalize(optarg ? optarg : ""));
+				}
 			}
 		}
-	
-	if (! quiet_output) {
+	}
+
+	if (quiet_output == 0) {
 		printf(" --");
-		while (optind < argc) 
-			printf(" %s",normalize(argv[optind++]));
+		while (optind < argc) {
+			printf(" %s", normalize(argv[optind++]));
+		}
 		printf("\n");
 	}
 	return exit_code;
 }
 
-static struct option *long_options=NULL;
-static int long_options_length=0; /* Length of array */
-static int long_options_nr=0; /* Nr of used elements in array */
+static struct option *long_options = NULL;
+static int long_options_length = 0;	/* Length of array */
+static int long_options_nr = 0;		/* Nr of used elements in array */
 #define LONG_OPTIONS_INCR 10
 #define init_longopt() add_longopt(NULL,0)
 
 /* Register a long option. The contents of name is copied. */
-void add_longopt(const char *name,int has_arg)
+void add_longopt(const char *name, int has_arg)
 {
 	char *tmp;
-	if (!name) { /* init */
+	/* at init name is null */
+	if (name == NULL) {
 		free(long_options);
-		long_options=NULL;
-		long_options_length=0;
-		long_options_nr=0;
+		long_options = NULL;
+		long_options_length = 0;
+		long_options_nr = 0;
 	}
 
 	if (long_options_nr == long_options_length) {
 		long_options_length += LONG_OPTIONS_INCR;
-		long_options=xrealloc(long_options,
-		                         sizeof(struct option) * 
-		                           long_options_length);
+		long_options = xrealloc(long_options,
+					sizeof(struct option) *
+					long_options_length);
 	}
 
-	long_options[long_options_nr].name=NULL;
-	long_options[long_options_nr].has_arg=0;
-	long_options[long_options_nr].flag=NULL;
-	long_options[long_options_nr].val=0;
-
-	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;
-		tmp = xmalloc(strlen(name)+1);
-		strcpy(tmp,name);
-		long_options[long_options_nr-1].name=tmp;
+	long_options[long_options_nr].name = NULL;
+	long_options[long_options_nr].has_arg = 0;
+	long_options[long_options_nr].flag = NULL;
+	long_options[long_options_nr].val = 0;
+
+	/* Not for init! */
+	if (0 < long_options_nr) {
+		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;
+		tmp = xmalloc(strlen(name) + 1);
+		strcpy(tmp, name);
+		long_options[long_options_nr - 1].name = tmp;
 	}
 	long_options_nr++;
 }
-	
 
 /* 
- * 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)
 {
 	int arg_opt;
-	char *tokptr=strtok(options,", \t\n");
+	char *tokptr = strtok(options, ", \t\n");
 	while (tokptr) {
-		arg_opt=no_argument;
+		arg_opt = no_argument;
 		if (strlen(tokptr) > 0) {
-			if (tokptr[strlen(tokptr)-1] == ':') {
-				if (tokptr[strlen(tokptr)-2] == ':') {
-					tokptr[strlen(tokptr)-2]='\0';
-					arg_opt=optional_argument;
+			if (tokptr[strlen(tokptr) - 1] == ':') {
+				if (tokptr[strlen(tokptr) - 2] == ':') {
+					tokptr[strlen(tokptr) - 2] = '\0';
+					arg_opt = optional_argument;
 				} else {
-					tokptr[strlen(tokptr)-1]='\0';
-					arg_opt=required_argument;
+					tokptr[strlen(tokptr) - 1] = '\0';
+					arg_opt = required_argument;
+				}
+				if (strlen(tokptr) == 0) {
+					errx(EXIT_FAILURE,
+					     _("empty long option after -l or --long argument"));
 				}
-				if (strlen(tokptr) == 0)
-					errx(EXIT_FAILURE, _("empty long option after "
-					              "-l or --long argument"));
 			}
-			add_longopt(tokptr,arg_opt);
+			add_longopt(tokptr, arg_opt);
 		}
-		tokptr=strtok(NULL,", \t\n");
+		tokptr = strtok(NULL, ", \t\n");
 	}
 }
 
 void set_shell(const char *new_shell)
 {
-	if (!strcmp(new_shell,"bash"))
-		shell=BASH;
-	else if (!strcmp(new_shell,"tcsh"))
-		shell=TCSH;
-	else if (!strcmp(new_shell,"sh"))
-		shell=BASH;
-	else if (!strcmp(new_shell,"csh"))
-		shell=TCSH;
+	if (strcmp(new_shell, "bash") == 0)
+		shell = BASH;
+	else if (strcmp(new_shell, "tcsh") == 0)
+		shell = TCSH;
+	else if (strcmp(new_shell, "sh") == 0)
+		shell = BASH;
+	else if (strcmp(new_shell, "csh") == 0)
+		shell = TCSH;
 	else
-		errx(EXIT_FAILURE, _("unknown shell after -s or --shell argument"));
+		errx(EXIT_FAILURE,
+		     _("unknown shell after -s or --shell argument"));
 }
 
-static void __attribute__((__noreturn__)) usage(FILE *out)
+static void __attribute__ ((__noreturn__)) usage(FILE * out)
 {
 	fprintf(out, _("Usage: %s optstring parameters\n"), program_invocation_short_name);
 	fprintf(out, _("       %s [options] [--] optstring parameters\n"), program_invocation_short_name);
@@ -295,92 +309,94 @@ static void __attribute__((__noreturn__)) usage(FILE *out)
 	fprintf(out, _("  -o, --options=optstring      Short options to be recognized\n"));
 	fprintf(out, _("  -q, --quiet                  Disable error reporting by getopt(3)\n"));
 	fprintf(out, _("  -Q, --quiet-output           No normal output\n"));
-	fprintf(out, _("  -s, --shell=shell            Set shell quoting conventions\n"));	
+	fprintf(out, _("  -s, --shell=shell            Set shell quoting conventions\n"));
 	fprintf(out, _("  -T, --test                   Test for getopt(1) version\n"));
 	fprintf(out, _("  -u, --unqote                 Do not quote the output\n"));
 	fprintf(out, _("  -V, --version                Output version information\n"));
 
 	exit(out == stderr ? EXIT_FAILURE : EXIT_SUCCESS);
 }
-	
-static struct option longopts[]={ {"options",required_argument,NULL,'o'},
-                                  {"longoptions",required_argument,NULL,'l'},
-                                  {"quiet",no_argument,NULL,'q'},
-                                  {"quiet-output",no_argument,NULL,'Q'},
-                                  {"shell",required_argument,NULL,'s'},
-                                  {"test",no_argument,NULL,'T'},
-                                  {"unquoted",no_argument,NULL,'u'},
-                                  {"help",no_argument,NULL,'h'},
-                                  {"alternative",no_argument,NULL,'a'},
-                                  {"name",required_argument,NULL,'n'},
-                                  {"version",no_argument,NULL,'V'},
-                                  {NULL,0,NULL,0}
-                                };
+
+static struct option longopts[] = {
+	{ "options",	  required_argument,	NULL, 'o' },
+	{ "longoptions",  required_argument,	NULL, 'l' },
+	{ "quiet",	  no_argument,		NULL, 'q' },
+	{ "quiet-output", no_argument,		NULL, 'Q' },
+	{ "shell",	  required_argument,	NULL, 's' },
+	{ "test",	  no_argument,		NULL, 'T' },
+	{ "unquoted",	  no_argument,		NULL, 'u' },
+	{ "help",	  no_argument,		NULL, 'h' },
+	{ "alternative",  no_argument,		NULL, 'a' },
+	{ "name",	  required_argument,	NULL, 'n' },
+	{ "version",	  no_argument,		NULL, 'V' },
+	{ NULL,		  0, 0, 0 }
+};
 
 /* Stop scanning as soon as a non-option argument is found! */
-static const char *shortopts="+ao:l:n:qQs:TuhV";
+static const char *shortopts = "+ao:l:n:qQs:TuhV";
 
 int main(int argc, char *argv[])
 {
-	char *optstr=NULL;
-	char *name=NULL;
+	char *optstr = NULL;
+	char *name = NULL;
 	int opt;
-	int compatible=0;
+	int compatible = 0;
 
-	setlocale(LC_ALL,"");
+	setlocale(LC_ALL, "");
 	bindtextdomain(PACKAGE, LOCALEDIR);
 	textdomain(PACKAGE);
 
 	init_longopt();
 
-	if (getenv("GETOPT_COMPATIBLE")) 
-		compatible=1;
+	if (getenv("GETOPT_COMPATIBLE"))
+		compatible = 1;
 
-	if (argc == 1) 
-	{
+	if (argc == 1) {
 		if (compatible) {
 			/* For some reason, the original getopt gave no error
-                           when there were no arguments. */
+			 * when there were no arguments. */
 			printf(" --\n");
 			exit(EXIT_SUCCESS);
-		}
-		else
+		} else
 			errx(EXIT_FAILURE, _("missing optstring argument"));
 	}
-	
-	if (argv[1][0] != '-' || compatible) {
-		quote=0;
-		optstr=xmalloc(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));
+
+	if (argv[1][0] != '-' || compatible == 1) {
+		quote = 0;
+		optstr = xmalloc(strlen(argv[1]) + 1);
+		strcpy(optstr, argv[1] + strspn(argv[1], "-+"));
+		argv[1] = argv[0];
+
+		return(generate_output
+		     (argv + 1, argc - 1, optstr, long_options));
 	}
-	
-	while ((opt=getopt_long(argc,argv,shortopts,longopts,NULL)) != EOF) 
+
+	while ((opt =
+		getopt_long(argc, argv, shortopts, longopts, NULL)) != EOF)
 		switch (opt) {
 		case 'a':
-			alternative=1;
+			alternative = 1;
 			break;
 		case 'h':
 			usage(stdout);
 		case 'o':
 			free(optstr);
-			optstr=xmalloc(strlen(optarg)+1);
-			strcpy(optstr,optarg);
+			optstr = xmalloc(strlen(optarg) + 1);
+			strcpy(optstr, optarg);
 			break;
 		case 'l':
 			add_long_options(optarg);
 			break;
 		case 'n':
 			free(name);
-			name=xmalloc(strlen(optarg)+1);
-			strcpy(name,optarg);
+			name = xmalloc(strlen(optarg) + 1);
+			strcpy(name, optarg);
 			break;
 		case 'q':
-			quiet_errors=1;
+			quiet_errors = 1;
 			break;
 		case 'Q':
-			quiet_output=1;
+			quiet_output = 1;
 			break;
 		case 's':
 			set_shell(optarg);
@@ -388,31 +404,36 @@ int main(int argc, char *argv[])
 		case 'T':
 			exit(EXIT_FAILURE);
 		case 'u':
-			quote=0;
+			quote = 0;
 			break;
 		case 'V':
-			printf(_("%s from %s\n"), program_invocation_short_name, PACKAGE_STRING);
+			printf(_("%s from %s\n"),
+			       program_invocation_short_name,
+			       PACKAGE_STRING);
 			exit(EXIT_SUCCESS);
 		case '?':
 		case ':':
 			usage(stderr);
 		default:
-			errx(EXIT_FAILURE, _("internal error, contact the author."));
+			errx(EXIT_FAILURE,
+			     _("internal error, contact the author."));
 		}
-	
-	if (!optstr) 
-	{
+
+	if (!optstr) {
 		if (optind >= argc)
-			errx(EXIT_FAILURE, _("missing optstring argument"));
+			errx(EXIT_FAILURE,
+			     _("missing optstring argument"));
 		else {
-			optstr=xmalloc(strlen(argv[optind])+1);
-			strcpy(optstr,argv[optind]);
+			optstr = xmalloc(strlen(argv[optind]) + 1);
+			strcpy(optstr, argv[optind]);
 			optind++;
 		}
 	}
 	if (name)
-		argv[optind-1]=name;
+		argv[optind - 1] = name;
 	else
-		argv[optind-1]=argv[0];
-	exit(generate_output(argv+optind-1,argc-optind+1,optstr,long_options));
+		argv[optind - 1] = argv[0];
+
+	return(generate_output
+	     (argv + optind - 1, argc - optind + 1, optstr, long_options));
 }
-- 
1.7.3.5

From c657441b81a68b5ca145d4287b9ed7bc5a595ac8 Mon Sep 17 00:00:00 2001
From: Sami Kerola <kerolasa@xxxxxx>
Date: Mon, 17 Jan 2011 21:27:37 +0100
Subject: [PATCH 3/3] getopt: clean up after changes in exit codes

Signed-off-by: Sami Kerola <kerolasa@xxxxxx>
---
 getopt/Makefile.am      |    3 +--
 getopt/getopt-test.bash |    6 ------
 getopt/getopt-test.tcsh |    7 -------
 3 files changed, 1 insertions(+), 15 deletions(-)
 delete mode 100755 getopt/getopt-test.bash
 delete mode 100755 getopt/getopt-test.tcsh

diff --git a/getopt/Makefile.am b/getopt/Makefile.am
index bd3e794..7c1b66b 100644
--- a/getopt/Makefile.am
+++ b/getopt/Makefile.am
@@ -4,8 +4,7 @@ usrbin_exec_PROGRAMS = getopt
 dist_man_MANS = getopt.1
 
 exampledir = $(datadir)/getopt/
-dist_example_SCRIPTS = getopt-parse.bash getopt-parse.tcsh \
-	getopt-test.bash getopt-test.tcsh
+dist_example_SCRIPTS = getopt-parse.bash getopt-parse.tcsh
 
 EXTRA_DIST = README Changelog COPYING
 
diff --git a/getopt/getopt-test.bash b/getopt/getopt-test.bash
deleted file mode 100755
index 149e1f9..0000000
--- a/getopt/getopt-test.bash
+++ /dev/null
@@ -1,6 +0,0 @@
-#!/bin/bash
-if `getopt -T >/dev/null 2>&1` ; [ $? = 4 ] ; then
-  echo "Enhanced getopt(1)"
-else
-  echo "Old getopt(1)"
-fi
diff --git a/getopt/getopt-test.tcsh b/getopt/getopt-test.tcsh
deleted file mode 100755
index d661e76..0000000
--- a/getopt/getopt-test.tcsh
+++ /dev/null
@@ -1,7 +0,0 @@
-#!/bin/tcsh
-getopt -T >&/dev/null
-if ( $status == 4) then
-  echo "Enhanced getopt(1)"
-else
-  echo "Old getopt(1)"
-endif
-- 
1.7.3.5


[Index of Archives]     [Netdev]     [Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux