1/* Declarations for getopt.
2   Copyright (C) 1989, 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
3
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
7   later version.
8
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.  */
13
14#ifndef _GETOPT_H
15#define _GETOPT_H 1
16
17#ifdef	__cplusplus
18extern "C" {
19#endif
20
21/* For communication from `getopt' to the caller.
22   When `getopt' finds an option that takes an argument,
23   the argument value is returned here.
24   Also, when `ordering' is RETURN_IN_ORDER,
25   each non-option ARGV-element is returned here.  */
26
27extern char *optarg;
28
29/* Index in ARGV of the next element to be scanned.
30   This is used for communication to and from the caller
31   and for communication between successive calls to `getopt'.
32
33   On entry to `getopt', zero means this is the first call; initialize.
34
35   When `getopt' returns EOF, this is the index of the first of the
36   non-option elements that the caller should itself scan.
37
38   Otherwise, `optind' communicates from one call to the next
39   how much of ARGV has been scanned so far.  */
40
41extern int optind;
42
43/* Callers store zero here to inhibit the error message `getopt' prints
44   for unrecognized options.  */
45
46extern int opterr;
47
48/* Set to an option character which was unrecognized.  */
49
50extern int optopt;
51
52/* Describe the long-named options requested by the application.
53   The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
54   of `struct option' terminated by an element containing a name which is
55   zero.
56
57   The field `has_arg' is:
58   no_argument		(or 0) if the option does not take an argument,
59   required_argument	(or 1) if the option requires an argument,
60   optional_argument 	(or 2) if the option takes an optional argument.
61
62   If the field `flag' is not NULL, it points to a variable that is set
63   to the value given in the field `val' when the option is found, but
64   left unchanged if the option is not found.
65
66   To have a long-named option do something other than set an `int' to
67   a compiled-in constant, such as set a value from `optarg', set the
68   option's `flag' field to zero and its `val' field to a nonzero
69   value (the equivalent single-letter option character, if there is
70   one).  For long options that have a zero `flag' field, `getopt'
71   returns the contents of the `val' field.  */
72
73struct option
74{
75#if	__STDC__
76  const char *name;
77#else
78  char *name;
79#endif
80  /* has_arg can't be an enum because some compilers complain about
81     type mismatches in all the code that assumes it is an int.  */
82  int has_arg;
83  int *flag;
84  int val;
85};
86
87/* Names for the values of the `has_arg' field of `struct option'.  */
88
89#define	no_argument		0
90#define required_argument	1
91#define optional_argument	2
92
93#if __STDC__
94/* Many other libraries have conflicting prototypes for getopt, with
95   differences in the consts, in stdlib.h.  We used to try to prototype
96   it if __GNU_LIBRARY__ but that wasn't problem free either (I'm not sure
97   exactly why), and there is no particular need to prototype it.
98   We really shouldn't be trampling on the system's namespace at all by
99   declaring getopt() but that is a bigger issue.  */
100extern int getopt ();
101
102extern int getopt_long (int argc, char *const *argv, const char *shortopts,
103		        const struct option *longopts, int *longind);
104extern int getopt_long_only (int argc, char *const *argv,
105			     const char *shortopts,
106		             const struct option *longopts, int *longind);
107
108/* Internal only.  Users should not call this directly.  */
109extern int _getopt_internal (int argc, char *const *argv,
110			     const char *shortopts,
111		             const struct option *longopts, int *longind,
112			     int long_only);
113#else /* not __STDC__ */
114extern int getopt ();
115extern int getopt_long ();
116extern int getopt_long_only ();
117
118extern int _getopt_internal ();
119#endif /* not __STDC__ */
120
121#ifdef	__cplusplus
122}
123#endif
124
125#endif /* _GETOPT_H */
126