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