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