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
This program is free software; you can redistribute it and/or modify
6
it under the terms of the GNU General Public License as published by
7
the Free Software Foundation; either version 2, or (at your option)
10
This program 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
13
GNU General Public License for more details.
15
You should have received a copy of the GNU General Public License
16
along with this program; if not, write to the Free Software Foundation,
17
Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
25
/* If __GNU_LIBRARY__ is not already defined, either we are being used
26
standalone, or this is the first header included in the source file.
27
If we are being used with glibc, we need to include <features.h>, but
28
that does not exist if we are standalone. So: if __GNU_LIBRARY__ is
29
not defined, include <ctype.h>, which will pull in <features.h> for us
30
if it's from glibc. (Why ctype.h? It's guaranteed to exist and it
31
doesn't flood the namespace with stuff the way some other headers do.) */
32
#if !defined __GNU_LIBRARY__
40
/* For communication from `getopt' to the caller.
41
When `getopt' finds an option that takes an argument,
42
the argument value is returned here.
43
Also, when `ordering' is RETURN_IN_ORDER,
44
each non-option ARGV-element is returned here. */
48
/* Index in ARGV of the next element to be scanned.
49
This is used for communication to and from the caller
50
and for communication between successive calls to `getopt'.
52
On entry to `getopt', zero means this is the first call; initialize.
54
When `getopt' returns -1, this is the index of the first of the
55
non-option elements that the caller should itself scan.
57
Otherwise, `optind' communicates from one call to the next
58
how much of ARGV has been scanned so far. */
62
/* Callers store zero here to inhibit the error message `getopt' prints
63
for unrecognized options. */
67
/* Set to an option character which was unrecognized. */
72
/* Describe the long-named options requested by the application.
73
The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
74
of `struct option' terminated by an element containing a name which is
77
The field `has_arg' is:
78
no_argument (or 0) if the option does not take an argument,
79
required_argument (or 1) if the option requires an argument,
80
optional_argument (or 2) if the option takes an optional argument.
82
If the field `flag' is not NULL, it points to a variable that is set
83
to the value given in the field `val' when the option is found, but
84
left unchanged if the option is not found.
86
To have a long-named option do something other than set an `int' to
87
a compiled-in constant, such as set a value from `optarg', set the
88
option's `flag' field to zero and its `val' field to a nonzero
89
value (the equivalent single-letter option character, if there is
90
one). For long options that have a zero `flag' field, `getopt'
91
returns the contents of the `val' field. */
95
# if (defined __STDC__ && __STDC__) || defined __cplusplus
100
/* has_arg can't be an enum because some compilers complain about
101
type mismatches in all the code that assumes it is an int. */
107
/* Names for the values of the `has_arg' field of `struct option'. */
109
# define no_argument 0
110
# define required_argument 1
111
# define optional_argument 2
112
#endif /* need getopt */
115
/* Get definitions and prototypes for functions to process the
116
arguments in ARGV (ARGC of them, minus the program name) for
117
options given in OPTS.
119
Return the option character from OPTS just read. Return -1 when
120
there are no more options. For unrecognized options, or options
121
missing arguments, `optopt' is set to the option letter, and '?' is
124
The OPTS string is a list of characters which are recognized option
125
letters, optionally followed by colons, specifying that that letter
126
takes an argument, to be placed in `optarg'.
128
If a letter in OPTS is followed by two colons, its argument is
129
optional. This behavior is specific to the GNU `getopt'.
131
The argument `--' causes premature termination of argument
132
scanning, explicitly telling `getopt' that there are no more
135
If OPTS begins with `--', then non-option arguments are treated as
136
arguments to the option '\0'. This behavior is specific to the GNU
139
#if (defined __STDC__ && __STDC__) || defined __cplusplus
140
# ifdef __GNU_LIBRARY__
141
/* Many other libraries have conflicting prototypes for getopt, with
142
differences in the consts, in stdlib.h. To avoid compilation
143
errors, only prototype getopt for the GNU C library. */
144
extern int getopt (int argc, char *const *argv, const char *shortopts);
145
# else /* not __GNU_LIBRARY__ */
146
extern int getopt ();
147
# endif /* __GNU_LIBRARY__ */
149
# ifndef __need_getopt
150
extern int getopt_long (int argc, char *const *argv, const char *shortopts,
151
const struct option *longopts, int *longind);
152
extern int getopt_long_only (int argc, char *const *argv,
153
const char *shortopts,
154
const struct option *longopts, int *longind);
156
/* Internal only. Users should not call this directly. */
157
extern int _getopt_internal (int argc, char *const *argv,
158
const char *shortopts,
159
const struct option *longopts, int *longind,
162
#else /* not __STDC__ */
163
extern int getopt ();
164
# ifndef __need_getopt
165
extern int getopt_long ();
166
extern int getopt_long_only ();
168
extern int _getopt_internal ();
170
#endif /* __STDC__ */
176
/* Make sure we later can get all the definitions and declarations. */
179
#endif /* getopt.h */
added
removed
tools/getopt.h
