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