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