1 /* DO NOT EDIT! GENERATED AUTOMATICALLY! */ 2 /* Declarations for getopt. 3 Copyright (C) 1989-1994, 1996-1999, 2001, 2003-2007, 2009-2010 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 /* 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 1 30 # define _GL_SYSTEM_GETOPT 31 # include_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 !1 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 /* _GL_ARG_NONNULL((n,...,m)) tells the compiler and static analyzer tools 127 that the values passed as arguments n, ..., m must be non-NULL pointers. 128 n = 1 stands for the first argument, n = 2 for the second argument etc. */ 129 #ifndef _GL_ARG_NONNULL 130 # if (__GNUC__ == 3 && __GNUC_MINOR__ >= 3) || __GNUC__ > 3 131 # define _GL_ARG_NONNULL(params) __attribute__ ((__nonnull__ params)) 132 # else 133 # define _GL_ARG_NONNULL(params) 134 # endif 135 #endif 136 137 #ifdef __cplusplus 138 extern "C" { 139 #endif 140 141 /* For communication from `getopt' to the caller. 142 When `getopt' finds an option that takes an argument, 143 the argument value is returned here. 144 Also, when `ordering' is RETURN_IN_ORDER, 145 each non-option ARGV-element is returned here. */ 146 147 extern char *optarg; 148 149 /* Index in ARGV of the next element to be scanned. 150 This is used for communication to and from the caller 151 and for communication between successive calls to `getopt'. 152 153 On entry to `getopt', zero means this is the first call; initialize. 154 155 When `getopt' returns -1, this is the index of the first of the 156 non-option elements that the caller should itself scan. 157 158 Otherwise, `optind' communicates from one call to the next 159 how much of ARGV has been scanned so far. */ 160 161 extern int optind; 162 163 /* Callers store zero here to inhibit the error message `getopt' prints 164 for unrecognized options. */ 165 166 extern int opterr; 167 168 /* Set to an option character which was unrecognized. */ 169 170 extern int optopt; 171 172 #ifndef __need_getopt 173 /* Describe the long-named options requested by the application. 174 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector 175 of `struct option' terminated by an element containing a name which is 176 zero. 177 178 The field `has_arg' is: 179 no_argument (or 0) if the option does not take an argument, 180 required_argument (or 1) if the option requires an argument, 181 optional_argument (or 2) if the option takes an optional argument. 182 183 If the field `flag' is not NULL, it points to a variable that is set 184 to the value given in the field `val' when the option is found, but 185 left unchanged if the option is not found. 186 187 To have a long-named option do something other than set an `int' to 188 a compiled-in constant, such as set a value from `optarg', set the 189 option's `flag' field to zero and its `val' field to a nonzero 190 value (the equivalent single-letter option character, if there is 191 one). For long options that have a zero `flag' field, `getopt' 192 returns the contents of the `val' field. */ 193 194 struct option 195 { 196 const char *name; 197 /* has_arg can't be an enum because some compilers complain about 198 type mismatches in all the code that assumes it is an int. */ 199 int has_arg; 200 int *flag; 201 int val; 202 }; 203 204 /* Names for the values of the `has_arg' field of `struct option'. */ 205 206 # define no_argument 0 207 # define required_argument 1 208 # define optional_argument 2 209 #endif /* need getopt */ 210 211 212 /* Get definitions and prototypes for functions to process the 213 arguments in ARGV (ARGC of them, minus the program name) for 214 options given in OPTS. 215 216 Return the option character from OPTS just read. Return -1 when 217 there are no more options. For unrecognized options, or options 218 missing arguments, `optopt' is set to the option letter, and '?' is 219 returned. 220 221 The OPTS string is a list of characters which are recognized option 222 letters, optionally followed by colons, specifying that that letter 223 takes an argument, to be placed in `optarg'. 224 225 If a letter in OPTS is followed by two colons, its argument is 226 optional. This behavior is specific to the GNU `getopt'. 227 228 The argument `--' causes premature termination of argument 229 scanning, explicitly telling `getopt' that there are no more 230 options. 231 232 If OPTS begins with `-', then non-option arguments are treated as 233 arguments to the option '\1'. This behavior is specific to the GNU 234 `getopt'. If OPTS begins with `+', or POSIXLY_CORRECT is set in 235 the environment, then do not permute arguments. */ 236 237 extern int getopt (int ___argc, char *const *___argv, const char *__shortopts) 238 __THROW _GL_ARG_NONNULL ((2, 3)); 239 240 #ifndef __need_getopt 241 extern int getopt_long (int ___argc, char *__getopt_argv_const *___argv, 242 const char *__shortopts, 243 const struct option *__longopts, int *__longind) 244 __THROW _GL_ARG_NONNULL ((2, 3)); 245 extern int getopt_long_only (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 250 #endif 251 252 #ifdef __cplusplus 253 } 254 #endif 255 256 /* Make sure we later can get all the definitions and declarations. */ 257 #undef __need_getopt 258 259 #endif /* getopt.h */ 260 #endif /* getopt.h */ 261