src/utils/gnugetopt.h

/* Declarations for getopt.
   Copyright (C) 1989-1994, 1996-1999, 2001 Free Software Foundation, Inc.
   This file is part of the GNU C Library.

   The GNU C Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   The GNU C Library 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
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with the GNU C Library; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
   02111-1307 USA.  */

#ifndef _GETOPT_H

#ifndef __need_getopt
# define _GETOPT_H 1
#endif

/* If __GNU_LIBRARY__ is not already defined, either we are being used
   standalone, or this is the first header included in the source file.
   If we are being used with glibc, we need to include <features.h>, but
   that does not exist if we are standalone.  So: if __GNU_LIBRARY__ is
   not defined, include <ctype.h>, which will pull in <features.h> for us
   if it's from glibc.  (Why ctype.h?  It's guaranteed to exist and it
   doesn't flood the namespace with stuff the way some other headers do.)  */
#if !defined __GNU_LIBRARY__
# include <ctype.h>
#endif

#ifdef  __cplusplus
extern "C" {
#endif

  /* For communication from `getopt' to the caller.
     When `getopt' finds an option that takes an argument,
     the argument value is returned here.
     Also, when `ordering' is RETURN_IN_ORDER,
     each non-option ARGV-element is returned here.  */

  extern char *optarg;

  /* Index in ARGV of the next element to be scanned.
     This is used for communication to and from the caller
     and for communication between successive calls to `getopt'.

     On entry to `getopt', zero means this is the first call; initialize.

     When `getopt' returns -1, this is the index of the first of the
     non-option elements that the caller should itself scan.

     Otherwise, `optind' communicates from one call to the next
     how much of ARGV has been scanned so far.  */

  extern int optind;

  /* Callers store zero here to inhibit the error message `getopt' prints
     for unrecognized options.  */

  extern int opterr;

  /* Set to an option character which was unrecognized.  */

  extern int optopt;

#ifndef __need_getopt
  /* Describe the long-named options requested by the application.
     The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
     of `struct option' terminated by an element containing a name which is
     zero.

     The field `has_arg' is:
     no_argument                (or 0) if the option does not take an argument,
     required_argument  (or 1) if the option requires an argument,
     optional_argument  (or 2) if the option takes an optional argument.

     If the field `flag' is not NULL, it points to a variable that is set
     to the value given in the field `val' when the option is found, but
     left unchanged if the option is not found.

     To have a long-named option do something other than set an `int' to
     a compiled-in constant, such as set a value from `optarg', set the
     option's `flag' field to zero and its `val' field to a nonzero
     value (the equivalent single-letter option character, if there is
     one).  For long options that have a zero `flag' field, `getopt'
     returns the contents of the `val' field.  */

  struct option
  {
# if (defined __STDC__ && __STDC__) || defined __cplusplus
    const char *name;
# else
    char *name;
# endif
    /* has_arg can't be an enum because some compilers complain about
       type mismatches in all the code that assumes it is an int.  */
    int has_arg;
    int *flag;
    int val;
  };

  /* Names for the values of the `has_arg' field of `struct option'.  */

# define no_argument            0
# define required_argument      1
# define optional_argument      2
#endif  /* need getopt */


  /* Get definitions and prototypes for functions to process the
     arguments in ARGV (ARGC of them, minus the program name) for
     options given in OPTS.

     Return the option character from OPTS just read.  Return -1 when
     there are no more options.  For unrecognized options, or options
     missing arguments, `optopt' is set to the option letter, and '?' is
     returned.

     The OPTS string is a list of characters which are recognized option
     letters, optionally followed by colons, specifying that that letter
     takes an argument, to be placed in `optarg'.

     If a letter in OPTS is followed by two colons, its argument is
     optional.  This behavior is specific to the GNU `getopt'.

     The argument `--' causes premature termination of argument
     scanning, explicitly telling `getopt' that there are no more
     options.

     If OPTS begins with `--', then non-option arguments are treated as
     arguments to the option '\0'.  This behavior is specific to the GNU
     `getopt'.  */

#if (defined __STDC__ && __STDC__) || defined __cplusplus
# ifdef __GNU_LIBRARY__
  /* Many other libraries have conflicting prototypes for getopt, with
     differences in the consts, in stdlib.h.  To avoid compilation
     errors, only prototype getopt for the GNU C library.  */
  extern int getopt (int __argc, char *const *__argv, const char *__shortopts);
# else /* not __GNU_LIBRARY__ */
  extern int getopt ();
# endif /* __GNU_LIBRARY__ */

# ifndef __need_getopt
  extern int getopt_long (int __argc, char *const *__argv, const char *__shortopts,
                          const struct option *__longopts, int *__longind);
  extern int getopt_long_only (int __argc, char *const *__argv,
                               const char *__shortopts,
                               const struct option *__longopts, int *__longind);

  /* Internal only.  Users should not call this directly.  */
  extern int _getopt_internal (int __argc, char *const *__argv,
                               const char *__shortopts,
                               const struct option *__longopts, int *__longind,
                               int __long_only);
# endif
#else /* not __STDC__ */
  extern int getopt ();
# ifndef __need_getopt
  extern int getopt_long ();
  extern int getopt_long_only ();

  extern int _getopt_internal ();
# endif
#endif /* __STDC__ */

#ifdef  __cplusplus
}
#endif

