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