1 /* Declarations for getopt. 2 Copyright (C) 1989,90,91,92,93,94,96,97 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 Library General Public License as 7 published by the Free Software Foundation; either version 2 of the 8 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 Library General Public License for more details. 14 15 You should have received a copy of the GNU Library General Public 16 License along with the GNU C Library; see the file COPYING.LIB. If not, 17 write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 18 Boston, MA 02111-1307, USA. */ 19 20 #ifndef _GETOPT_H 21 #define _GETOPT_H 1 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 #ifndef GETOPT_VARIABLE 28 #define GETOPT_VARIABLE 29 #endif 30 31 /* For communication from `getopt' to the caller. 32 When `getopt' finds an option that takes an argument, 33 the argument value is returned here. 34 Also, when `ordering' is RETURN_IN_ORDER, 35 each non-option ARGV-element is returned here. */ 36 37 extern GETOPT_VARIABLE char *optarg; 38 39 /* Index in ARGV of the next element to be scanned. 40 This is used for communication to and from the caller 41 and for communication between successive calls to `getopt'. 42 43 On entry to `getopt', zero means this is the first call; initialize. 44 45 When `getopt' returns -1, this is the index of the first of the 46 non-option elements that the caller should itself scan. 47 48 Otherwise, `optind' communicates from one call to the next 49 how much of ARGV has been scanned so far. */ 50 51 extern GETOPT_VARIABLE int optind; 52 53 /* Callers store zero here to inhibit the error message `getopt' prints 54 for unrecognized options. */ 55 56 extern GETOPT_VARIABLE int opterr; 57 58 /* Set to an option character which was unrecognized. */ 59 60 extern GETOPT_VARIABLE int optopt; 61 62 /* Describe the long-named options requested by the application. 63 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector 64 of `struct option' terminated by an element containing a name which is 65 zero. 66 67 The field `has_arg' is: 68 no_argument (or 0) if the option does not take an argument, 69 required_argument (or 1) if the option requires an argument, 70 optional_argument (or 2) if the option takes an optional argument. 71 72 If the field `flag' is not NULL, it points to a variable that is set 73 to the value given in the field `val' when the option is found, but 74 left unchanged if the option is not found. 75 76 To have a long-named option do something other than set an `int' to 77 a compiled-in constant, such as set a value from `optarg', set the 78 option's `flag' field to zero and its `val' field to a nonzero 79 value (the equivalent single-letter option character, if there is 80 one). For long options that have a zero `flag' field, `getopt' 81 returns the contents of the `val' field. */ 82 83 struct option 84 { 85 #if defined (__STDC__) && __STDC__ 86 const char *name; 87 #else 88 char *name; 89 #endif 90 /* has_arg can't be an enum because some compilers complain about 91 type mismatches in all the code that assumes it is an int. */ 92 int has_arg; 93 int *flag; 94 int val; 95 }; 96 97 /* Names for the values of the `has_arg' field of `struct option'. */ 98 99 #define no_argument 0 100 #define required_argument 1 101 #define optional_argument 2 102 103 #if defined (__STDC__) && __STDC__ 104 #ifdef __GNU_LIBRARY__ 105 /* Many other libraries have conflicting prototypes for getopt, with 106 differences in the consts, in stdlib.h. To avoid compilation 107 errors, only prototype getopt for the GNU C library. */ 108 extern int getopt (int argc, char *const *argv, const char *shortopts); 109 #else /* not __GNU_LIBRARY__ */ 110 extern int getopt (); 111 #endif /* __GNU_LIBRARY__ */ 112 extern int getopt_long (int argc, char *const *argv, const char *shortopts, 113 const struct option *longopts, int *longind); 114 extern int getopt_long_only (int argc, char *const *argv, 115 const char *shortopts, 116 const struct option *longopts, int *longind); 117 118 /* Internal only. Users should not call this directly. */ 119 extern int _getopt_internal (int argc, char *const *argv, 120 const char *shortopts, 121 const struct option *longopts, int *longind, 122 int long_only); 123 #else /* not __STDC__ */ 124 extern int getopt (); 125 extern int getopt_long (); 126 extern int getopt_long_only (); 127 128 extern int _getopt_internal (); 129 #endif /* __STDC__ */ 130 131 #ifdef __cplusplus 132 } 133 #endif 134 135 #endif /* _GETOPT_H */ 136
