1/*	$NetBSD$	*/
2
3/* Declarations for getopt.
4   Copyright (C) 1989-1994,1996-1999,2001,2003,2004
5   Free Software Foundation, Inc.
6   This file is part of the GNU C Library.
7
8   This program is free software; you can redistribute it and/or modify
9   it under the terms of the GNU General Public License as published by
10   the Free Software Foundation; either version 2, or (at your option)
11   any later version.
12
13   This program is distributed in the hope that it will be useful,
14   but WITHOUT ANY WARRANTY; without even the implied warranty of
15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16   GNU General Public License for more details.
17
18   You should have received a copy of the GNU General Public License along
19   with this program; if not, write to the Free Software Foundation,
20   Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
21
22#ifndef _GETOPT_H
23
24#ifndef __need_getopt
25# define _GETOPT_H 1
26#endif
27
28/* If __GNU_LIBRARY__ is not already defined, either we are being used
29   standalone, or this is the first header included in the source file.
30   If we are being used with glibc, we need to include <features.h>, but
31   that does not exist if we are standalone.  So: if __GNU_LIBRARY__ is
32   not defined, include <ctype.h>, which will pull in <features.h> for us
33   if it's from glibc.  (Why ctype.h?  It's guaranteed to exist and it
34   doesn't flood the namespace with stuff the way some other headers do.)  */
35#if !defined __GNU_LIBRARY__
36# include <ctype.h>
37#endif
38
39#ifndef __THROW
40# ifndef __GNUC_PREREQ
41#  define __GNUC_PREREQ(maj, min) (0)
42# endif
43# if defined __cplusplus && __GNUC_PREREQ (2,8)
44#  define __THROW	throw ()
45# else
46#  define __THROW
47# endif
48#endif
49
50#ifdef	__cplusplus
51extern "C" {
52#endif
53
54/* For communication from `getopt' to the caller.
55   When `getopt' finds an option that takes an argument,
56   the argument value is returned here.
57   Also, when `ordering' is RETURN_IN_ORDER,
58   each non-option ARGV-element is returned here.  */
59
60extern char *optarg;
61
62/* Index in ARGV of the next element to be scanned.
63   This is used for communication to and from the caller
64   and for communication between successive calls to `getopt'.
65
66   On entry to `getopt', zero means this is the first call; initialize.
67
68   When `getopt' returns -1, this is the index of the first of the
69   non-option elements that the caller should itself scan.
70
71   Otherwise, `optind' communicates from one call to the next
72   how much of ARGV has been scanned so far.  */
73
74extern int optind;
75
76/* Callers store zero here to inhibit the error message `getopt' prints
77   for unrecognized options.  */
78
79extern int opterr;
80
81/* Set to an option character which was unrecognized.  */
82
83extern int optopt;
84
85#ifndef __need_getopt
86/* Describe the long-named options requested by the application.
87   The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
88   of `struct option' terminated by an element containing a name which is
89   zero.
90
91   The field `has_arg' is:
92   no_argument		(or 0) if the option does not take an argument,
93   required_argument	(or 1) if the option requires an argument,
94   optional_argument 	(or 2) if the option takes an optional argument.
95
96   If the field `flag' is not NULL, it points to a variable that is set
97   to the value given in the field `val' when the option is found, but
98   left unchanged if the option is not found.
99
100   To have a long-named option do something other than set an `int' to
101   a compiled-in constant, such as set a value from `optarg', set the
102   option's `flag' field to zero and its `val' field to a nonzero
103   value (the equivalent single-letter option character, if there is
104   one).  For long options that have a zero `flag' field, `getopt'
105   returns the contents of the `val' field.  */
106
107struct option
108{
109  const char *name;
110  /* has_arg can't be an enum because some compilers complain about
111     type mismatches in all the code that assumes it is an int.  */
112  int has_arg;
113  int *flag;
114  int val;
115};
116
117/* Names for the values of the `has_arg' field of `struct option'.  */
118
119# define no_argument		0
120# define required_argument	1
121# define optional_argument	2
122#endif	/* need getopt */
123
124
125/* Get definitions and prototypes for functions to process the
126   arguments in ARGV (ARGC of them, minus the program name) for
127   options given in OPTS.
128
129   Return the option character from OPTS just read.  Return -1 when
130   there are no more options.  For unrecognized options, or options
131   missing arguments, `optopt' is set to the option letter, and '?' is
132   returned.
133
134   The OPTS string is a list of characters which are recognized option
135   letters, optionally followed by colons, specifying that that letter
136   takes an argument, to be placed in `optarg'.
137
138   If a letter in OPTS is followed by two colons, its argument is
139   optional.  This behavior is specific to the GNU `getopt'.
140
141   The argument `--' causes premature termination of argument
142   scanning, explicitly telling `getopt' that there are no more
143   options.
144
145   If OPTS begins with `--', then non-option arguments are treated as
146   arguments to the option '\0'.  This behavior is specific to the GNU
147   `getopt'.  */
148
149#ifdef __GNU_LIBRARY__
150/* Many other libraries have conflicting prototypes for getopt, with
151   differences in the consts, in stdlib.h.  To avoid compilation
152   errors, only prototype getopt for the GNU C library.  */
153extern int getopt (int ___argc, char *const *___argv, const char *__shortopts)
154       __THROW;
155#else /* not __GNU_LIBRARY__ */
156extern int getopt ();
157#endif /* __GNU_LIBRARY__ */
158
159#ifndef __need_getopt
160extern int getopt_long (int ___argc, char *const *___argv,
161			const char *__shortopts,
162		        const struct option *__longopts, int *__longind)
163       __THROW;
164extern int getopt_long_only (int ___argc, char *const *___argv,
165			     const char *__shortopts,
166		             const struct option *__longopts, int *__longind)
167       __THROW;
168
169#endif
170
171#ifdef	__cplusplus
172}
173#endif
174
175/* Make sure we later can get all the definitions and declarations.  */
176#undef __need_getopt
177
178#endif /* getopt.h */
179