1 /* Declarations for getopt. 2 Copyright (C) 1989-1994, 1996-1999, 2001 Free Software Foundation, Inc. 3 This file is part of the GNU C Library. 4 5 The GNU C Library is free software; you can redistribute it and/or 6 modify it under the terms of the GNU Lesser General Public 7 License as published by the Free Software Foundation; either 8 version 2.1 of the License, or (at your option) any later version. 9 10 The GNU C Library is distributed in the hope that it will be useful, 11 but WITHOUT ANY WARRANTY; without even the implied warranty of 12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 Lesser General Public License for more details. 14 15 You should have received a copy of the GNU Lesser General Public 16 License along with the GNU C Library; if not, write to the Free 17 Software Foundation, Inc., 51 Franklin Street - Suite 500, Boston, 18 MA 02110-1335, USA */ 19 20 #ifndef _GETOPT_H 21 22 #ifndef __need_getopt 23 # define _GETOPT_H 1 24 #endif 25 26 /* If __GNU_LIBRARY__ is not already defined, either we are being used 27 standalone, or this is the first header included in the source file. 28 If we are being used with glibc, we need to include <features.h>, but 29 that does not exist if we are standalone. So: if __GNU_LIBRARY__ is 30 not defined, include <ctype.h>, which will pull in <features.h> for us 31 if it's from glibc. (Why ctype.h? It's guaranteed to exist and it 32 doesn't flood the namespace with stuff the way some other headers do.) */ 33 #if !defined __GNU_LIBRARY__ 34 # include <ctype.h> 35 #endif 36 37 #ifdef __cplusplus 38 extern "C" { 39 #endif 40 41 /* For communication from `getopt' to the caller. 42 When `getopt' finds an option that takes an argument, 43 the argument value is returned here. 44 Also, when `ordering' is RETURN_IN_ORDER, 45 each non-option ARGV-element is returned here. */ 46 47 48 /* Index in ARGV of the next element to be scanned. 49 This is used for communication to and from the caller 50 and for communication between successive calls to `getopt'. 51 52 On entry to `getopt', zero means this is the first call; initialize. 53 54 When `getopt' returns -1, this is the index of the first of the 55 non-option elements that the caller should itself scan. 56 57 Otherwise, `optind' communicates from one call to the next 58 how much of ARGV has been scanned so far. */ 59 60 61 /* Callers store zero here to inhibit the error message `getopt' prints 62 for unrecognized options. */ 63 64 65 /* Set to an option character which was unrecognized. */ 66 67 68 #ifndef __need_getopt 69 /* Describe the long-named options requested by the application. 70 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector 71 of `struct option' terminated by an element containing a name which is 72 zero. 73 74 The field `has_arg' is: 75 no_argument (or 0) if the option does not take an argument, 76 required_argument (or 1) if the option requires an argument, 77 optional_argument (or 2) if the option takes an optional argument. 78 79 If the field `flag' is not NULL, it points to a variable that is set 80 to the value given in the field `val' when the option is found, but 81 left unchanged if the option is not found. 82 83 To have a long-named option do something other than set an `int' to 84 a compiled-in constant, such as set a value from `optarg', set the 85 option's `flag' field to zero and its `val' field to a nonzero 86 value (the equivalent single-letter option character, if there is 87 one). For long options that have a zero `flag' field, `getopt' 88 returns the contents of the `val' field. */ 89 90 struct option 91 { 92 # if (defined __STDC__ && __STDC__) || defined __cplusplus 93 const char *name; 94 # else 95 char *name; 96 # endif 97 /* has_arg can't be an enum because some compilers complain about 98 type mismatches in all the code that assumes it is an int. */ 99 int has_arg; 100 int *flag; 101 int val; 102 }; 103 104 /* Names for the values of the `has_arg' field of `struct option'. */ 105 106 # define no_argument 0 107 # define required_argument 1 108 # define optional_argument 2 109 #endif /* need getopt */ 110 111 112 /* Get definitions and prototypes for functions to process the 113 arguments in ARGV (ARGC of them, minus the program name) for 114 options given in OPTS. 115 116 Return the option character from OPTS just read. Return -1 when 117 there are no more options. For unrecognized options, or options 118 missing arguments, `optopt' is set to the option letter, and '?' is 119 returned. 120 121 The OPTS string is a list of characters which are recognized option 122 letters, optionally followed by colons, specifying that that letter 123 takes an argument, to be placed in `optarg'. 124 125 If a letter in OPTS is followed by two colons, its argument is 126 optional. This behavior is specific to the GNU `getopt'. 127 128 The argument `--' causes premature termination of argument 129 scanning, explicitly telling `getopt' that there are no more 130 options. 131 132 If OPTS begins with `--', then non-option arguments are treated as 133 arguments to the option '\0'. This behavior is specific to the GNU 134 `getopt'. */ 135 136 #if (defined __STDC__ && __STDC__) || defined __cplusplus 137 # ifdef __GNU_LIBRARY__ 138 /* Many other libraries have conflicting prototypes for getopt, with 139 differences in the consts, in stdlib.h. To avoid compilation 140 errors, only prototype getopt for the GNU C library. */ 141 extern int getopt (int ___argc, char *const *___argv, const char *__shortopts); 142 # else /* not __GNU_LIBRARY__ */ 143 extern int getopt (); 144 # endif /* __GNU_LIBRARY__ */ 145 146 # ifndef __need_getopt 147 extern int getopt_long (int ___argc, char *const *___argv, 148 const char *__shortopts, 149 const struct option *__longopts, int *__longind); 150 extern int getopt_long_only (int ___argc, char *const *___argv, 151 const char *__shortopts, 152 const struct option *__longopts, int *__longind); 153 154 /* Internal only. Users should not call this directly. */ 155 extern int _getopt_internal (int ___argc, char *const *___argv, 156 const char *__shortopts, 157 const struct option *__longopts, int *__longind, 158 int __long_only); 159 # endif 160 #else /* not __STDC__ */ 161 extern int getopt (); 162 # ifndef __need_getopt 163 extern int getopt_long (); 164 extern int getopt_long_only (); 165 166 extern int _getopt_internal (); 167 # endif 168 #endif /* __STDC__ */ 169 170 #ifdef __cplusplus 171 } 172 #endif 173 174 /* Make sure we later can get all the definitions and declarations. */ 175 #undef __need_getopt 176 177 #endif /* getopt.h */ 178 179