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