/* Make sure we later can get all the definitions and declarations.  */
#undef __need_getopt

#endif /* getopt.h */
Revision:	2204
Committed:	Fri Apr 15 22:04:00 2005 UTC (20 years, 6 months ago) by gezelter
Content type:	text/plain
File size:	6596 byte(s)
Log Message:	xemacs has been drafted to perform our indentation services
#	User	Rev	Content
1	gezelter	1541	/* Declarations for getopt.
2			Copyright (C) 1989-1994, 1996-1999, 2001 Free Software Foundation, Inc.
3			This file is part of the GNU C Library.
4
5			The GNU C Library is free software; you can redistribute it and/or
6			modify it under the terms of the GNU Lesser General Public
7			License as published by the Free Software Foundation; either
8			version 2.1 of the License, or (at your option) any later version.
9
10			The GNU C Library 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 GNU
13			Lesser General Public License for more details.
14
15			You should have received a copy of the GNU Lesser General Public
16			License along with the GNU C Library; if not, write to the Free
17			Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18			02111-1307 USA. */
19
20			#ifndef _GETOPT_H
21
22			#ifndef __need_getopt
23			# define _GETOPT_H 1
24			#endif
25
26			/* If __GNU_LIBRARY__ is not already defined, either we are being used
27			standalone, or this is the first header included in the source file.
28			If we are being used with glibc, we need to include <features.h>, but
29			that does not exist if we are standalone. So: if __GNU_LIBRARY__ is
30			not defined, include <ctype.h>, which will pull in <features.h> for us
31			if it's from glibc. (Why ctype.h? It's guaranteed to exist and it
32			doesn't flood the namespace with stuff the way some other headers do.) */
33			#if !defined __GNU_LIBRARY__
34			# include <ctype.h>
35			#endif
36
37			#ifdef __cplusplus
38			extern "C" {
39			#endif
40
41	gezelter	2204	/* For communication from `getopt' to the caller.
42			When `getopt' finds an option that takes an argument,
43			the argument value is returned here.
44			Also, when `ordering' is RETURN_IN_ORDER,
45			each non-option ARGV-element is returned here. */
46	gezelter	1541
47	gezelter	2204	extern char *optarg;
48	gezelter	1541
49	gezelter	2204	/* Index in ARGV of the next element to be scanned.
50			This is used for communication to and from the caller
51			and for communication between successive calls to `getopt'.
52	gezelter	1541
53	gezelter	2204	On entry to `getopt', zero means this is the first call; initialize.
54	gezelter	1541
55	gezelter	2204	When `getopt' returns -1, this is the index of the first of the
56			non-option elements that the caller should itself scan.
57	gezelter	1541
58	gezelter	2204	Otherwise, `optind' communicates from one call to the next
59			how much of ARGV has been scanned so far. */
60	gezelter	1541
61	gezelter	2204	extern int optind;
62	gezelter	1541
63	gezelter	2204	/* Callers store zero here to inhibit the error message `getopt' prints
64			for unrecognized options. */
65	gezelter	1541
66	gezelter	2204	extern int opterr;
67	gezelter	1541
68	gezelter	2204	/* Set to an option character which was unrecognized. */
69	gezelter	1541
70	gezelter	2204	extern int optopt;
71	gezelter	1541
72			#ifndef __need_getopt
73	gezelter	2204	/* Describe the long-named options requested by the application.
74			The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
75			of `struct option' terminated by an element containing a name which is
76			zero.
77	gezelter	1541
78	gezelter	2204	The field `has_arg' is:
79			no_argument (or 0) if the option does not take an argument,
80			required_argument (or 1) if the option requires an argument,
81			optional_argument (or 2) if the option takes an optional argument.
82	gezelter	1541
83	gezelter	2204	If the field `flag' is not NULL, it points to a variable that is set
84			to the value given in the field `val' when the option is found, but
85			left unchanged if the option is not found.
86	gezelter	1541
87	gezelter	2204	To have a long-named option do something other than set an `int' to
88			a compiled-in constant, such as set a value from `optarg', set the
89			option's `flag' field to zero and its `val' field to a nonzero
90			value (the equivalent single-letter option character, if there is
91			one). For long options that have a zero `flag' field, `getopt'
92			returns the contents of the `val' field. */
93	gezelter	1541
94	gezelter	2204	struct option
95			{
96	gezelter	1541	# if (defined __STDC__ && __STDC__) \|\| defined __cplusplus
97	gezelter	2204	const char *name;
98	gezelter	1541	# else
99	gezelter	2204	char *name;
100	gezelter	1541	# endif
101	gezelter	2204	/* has_arg can't be an enum because some compilers complain about
102			type mismatches in all the code that assumes it is an int. */
103			int has_arg;
104			int *flag;
105			int val;
106			};
107	gezelter	1541
108	gezelter	2204	/* Names for the values of the `has_arg' field of `struct option'. */
109	gezelter	1541
110			# define no_argument 0
111			# define required_argument 1
112			# define optional_argument 2
113			#endif /* need getopt */
114
115
116	gezelter	2204	/* Get definitions and prototypes for functions to process the
117			arguments in ARGV (ARGC of them, minus the program name) for
118			options given in OPTS.
119	gezelter	1541
120	gezelter	2204	Return the option character from OPTS just read. Return -1 when
121			there are no more options. For unrecognized options, or options
122			missing arguments, `optopt' is set to the option letter, and '?' is
123			returned.
124	gezelter	1541
125	gezelter	2204	The OPTS string is a list of characters which are recognized option
126			letters, optionally followed by colons, specifying that that letter
127			takes an argument, to be placed in `optarg'.
128	gezelter	1541
129	gezelter	2204	If a letter in OPTS is followed by two colons, its argument is
130			optional. This behavior is specific to the GNU `getopt'.
131	gezelter	1541
132	gezelter	2204	The argument `--' causes premature termination of argument
133			scanning, explicitly telling `getopt' that there are no more
134			options.
135	gezelter	1541
136	gezelter	2204	If OPTS begins with `--', then non-option arguments are treated as
137			arguments to the option '\0'. This behavior is specific to the GNU
138			`getopt'. */
139	gezelter	1541
140			#if (defined __STDC__ && __STDC__) \|\| defined __cplusplus
141			# ifdef __GNU_LIBRARY__
142	gezelter	2204	/* Many other libraries have conflicting prototypes for getopt, with
143			differences in the consts, in stdlib.h. To avoid compilation
144			errors, only prototype getopt for the GNU C library. */
145			extern int getopt (int __argc, char const __argv, const char *__shortopts);
146	gezelter	1541	# else /* not __GNU_LIBRARY__ */
147	gezelter	2204	extern int getopt ();
148	gezelter	1541	# endif /* __GNU_LIBRARY__ */
149
150			# ifndef __need_getopt
151	gezelter	2204	extern int getopt_long (int __argc, char const __argv, const char *__shortopts,
152			const struct option __longopts, int __longind);
153			extern int getopt_long_only (int __argc, char const __argv,
154			const char *__shortopts,
155			const struct option __longopts, int __longind);
156	gezelter	1541
157	gezelter	2204	/* Internal only. Users should not call this directly. */
158			extern int _getopt_internal (int __argc, char const __argv,
159			const char *__shortopts,
160			const struct option __longopts, int __longind,
161			int __long_only);
162	gezelter	1541	# endif
163			#else /* not __STDC__ */
164	gezelter	2204	extern int getopt ();
165	gezelter	1541	# ifndef __need_getopt
166	gezelter	2204	extern int getopt_long ();
167			extern int getopt_long_only ();
168	gezelter	1541
169	gezelter	2204	extern int _getopt_internal ();
170	gezelter	1541	# endif
171			#endif /* __STDC__ */
172
173			#ifdef __cplusplus
174			}
175			#endif
176
177			/* Make sure we later can get all the definitions and declarations. */
178			#undef __need_getopt
179
180			#endif /* getopt.h */