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