getopt.in.h 8.89 KB
Newer Older
1
/* Declarations for getopt.
2
   Copyright (C) 1989-1994, 1996-1999, 2001, 2003-2007, 2009-2013 Free Software
3
   Foundation, Inc.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
   This file is part of the GNU C Library.

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

   This program 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 General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

19
#ifndef _@GUARD_PREFIX@_GETOPT_H
20 21 22 23

#if __GNUC__ >= 3
@PRAGMA_SYSTEM_HEADER@
#endif
24
@PRAGMA_COLUMNS@
25 26 27 28 29 30 31 32 33 34

/* The include_next requires a split double-inclusion guard.  We must
   also inform the replacement unistd.h to not recursively use
   <getopt.h>; our definitions will be present soon enough.  */
#if @HAVE_GETOPT_H@
# define _GL_SYSTEM_GETOPT
# @INCLUDE_NEXT@ @NEXT_GETOPT_H@
# undef _GL_SYSTEM_GETOPT
#endif

35
#ifndef _@GUARD_PREFIX@_GETOPT_H
36 37

#ifndef __need_getopt
38
# define _@GUARD_PREFIX@_GETOPT_H 1
39 40 41 42 43 44
#endif

/* Standalone applications should #define __GETOPT_PREFIX to an
   identifier that prefixes the external functions and variables
   defined in this header.  When this happens, include the
   headers that might declare getopt so that they will not cause
45 46
   confusion if included after this file (if the system had <getopt.h>,
   we have already included it).  Then systematically rename
47 48 49 50
   identifiers so that they do not collide with the system functions
   and variables.  Renaming avoids problems with some compilers and
   linkers.  */
#if defined __GETOPT_PREFIX && !defined __need_getopt
51
# if !@HAVE_GETOPT_H@
52
#  define __need_system_stdlib_h
53
#  include <stdlib.h>
54
#  undef __need_system_stdlib_h
55 56 57
#  include <stdio.h>
#  include <unistd.h>
# endif
58 59 60 61 62 63 64 65
# undef __need_getopt
# undef getopt
# undef getopt_long
# undef getopt_long_only
# undef optarg
# undef opterr
# undef optind
# undef optopt
66
# undef option
67 68 69 70 71 72 73 74 75 76
# define __GETOPT_CONCAT(x, y) x ## y
# define __GETOPT_XCONCAT(x, y) __GETOPT_CONCAT (x, y)
# define __GETOPT_ID(y) __GETOPT_XCONCAT (__GETOPT_PREFIX, y)
# define getopt __GETOPT_ID (getopt)
# define getopt_long __GETOPT_ID (getopt_long)
# define getopt_long_only __GETOPT_ID (getopt_long_only)
# define optarg __GETOPT_ID (optarg)
# define opterr __GETOPT_ID (opterr)
# define optind __GETOPT_ID (optind)
# define optopt __GETOPT_ID (optopt)
77 78
# define option __GETOPT_ID (option)
# define _getopt_internal __GETOPT_ID (getopt_internal)
79 80 81 82 83 84 85 86
#endif

/* Standalone applications get correct prototypes for getopt_long and
   getopt_long_only; they declare "char **argv".  libc uses prototypes
   with "char *const *argv" that are incorrect because getopt_long and
   getopt_long_only can permute argv; this is required for backward
   compatibility (e.g., for LSB 2.0.1).

87
   This used to be '#if defined __GETOPT_PREFIX && !defined __need_getopt',
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
   but it caused redefinition warnings if both unistd.h and getopt.h were
   included, since unistd.h includes getopt.h having previously defined
   __need_getopt.

   The only place where __getopt_argv_const is used is in definitions
   of getopt_long and getopt_long_only below, but these are visible
   only if __need_getopt is not defined, so it is quite safe to rewrite
   the conditional as follows:
*/
#if !defined __need_getopt
# if defined __GETOPT_PREFIX
#  define __getopt_argv_const /* empty */
# else
#  define __getopt_argv_const const
# endif
#endif

/* If __GNU_LIBRARY__ is not already defined, either we are being used
   standalone, or this is the first header included in the source file.
   If we are being used with glibc, we need to include <features.h>, but
   that does not exist if we are standalone.  So: if __GNU_LIBRARY__ is
   not defined, include <ctype.h>, which will pull in <features.h> for us
   if it's from glibc.  (Why ctype.h?  It's guaranteed to exist and it
   doesn't flood the namespace with stuff the way some other headers do.)  */
#if !defined __GNU_LIBRARY__
# include <ctype.h>
#endif

