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__
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. */
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__) || defined __cplusplus
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. */
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__) || defined __cplusplus
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,
146 const char *__shortopts);
147 # else /* not __GNU_LIBRARY__ */
148 extern int getopt ();
149 # endif /* __GNU_LIBRARY__ */
151 # ifndef __need_getopt
152 extern int getopt_long (int __argc, char *const *__argv,
153 const char *__shortopts,
154 const struct option *__longopts, int *__longind);
155 extern int getopt_long_only (int __argc, char *const *__argv,
156 const char *__shortopts,
157 const struct option *__longopts,
160 /* Internal only. Users should not call this directly. */
161 extern int _getopt_internal (int __argc, char *const *__argv,
162 const char *__shortopts,
163 const struct option *__longopts,
164 int *__longind, int __long_only);
166 #else /* not __STDC__ */
167 extern int getopt ();
168 # ifndef __need_getopt
169 extern int getopt_long ();
170 extern int getopt_long_only ();
172 extern int _getopt_internal ();
174 #endif /* __STDC__ */
180 /* Make sure we later can get all the definitions and declarations. */
183 #endif /* getopt.h */