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