aboutsummaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorJoakim Verona2013-01-12 00:04:04 +0100
committerJoakim Verona2013-01-12 00:04:04 +0100
commitc655adbbab4baf73b652c86dcc53a2fc049ea7a5 (patch)
treeb3198033222acb2c309652a0e11590f109d037c6 /lib
parent26f277ba01010776e63623d446f182f5b6f23dd3 (diff)
parentc88be99696aa39e3aed1e32ada7bf6e0cc472c90 (diff)
downloademacs-c655adbbab4baf73b652c86dcc53a2fc049ea7a5.tar.gz
emacs-c655adbbab4baf73b652c86dcc53a2fc049ea7a5.zip
auto upstream
Diffstat (limited to 'lib')
-rw-r--r--lib/getopt_.h568
1 files changed, 285 insertions, 283 deletions
diff --git a/lib/getopt_.h b/lib/getopt_.h
index 3f602dba2c6..10edb73f417 100644
--- a/lib/getopt_.h
+++ b/lib/getopt_.h
@@ -1,283 +1,285 @@
1/* Declarations for getopt. 1/* Declarations for getopt.
2 Copyright (C) 1989-1994, 1996-1999, 2001, 2003-2007, 2009-2013 Free 2 Copyright (C) 1989-1994, 1996-1999, 2001, 2003-2007, 2009-2013 Free Software
3 Software Foundation, Inc. 3 Foundation, Inc.
4 This file is part of the GNU C Library. 4 This file is part of the GNU C Library.
5 5
6 This program is free software: you can redistribute it and/or modify 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 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 8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version. 9 (at your option) any later version.
10 10
11 This program is distributed in the hope that it will be useful, 11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of 12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details. 14 GNU General Public License for more details.
15 15
16 You should have received a copy of the GNU General Public License 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/>. */ 17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
18 18
19#ifndef _GL_GETOPT_H 19#ifndef _GL_GETOPT_H
20 20
21#if __GNUC__ >= 3 21#if __GNUC__ >= 3
22#pragma GCC system_header 22#pragma GCC system_header
23#endif 23#endif
24 24
25 25
26/* The include_next requires a split double-inclusion guard. We must 26/* The include_next requires a split double-inclusion guard. We must
27 also inform the replacement unistd.h to not recursively use 27 also inform the replacement unistd.h to not recursively use
28 <getopt.h>; our definitions will be present soon enough. */ 28 <getopt.h>; our definitions will be present soon enough. */
29#if HAVE_GETOPT_H 29#if HAVE_GETOPT_H
30# define _GL_SYSTEM_GETOPT 30# define _GL_SYSTEM_GETOPT
31# ifndef __GNUC__ 31# ifndef __GNUC__
32# include <next_getopt.h> 32# include <next_getopt.h>
33# else 33# else
34# include_next <getopt.h> 34# include_next <getopt.h>
35# endif 35# endif
36# undef _GL_SYSTEM_GETOPT 36# undef _GL_SYSTEM_GETOPT
37#endif 37#endif
38 38
39#ifndef _GL_GETOPT_H 39#ifndef _GL_GETOPT_H
40 40
41#ifndef __need_getopt 41#ifndef __need_getopt
42# define _GL_GETOPT_H 1 42# define _GL_GETOPT_H 1
43#endif 43#endif
44 44
45/* Standalone applications should #define __GETOPT_PREFIX to an 45/* Standalone applications should #define __GETOPT_PREFIX to an
46 identifier that prefixes the external functions and variables 46 identifier that prefixes the external functions and variables
47 defined in this header. When this happens, include the 47 defined in this header. When this happens, include the
48 headers that might declare getopt so that they will not cause 48 headers that might declare getopt so that they will not cause
49 confusion if included after this file (if the system had <getopt.h>, 49 confusion if included after this file (if the system had <getopt.h>,
50 we have already included it). Then systematically rename 50 we have already included it). Then systematically rename
51 identifiers so that they do not collide with the system functions 51 identifiers so that they do not collide with the system functions
52 and variables. Renaming avoids problems with some compilers and 52 and variables. Renaming avoids problems with some compilers and
53 linkers. */ 53 linkers. */
54#if defined __GETOPT_PREFIX && !defined __need_getopt 54#if defined __GETOPT_PREFIX && !defined __need_getopt
55# if !HAVE_GETOPT_H 55# if !HAVE_GETOPT_H
56# include <stdlib.h> 56# define __need_system_stdlib_h
57# include <stdio.h> 57# include <stdlib.h>
58# include <unistd.h> 58# undef __need_system_stdlib_h
59# endif 59# include <stdio.h>
60# undef __need_getopt 60# include <unistd.h>
61# undef getopt 61# endif
62# undef getopt_long 62# undef __need_getopt
63# undef getopt_long_only 63# undef getopt
64# undef optarg 64# undef getopt_long
65# undef opterr 65# undef getopt_long_only
66# undef optind 66# undef optarg
67# undef optopt 67# undef opterr
68# undef option 68# undef optind
69# define __GETOPT_CONCAT(x, y) x ## y 69# undef optopt
70# define __GETOPT_XCONCAT(x, y) __GETOPT_CONCAT (x, y) 70# undef option
71# define __GETOPT_ID(y) __GETOPT_XCONCAT (__GETOPT_PREFIX, y) 71# define __GETOPT_CONCAT(x, y) x ## y
72# define getopt __GETOPT_ID (getopt) 72# define __GETOPT_XCONCAT(x, y) __GETOPT_CONCAT (x, y)
73# define getopt_long __GETOPT_ID (getopt_long) 73# define __GETOPT_ID(y) __GETOPT_XCONCAT (__GETOPT_PREFIX, y)
74# define getopt_long_only __GETOPT_ID (getopt_long_only) 74# define getopt __GETOPT_ID (getopt)
75# define optarg __GETOPT_ID (optarg) 75# define getopt_long __GETOPT_ID (getopt_long)
76# define opterr __GETOPT_ID (opterr) 76# define getopt_long_only __GETOPT_ID (getopt_long_only)
77# define optind __GETOPT_ID (optind) 77# define optarg __GETOPT_ID (optarg)
78# define optopt __GETOPT_ID (optopt) 78# define opterr __GETOPT_ID (opterr)
79# define option __GETOPT_ID (option) 79# define optind __GETOPT_ID (optind)
80# define _getopt_internal __GETOPT_ID (getopt_internal) 80# define optopt __GETOPT_ID (optopt)
81#endif 81# define option __GETOPT_ID (option)
82 82# define _getopt_internal __GETOPT_ID (getopt_internal)
83/* Standalone applications get correct prototypes for getopt_long and 83#endif
84 getopt_long_only; they declare "char **argv". libc uses prototypes 84
85 with "char *const *argv" that are incorrect because getopt_long and 85/* Standalone applications get correct prototypes for getopt_long and
86 getopt_long_only can permute argv; this is required for backward 86 getopt_long_only; they declare "char **argv". libc uses prototypes
87 compatibility (e.g., for LSB 2.0.1). 87 with "char *const *argv" that are incorrect because getopt_long and
88 88 getopt_long_only can permute argv; this is required for backward
89 This used to be '#if defined __GETOPT_PREFIX && !defined __need_getopt', 89 compatibility (e.g., for LSB 2.0.1).
90 but it caused redefinition warnings if both unistd.h and getopt.h were 90
91 included, since unistd.h includes getopt.h having previously defined 91 This used to be '#if defined __GETOPT_PREFIX && !defined __need_getopt',
92 __need_getopt. 92 but it caused redefinition warnings if both unistd.h and getopt.h were
93 93 included, since unistd.h includes getopt.h having previously defined
94 The only place where __getopt_argv_const is used is in definitions 94 __need_getopt.
95 of getopt_long and getopt_long_only below, but these are visible 95
96 only if __need_getopt is not defined, so it is quite safe to rewrite 96 The only place where __getopt_argv_const is used is in definitions
97 the conditional as follows: 97 of getopt_long and getopt_long_only below, but these are visible
98*/ 98 only if __need_getopt is not defined, so it is quite safe to rewrite
99#if !defined __need_getopt 99 the conditional as follows:
100# if defined __GETOPT_PREFIX 100*/
101# define __getopt_argv_const /* empty */ 101#if !defined __need_getopt
102# else 102# if defined __GETOPT_PREFIX
103# define __getopt_argv_const const 103# define __getopt_argv_const /* empty */
104# endif 104# else
105#endif 105# define __getopt_argv_const const
106 106# endif
107/* If __GNU_LIBRARY__ is not already defined, either we are being used 107#endif
108 standalone, or this is the first header included in the source file. 108
109 If we are being used with glibc, we need to include <features.h>, but 109/* If __GNU_LIBRARY__ is not already defined, either we are being used
110 that does not exist if we are standalone. So: if __GNU_LIBRARY__ is 110 standalone, or this is the first header included in the source file.
111 not defined, include <ctype.h>, which will pull in <features.h> for us 111 If we are being used with glibc, we need to include <features.h>, but
112 if it's from glibc. (Why ctype.h? It's guaranteed to exist and it 112 that does not exist if we are standalone. So: if __GNU_LIBRARY__ is
113 doesn't flood the namespace with stuff the way some other headers do.) */ 113 not defined, include <ctype.h>, which will pull in <features.h> for us
114#if !defined __GNU_LIBRARY__ 114 if it's from glibc. (Why ctype.h? It's guaranteed to exist and it
115# include <ctype.h> 115 doesn't flood the namespace with stuff the way some other headers do.) */
116#endif 116#if !defined __GNU_LIBRARY__
117 117# include <ctype.h>
118#ifndef __THROW 118#endif
119# ifndef __GNUC_PREREQ 119
120# define __GNUC_PREREQ(maj, min) (0) 120#ifndef __THROW
121# endif 121# ifndef __GNUC_PREREQ
122# if defined __cplusplus && __GNUC_PREREQ (2,8) 122# define __GNUC_PREREQ(maj, min) (0)
123# define __THROW throw () 123# endif
124# else 124# if defined __cplusplus && __GNUC_PREREQ (2,8)
125# define __THROW 125# define __THROW throw ()
126# endif 126# else
127#endif 127# define __THROW
128 128# endif
129/* The definition of _GL_ARG_NONNULL is copied here. */ 129#endif
130/* A C macro for declaring that specific arguments must not be NULL. 130
131 Copyright (C) 2009-2012 Free Software Foundation, Inc. 131/* The definition of _GL_ARG_NONNULL is copied here. */
132 132/* A C macro for declaring that specific arguments must not be NULL.
133 This program is free software: you can redistribute it and/or modify it 133 Copyright (C) 2009-2013 Free Software Foundation, Inc.
134 under the terms of the GNU General Public License as published 134
135 by the Free Software Foundation; either version 3 of the License, or 135 This program is free software: you can redistribute it and/or modify it
136 (at your option) any later version. 136 under the terms of the GNU General Public License as published
137 137 by the Free Software Foundation; either version 3 of the License, or
138 This program is distributed in the hope that it will be useful, 138 (at your option) any later version.
139 but WITHOUT ANY WARRANTY; without even the implied warranty of 139
140 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 140 This program is distributed in the hope that it will be useful,
141 General Public License for more details. 141 but WITHOUT ANY WARRANTY; without even the implied warranty of
142 142 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
143 You should have received a copy of the GNU General Public License 143 General Public License for more details.
144 along with this program. If not, see <http://www.gnu.org/licenses/>. */ 144
145 145 You should have received a copy of the GNU General Public License
146/* _GL_ARG_NONNULL((n,...,m)) tells the compiler and static analyzer tools 146 along with this program. If not, see <http://www.gnu.org/licenses/>. */
147 that the values passed as arguments n, ..., m must be non-NULL pointers. 147
148 n = 1 stands for the first argument, n = 2 for the second argument etc. */ 148/* _GL_ARG_NONNULL((n,...,m)) tells the compiler and static analyzer tools
149#ifndef _GL_ARG_NONNULL 149 that the values passed as arguments n, ..., m must be non-NULL pointers.
150# if (__GNUC__ == 3 && __GNUC_MINOR__ >= 3) || __GNUC__ > 3 150 n = 1 stands for the first argument, n = 2 for the second argument etc. */
151# define _GL_ARG_NONNULL(params) __attribute__ ((__nonnull__ params)) 151#ifndef _GL_ARG_NONNULL
152# else 152# if (__GNUC__ == 3 && __GNUC_MINOR__ >= 3) || __GNUC__ > 3
153# define _GL_ARG_NONNULL(params) 153# define _GL_ARG_NONNULL(params) __attribute__ ((__nonnull__ params))
154# endif 154# else
155#endif 155# define _GL_ARG_NONNULL(params)
156 156# endif
157#ifdef __cplusplus 157#endif
158extern "C" { 158
159#endif 159#ifdef __cplusplus
160 160extern "C" {
161/* For communication from 'getopt' to the caller. 161#endif
162 When 'getopt' finds an option that takes an argument, 162
163 the argument value is returned here. 163/* For communication from 'getopt' to the caller.
164 Also, when 'ordering' is RETURN_IN_ORDER, 164 When 'getopt' finds an option that takes an argument,
165 each non-option ARGV-element is returned here. */ 165 the argument value is returned here.
166 166 Also, when 'ordering' is RETURN_IN_ORDER,
167extern char *optarg; 167 each non-option ARGV-element is returned here. */
168 168
169/* Index in ARGV of the next element to be scanned. 169extern char *optarg;
170 This is used for communication to and from the caller 170
171 and for communication between successive calls to 'getopt'. 171/* Index in ARGV of the next element to be scanned.
172 172 This is used for communication to and from the caller
173 On entry to 'getopt', zero means this is the first call; initialize. 173 and for communication between successive calls to 'getopt'.
174 174
175 When 'getopt' returns -1, this is the index of the first of the 175 On entry to 'getopt', zero means this is the first call; initialize.
176 non-option elements that the caller should itself scan. 176
177 177 When 'getopt' returns -1, this is the index of the first of the
178 Otherwise, 'optind' communicates from one call to the next 178 non-option elements that the caller should itself scan.
179 how much of ARGV has been scanned so far. */ 179
180 180 Otherwise, 'optind' communicates from one call to the next
181extern int optind; 181 how much of ARGV has been scanned so far. */
182 182
183/* Callers store zero here to inhibit the error message 'getopt' prints 183extern int optind;
184 for unrecognized options. */ 184
185 185/* Callers store zero here to inhibit the error message 'getopt' prints
186extern int opterr; 186 for unrecognized options. */
187 187
188/* Set to an option character which was unrecognized. */ 188extern int opterr;
189 189
190extern int optopt; 190/* Set to an option character which was unrecognized. */
191 191
192#ifndef __need_getopt 192extern int optopt;
193/* Describe the long-named options requested by the application. 193
194 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector 194#ifndef __need_getopt
195 of 'struct option' terminated by an element containing a name which is 195/* Describe the long-named options requested by the application.
196 zero. 196 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
197 197 of 'struct option' terminated by an element containing a name which is
198 The field 'has_arg' is: 198 zero.
199 no_argument (or 0) if the option does not take an argument, 199
200 required_argument (or 1) if the option requires an argument, 200 The field 'has_arg' is:
201 optional_argument (or 2) if the option takes an optional argument. 201 no_argument (or 0) if the option does not take an argument,
202 202 required_argument (or 1) if the option requires an argument,
203 If the field 'flag' is not NULL, it points to a variable that is set 203 optional_argument (or 2) if the option takes an optional argument.
204 to the value given in the field 'val' when the option is found, but 204
205 left unchanged if the option is not found. 205 If the field 'flag' is not NULL, it points to a variable that is set
206 206 to the value given in the field 'val' when the option is found, but
207 To have a long-named option do something other than set an 'int' to 207 left unchanged if the option is not found.
208 a compiled-in constant, such as set a value from 'optarg', set the 208
209 option's 'flag' field to zero and its 'val' field to a nonzero 209 To have a long-named option do something other than set an 'int' to
210 value (the equivalent single-letter option character, if there is 210 a compiled-in constant, such as set a value from 'optarg', set the
211 one). For long options that have a zero 'flag' field, 'getopt' 211 option's 'flag' field to zero and its 'val' field to a nonzero
212 returns the contents of the 'val' field. */ 212 value (the equivalent single-letter option character, if there is
213 213 one). For long options that have a zero 'flag' field, 'getopt'
214# if !GNULIB_defined_struct_option 214 returns the contents of the 'val' field. */
215struct option 215
216{ 216# if !GNULIB_defined_struct_option
217 const char *name; 217struct option
218 /* has_arg can't be an enum because some compilers complain about 218{
219 type mismatches in all the code that assumes it is an int. */ 219 const char *name;
220 int has_arg; 220 /* has_arg can't be an enum because some compilers complain about
221 int *flag; 221 type mismatches in all the code that assumes it is an int. */
222 int val; 222 int has_arg;
223}; 223 int *flag;
224# define GNULIB_defined_struct_option 1 224 int val;
225# endif 225};
226 226# define GNULIB_defined_struct_option 1
227/* Names for the values of the 'has_arg' field of 'struct option'. */ 227# endif
228 228
229# define no_argument 0 229/* Names for the values of the 'has_arg' field of 'struct option'. */
230# define required_argument 1 230
231# define optional_argument 2 231# define no_argument 0
232#endif /* need getopt */ 232# define required_argument 1
233 233# define optional_argument 2
234 234#endif /* need getopt */
235/* Get definitions and prototypes for functions to process the 235
236 arguments in ARGV (ARGC of them, minus the program name) for 236
237 options given in OPTS. 237/* Get definitions and prototypes for functions to process the
238 238 arguments in ARGV (ARGC of them, minus the program name) for
239 Return the option character from OPTS just read. Return -1 when 239 options given in OPTS.
240 there are no more options. For unrecognized options, or options 240
241 missing arguments, 'optopt' is set to the option letter, and '?' is 241 Return the option character from OPTS just read. Return -1 when
242 returned. 242 there are no more options. For unrecognized options, or options
243 243 missing arguments, 'optopt' is set to the option letter, and '?' is
244 The OPTS string is a list of characters which are recognized option 244 returned.
245 letters, optionally followed by colons, specifying that that letter 245
246 takes an argument, to be placed in 'optarg'. 246 The OPTS string is a list of characters which are recognized option
247 247 letters, optionally followed by colons, specifying that that letter
248 If a letter in OPTS is followed by two colons, its argument is 248 takes an argument, to be placed in 'optarg'.
249 optional. This behavior is specific to the GNU 'getopt'. 249
250 250 If a letter in OPTS is followed by two colons, its argument is
251 The argument '--' causes premature termination of argument 251 optional. This behavior is specific to the GNU 'getopt'.
252 scanning, explicitly telling 'getopt' that there are no more 252
253 options. 253 The argument '--' causes premature termination of argument
254 254 scanning, explicitly telling 'getopt' that there are no more
255 If OPTS begins with '-', then non-option arguments are treated as 255 options.
256 arguments to the option '\1'. This behavior is specific to the GNU 256
257 'getopt'. If OPTS begins with '+', or POSIXLY_CORRECT is set in 257 If OPTS begins with '-', then non-option arguments are treated as
258 the environment, then do not permute arguments. */ 258 arguments to the option '\1'. This behavior is specific to the GNU
259 259 'getopt'. If OPTS begins with '+', or POSIXLY_CORRECT is set in
260extern int getopt (int ___argc, char *const *___argv, const char *__shortopts) 260 the environment, then do not permute arguments. */
261 __THROW _GL_ARG_NONNULL ((2, 3)); 261
262 262extern int getopt (int ___argc, char *const *___argv, const char *__shortopts)
263#ifndef __need_getopt 263 __THROW _GL_ARG_NONNULL ((2, 3));
264extern int getopt_long (int ___argc, char *__getopt_argv_const *___argv, 264
265 const char *__shortopts, 265#ifndef __need_getopt
266 const struct option *__longopts, int *__longind) 266extern int getopt_long (int ___argc, char *__getopt_argv_const *___argv,
267 __THROW _GL_ARG_NONNULL ((2, 3)); 267 const char *__shortopts,
268extern int getopt_long_only (int ___argc, char *__getopt_argv_const *___argv, 268 const struct option *__longopts, int *__longind)
269 const char *__shortopts, 269 __THROW _GL_ARG_NONNULL ((2, 3));
270 const struct option *__longopts, int *__longind) 270extern int getopt_long_only (int ___argc, char *__getopt_argv_const *___argv,
271 __THROW _GL_ARG_NONNULL ((2, 3)); 271 const char *__shortopts,
272 272 const struct option *__longopts, int *__longind)
273#endif 273 __THROW _GL_ARG_NONNULL ((2, 3));
274 274
275#ifdef __cplusplus 275#endif
276} 276
277#endif 277#ifdef __cplusplus
278 278}
279/* Make sure we later can get all the definitions and declarations. */ 279#endif
280#undef __need_getopt 280
281 281/* Make sure we later can get all the definitions and declarations. */
282#endif /* _GL_GETOPT_H */ 282#undef __need_getopt
283#endif /* _GL_GETOPT_H */ 283
284#endif /* _GL_GETOPT_H */
285#endif /* _GL_GETOPT_H */