getopt.h 6.87 KB
Newer Older
Josh Coalson's avatar
Josh Coalson committed
1 2 3 4 5 6 7 8 9 10
/*
	NOTE:
	I cannot get the vanilla getopt code to work (i.e. compile only what
	is needed and not duplicate symbols found in the standard library)
	on all the platforms that FLAC supports.  In particular the gating
	of code with the ELIDE_CODE #define is not accurate enough on systems
	that are POSIX but not glibc.  If someone has a patch that works on
	GNU/Linux, Darwin, AND Solaris please submit it on the project page:
		http://sourceforge.net/projects/flac

Josh Coalson's avatar
Josh Coalson committed
11
	In the meantime I have munged the global symbols and removed gates
Josh Coalson's avatar
Josh Coalson committed
12 13 14
	around code, while at the same time trying to touch the original as
	little as possible.
*/
Josh Coalson's avatar
Josh Coalson committed
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
/* Declarations for getopt.
   Copyright (C) 1989,90,91,92,93,94,96,97,98 Free Software Foundation, Inc.
   This file is part of the GNU C Library.

   The GNU C Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public License as
   published by the Free Software Foundation; either version 2 of the
   License, or (at your option) any later version.

   The GNU C Library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with the GNU C Library; see the file COPYING.LIB.  If not,
Miroslav Lichvar's avatar
Miroslav Lichvar committed
31 32
   write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.  */
Josh Coalson's avatar
Josh Coalson committed
33

Josh Coalson's avatar
Josh Coalson committed
34 35
#ifndef SHARE__GETOPT_H
#define SHARE__GETOPT_H
Josh Coalson's avatar
Josh Coalson committed
36

Josh Coalson's avatar
Josh Coalson committed
37 38 39
/*[JEC] was:#ifndef __need_getopt*/
/*[JEC] was:# define _GETOPT_H 1*/
/*[JEC] was:#endif*/
Josh Coalson's avatar
Josh Coalson committed
40 41 42 43 44

