getopt.in.h 8.66 KB
Newer Older
Paul Eggert's avatar
Paul Eggert committed
1
/* Declarations for getopt.
2 3
   Copyright (C) 1989-1994, 1996-1999, 2001, 2003-2007, 2009-2010 Free Software
   Foundation, Inc.
Paul Eggert's avatar
Paul Eggert committed
4 5
   This file is part of the GNU C Library.

6
   This program is free software: you can redistribute it and/or modify
Paul Eggert's avatar
Paul Eggert committed
7
   it under the terms of the GNU General Public License as published by
8 9
   the Free Software Foundation; either version 3 of the License, or
   (at your option) any later version.
Paul Eggert's avatar
Paul Eggert committed
10 11 12 13 14 15

   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.

16 17
   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
Paul Eggert's avatar
Paul Eggert committed
18

19 20
#ifndef _GL_GETOPT_H

21 22 23 24
#if __GNUC__ >= 3
@PRAGMA_SYSTEM_HEADER@
#endif

25 26 27
/* 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.  */
28
#if @HAVE_GETOPT_H@
29
# define _GL_SYSTEM_GETOPT
30
# @INCLUDE_NEXT@ @NEXT_GETOPT_H@
31
# undef _GL_SYSTEM_GETOPT
32 33
#endif

34
#ifndef _GL_GETOPT_H
35

Paul Eggert's avatar
Paul Eggert committed
36
#ifndef __need_getopt
37
# define _GL_GETOPT_H 1
Paul Eggert's avatar
Paul Eggert committed
38 39
#endif

40 41
/* Standalone applications should #define __GETOPT_PREFIX to an
   identifier that prefixes the external functions and variables
42 43
   defined in this header.  When this happens, include the
   headers that might declare getopt so that they will not cause
44 45
   confusion if included after this file (if the system had <getopt.h>,
   we have already included it).  Then systematically rename
46 47 48 49
   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
50 51 52 53 54
# if !@HAVE_GETOPT_H@
#  include <stdlib.h>
#  include <stdio.h>
#  include <unistd.h>
# endif
55
# undef __need_getopt
56 57 58 59 60 61 62
# undef getopt
# undef getopt_long
# undef getopt_long_only
# undef optarg
# undef opterr
# undef optind
# undef optopt
63
# undef option
64 65 66 67 68 69 70 71 72 73
# 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)
74
# define option __GETOPT_ID (option)
75
# define _getopt_internal __GETOPT_ID (getopt_internal)
76 77
#endif

78 79 80 81
/* 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
82 83 84 85 86 87
   compatibility (e.g., for LSB 2.0.1).

   This used to be `#if defined __GETOPT_PREFIX && !defined __need_getopt',
   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.
Jim Meyering's avatar
Jim Meyering committed
88

89 90 91 92 93 94
   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
Jim Meyering's avatar
Jim Meyering committed
95
# if defined __GETOPT_PREFIX
96 97 98 99
#  define __getopt_argv_const /* empty */
# else
#  define __getopt_argv_const const
# endif
100 101
#endif

Paul Eggert's avatar
Paul Eggert committed
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
/* 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)
118
#  define __THROW       throw ()
Paul Eggert's avatar
Paul Eggert committed
119 120 121 122 123
# else
#  define __THROW
# endif
#endif

124 125
/* The definition of _GL_ARG_NONNULL is copied here.  */

126
#ifdef __cplusplus
Paul Eggert's avatar
Paul Eggert committed
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
extern "C" {
#endif

/* For communication from `getopt' to the caller.
   When `getopt' finds an option that takes an argument,
   the argument value is returned here.
   Also, when `ordering' is RETURN_IN_ORDER,
   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
   and for communication between successive calls to `getopt'.

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

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

   Otherwise, `optind' communicates from one call to the next
   how much of ARGV has been scanned so far.  */

extern int optind;

/* Callers store zero here to inhibit the error message `getopt' prints
   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
   of `struct option' terminated by an element containing a name which is
   zero.

   The field `has_arg' is:
168 169 170
   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.
Paul Eggert's avatar
Paul Eggert committed
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194

   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
   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
   value (the equivalent single-letter option character, if there is
   one).  For long options that have a zero `flag' field, `getopt'
   returns the contents of the `val' field.  */

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;
};

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

195 196 197 198
# define no_argument            0
# define required_argument      1
# define optional_argument      2
#endif  /* need getopt */
Paul Eggert's avatar
Paul Eggert committed
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220


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

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

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

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

221 222 223 224
   If OPTS begins with `-', then non-option arguments are treated as
   arguments to the option '\1'.  This behavior is specific to the GNU
   `getopt'.  If OPTS begins with `+', or POSIXLY_CORRECT is set in
   the environment, then do not permute arguments.  */
Paul Eggert's avatar
Paul Eggert committed
225

226
extern int getopt (int ___argc, char *const *___argv, const char *__shortopts)
227
       __THROW _GL_ARG_NONNULL ((2, 3));
Paul Eggert's avatar
Paul Eggert committed
228 229

#ifndef __need_getopt
230
extern int getopt_long (int ___argc, char *__getopt_argv_const *___argv,
231 232
                        const char *__shortopts,
                        const struct option *__longopts, int *__longind)
233
       __THROW _GL_ARG_NONNULL ((2, 3));
234
extern int getopt_long_only (int ___argc, char *__getopt_argv_const *___argv,
235 236
                             const char *__shortopts,
                             const struct option *__longopts, int *__longind)
237
       __THROW _GL_ARG_NONNULL ((2, 3));
Paul Eggert's avatar
Paul Eggert committed
238 239 240

#endif

241
#ifdef __cplusplus
Paul Eggert's avatar
Paul Eggert committed
242 243 244 245 246 247 248
}
#endif

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

#endif /* getopt.h */
249
#endif /* getopt.h */