1 /* Declarations for getopt.
2 Copyright (C) 1989-2014 Free Software Foundation, Inc.
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/>. */
25 /* Standalone applications should #define __GETOPT_PREFIX to an
26 identifier that prefixes the external functions and variables
27 defined in this header. When this happens, include the
28 headers that might declare getopt so that they will not cause
29 confusion if included after this file. Then systematically rename
30 identifiers so that they do not collide with the system functions
31 and variables. Renaming avoids problems with some compilers and
33 #if defined __GETOPT_PREFIX && !defined __need_getopt
42 # undef getopt_long_only
47 # define __GETOPT_CONCAT(x, y) x ## y
48 # define __GETOPT_XCONCAT(x, y) __GETOPT_CONCAT (x, y)
49 # define __GETOPT_ID(y) __GETOPT_XCONCAT (__GETOPT_PREFIX, y)
50 # define getopt __GETOPT_ID (getopt)
51 # define getopt_long __GETOPT_ID (getopt_long)
52 # define getopt_long_only __GETOPT_ID (getopt_long_only)
53 # define optarg __GETOPT_ID (optarg)
54 # define opterr __GETOPT_ID (opterr)
55 # define optind __GETOPT_ID (optind)
56 # define optopt __GETOPT_ID (optopt)
59 /* Standalone applications get correct prototypes for getopt_long and
60 getopt_long_only; they declare "char **argv". libc uses prototypes
61 with "char *const *argv" that are incorrect because getopt_long and
62 getopt_long_only can permute argv; this is required for backward
63 compatibility (e.g., for LSB 2.0.1).
65 This used to be `#if defined __GETOPT_PREFIX && !defined __need_getopt',
66 but it caused redefinition warnings if both unistd.h and getopt.h were
67 included, since unistd.h includes getopt.h having previously defined
70 The only place where __getopt_argv_const is used is in definitions
71 of getopt_long and getopt_long_only below, but these are visible
72 only if __need_getopt is not defined, so it is quite safe to rewrite
73 the conditional as follows:
75 #if !defined __need_getopt
76 # if defined __GETOPT_PREFIX
77 # define __getopt_argv_const /* empty */
79 # define __getopt_argv_const const
83 /* If __GNU_LIBRARY__ is not already defined, either we are being used
84 standalone, or this is the first header included in the source file.
85 If we are being used with glibc, we need to include <features.h>, but
86 that does not exist if we are standalone. So: if __GNU_LIBRARY__ is
87 not defined, include <ctype.h>, which will pull in <features.h> for us
88 if it's from glibc. (Why ctype.h? It's guaranteed to exist and it
89 doesn't flood the namespace with stuff the way some other headers do.) */
90 #if !defined __GNU_LIBRARY__
95 # ifndef __GNUC_PREREQ
96 # define __GNUC_PREREQ(maj, min) (0)
98 # if defined __cplusplus && __GNUC_PREREQ (2,8)
99 # define __THROW throw ()
109 /* For communication from `getopt' to the caller.
110 When `getopt' finds an option that takes an argument,
111 the argument value is returned here.
112 Also, when `ordering' is RETURN_IN_ORDER,
113 each non-option ARGV-element is returned here. */
117 /* Index in ARGV of the next element to be scanned.
118 This is used for communication to and from the caller
119 and for communication between successive calls to `getopt'.
121 On entry to `getopt', zero means this is the first call; initialize.
123 When `getopt' returns -1, this is the index of the first of the
124 non-option elements that the caller should itself scan.
126 Otherwise, `optind' communicates from one call to the next
127 how much of ARGV has been scanned so far. */
131 /* Callers store zero here to inhibit the error message `getopt' prints
132 for unrecognized options. */
136 /* Set to an option character which was unrecognized. */
140 #ifndef __need_getopt
141 /* Describe the long-named options requested by the application.
142 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
143 of `struct option' terminated by an element containing a name which is
146 The field `has_arg' is:
147 no_argument (or 0) if the option does not take an argument,
148 required_argument (or 1) if the option requires an argument,
149 optional_argument (or 2) if the option takes an optional argument.
151 If the field `flag' is not NULL, it points to a variable that is set
152 to the value given in the field `val' when the option is found, but
153 left unchanged if the option is not found.
155 To have a long-named option do something other than set an `int' to
156 a compiled-in constant, such as set a value from `optarg', set the
157 option's `flag' field to zero and its `val' field to a nonzero
158 value (the equivalent single-letter option character, if there is
159 one). For long options that have a zero `flag' field, `getopt'
160 returns the contents of the `val' field. */
165 /* has_arg can't be an enum because some compilers complain about
166 type mismatches in all the code that assumes it is an int. */
172 /* Names for the values of the `has_arg' field of `struct option'. */
174 # define no_argument 0
175 # define required_argument 1
176 # define optional_argument 2
177 #endif /* need getopt */
180 /* Get definitions and prototypes for functions to process the
181 arguments in ARGV (ARGC of them, minus the program name) for
182 options given in OPTS.
184 Return the option character from OPTS just read. Return -1 when
185 there are no more options. For unrecognized options, or options
186 missing arguments, `optopt' is set to the option letter, and '?' is
189 The OPTS string is a list of characters which are recognized option
190 letters, optionally followed by colons, specifying that that letter
191 takes an argument, to be placed in `optarg'.
193 If a letter in OPTS is followed by two colons, its argument is
194 optional. This behavior is specific to the GNU `getopt'.
196 The argument `--' causes premature termination of argument
197 scanning, explicitly telling `getopt' that there are no more
200 If OPTS begins with `--', then non-option arguments are treated as
201 arguments to the option '\0'. This behavior is specific to the GNU
204 extern int getopt (int ___argc, char *const *___argv, const char *__shortopts)
207 #ifndef __need_getopt
208 extern int getopt_long (int ___argc, char *__getopt_argv_const *___argv,
209 const char *__shortopts,
210 const struct option *__longopts, int *__longind)
212 extern int getopt_long_only (int ___argc, char *__getopt_argv_const *___argv,
213 const char *__shortopts,
214 const struct option *__longopts, int *__longind)
223 /* Make sure we later can get all the definitions and declarations. */
226 #endif /* getopt.h */