00001 /* Declarations for getopt. 00002 Copyright 1989, 1990, 1991, 1992, 1993, 1994, 1996, 1997, 1998, 2000, 00003 2002 Free Software Foundation, Inc. 00004 00005 NOTE: The canonical source of this file is maintained with the GNU C Library. 00006 Bugs can be reported to bug-glibc@gnu.org. 00007 00008 This program is free software; you can redistribute it and/or modify it 00009 under the terms of the GNU General Public License as published by the 00010 Free Software Foundation; either version 2, or (at your option) any 00011 later version. 00012 00013 This program is distributed in the hope that it will be useful, 00014 but WITHOUT ANY WARRANTY; without even the implied warranty of 00015 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00016 GNU General Public License for more details. 00017 00018 You should have received a copy of the GNU General Public License 00019 along with this program; if not, write to the Free Software 00020 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 00021 USA. */ 00022 00023 #ifndef _GETOPT_H 00024 #define _GETOPT_H 1 00025 00026 #ifdef __cplusplus 00027 extern "C" { 00028 #endif 00029 00030 /* For communication from `getopt' to the caller. 00031 When `getopt' finds an option that takes an argument, 00032 the argument value is returned here. 00033 Also, when `ordering' is RETURN_IN_ORDER, 00034 each non-option ARGV-element is returned here. */ 00035 00036 extern char *optarg; 00037 00038 /* Index in ARGV of the next element to be scanned. 00039 This is used for communication to and from the caller 00040 and for communication between successive calls to `getopt'. 00041 00042 On entry to `getopt', zero means this is the first call; initialize. 00043 00044 When `getopt' returns -1, this is the index of the first of the 00045 non-option elements that the caller should itself scan. 00046 00047 Otherwise, `optind' communicates from one call to the next 00048 how much of ARGV has been scanned so far. */ 00049 00050 extern int optind; 00051 00052 /* Callers store zero here to inhibit the error message `getopt' prints 00053 for unrecognized options. */ 00054 00055 extern int opterr; 00056 00057 /* Set to an option character which was unrecognized. */ 00058 00059 extern int optopt; 00060 00061 /* Describe the long-named options requested by the application. 00062 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector 00063 of `struct option' terminated by an element containing a name which is 00064 zero. 00065 00066 The field `has_arg' is: 00067 no_argument (or 0) if the option does not take an argument, 00068 required_argument (or 1) if the option requires an argument, 00069 optional_argument (or 2) if the option takes an optional argument. 00070 00071 If the field `flag' is not NULL, it points to a variable that is set 00072 to the value given in the field `val' when the option is found, but 00073 left unchanged if the option is not found. 00074 00075 To have a long-named option do something other than set an `int' to 00076 a compiled-in constant, such as set a value from `optarg', set the 00077 option's `flag' field to zero and its `val' field to a nonzero 00078 value (the equivalent single-letter option character, if there is 00079 one). For long options that have a zero `flag' field, `getopt' 00080 returns the contents of the `val' field. */ 00081 00082 struct option 00083 { 00084 #if defined (__STDC__) && __STDC__ 00085 const char *name; 00086 #else 00087 char *name; 00088 #endif 00089 /* has_arg can't be an enum because some compilers complain about 00090 type mismatches in all the code that assumes it is an int. */ 00091 int has_arg; 00092 int *flag; 00093 int val; 00094 }; 00095 00096 /* Names for the values of the `has_arg' field of `struct option'. */ 00097 00098 #define no_argument 0 00099 #define required_argument 1 00100 #define optional_argument 2 00101 00102 #if defined (__STDC__) && __STDC__ 00103 /* HAVE_DECL_* is a three-state macro: undefined, 0 or 1. If it is 00104 undefined, we haven't run the autoconf check so provide the 00105 declaration without arguments. If it is 0, we checked and failed 00106 to find the declaration so provide a fully prototyped one. If it 00107 is 1, we found it so don't provide any declaration at all. */ 00108 #if !HAVE_DECL_GETOPT 00109 #if defined (__GNU_LIBRARY__) || defined (HAVE_DECL_GETOPT) 00110 /* Many other libraries have conflicting prototypes for getopt, with 00111 differences in the consts, in unistd.h. To avoid compilation 00112 errors, only prototype getopt for the GNU C library. */ 00113 extern int getopt (int argc, char *const *argv, const char *shortopts); 00114 #else 00115 #ifndef __cplusplus 00116 extern int getopt (); 00117 #endif /* __cplusplus */ 00118 #endif 00119 #endif /* !HAVE_DECL_GETOPT */ 00120 00121 extern int getopt_long (int argc, char *const *argv, const char *shortopts, 00122 const struct option *longopts, int *longind); 00123 extern int getopt_long_only (int argc, char *const *argv, 00124 const char *shortopts, 00125 const struct option *longopts, int *longind); 00126 00127 /* Internal only. Users should not call this directly. */ 00128 extern int _getopt_internal (int argc, char *const *argv, 00129 const char *shortopts, 00130 const struct option *longopts, int *longind, 00131 int long_only); 00132 #else /* not __STDC__ */ 00133 extern int getopt (); 00134 extern int getopt_long (); 00135 extern int getopt_long_only (); 00136 00137 extern int _getopt_internal (); 00138 #endif /* __STDC__ */ 00139 00140 #ifdef __cplusplus 00141 } 00142 #endif 00143 00144 #endif /* getopt.h */