2
* getopt.h - interface to my re-implementation of getopt.
3
* Copyright 1997, 2000, 2001, 2002, 2006, Benjamin Sittler
5
* Permission is hereby granted, free of charge, to any person
6
* obtaining a copy of this software and associated documentation
7
* files (the "Software"), to deal in the Software without
8
* restriction, including without limitation the rights to use, copy,
9
* modify, merge, publish, distribute, sublicense, and/or sell copies
10
* of the Software, and to permit persons to whom the Software is
11
* furnished to do so, subject to the following conditions:
13
* The above copyright notice and this permission notice shall be
14
* included in all copies or substantial portions of the Software.
16
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
20
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
21
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23
* DEALINGS IN THE SOFTWARE.
26
#ifndef _GETOPT_H_INCLUDED
27
#define _GETOPT_H_INCLUDED
1
/* Declarations for getopt.
2
Copyright (C) 1989,90,91,92,93,94,96,97,98,99 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 Library General Public License as
7
published by the Free Software Foundation; either version 2 of the
8
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
Library General Public License for more details.
15
You should have received a copy of the GNU Library General Public
16
License along with the GNU C Library; see the file COPYING.LIB. If not,
17
write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18
Boston, MA 02111-1307, USA. */
26
/* If __GNU_LIBRARY__ is not already defined, either we are being used
27
standalone, or this is the first header included in the source file.
28
If we are being used with glibc, we need to include <features.h>, but
29
that does not exist if we are standalone. So: if __GNU_LIBRARY__ is
30
not defined, include <ctype.h>, which will pull in <features.h> for us
31
if it's from glibc. (Why ctype.h? It's guaranteed to exist and it
32
doesn't flood the namespace with stuff the way some other headers do.) */
33
#if !defined __GNU_LIBRARY__
33
/* UNIX-style short-argument parser */
34
extern int my_getopt(int argc, char *argv[], const char *opts);
41
/* For communication from `getopt' to the caller.
42
When `getopt' finds an option that takes an argument,
43
the argument value is returned here.
44
Also, when `ordering' is RETURN_IN_ORDER,
45
each non-option ARGV-element is returned here. */
36
extern int optind, opterr, optopt;
37
47
extern char *optarg;
49
/* Index in ARGV of the next element to be scanned.
50
This is used for communication to and from the caller
51
and for communication between successive calls to `getopt'.
53
On entry to `getopt', zero means this is the first call; initialize.
55
When `getopt' returns -1, this is the index of the first of the
56
non-option elements that the caller should itself scan.
58
Otherwise, `optind' communicates from one call to the next
59
how much of ARGV has been scanned so far. */
63
/* Callers store zero here to inhibit the error message `getopt' prints
64
for unrecognized options. */
68
/* Set to an option character which was unrecognized. */
73
/* Describe the long-named options requested by the application.
74
The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
75
of `struct option' terminated by an element containing a name which is
78
The field `has_arg' is:
79
no_argument (or 0) if the option does not take an argument,
80
required_argument (or 1) if the option requires an argument,
81
optional_argument (or 2) if the option takes an optional argument.
83
If the field `flag' is not NULL, it points to a variable that is set
84
to the value given in the field `val' when the option is found, but
85
left unchanged if the option is not found.
87
To have a long-named option do something other than set an `int' to
88
a compiled-in constant, such as set a value from `optarg', set the
89
option's `flag' field to zero and its `val' field to a nonzero
90
value (the equivalent single-letter option character, if there is
91
one). For long options that have a zero `flag' field, `getopt'
92
returns the contents of the `val' field. */
96
# if defined __STDC__ && __STDC__
101
/* has_arg can't be an enum because some compilers complain about
102
type mismatches in all the code that assumes it is an int. */
46
/* human-readable values for has_arg */
49
#undef required_argument
50
#define required_argument 1
51
#undef optional_argument
52
#define optional_argument 2
54
/* GNU-style long-argument parsers */
55
extern int my_getopt_long(int argc, char * argv[], const char *shortopts,
56
const struct option *longopts, int *longind);
58
extern int my_getopt_long_only(int argc, char * argv[], const char *shortopts,
59
const struct option *longopts, int *longind);
108
/* Names for the values of the `has_arg' field of `struct option'. */
110
# define no_argument 0
111
# define required_argument 1
112
# define optional_argument 2
113
#endif /* need getopt */
116
/* Get definitions and prototypes for functions to process the
117
arguments in ARGV (ARGC of them, minus the program name) for
118
options given in OPTS.
120
Return the option character from OPTS just read. Return -1 when
121
there are no more options. For unrecognized options, or options
122
missing arguments, `optopt' is set to the option letter, and '?' is
125
The OPTS string is a list of characters which are recognized option
126
letters, optionally followed by colons, specifying that that letter
127
takes an argument, to be placed in `optarg'.
129
If a letter in OPTS is followed by two colons, its argument is
130
optional. This behavior is specific to the GNU `getopt'.
132
The argument `--' causes premature termination of argument
133
scanning, explicitly telling `getopt' that there are no more
136
If OPTS begins with `--', then non-option arguments are treated as
137
arguments to the option '\0'. This behavior is specific to the GNU
140
#if defined __STDC__ && __STDC__
141
# ifdef __GNU_LIBRARY__
142
/* Many other libraries have conflicting prototypes for getopt, with
143
differences in the consts, in stdlib.h. To avoid compilation
144
errors, only prototype getopt for the GNU C library. */
145
extern int getopt (int __argc, char *const *__argv, const char *__shortopts);
146
# else /* not __GNU_LIBRARY__ */
147
extern int getopt ();
148
# endif /* __GNU_LIBRARY__ */
150
# ifndef __need_getopt
151
extern int getopt_long (int __argc, char *const *__argv, const char *__shortopts,
152
const struct option *__longopts, int *__longind);
153
extern int getopt_long_only (int __argc, char *const *__argv,
154
const char *__shortopts,
155
const struct option *__longopts, int *__longind);
157
/* Internal only. Users should not call this directly. */
158
extern int _getopt_internal (int __argc, char *const *__argv,
159
const char *__shortopts,
160
const struct option *__longopts, int *__longind,
163
#else /* not __STDC__ */
164
extern int getopt ();
165
# ifndef __need_getopt
166
extern int getopt_long ();
167
extern int getopt_long_only ();
169
extern int _getopt_internal ();
171
#endif /* __STDC__ */
65
#endif /* _GETOPT_H_INCLUDED */
177
/* Make sure we later can get all the definitions and declarations. */
180
#endif /* getopt.h */