|
1 /* from http://www.pwilson.net/getopt.html */ |
|
2 |
|
3 /* getopt.h */ |
|
4 /* Declarations for getopt. |
|
5 Copyright (C) 1989-1994, 1996-1999, 2001 Free Software |
|
6 Foundation, Inc. This file is part of the GNU C Library. |
|
7 |
|
8 The GNU C Library is free software; you can redistribute |
|
9 it and/or modify it under the terms of the GNU Lesser |
|
10 General Public License as published by the Free Software |
|
11 Foundation; either version 2.1 of the License, or |
|
12 (at your option) any later version. |
|
13 |
|
14 The GNU C Library is distributed in the hope that it will |
|
15 be useful, but WITHOUT ANY WARRANTY; without even the |
|
16 implied warranty of MERCHANTABILITY or FITNESS FOR A |
|
17 PARTICULAR PURPOSE. See the GNU Lesser General Public |
|
18 License for more details. |
|
19 |
|
20 You should have received a copy of the GNU Lesser General |
|
21 Public License along with the GNU C Library; if not, write |
|
22 to the Free Software Foundation, Inc., 59 Temple Place, |
|
23 Suite 330, Boston, MA 02111-1307 USA. */ |
|
24 |
|
25 |
|
26 |
|
27 |
|
28 |
|
29 #ifndef _GETOPT_H |
|
30 |
|
31 #ifndef __need_getopt |
|
32 # define _GETOPT_H 1 |
|
33 #endif |
|
34 |
|
35 /* If __GNU_LIBRARY__ is not already defined, either we are being used |
|
36 standalone, or this is the first header included in the source file. |
|
37 If we are being used with glibc, we need to include <features.h>, but |
|
38 that does not exist if we are standalone. So: if __GNU_LIBRARY__ is |
|
39 not defined, include <ctype.h>, which will pull in <features.h> for us |
|
40 if it's from glibc. (Why ctype.h? It's guaranteed to exist and it |
|
41 doesn't flood the namespace with stuff the way some other headers do.) */ |
|
42 #if !defined __GNU_LIBRARY__ |
|
43 # include <ctype.h> |
|
44 #endif |
|
45 |
|
46 #ifdef __cplusplus |
|
47 extern "C" { |
|
48 #endif |
|
49 |
|
50 /* For communication from `getopt' to the caller. |
|
51 When `getopt' finds an option that takes an argument, |
|
52 the argument value is returned here. |
|
53 Also, when `ordering' is RETURN_IN_ORDER, |
|
54 each non-option ARGV-element is returned here. */ |
|
55 |
|
56 extern char *optarg; |
|
57 |
|
58 /* Index in ARGV of the next element to be scanned. |
|
59 This is used for communication to and from the caller |
|
60 and for communication between successive calls to `getopt'. |
|
61 |
|
62 On entry to `getopt', zero means this is the first call; initialize. |
|
63 |
|
64 When `getopt' returns -1, this is the index of the first of the |
|
65 non-option elements that the caller should itself scan. |
|
66 |
|
67 Otherwise, `optind' communicates from one call to the next |
|
68 how much of ARGV has been scanned so far. */ |
|
69 |
|
70 extern int optind; |
|
71 |
|
72 /* Callers store zero here to inhibit the error message `getopt' prints |
|
73 for unrecognized options. */ |
|
74 |
|
75 extern int opterr; |
|
76 |
|
77 /* Set to an option character which was unrecognized. */ |
|
78 |
|
79 extern int optopt; |
|
80 |
|
81 #ifndef __need_getopt |
|
82 /* Describe the long-named options requested by the application. |
|
83 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector |
|
84 of `struct option' terminated by an element containing a name which is |
|
85 zero. |
|
86 |
|
87 The field `has_arg' is: |
|
88 no_argument (or 0) if the option does not take an argument, |
|
89 required_argument (or 1) if the option requires an argument, |
|
90 optional_argument (or 2) if the option takes an optional argument. |
|
91 |
|
92 If the field `flag' is not NULL, it points to a variable that is set |
|
93 to the value given in the field `val' when the option is found, but |
|
94 left unchanged if the option is not found. |
|
95 |
|
96 To have a long-named option do something other than set an `int' to |
|
97 a compiled-in constant, such as set a value from `optarg', set the |
|
98 option's `flag' field to zero and its `val' field to a nonzero |
|
99 value (the equivalent single-letter option character, if there is |
|
100 one). For long options that have a zero `flag' field, `getopt' |
|
101 returns the contents of the `val' field. */ |
|
102 |
|
103 struct option |
|
104 { |
|
105 # if (defined __STDC__ && __STDC__) || defined __cplusplus |
|
106 const char *name; |
|
107 # else |
|
108 char *name; |
|
109 # endif |
|
110 /* has_arg can't be an enum because some compilers complain about |
|
111 type mismatches in all the code that assumes it is an int. */ |
|
112 int has_arg; |
|
113 int *flag; |
|
114 int val; |
|
115 }; |
|
116 |
|
117 /* Names for the values of the `has_arg' field of `struct option'. */ |
|
118 |
|
119 # define no_argument 0 |
|
120 # define required_argument 1 |
|
121 # define optional_argument 2 |
|
122 #endif /* need getopt */ |
|
123 |
|
124 |
|
125 /* Get definitions and prototypes for functions to process the |
|
126 arguments in ARGV (ARGC of them, minus the program name) for |
|
127 options given in OPTS. |
|
128 |
|
129 Return the option character from OPTS just read. Return -1 when |
|
130 there are no more options. For unrecognized options, or options |
|
131 missing arguments, `optopt' is set to the option letter, and '?' is |
|
132 returned. |
|
133 |
|
134 The OPTS string is a list of characters which are recognized option |
|
135 letters, optionally followed by colons, specifying that that letter |
|
136 takes an argument, to be placed in `optarg'. |
|
137 |
|
138 If a letter in OPTS is followed by two colons, its argument is |
|
139 optional. This behavior is specific to the GNU `getopt'. |
|
140 |
|
141 The argument `--' causes premature termination of argument |
|
142 scanning, explicitly telling `getopt' that there are no more |
|
143 options. |
|
144 |
|
145 If OPTS begins with `--', then non-option arguments are treated as |
|
146 arguments to the option '\0'. This behavior is specific to the GNU |
|
147 `getopt'. */ |
|
148 |
|
149 #if (defined __STDC__ && __STDC__) || defined __cplusplus |
|
150 # ifdef __GNU_LIBRARY__ |
|
151 /* Many other libraries have conflicting prototypes for getopt, with |
|
152 differences in the consts, in stdlib.h. To avoid compilation |
|
153 errors, only prototype getopt for the GNU C library. */ |
|
154 extern int getopt (int ___argc, char *const *___argv, const char *__shortopts); |
|
155 # else /* not __GNU_LIBRARY__ */ |
|
156 extern int getopt (); |
|
157 # endif /* __GNU_LIBRARY__ */ |
|
158 |
|
159 # ifndef __need_getopt |
|
160 extern int getopt_long (int ___argc, char *const *___argv, |
|
161 const char *__shortopts, |
|
162 const struct option *__longopts, int *__longind); |
|
163 extern int getopt_long_only (int ___argc, char *const *___argv, |
|
164 const char *__shortopts, |
|
165 const struct option *__longopts, int *__longind); |
|
166 |
|
167 /* Internal only. Users should not call this directly. */ |
|
168 extern int _getopt_internal (int ___argc, char *const *___argv, |
|
169 const char *__shortopts, |
|
170 const struct option *__longopts, int *__longind, |
|
171 int __long_only); |
|
172 # endif |
|
173 #else /* not __STDC__ */ |
|
174 extern int getopt (); |
|
175 # ifndef __need_getopt |
|
176 extern int getopt_long (); |
|
177 extern int getopt_long_only (); |
|
178 |
|
179 extern int _getopt_internal (); |
|
180 # endif |
|
181 #endif /* __STDC__ */ |
|
182 |
|
183 #ifdef __cplusplus |
|
184 } |
|
185 #endif |
|
186 |
|
187 /* Make sure we later can get all the definitions and declarations. */ |
|
188 #undef __need_getopt |
|
189 |
|
190 #endif /* getopt.h */ |
|
191 |