1
/* Declarations for getopt.
2
Copyright (C) 1989, 1990, 1991, 1992 Free Software Foundation, Inc.
4
This program is free software; you can redistribute it and/or modify it
5
under the terms of the GNU Library General Public License as published
6
by the Free Software Foundation; either version 2, or (at your option)
9
This program is distributed in the hope that it will be useful,
10
but WITHOUT ANY WARRANTY; without even the implied warranty of
11
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
GNU General Public License for more details.
14
You should have received a copy of the GNU Library General Public
15
License along with this program; if not, write to the Free Software
16
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
25
/* For communication from `getopt' to the caller.
26
When `getopt' finds an option that takes an argument,
27
the argument value is returned here.
28
Also, when `ordering' is RETURN_IN_ORDER,
29
each non-option ARGV-element is returned here. */
33
/* Index in ARGV of the next element to be scanned.
34
This is used for communication to and from the caller
35
and for communication between successive calls to `getopt'.
37
On entry to `getopt', zero means this is the first call; initialize.
39
When `getopt' returns EOF, this is the index of the first of the
40
non-option elements that the caller should itself scan.
42
Otherwise, `optind' communicates from one call to the next
43
how much of ARGV has been scanned so far. */
47
/* Callers store zero here to inhibit the error message `getopt' prints
48
for unrecognized options. */
52
/* Describe the long-named options requested by the application.
53
The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
54
of `struct option' terminated by an element containing a name which is
57
The field `has_arg' is:
58
no_argument (or 0) if the option does not take an argument,
59
required_argument (or 1) if the option requires an argument,
60
optional_argument (or 2) if the option takes an optional argument.
62
If the field `flag' is not NULL, it points to a variable that is set
63
to the value given in the field `val' when the option is found, but
64
left unchanged if the option is not found.
66
To have a long-named option do something other than set an `int' to
67
a compiled-in constant, such as set a value from `optarg', set the
68
option's `flag' field to zero and its `val' field to a nonzero
69
value (the equivalent single-letter option character, if there is
70
one). For long options that have a zero `flag' field, `getopt'
71
returns the contents of the `val' field. */
80
/* has_arg can't be an enum because some compilers complain about
81
type mismatches in all the code that assumes it is an int. */
87
/* Names for the values of the `has_arg' field of `struct option'. */
96
#if __STDC__ || __BORLANDC__ || _MSC_VER
97
extern int getopt (int argc, char *const *argv, const char *shortopts);
98
extern int getopt_long (int argc, char *const *argv, const char *shortopts,
99
const struct option *longopts, int *longind);
100
extern int getopt_long_only (int argc, char *const *argv,
101
const char *shortopts,
102
const struct option *longopts, int *longind);
104
/* Internal only. Users should not call this directly. */
105
extern int _getopt_internal (int argc, char *const *argv,
106
const char *shortopts,
107
const struct option *longopts, int *longind,
109
#else /* not __STDC__ */
110
extern int getopt ();
111
extern int getopt_long ();
112
extern int getopt_long_only ();
114
extern int _getopt_internal ();
115
#endif /* not __STDC__ */
121
#endif /* _GETOPT_H */