1 /* -*- buffer-read-only: t -*- vi: set ro: */
2 /* DO NOT EDIT! GENERATED AUTOMATICALLY! */
3 /* Declarations for getopt.
4 Copyright (C) 1989-1994, 1996-1999, 2001, 2003-2007, 2009-2010 Free Software
6 This file is part of the GNU C Library.
8 This program is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 @PRAGMA_SYSTEM_HEADER@
27 /* The include_next requires a split double-inclusion guard. We must
28 also inform the replacement unistd.h to not recursively use
29 <getopt.h>; our definitions will be present soon enough. */
31 # define _GL_SYSTEM_GETOPT
32 # @INCLUDE_NEXT@ @NEXT_GETOPT_H@
33 # undef _GL_SYSTEM_GETOPT
39 # define _GL_GETOPT_H 1
42 /* Standalone applications should #define __GETOPT_PREFIX to an
43 identifier that prefixes the external functions and variables
44 defined in this header. When this happens, include the
45 headers that might declare getopt so that they will not cause
46 confusion if included after this file (if the system had <getopt.h>,
47 we have already included it). Then systematically rename
48 identifiers so that they do not collide with the system functions
49 and variables. Renaming avoids problems with some compilers and
51 #if defined __GETOPT_PREFIX && !defined __need_getopt
60 # undef getopt_long_only
66 # define __GETOPT_CONCAT(x, y) x ## y
67 # define __GETOPT_XCONCAT(x, y) __GETOPT_CONCAT (x, y)
68 # define __GETOPT_ID(y) __GETOPT_XCONCAT (__GETOPT_PREFIX, y)
69 # define getopt __GETOPT_ID (getopt)
70 # define getopt_long __GETOPT_ID (getopt_long)
71 # define getopt_long_only __GETOPT_ID (getopt_long_only)
72 # define optarg __GETOPT_ID (optarg)
73 # define opterr __GETOPT_ID (opterr)
74 # define optind __GETOPT_ID (optind)
75 # define optopt __GETOPT_ID (optopt)
76 # define option __GETOPT_ID (option)
77 # define _getopt_internal __GETOPT_ID (getopt_internal)
80 /* Standalone applications get correct prototypes for getopt_long and
81 getopt_long_only; they declare "char **argv". libc uses prototypes
82 with "char *const *argv" that are incorrect because getopt_long and
83 getopt_long_only can permute argv; this is required for backward
84 compatibility (e.g., for LSB 2.0.1).
86 This used to be `#if defined __GETOPT_PREFIX && !defined __need_getopt',
87 but it caused redefinition warnings if both unistd.h and getopt.h were
88 included, since unistd.h includes getopt.h having previously defined
91 The only place where __getopt_argv_const is used is in definitions
92 of getopt_long and getopt_long_only below, but these are visible
93 only if __need_getopt is not defined, so it is quite safe to rewrite
94 the conditional as follows:
96 #if !defined __need_getopt
97 # if defined __GETOPT_PREFIX
98 # define __getopt_argv_const /* empty */
100 # define __getopt_argv_const const
104 /* If __GNU_LIBRARY__ is not already defined, either we are being used
105 standalone, or this is the first header included in the source file.
106 If we are being used with glibc, we need to include <features.h>, but
107 that does not exist if we are standalone. So: if __GNU_LIBRARY__ is
108 not defined, include <ctype.h>, which will pull in <features.h> for us
109 if it's from glibc. (Why ctype.h? It's guaranteed to exist and it
110 doesn't flood the namespace with stuff the way some other headers do.) */
111 #if !defined __GNU_LIBRARY__
116 # ifndef __GNUC_PREREQ
117 # define __GNUC_PREREQ(maj, min) (0)
119 # if defined __cplusplus && __GNUC_PREREQ (2,8)
120 # define __THROW throw ()
126 /* The definition of _GL_ARG_NONNULL is copied here. */
132 /* For communication from `getopt' to the caller.
133 When `getopt' finds an option that takes an argument,
134 the argument value is returned here.
135 Also, when `ordering' is RETURN_IN_ORDER,
136 each non-option ARGV-element is returned here. */
140 /* Index in ARGV of the next element to be scanned.
141 This is used for communication to and from the caller
142 and for communication between successive calls to `getopt'.
144 On entry to `getopt', zero means this is the first call; initialize.
146 When `getopt' returns -1, this is the index of the first of the
147 non-option elements that the caller should itself scan.
149 Otherwise, `optind' communicates from one call to the next
150 how much of ARGV has been scanned so far. */
154 /* Callers store zero here to inhibit the error message `getopt' prints
155 for unrecognized options. */
159 /* Set to an option character which was unrecognized. */
163 #ifndef __need_getopt
164 /* Describe the long-named options requested by the application.
165 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
166 of `struct option' terminated by an element containing a name which is
169 The field `has_arg' is:
170 no_argument (or 0) if the option does not take an argument,
171 required_argument (or 1) if the option requires an argument,
172 optional_argument (or 2) if the option takes an optional argument.
174 If the field `flag' is not NULL, it points to a variable that is set
175 to the value given in the field `val' when the option is found, but
176 left unchanged if the option is not found.
178 To have a long-named option do something other than set an `int' to
179 a compiled-in constant, such as set a value from `optarg', set the
180 option's `flag' field to zero and its `val' field to a nonzero
181 value (the equivalent single-letter option character, if there is
182 one). For long options that have a zero `flag' field, `getopt'
183 returns the contents of the `val' field. */
188 /* has_arg can't be an enum because some compilers complain about
189 type mismatches in all the code that assumes it is an int. */
195 /* Names for the values of the `has_arg' field of `struct option'. */
197 # define no_argument 0
198 # define required_argument 1
199 # define optional_argument 2
200 #endif /* need getopt */
203 /* Get definitions and prototypes for functions to process the
204 arguments in ARGV (ARGC of them, minus the program name) for
205 options given in OPTS.
207 Return the option character from OPTS just read. Return -1 when
208 there are no more options. For unrecognized options, or options
209 missing arguments, `optopt' is set to the option letter, and '?' is
212 The OPTS string is a list of characters which are recognized option
213 letters, optionally followed by colons, specifying that that letter
214 takes an argument, to be placed in `optarg'.
216 If a letter in OPTS is followed by two colons, its argument is
217 optional. This behavior is specific to the GNU `getopt'.
219 The argument `--' causes premature termination of argument
220 scanning, explicitly telling `getopt' that there are no more
223 If OPTS begins with `-', then non-option arguments are treated as
224 arguments to the option '\1'. This behavior is specific to the GNU
225 `getopt'. If OPTS begins with `+', or POSIXLY_CORRECT is set in
226 the environment, then do not permute arguments. */
228 extern int getopt (int ___argc, char *const *___argv, const char *__shortopts)
229 __THROW _GL_ARG_NONNULL ((2, 3));
231 #ifndef __need_getopt
232 extern int getopt_long (int ___argc, char *__getopt_argv_const *___argv,
233 const char *__shortopts,
234 const struct option *__longopts, int *__longind)
235 __THROW _GL_ARG_NONNULL ((2, 3));
236 extern int getopt_long_only (int ___argc, char *__getopt_argv_const *___argv,
237 const char *__shortopts,
238 const struct option *__longopts, int *__longind)
239 __THROW _GL_ARG_NONNULL ((2, 3));
247 /* Make sure we later can get all the definitions and declarations. */
250 #endif /* getopt.h */
251 #endif /* getopt.h */