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.
4
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)
8   any later version.
9
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.
14
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.  */
18
19#ifndef _GETOPT_H
20
21#ifndef __need_getopt
22# define _GETOPT_H 1
23#endif
24
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__
33# include <ctype.h>
34#endif
35
36#ifdef	__cplusplus
37extern "C" {
38#endif
39
40/* For communication from `getopt' to the caller.
41   When `getopt' finds an option that takes an argument,
42   the argument value is returned here.
43   Also, when `ordering' is RETURN_IN_ORDER,
44   each non-option ARGV-element is returned here.  */
45
46extern char *optarg;
47
48/* Index in ARGV of the next element to be scanned.
49   This is used for communication to and from the caller
50   and for communication between successive calls to `getopt'.
51
52   On entry to `getopt', zero means this is the first call; initialize.
53
54   When `getopt' returns -1, this is the index of the first of the
55   non-option elements that the caller should itself scan.
56
57   Otherwise, `optind' communicates from one call to the next
58   how much of ARGV has been scanned so far.  */
59
60extern int optind;
61
62/* Callers store zero here to inhibit the error message `getopt' prints
63   for unrecognized options.  */
64
65extern int opterr;
66
67/* Set to an option character which was unrecognized.  */
68
69extern int optopt;
70
71#ifndef __need_getopt
72/* Describe the long-named options requested by the application.
73   The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
74   of `struct option' terminated by an element containing a name which is
75   zero.
76
77   The field `has_arg' is:
78   no_argument		(or 0) if the option does not take an argument,
79   required_argument	(or 1) if the option requires an argument,
80   optional_argument 	(or 2) if the option takes an optional argument.
81
82   If the field `flag' is not NULL, it points to a variable that is set
83   to the value given in the field `val' when the option is found, but
84   left unchanged if the option is not found.
85
86   To have a long-named option do something other than set an `int' to
87   a compiled-in constant, such as set a value from `optarg', set the
88   option's `flag' field to zero and its `val' field to a nonzero
89   value (the equivalent single-letter option character, if there is
90   one).  For long options that have a zero `flag' field, `getopt'
91   returns the contents of the `val' field.  */
92
93struct option
94{
95# if (defined __STDC__ && __STDC__) || defined __cplusplus
96  const char *name;
97# else
98  char *name;
99# endif
100  /* has_arg can't be an enum because some compilers complain about
101     type mismatches in all the code that assumes it is an int.  */
102  int has_arg;
103  int *flag;
104  int val;
105};
106
107/* Names for the values of the `has_arg' field of `struct option'.  */
108
109# define no_argument		0
110# define required_argument	1
111# define optional_argument	2
112#endif	/* need getopt */
113
114
115/* Get definitions and prototypes for functions to process the
116   arguments in ARGV (ARGC of them, minus the program name) for
117   options given in OPTS.
118
119   Return the option character from OPTS just read.  Return -1 when
120   there are no more options.  For unrecognized options, or options
121   missing arguments, `optopt' is set to the option letter, and '?' is
122   returned.
123
124   The OPTS string is a list of characters which are recognized option
125   letters, optionally followed by colons, specifying that that letter
126   takes an argument, to be placed in `optarg'.
127
128   If a letter in OPTS is followed by two colons, its argument is
129   optional.  This behavior is specific to the GNU `getopt'.
130
131   The argument `--' causes premature termination of argument
132   scanning, explicitly telling `getopt' that there are no more
133   options.
134
135   If OPTS begins with `--', then non-option arguments are treated as
136   arguments to the option '\0'.  This behavior is specific to the GNU
137   `getopt'.  */
138
139#if (defined __STDC__ && __STDC__) || defined __cplusplus
140# ifdef __GNU_LIBRARY__
141/* Many other libraries have conflicting prototypes for getopt, with
142   differences in the consts, in stdlib.h.  To avoid compilation
143   errors, only prototype getopt for the GNU C library.  */
144extern int getopt (int __argc, char *const *__argv, const char *__shortopts);
145# else /* not __GNU_LIBRARY__ */
146extern int getopt ();
147# endif /* __GNU_LIBRARY__ */
148
149# ifndef __need_getopt
150extern int getopt_long (int __argc, char *const *__argv, const char *__shortopts,
151		        const struct option *__longopts, int *__longind);
152extern int getopt_long_only (int __argc, char *const *__argv,
153			     const char *__shortopts,
154		             const struct option *__longopts, int *__longind);
155
156/* Internal only.  Users should not call this directly.  */
157extern int _getopt_internal (int __argc, char *const *__argv,
158			     const char *__shortopts,
159		             const struct option *__longopts, int *__longind,
160			     int __long_only);
161# endif
162#else /* not __STDC__ */
163extern int getopt ();
164# ifndef __need_getopt
165extern int getopt_long ();
166extern int getopt_long_only ();
167
168extern int _getopt_internal ();
169# endif
170#endif /* __STDC__ */
171
172#ifdef	__cplusplus
173}
174#endif
175
176/* Make sure we later can get all the definitions and declarations.  */
177#undef __need_getopt
178
179#endif /* getopt.h */
180