00001 /* Declarations for getCCAFEopt. (produced from gnu getopt with 00002 * sed -e 's/opt/CCAFEopt/g') 00003 Copyright (C) 1989,90,91,92,93,94,96,97 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 CCAFEoption) 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 _GETCCAFEOPT_H 00024 #define _GETCCAFEOPT_H 1 00025 00026 #ifdef __cplusplus 00027 extern "C" { 00028 #endif 00029 00030 /* For communication from `getCCAFEopt' to the caller. 00031 When `getCCAFEopt' finds an CCAFEoption that takes an argument, 00032 the argument value is returned here. 00033 Also, when `ordering' is RETURN_IN_ORDER, 00034 each non-CCAFEoption ARGV-element is returned here. */ 00035 00036 extern char *CCAFEoptarg; 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 `getCCAFEopt'. 00041 00042 On entry to `getCCAFEopt', zero means this is the first call; initialize. 00043 00044 When `getCCAFEopt' returns -1, this is the index of the first of the 00045 non-CCAFEoption elements that the caller should itself scan. 00046 00047 Otherwise, `CCAFEoptind' communicates from one call to the next 00048 how much of ARGV has been scanned so far. */ 00049 00050 extern int CCAFEoptind; 00051 00052 /* Callers store zero here to inhibit the error message `getCCAFEopt' prints 00053 for unrecognized CCAFEoptions. */ 00054 00055 extern int CCAFEopterr; 00056 00057 /* Set to an CCAFEoption character which was unrecognized. */ 00058 00059 extern int CCAFEoptCCAFEopt; 00060 00061 /* Describe the long-named CCAFEoptions requested by the application. 00062 The LONG_OPTIONS argument to getCCAFEopt_long or getCCAFEopt_long_only is a vector 00063 of `struct CCAFEoption' 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 CCAFEoption does not take an argument, 00068 required_argument (or 1) if the CCAFEoption requires an argument, 00069 CCAFEoptional_argument (or 2) if the CCAFEoption takes an CCAFEoptional 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 CCAFEoption is found, but 00073 left unchanged if the CCAFEoption is not found. 00074 00075 To have a long-named CCAFEoption do something other than set an `int' to 00076 a compiled-in constant, such as set a value from `CCAFEoptarg', set the 00077 CCAFEoption's `flag' field to zero and its `val' field to a nonzero 00078 value (the equivalent single-letter CCAFEoption character, if there is 00079 one). For long CCAFEoptions that have a zero `flag' field, `getCCAFEopt' 00080 returns the contents of the `val' field. */ 00081 00082 struct CCAFEoption 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 CCAFEoption'. */ 00097 00098 #define no_argument 0 00099 #define required_argument 1 00100 #define CCAFEoptional_argument 2 00101 00102 #if defined (__STDC__) && __STDC__ 00103 #ifdef __GNU_LIBRARY__ 00104 /* Many other libraries have conflicting prototypes for getCCAFEopt, with 00105 differences in the consts, in stdlib.h. To avoid compilation 00106 errors, only prototype getCCAFEopt for the GNU C library. */ 00107 extern int getCCAFEopt (int argc, char *const *argv, const char *shortCCAFEopts); 00108 #else /* not __GNU_LIBRARY__ */ 00109 extern int getCCAFEopt (); 00110 #endif /* __GNU_LIBRARY__ */ 00111 extern int getCCAFEopt_long (int argc, char *const *argv, const char *shortCCAFEopts, 00112 const struct CCAFEoption *longCCAFEopts, int *longind); 00113 extern int getCCAFEopt_long_only (int argc, char *const *argv, 00114 const char *shortCCAFEopts, 00115 const struct CCAFEoption *longCCAFEopts, int *longind); 00116 00117 /* Internal only. Users should not call this directly. */ 00118 extern int _getCCAFEopt_internal (int argc, char *const *argv, 00119 const char *shortCCAFEopts, 00120 const struct CCAFEoption *longCCAFEopts, int *longind, 00121 int long_only); 00122 #else /* not __STDC__ */ 00123 extern int getCCAFEopt (int argc, char *const *argv, const char *shortCCAFEopts); 00124 extern int getCCAFEopt_long (int argc, char *const *argv, const char *shortCCAFEopts, 00125 const struct CCAFEoption *longCCAFEopts, int *longind); 00126 extern int getCCAFEopt_long_only (int argc, char *const *argv, 00127 const char *shortCCAFEopts, 00128 const struct CCAFEoption *longCCAFEopts, int *longind); 00129 00130 extern int _getCCAFEopt_internal (); 00131 #endif /* __STDC__ */ 00132 00133 #ifdef __cplusplus 00134 } 00135 #endif 00136 00137 #endif /* getCCAFEopt.h */