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 2, 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, write to the Free Software
16 Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
19 * $FreeBSD: src/gnu/usr.bin/patch/getopt.h,v 1.3.6.2 2002/04/30 20:40:02 gad Exp $
20 * $DragonFly: src/gnu/usr.bin/patch/Attic/getopt.h,v 1.2 2003/06/17 04:25:47 dillon Exp $
30 /* For communication from `getopt' to the caller.
31 When `getopt' finds an option that takes an argument,
32 the argument value is returned here.
33 Also, when `ordering' is RETURN_IN_ORDER,
34 each non-option ARGV-element is returned here. */
38 /* Index in ARGV of the next element to be scanned.
39 This is used for communication to and from the caller
40 and for communication between successive calls to `getopt'.
42 On entry to `getopt', zero means this is the first call; initialize.
44 When `getopt' returns EOF, this is the index of the first of the
45 non-option elements that the caller should itself scan.
47 Otherwise, `optind' communicates from one call to the next
48 how much of ARGV has been scanned so far. */
52 /* Callers store zero here to inhibit the error message `getopt' prints
53 for unrecognized options. */
57 /* Set to an option character which was unrecognized. */
61 /* Describe the long-named options requested by the application.
62 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
63 of `struct option' terminated by an element containing a name which is
66 The field `has_arg' is:
67 no_argument (or 0) if the option does not take an argument,
68 required_argument (or 1) if the option requires an argument,
69 optional_argument (or 2) if the option takes an optional argument.
71 If the field `flag' is not NULL, it points to a variable that is set
72 to the value given in the field `val' when the option is found, but
73 left unchanged if the option is not found.
75 To have a long-named option do something other than set an `int' to
76 a compiled-in constant, such as set a value from `optarg', set the
77 option's `flag' field to zero and its `val' field to a nonzero
78 value (the equivalent single-letter option character, if there is
79 one). For long options that have a zero `flag' field, `getopt'
80 returns the contents of the `val' field. */
89 /* has_arg can't be an enum because some compilers complain about
90 type mismatches in all the code that assumes it is an int. */
96 /* Names for the values of the `has_arg' field of `struct option'. */
99 #define required_argument 1
100 #define optional_argument 2
103 #if defined(__GNU_LIBRARY__)
104 /* Many other libraries have conflicting prototypes for getopt, with
105 differences in the consts, in stdlib.h. To avoid compilation
106 errors, only prototype getopt for the GNU C library. */
107 extern int getopt (int argc, char *const *argv, const char *shortopts);
108 #else /* not __GNU_LIBRARY__ */
109 extern int getopt(int _argc, char *const *_argv, const char *_optstring);
110 #endif /* not __GNU_LIBRARY__ */
111 extern int getopt_long (int argc, char *const *argv, const char *shortopts,
112 const struct option *longopts, int *longind);
113 extern int getopt_long_only (int argc, char *const *argv,
114 const char *shortopts,
115 const struct option *longopts, int *longind);
117 /* Internal only. Users should not call this directly. */
118 extern int _getopt_internal (int argc, char *const *argv,
119 const char *shortopts,
120 const struct option *longopts, int *longind,
122 #else /* not __STDC__ */
123 extern int getopt ();
124 extern int getopt_long ();
125 extern int getopt_long_only ();
127 extern int _getopt_internal ();
128 #endif /* not __STDC__ */
134 #endif /* _GETOPT_H */