1 /* Declarations for getopt.
2 Copyright (C) 1989-1994, 1996-1999, 2001, 2003-2007, 2009-2015 Free Software
4 This file is part of the GNU C Library.
6 This program is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19 #ifndef _@GUARD_PREFIX@_GETOPT_H
22 @PRAGMA_SYSTEM_HEADER@
26 /* The include_next requires a split double-inclusion guard. We must
27 also inform the replacement unistd.h to not recursively use
28 <getopt.h>; our definitions will be present soon enough. */
30 # define _GL_SYSTEM_GETOPT
31 # @INCLUDE_NEXT@ @NEXT_GETOPT_H@
32 # undef _GL_SYSTEM_GETOPT
35 #ifndef _@GUARD_PREFIX@_GETOPT_H
38 # define _@GUARD_PREFIX@_GETOPT_H 1
41 /* Ensure that DLL_VARIABLE is defined. Since on OSF/1 4.0 and Irix 6.5
42 <stdlib.h> includes <getopt.h>, and <config.h> is not a prerequisite for
43 using <stdlib.h>, this file can be included without a prior
44 "#include <config.h>". */
49 /* Standalone applications should #define __GETOPT_PREFIX to an
50 identifier that prefixes the external functions and variables
51 defined in this header. When this happens, include the
52 headers that might declare getopt so that they will not cause
53 confusion if included after this file (if the system had <getopt.h>,
54 we have already included it). Then systematically rename
55 identifiers so that they do not collide with the system functions
56 and variables. Renaming avoids problems with some compilers and
58 #if defined __GETOPT_PREFIX && !defined __need_getopt
60 # define __need_system_stdlib_h
62 # undef __need_system_stdlib_h
69 # undef getopt_long_only
75 # define __GETOPT_CONCAT(x, y) x ## y
76 # define __GETOPT_XCONCAT(x, y) __GETOPT_CONCAT (x, y)
77 # define __GETOPT_ID(y) __GETOPT_XCONCAT (__GETOPT_PREFIX, y)
78 # define getopt __GETOPT_ID (getopt)
79 # define getopt_long __GETOPT_ID (getopt_long)
80 # define getopt_long_only __GETOPT_ID (getopt_long_only)
81 # define optarg __GETOPT_ID (optarg)
82 # define opterr __GETOPT_ID (opterr)
83 # define optind __GETOPT_ID (optind)
84 # define optopt __GETOPT_ID (optopt)
85 # define option __GETOPT_ID (option)
86 # define _getopt_internal __GETOPT_ID (getopt_internal)
89 /* Standalone applications get correct prototypes for getopt_long and
90 getopt_long_only; they declare "char **argv". libc uses prototypes
91 with "char *const *argv" that are incorrect because getopt_long and
92 getopt_long_only can permute argv; this is required for backward
93 compatibility (e.g., for LSB 2.0.1).
95 This used to be '#if defined __GETOPT_PREFIX && !defined __need_getopt',
96 but it caused redefinition warnings if both unistd.h and getopt.h were
97 included, since unistd.h includes getopt.h having previously defined
100 The only place where __getopt_argv_const is used is in definitions
101 of getopt_long and getopt_long_only below, but these are visible
102 only if __need_getopt is not defined, so it is quite safe to rewrite
103 the conditional as follows:
105 #if !defined __need_getopt
106 # if defined __GETOPT_PREFIX
107 # define __getopt_argv_const /* empty */
109 # define __getopt_argv_const const
113 /* If __GNU_LIBRARY__ is not already defined, either we are being used
114 standalone, or this is the first header included in the source file.
115 If we are being used with glibc, we need to include <features.h>, but
116 that does not exist if we are standalone. So: if __GNU_LIBRARY__ is
117 not defined, include <ctype.h>, which will pull in <features.h> for us
118 if it's from glibc. (Why ctype.h? It's guaranteed to exist and it
119 doesn't flood the namespace with stuff the way some other headers do.) */
120 #if !defined __GNU_LIBRARY__
125 # ifndef __GNUC_PREREQ
126 # define __GNUC_PREREQ(maj, min) (0)
128 # if defined __cplusplus && __GNUC_PREREQ (2,8)
129 # define __THROW throw ()
135 /* The definition of _GL_ARG_NONNULL is copied here. */
141 /* For communication from 'getopt' to the caller.
142 When 'getopt' finds an option that takes an argument,
143 the argument value is returned here.
144 Also, when 'ordering' is RETURN_IN_ORDER,
145 each non-option ARGV-element is returned here. */
147 extern DLL_VARIABLE char *optarg;
149 /* Index in ARGV of the next element to be scanned.
150 This is used for communication to and from the caller
151 and for communication between successive calls to 'getopt'.
153 On entry to 'getopt', zero means this is the first call; initialize.
155 When 'getopt' returns -1, this is the index of the first of the
156 non-option elements that the caller should itself scan.
158 Otherwise, 'optind' communicates from one call to the next
159 how much of ARGV has been scanned so far. */
161 extern DLL_VARIABLE int optind;
163 /* Callers store zero here to inhibit the error message 'getopt' prints
164 for unrecognized options. */
166 extern DLL_VARIABLE int opterr;
168 /* Set to an option character which was unrecognized. */
170 extern DLL_VARIABLE int optopt;
172 #ifndef __need_getopt
173 /* Describe the long-named options requested by the application.
174 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
175 of 'struct option' terminated by an element containing a name which is
178 The field 'has_arg' is:
179 no_argument (or 0) if the option does not take an argument,
180 required_argument (or 1) if the option requires an argument,
181 optional_argument (or 2) if the option takes an optional argument.
183 If the field 'flag' is not NULL, it points to a variable that is set
184 to the value given in the field 'val' when the option is found, but
185 left unchanged if the option is not found.
187 To have a long-named option do something other than set an 'int' to
188 a compiled-in constant, such as set a value from 'optarg', set the
189 option's 'flag' field to zero and its 'val' field to a nonzero
190 value (the equivalent single-letter option character, if there is
191 one). For long options that have a zero 'flag' field, 'getopt'
192 returns the contents of the 'val' field. */
194 # if !GNULIB_defined_struct_option
198 /* has_arg can't be an enum because some compilers complain about
199 type mismatches in all the code that assumes it is an int. */
204 # define GNULIB_defined_struct_option 1
207 /* Names for the values of the 'has_arg' field of 'struct option'. */
209 # define no_argument 0
210 # define required_argument 1
211 # define optional_argument 2
212 #endif /* need getopt */
215 /* Get definitions and prototypes for functions to process the
216 arguments in ARGV (ARGC of them, minus the program name) for
217 options given in OPTS.
219 Return the option character from OPTS just read. Return -1 when
220 there are no more options. For unrecognized options, or options
221 missing arguments, 'optopt' is set to the option letter, and '?' is
224 The OPTS string is a list of characters which are recognized option
225 letters, optionally followed by colons, specifying that that letter
226 takes an argument, to be placed in 'optarg'.
228 If a letter in OPTS is followed by two colons, its argument is
229 optional. This behavior is specific to the GNU 'getopt'.
231 The argument '--' causes premature termination of argument
232 scanning, explicitly telling 'getopt' that there are no more
235 If OPTS begins with '-', then non-option arguments are treated as
236 arguments to the option '\1'. This behavior is specific to the GNU
237 'getopt'. If OPTS begins with '+', or POSIXLY_CORRECT is set in
238 the environment, then do not permute arguments. */
240 extern int getopt (int ___argc, char *const *___argv, const char *__shortopts)
241 __THROW _GL_ARG_NONNULL ((2, 3));
243 #ifndef __need_getopt
244 extern int getopt_long (int ___argc, char *__getopt_argv_const *___argv,
245 const char *__shortopts,
246 const struct option *__longopts, int *__longind)
247 __THROW _GL_ARG_NONNULL ((2, 3));
248 extern int getopt_long_only (int ___argc, char *__getopt_argv_const *___argv,
249 const char *__shortopts,
250 const struct option *__longopts, int *__longind)
251 __THROW _GL_ARG_NONNULL ((2, 3));
259 /* Make sure we later can get all the definitions and declarations. */
262 #endif /* _@GUARD_PREFIX@_GETOPT_H */
263 #endif /* _@GUARD_PREFIX@_GETOPT_H */