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