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