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