1 /* Declarations for getopt.
2 Copyright (C) 1989, 1990, 1991, 1992, 1993 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 General Public License as published by the
6 Free Software Foundation; either version 3, or (at your option) any
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 General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 /* For communication from `getopt' to the caller.
25 When `getopt' finds an option that takes an argument,
26 the argument value is returned here.
27 Also, when `ordering' is RETURN_IN_ORDER,
28 each non-option ARGV-element is returned here. */
32 /* Index in ARGV of the next element to be scanned.
33 This is used for communication to and from the caller
34 and for communication between successive calls to `getopt'.
36 On entry to `getopt', zero means this is the first call; initialize.
38 When `getopt' returns EOF, this is the index of the first of the
39 non-option elements that the caller should itself scan.
41 Otherwise, `optind' communicates from one call to the next
42 how much of ARGV has been scanned so far. */
46 /* Callers store zero here to inhibit the error message `getopt' prints
47 for unrecognized options. */
51 /* Set to an option character which was unrecognized. */
55 /* Describe the long-named options requested by the application.
56 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
57 of `struct option' terminated by an element containing a name which is
60 The field `has_arg' is:
61 no_argument (or 0) if the option does not take an argument,
62 required_argument (or 1) if the option requires an argument,
63 optional_argument (or 2) if the option takes an optional argument.
65 If the field `flag' is not NULL, it points to a variable that is set
66 to the value given in the field `val' when the option is found, but
67 left unchanged if the option is not found.
69 To have a long-named option do something other than set an `int' to
70 a compiled-in constant, such as set a value from `optarg', set the
71 option's `flag' field to zero and its `val' field to a nonzero
72 value (the equivalent single-letter option character, if there is
73 one). For long options that have a zero `flag' field, `getopt'
74 returns the contents of the `val' field. */
79 /* has_arg can't be an enum because some compilers complain about
80 type mismatches in all the code that assumes it is an int. */
86 /* Names for the values of the `has_arg' field of `struct option'. */
89 #define required_argument 1
90 #define optional_argument 2
93 #if defined(__GNU_LIBRARY__)
94 /* Many other libraries have conflicting prototypes for getopt, with
95 differences in the consts, in stdlib.h. To avoid compilation
96 errors, only prototype getopt for the GNU C library. */
97 extern int getopt (int argc, char *const *argv, const char *shortopts);
98 #else /* not __GNU_LIBRARY__ */
100 #endif /* not __GNU_LIBRARY__ */
101 extern int getopt_long (int argc, char *const *argv, const char *shortopts,
102 const struct option *longopts, int *longind);
103 extern int getopt_long_only (int argc, char *const *argv,
104 const char *shortopts,
105 const struct option *longopts, int *longind);
107 /* Internal only. Users should not call this directly. */
108 extern int _getopt_internal (int argc, char *const *argv,
109 const char *shortopts,
110 const struct option *longopts, int *longind,
112 #else /* not __STDC__ */
113 extern int getopt ();
114 extern int getopt_long ();
115 extern int getopt_long_only ();
117 extern int _getopt_internal ();
118 #endif /* not __STDC__ */
124 #endif /* _GETOPT_H */