1 /* Declarations for getopt.
2 Copyright (C) 1989-1994, 1996-1999, 2001 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
10 The GNU C Library 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 GNU
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, write to the Free
17 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
28 /* If __GNU_LIBRARY__ is not already defined, either we are being used
29 standalone, or this is the first header included in the source file.
30 If we are being used with glibc, we need to include <features.h>, but
31 that does not exist if we are standalone. So: if __GNU_LIBRARY__ is
32 not defined, include <ctype.h>, which will pull in <features.h> for us
33 if it's from glibc. (Why ctype.h? It's guaranteed to exist and it
34 doesn't flood the namespace with stuff the way some other headers do.) */
35 #if !defined __GNU_LIBRARY__
43 /* For communication from `getopt' to the caller.
44 When `getopt' finds an option that takes an argument,
45 the argument value is returned here.
46 Also, when `ordering' is RETURN_IN_ORDER,
47 each non-option ARGV-element is returned here. */
51 /* Index in ARGV of the next element to be scanned.
52 This is used for communication to and from the caller
53 and for communication between successive calls to `getopt'.
55 On entry to `getopt', zero means this is the first call; initialize.
57 When `getopt' returns -1, this is the index of the first of the
58 non-option elements that the caller should itself scan.
60 Otherwise, `optind' communicates from one call to the next
61 how much of ARGV has been scanned so far. */
65 /* Callers store zero here to inhibit the error message `getopt' prints
66 for unrecognized options. */
70 /* Set to an option character which was unrecognized. */
75 /* Describe the long-named options requested by the application.
76 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
77 of `struct option' terminated by an element containing a name which is
80 The field `has_arg' is:
81 no_argument (or 0) if the option does not take an argument,
82 required_argument (or 1) if the option requires an argument,
83 optional_argument (or 2) if the option takes an optional argument.
85 If the field `flag' is not NULL, it points to a variable that is set
86 to the value given in the field `val' when the option is found, but
87 left unchanged if the option is not found.
89 To have a long-named option do something other than set an `int' to
90 a compiled-in constant, such as set a value from `optarg', set the
91 option's `flag' field to zero and its `val' field to a nonzero
92 value (the equivalent single-letter option character, if there is
93 one). For long options that have a zero `flag' field, `getopt'
94 returns the contents of the `val' field. */
98 # if (defined __STDC__ && __STDC__) || defined __cplusplus
103 /* has_arg can't be an enum because some compilers complain about
104 type mismatches in all the code that assumes it is an int. */
110 /* Names for the values of the `has_arg' field of `struct option'. */
112 # define no_argument 0
113 # define required_argument 1
114 # define optional_argument 2
115 #endif /* need getopt */
118 /* Get definitions and prototypes for functions to process the
119 arguments in ARGV (ARGC of them, minus the program name) for
120 options given in OPTS.
122 Return the option character from OPTS just read. Return -1 when
123 there are no more options. For unrecognized options, or options
124 missing arguments, `optopt' is set to the option letter, and '?' is
127 The OPTS string is a list of characters which are recognized option
128 letters, optionally followed by colons, specifying that that letter
129 takes an argument, to be placed in `optarg'.
131 If a letter in OPTS is followed by two colons, its argument is
132 optional. This behavior is specific to the GNU `getopt'.
134 The argument `--' causes premature termination of argument
135 scanning, explicitly telling `getopt' that there are no more
138 If OPTS begins with `--', then non-option arguments are treated as
139 arguments to the option '\0'. This behavior is specific to the GNU
142 #if (defined __STDC__ && __STDC__) || defined __cplusplus
143 # ifdef __GNU_LIBRARY__
144 /* Many other libraries have conflicting prototypes for getopt, with
145 differences in the consts, in stdlib.h. To avoid compilation
146 errors, only prototype getopt for the GNU C library. */
147 extern int getopt (int __argc
, char *const *__argv
, const char *__shortopts
);
148 # else /* not __GNU_LIBRARY__ */
149 extern int getopt ();
150 # endif /* __GNU_LIBRARY__ */
152 # ifndef __need_getopt
153 extern int getopt_long (int __argc
, char *const *__argv
, const char *__shortopts
,
154 const struct option
*__longopts
, int32_t *__longind
);
155 extern int getopt_long_only (int __argc
, char *const *__argv
,
156 const char *__shortopts
,
157 const struct option
*__longopts
, int32_t *__longind
);
159 /* Internal only. Users should not call this directly. */
160 extern int _getopt_internal (int __argc
, char *const *__argv
,
161 const char *__shortopts
,
162 const struct option
*__longopts
, int32_t *__longind
,
165 #else /* not __STDC__ */
166 extern int getopt ();
167 # ifndef __need_getopt
168 extern int getopt_long ();
169 extern int getopt_long_only ();
171 extern int _getopt_internal ();
173 #endif /* __STDC__ */
179 /* Make sure we later can get all the definitions and declarations. */
182 #endif /* getopt.h */