#ifdef	__cplusplus
extern "C" {
#endif

Josh Coalson's avatar
Josh Coalson committed
45 46
/* For communication from `share__getopt' to the caller.
   When `share__getopt' finds an option that takes an argument,
Josh Coalson's avatar
Josh Coalson committed
47 48 49 50
   the argument value is returned here.
   Also, when `ordering' is RETURN_IN_ORDER,
   each non-option ARGV-element is returned here.  */

51
extern char *share__optarg;
Josh Coalson's avatar
Josh Coalson committed
52 53 54

/* Index in ARGV of the next element to be scanned.
   This is used for communication to and from the caller
Josh Coalson's avatar
Josh Coalson committed
55
   and for communication between successive calls to `share__getopt'.
Josh Coalson's avatar
Josh Coalson committed
56

Josh Coalson's avatar
Josh Coalson committed
57
   On entry to `share__getopt', zero means this is the first call; initialize.
Josh Coalson's avatar
Josh Coalson committed
58

Josh Coalson's avatar
Josh Coalson committed
59
   When `share__getopt' returns -1, this is the index of the first of the
Josh Coalson's avatar
Josh Coalson committed
60 61
   non-option elements that the caller should itself scan.

Josh Coalson's avatar
Josh Coalson committed
62
   Otherwise, `share__optind' communicates from one call to the next
Josh Coalson's avatar
Josh Coalson committed
63 64
   how much of ARGV has been scanned so far.  */

65
extern int share__optind;
Josh Coalson's avatar
Josh Coalson committed
66

Josh Coalson's avatar
Josh Coalson committed
67
/* Callers store zero here to inhibit the error message `share__getopt' prints
Josh Coalson's avatar
Josh Coalson committed
68 69
   for unrecognized options.  */

70
extern int share__opterr;
Josh Coalson's avatar
Josh Coalson committed
71 72 73

/* Set to an option character which was unrecognized.  */

74
extern int share__optopt;
Josh Coalson's avatar
Josh Coalson committed
75

Josh Coalson's avatar
Josh Coalson committed
76
/*[JEC] was:#ifndef __need_getopt */
Josh Coalson's avatar
Josh Coalson committed
77
/* Describe the long-named options requested by the application.
Josh Coalson's avatar
Josh Coalson committed
78 79
   The LONG_OPTIONS argument to share__getopt_long or share__getopt_long_only is a vector
   of `struct share__option' terminated by an element containing a name which is
Josh Coalson's avatar
Josh Coalson committed
80 81 82
   zero.

   The field `has_arg' is:
Josh Coalson's avatar
Josh Coalson committed
83 84 85
   share__no_argument		(or 0) if the option does not take an argument,
   share__required_argument	(or 1) if the option requires an argument,
   share__optional_argument 	(or 2) if the option takes an optional argument.
Josh Coalson's avatar
Josh Coalson committed
86 87 88 89 90 91

   If the field `flag' is not NULL, it points to a variable that is set
   to the value given in the field `val' when the option is found, but
   left unchanged if the option is not found.

   To have a long-named option do something other than set an `int' to
Josh Coalson's avatar
Josh Coalson committed
92
   a compiled-in constant, such as set a value from `share__optarg', set the
Josh Coalson's avatar
Josh Coalson committed
93 94
   option's `flag' field to zero and its `val' field to a nonzero
   value (the equivalent single-letter option character, if there is
Josh Coalson's avatar
Josh Coalson committed
95
   one).  For long options that have a zero `flag' field, `share__getopt'
Josh Coalson's avatar
Josh Coalson committed
96 97
   returns the contents of the `val' field.  */

Josh Coalson's avatar
Josh Coalson committed
98
struct share__option
Josh Coalson's avatar
Josh Coalson committed
99 100 101 102 103 104 105 106 107 108 109 110 111
{
# if defined __STDC__ && __STDC__
  const char *name;
# else
  char *name;
# endif
  /* has_arg can't be an enum because some compilers complain about
     type mismatches in all the code that assumes it is an int.  */
  int has_arg;
  int *flag;
  int val;
};

Josh Coalson's avatar
Josh Coalson committed
112
/* Names for the values of the `has_arg' field of `struct share__option'.  */
Josh Coalson's avatar
Josh Coalson committed
113

Josh Coalson's avatar
Josh Coalson committed
114 115 116
# define share__no_argument		0
# define share__required_argument	1
# define share__optional_argument	2
Josh Coalson's avatar
Josh Coalson committed
117
/*[JEC] was:#endif*/	/* need getopt */
Josh Coalson's avatar
Josh Coalson committed
118 119 120 121 122 123 124 125


/* Get definitions and prototypes for functions to process the
   arguments in ARGV (ARGC of them, minus the program name) for
   options given in OPTS.

   Return the option character from OPTS just read.  Return -1 when
   there are no more options.  For unrecognized options, or options
Josh Coalson's avatar
Josh Coalson committed
126
   missing arguments, `share__optopt' is set to the option letter, and '?' is
Josh Coalson's avatar
Josh Coalson committed
127 128 129 130
   returned.

   The OPTS string is a list of characters which are recognized option
   letters, optionally followed by colons, specifying that that letter
Josh Coalson's avatar
Josh Coalson committed
131
   takes an argument, to be placed in `share__optarg'.
Josh Coalson's avatar
Josh Coalson committed
132 133

   If a letter in OPTS is followed by two colons, its argument is
Josh Coalson's avatar
Josh Coalson committed
134
   optional.  This behavior is specific to the GNU `share__getopt'.
Josh Coalson's avatar
Josh Coalson committed
135 136

   The argument `--' causes premature termination of argument
Josh Coalson's avatar
Josh Coalson committed
137
   scanning, explicitly telling `share__getopt' that there are no more
Josh Coalson's avatar
Josh Coalson committed
138 139 140 141
   options.

   If OPTS begins with `--', then non-option arguments are treated as
   arguments to the option '\0'.  This behavior is specific to the GNU
Josh Coalson's avatar
Josh Coalson committed
142
   `share__getopt'.  */
Josh Coalson's avatar
Josh Coalson committed
143

Josh Coalson's avatar
Josh Coalson committed
144 145
/*[JEC] was:#if defined __STDC__ && __STDC__*/
/*[JEC] was:# ifdef __GNU_LIBRARY__*/
Josh Coalson's avatar
Josh Coalson committed
146 147 148
/* Many other libraries have conflicting prototypes for getopt, with
   differences in the consts, in stdlib.h.  To avoid compilation
   errors, only prototype getopt for the GNU C library.  */
149
extern int share__getopt (int argc, char *const *argv, const char *shortopts);
Josh Coalson's avatar
Josh Coalson committed
150 151 152 153 154
/*[JEC] was:# else*/ /* not __GNU_LIBRARY__ */
/*[JEC] was:extern int getopt ();*/
/*[JEC] was:# endif*/ /* __GNU_LIBRARY__ */

/*[JEC] was:# ifndef __need_getopt*/
155 156 157 158 159
extern int share__getopt_long (int argc, char *const *argv, const char *shortopts,
		        const struct share__option *longopts, int *longind);
extern int share__getopt_long_only (int argc, char *const *argv,
			     const char *shortopts,
		             const struct share__option *longopts, int *longind);
Josh Coalson's avatar
Josh Coalson committed
160 161

/* Internal only.  Users should not call this directly.  */
162 163 164 165
extern int share___getopt_internal (int argc, char *const *argv,
			     const char *shortopts,
		             const struct share__option *longopts, int *longind,
			     int long_only);
Josh Coalson's avatar
Josh Coalson committed
166 167 168 169 170 171
/*[JEC] was:# endif*/
/*[JEC] was:#else*/ /* not __STDC__ */
/*[JEC] was:extern int getopt ();*/
/*[JEC] was:# ifndef __need_getopt*/
/*[JEC] was:extern int getopt_long ();*/
/*[JEC] was:extern int getopt_long_only ();*/
Josh Coalson's avatar
Josh Coalson committed
172

Josh Coalson's avatar
Josh Coalson committed
173 174 175
/*[JEC] was:extern int _getopt_internal ();*/
/*[JEC] was:# endif*/
/*[JEC] was:#endif*/ /* __STDC__ */
Josh Coalson's avatar
Josh Coalson committed
176 177 178 179 180 181

#ifdef	__cplusplus
}
#endif

/* Make sure we later can get all the definitions and declarations.  */
Josh Coalson's avatar
Josh Coalson committed
182
/*[JEC] was:#undef __need_getopt*/
Josh Coalson's avatar
Josh Coalson committed
183 184

#endif /* getopt.h */