#ifndef __THROW
# ifndef __GNUC_PREREQ
#  define __GNUC_PREREQ(maj, min) (0)
# endif
# if defined __cplusplus && __GNUC_PREREQ (2,8)
121
#  define __THROW       throw ()
122 123 124 125 126
# else
#  define __THROW
# endif
#endif

127 128
/* The definition of _GL_ARG_NONNULL is copied here.  */

129 130 131 132
#ifdef __cplusplus
extern "C" {
#endif

133 134
/* For communication from 'getopt' to the caller.
   When 'getopt' finds an option that takes an argument,
135
   the argument value is returned here.
136
   Also, when 'ordering' is RETURN_IN_ORDER,
137 138 139 140 141 142
   each non-option ARGV-element is returned here.  */

extern char *optarg;

/* Index in ARGV of the next element to be scanned.
   This is used for communication to and from the caller
143
   and for communication between successive calls to 'getopt'.
144

145
   On entry to 'getopt', zero means this is the first call; initialize.
146

147
   When 'getopt' returns -1, this is the index of the first of the
148 149
   non-option elements that the caller should itself scan.

150
   Otherwise, 'optind' communicates from one call to the next
151 152 153 154
   how much of ARGV has been scanned so far.  */

extern int optind;

155
/* Callers store zero here to inhibit the error message 'getopt' prints
156 157 158 159 160 161 162 163 164 165 166
   for unrecognized options.  */

extern int opterr;

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

extern int optopt;

#ifndef __need_getopt
/* Describe the long-named options requested by the application.
   The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
167
   of 'struct option' terminated by an element containing a name which is
168 169
   zero.

170
   The field 'has_arg' is:
171 172 173
   no_argument          (or 0) if the option does not take an argument,
   required_argument    (or 1) if the option requires an argument,
   optional_argument    (or 2) if the option takes an optional argument.
174

175 176
   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
177 178
   left unchanged if the option is not found.

179 180 181
   To have a long-named option do something other than set an 'int' to
   a compiled-in constant, such as set a value from 'optarg', set the
   option's 'flag' field to zero and its 'val' field to a nonzero
182
   value (the equivalent single-letter option character, if there is
183 184
   one).  For long options that have a zero 'flag' field, 'getopt'
   returns the contents of the 'val' field.  */
185

186
# if !GNULIB_defined_struct_option
187 188 189 190 191 192 193 194 195
struct option
{
  const char *name;
  /* 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;
};
196 197
#  define GNULIB_defined_struct_option 1
# endif
198

199
/* Names for the values of the 'has_arg' field of 'struct option'.  */
200

201 202 203 204
# define no_argument            0
# define required_argument      1
# define optional_argument      2
#endif  /* need getopt */
205 206 207 208 209 210 211 212


/* 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
213
   missing arguments, 'optopt' is set to the option letter, and '?' is
214 215 216 217
   returned.

   The OPTS string is a list of characters which are recognized option
   letters, optionally followed by colons, specifying that that letter
218
   takes an argument, to be placed in 'optarg'.
219 220

   If a letter in OPTS is followed by two colons, its argument is
221
   optional.  This behavior is specific to the GNU 'getopt'.
222

223 224
   The argument '--' causes premature termination of argument
   scanning, explicitly telling 'getopt' that there are no more
225 226
   options.

227
   If OPTS begins with '-', then non-option arguments are treated as
228
   arguments to the option '\1'.  This behavior is specific to the GNU
229
   'getopt'.  If OPTS begins with '+', or POSIXLY_CORRECT is set in
230 231 232
   the environment, then do not permute arguments.  */

extern int getopt (int ___argc, char *const *___argv, const char *__shortopts)
233
       __THROW _GL_ARG_NONNULL ((2, 3));
234 235 236

#ifndef __need_getopt
extern int getopt_long (int ___argc, char *__getopt_argv_const *___argv,
237 238 239
                        const char *__shortopts,
                        const struct option *__longopts, int *__longind)
       __THROW _GL_ARG_NONNULL ((2, 3));
240
extern int getopt_long_only (int ___argc, char *__getopt_argv_const *___argv,
241 242 243
                             const char *__shortopts,
                             const struct option *__longopts, int *__longind)
       __THROW _GL_ARG_NONNULL ((2, 3));
244 245 246 247 248 249 250 251 252 253

#endif

#ifdef __cplusplus
}
#endif

/* Make sure we later can get all the definitions and declarations.  */
#undef __need_getopt

254 255
#endif /* _@GUARD_PREFIX@_GETOPT_H */
#endif /* _@GUARD_PREFIX@_GETOPT_H */