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