|
398
|
1 /* Declarations for getopt.
|
|
|
2 Copyright (C) 1989-1994, 1996-1999, 2001, 2003-2007, 2009-2010 Free Software
|
|
|
3 Foundation, Inc.
|
|
|
4 This file is part of the GNU C Library.
|
|
|
5
|
|
|
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.
|
|
|
10
|
|
|
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.
|
|
|
15
|
|
|
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/>. */
|
|
|
18
|
|
|
19 #ifndef _GL_GETOPT_H
|
|
|
20
|
|
|
21 #if __GNUC__ >= 3
|
|
|
22 @PRAGMA_SYSTEM_HEADER@
|
|
|
23 #endif
|
|
|
24
|
|
|
25 /* The include_next requires a split double-inclusion guard. We must
|
|
|
26 also inform the replacement unistd.h to not recursively use
|
|
|
27 <getopt.h>; our definitions will be present soon enough. */
|
|
|
28 #if @HAVE_GETOPT_H@
|
|
|
29 # define _GL_SYSTEM_GETOPT
|
|
|
30 # @INCLUDE_NEXT@ @NEXT_GETOPT_H@
|
|
|
31 # undef _GL_SYSTEM_GETOPT
|
|
|
32 #endif
|
|
|
33
|
|
|
34 #ifndef _GL_GETOPT_H
|
|
|
35
|
|
|
36 #ifndef __need_getopt
|
|
|
37 # define _GL_GETOPT_H 1
|
|
|
38 #endif
|
|
|
39
|
|
|
40 /* Standalone applications should #define __GETOPT_PREFIX to an
|
|
|
41 identifier that prefixes the external functions and variables
|
|
|
42 defined in this header. When this happens, include the
|
|
|
43 headers that might declare getopt so that they will not cause
|
|
|
44 confusion if included after this file (if the system had <getopt.h>,
|
|
|
45 we have already included it). Then systematically rename
|
|
|
46 identifiers so that they do not collide with the system functions
|
|
|
47 and variables. Renaming avoids problems with some compilers and
|
|
|
48 linkers. */
|
|
|
49 #if defined __GETOPT_PREFIX && !defined __need_getopt
|
|
|
50 # if !@HAVE_GETOPT_H@
|
|
|
51 # include <stdlib.h>
|
|
|
52 # include <stdio.h>
|
|
|
53 # include <unistd.h>
|
|
|
54 # endif
|
|
|
55 # undef __need_getopt
|
|
|
56 # undef getopt
|
|
|
57 # undef getopt_long
|
|
|
58 # undef getopt_long_only
|
|
|
59 # undef optarg
|
|
|
60 # undef opterr
|
|
|
61 # undef optind
|
|
|
62 # undef optopt
|
|
|
63 # undef option
|
|
|
64 # define __GETOPT_CONCAT(x, y) x ## y
|
|
|
65 # define __GETOPT_XCONCAT(x, y) __GETOPT_CONCAT (x, y)
|
|
|
66 # define __GETOPT_ID(y) __GETOPT_XCONCAT (__GETOPT_PREFIX, y)
|
|
|
67 # define getopt __GETOPT_ID (getopt)
|
|
|
68 # define getopt_long __GETOPT_ID (getopt_long)
|
|
|
69 # define getopt_long_only __GETOPT_ID (getopt_long_only)
|
|
|
70 # define optarg __GETOPT_ID (optarg)
|
|
|
71 # define opterr __GETOPT_ID (opterr)
|
|
|
72 # define optind __GETOPT_ID (optind)
|
|
|
73 # define optopt __GETOPT_ID (optopt)
|
|
|
74 # define option __GETOPT_ID (option)
|
|
|
75 # define _getopt_internal __GETOPT_ID (getopt_internal)
|
|
|
76 #endif
|
|
|
77
|
|
|
78 /* Standalone applications get correct prototypes for getopt_long and
|
|
|
79 getopt_long_only; they declare "char **argv". libc uses prototypes
|
|
|
80 with "char *const *argv" that are incorrect because getopt_long and
|
|
|
81 getopt_long_only can permute argv; this is required for backward
|
|
|
82 compatibility (e.g., for LSB 2.0.1).
|
|
|
83
|
|
|
84 This used to be `#if defined __GETOPT_PREFIX && !defined __need_getopt',
|
|
|
85 but it caused redefinition warnings if both unistd.h and getopt.h were
|
|
|
86 included, since unistd.h includes getopt.h having previously defined
|
|
|
87 __need_getopt.
|
|
|
88
|
|
|
89 The only place where __getopt_argv_const is used is in definitions
|
|
|
90 of getopt_long and getopt_long_only below, but these are visible
|
|
|
91 only if __need_getopt is not defined, so it is quite safe to rewrite
|
|
|
92 the conditional as follows:
|
|
|
93 */
|
|
|
94 #if !defined __need_getopt
|
|
|
95 # if defined __GETOPT_PREFIX
|
|
|
96 # define __getopt_argv_const /* empty */
|
|
|
97 # else
|
|
|
98 # define __getopt_argv_const const
|
|
|
99 # endif
|
|
|
100 #endif
|
|
|
101
|
|
|
102 /* If __GNU_LIBRARY__ is not already defined, either we are being used
|
|
|
103 standalone, or this is the first header included in the source file.
|
|
|
104 If we are being used with glibc, we need to include <features.h>, but
|
|
|
105 that does not exist if we are standalone. So: if __GNU_LIBRARY__ is
|
|
|
106 not defined, include <ctype.h>, which will pull in <features.h> for us
|
|
|
107 if it's from glibc. (Why ctype.h? It's guaranteed to exist and it
|
|
|
108 doesn't flood the namespace with stuff the way some other headers do.) */
|
|
|
109 #if !defined __GNU_LIBRARY__
|
|
|
110 # include <ctype.h>
|
|
|
111 #endif
|
|
|
112
|
|
|
113 #ifndef __THROW
|
|
|
114 # ifndef __GNUC_PREREQ
|
|
|
115 # define __GNUC_PREREQ(maj, min) (0)
|
|
|
116 # endif
|
|
|
117 # if defined __cplusplus && __GNUC_PREREQ (2,8)
|
|
|
118 # define __THROW throw ()
|
|
|
119 # else
|
|
|
120 # define __THROW
|
|
|
121 # endif
|
|
|
122 #endif
|
|
|
123
|
|
|
124 /* The definition of _GL_ARG_NONNULL is copied here. */
|
|
|
125
|
|
|
126 #ifdef __cplusplus
|
|
|
127 extern "C" {
|
|
|
128 #endif
|
|
|
129
|
|
|
130 /* For communication from `getopt' to the caller.
|
|
|
131 When `getopt' finds an option that takes an argument,
|
|
|
132 the argument value is returned here.
|
|
|
133 Also, when `ordering' is RETURN_IN_ORDER,
|
|
|
134 each non-option ARGV-element is returned here. */
|
|
|
135
|
|
|
136 extern char *optarg;
|
|
|
137
|
|
|
138 /* Index in ARGV of the next element to be scanned.
|
|
|
139 This is used for communication to and from the caller
|
|
|
140 and for communication between successive calls to `getopt'.
|
|
|
141
|
|
|
142 On entry to `getopt', zero means this is the first call; initialize.
|
|
|
143
|
|
|
144 When `getopt' returns -1, this is the index of the first of the
|
|
|
145 non-option elements that the caller should itself scan.
|
|
|
146
|
|
|
147 Otherwise, `optind' communicates from one call to the next
|
|
|
148 how much of ARGV has been scanned so far. */
|
|
|
149
|
|
|
150 extern int optind;
|
|
|
151
|
|
|
152 /* Callers store zero here to inhibit the error message `getopt' prints
|
|
|
153 for unrecognized options. */
|
|
|
154
|
|
|
155 extern int opterr;
|
|
|
156
|
|
|
157 /* Set to an option character which was unrecognized. */
|
|
|
158
|
|
|
159 extern int optopt;
|
|
|
160
|
|
|
161 #ifndef __need_getopt
|
|
|
162 /* Describe the long-named options requested by the application.
|
|
|
163 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
|
|
|
164 of `struct option' terminated by an element containing a name which is
|
|
|
165 zero.
|
|
|
166
|
|
|
167 The field `has_arg' is:
|
|
|
168 no_argument (or 0) if the option does not take an argument,
|
|
|
169 required_argument (or 1) if the option requires an argument,
|
|
|
170 optional_argument (or 2) if the option takes an optional argument.
|
|
|
171
|
|
|
172 If the field `flag' is not NULL, it points to a variable that is set
|
|
|
173 to the value given in the field `val' when the option is found, but
|
|
|
174 left unchanged if the option is not found.
|
|
|
175
|
|
|
176 To have a long-named option do something other than set an `int' to
|
|
|
177 a compiled-in constant, such as set a value from `optarg', set the
|
|
|
178 option's `flag' field to zero and its `val' field to a nonzero
|
|
|
179 value (the equivalent single-letter option character, if there is
|
|
|
180 one). For long options that have a zero `flag' field, `getopt'
|
|
|
181 returns the contents of the `val' field. */
|
|
|
182
|
|
|
183 struct option
|
|
|
184 {
|
|
|
185 const char *name;
|
|
|
186 /* has_arg can't be an enum because some compilers complain about
|
|
|
187 type mismatches in all the code that assumes it is an int. */
|
|
|
188 int has_arg;
|
|
|
189 int *flag;
|
|
|
190 int val;
|
|
|
191 };
|
|
|
192
|
|
|
193 /* Names for the values of the `has_arg' field of `struct option'. */
|
|
|
194
|
|
|
195 # define no_argument 0
|
|
|
196 # define required_argument 1
|
|
|
197 # define optional_argument 2
|
|
|
198 #endif /* need getopt */
|
|
|
199
|
|
|
200
|
|
|
201 /* Get definitions and prototypes for functions to process the
|
|
|
202 arguments in ARGV (ARGC of them, minus the program name) for
|
|
|
203 options given in OPTS.
|
|
|
204
|
|
|
205 Return the option character from OPTS just read. Return -1 when
|
|
|
206 there are no more options. For unrecognized options, or options
|
|
|
207 missing arguments, `optopt' is set to the option letter, and '?' is
|
|
|
208 returned.
|
|
|
209
|
|
|
210 The OPTS string is a list of characters which are recognized option
|
|
|
211 letters, optionally followed by colons, specifying that that letter
|
|
|
212 takes an argument, to be placed in `optarg'.
|
|
|
213
|
|
|
214 If a letter in OPTS is followed by two colons, its argument is
|
|
|
215 optional. This behavior is specific to the GNU `getopt'.
|
|
|
216
|
|
|
217 The argument `--' causes premature termination of argument
|
|
|
218 scanning, explicitly telling `getopt' that there are no more
|
|
|
219 options.
|
|
|
220
|
|
|
221 If OPTS begins with `-', then non-option arguments are treated as
|
|
|
222 arguments to the option '\1'. This behavior is specific to the GNU
|
|
|
223 `getopt'. If OPTS begins with `+', or POSIXLY_CORRECT is set in
|
|
|
224 the environment, then do not permute arguments. */
|
|
|
225
|
|
|
226 extern int getopt (int ___argc, char *const *___argv, const char *__shortopts)
|
|
|
227 __THROW _GL_ARG_NONNULL ((2, 3));
|
|
|
228
|
|
|
229 #ifndef __need_getopt
|
|
|
230 extern int getopt_long (int ___argc, char *__getopt_argv_const *___argv,
|
|
|
231 const char *__shortopts,
|
|
|
232 const struct option *__longopts, int *__longind)
|
|
|
233 __THROW _GL_ARG_NONNULL ((2, 3));
|
|
|
234 extern int getopt_long_only (int ___argc, char *__getopt_argv_const *___argv,
|
|
|
235 const char *__shortopts,
|
|
|
236 const struct option *__longopts, int *__longind)
|
|
|
237 __THROW _GL_ARG_NONNULL ((2, 3));
|
|
|
238
|
|
|
239 #endif
|
|
|
240
|
|
|
241 #ifdef __cplusplus
|
|
|
242 }
|
|
|
243 #endif
|
|
|
244
|
|
|
245 /* Make sure we later can get all the definitions and declarations. */
|
|
|
246 #undef __need_getopt
|
|
|
247
|
|
|
248 #endif /* getopt.h */
|
|
|
249 #endif /* getopt.h */
|
