lib/getopt.in.h

   1 /* Declarations for getopt.
   2    Copyright (C) 1989-1994, 1996-1999, 2001, 2003-2007, 2009-2017 Free Software
   3    Foundation, Inc.
   4    This file is part of the GNU C Library.
   5
   6    This program is free software: you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef _@GUARD_PREFIX@_GETOPT_H
  20
  21 #if __GNUC__ >= 3
  22 @PRAGMA_SYSTEM_HEADER@
  23 #endif
  24 @PRAGMA_COLUMNS@
  25
  26 /* The include_next requires a split double-inclusion guard.  We must
  27    also inform the replacement unistd.h to not recursively use
  28    <getopt.h>; our definitions will be present soon enough.  */
  29 #if @HAVE_GETOPT_H@
  30 # define _GL_SYSTEM_GETOPT
  31 # @INCLUDE_NEXT@ @NEXT_GETOPT_H@
  32 # undef _GL_SYSTEM_GETOPT
  33 #endif
  34
  35 #ifndef _@GUARD_PREFIX@_GETOPT_H
  36
  37 #ifndef __need_getopt
  38 # define _@GUARD_PREFIX@_GETOPT_H 1
  39 #endif
  40
  41 /* Standalone applications should #define __GETOPT_PREFIX to an
  42    identifier that prefixes the external functions and variables
  43    defined in this header.  When this happens, include the
  44    headers that might declare getopt so that they will not cause
  45    confusion if included after this file (if the system had <getopt.h>,
  46    we have already included it).  Then systematically rename
  47    identifiers so that they do not collide with the system functions
  48    and variables.  Renaming avoids problems with some compilers and
  49    linkers.  */
  50 #if defined __GETOPT_PREFIX
  51 # if !defined __need_getopt
  52 #  if !@HAVE_GETOPT_H@
  53 #   define __need_system_stdlib_h
  54 #   include <stdlib.h>
  55 #   undef __need_system_stdlib_h
  56 #   include <stdio.h>
  57 #   include <unistd.h>
  58 #  endif
  59 #  undef __need_getopt
  60 # endif
  61 # undef __GETOPT_CONCAT
  62 # undef __GETOPT_XCONCAT
  63 # undef __GETOPT_ID
  64 # undef getopt
  65 # undef getopt_long
  66 # undef getopt_long_only
  67 # undef optarg
  68 # undef opterr
  69 # undef optind
  70 # undef optopt
  71 # undef option
  72 # undef _getopt_internal
  73 # define __GETOPT_CONCAT(x, y) x ## y
  74 # define __GETOPT_XCONCAT(x, y) __GETOPT_CONCAT (x, y)
  75 # define __GETOPT_ID(y) __GETOPT_XCONCAT (__GETOPT_PREFIX, y)
  76 # define getopt __GETOPT_ID (getopt)
  77 # define getopt_long __GETOPT_ID (getopt_long)
  78 # define getopt_long_only __GETOPT_ID (getopt_long_only)
  79 # define optarg __GETOPT_ID (optarg)
  80 # define opterr __GETOPT_ID (opterr)
  81 # define optind __GETOPT_ID (optind)
  82 # define optopt __GETOPT_ID (optopt)
  83 # define option __GETOPT_ID (option)
  84 # define _getopt_internal __GETOPT_ID (getopt_internal)
  85 #endif
  86
  87 /* Standalone applications get correct prototypes for getopt_long and
  88    getopt_long_only; they declare "char **argv".  libc uses prototypes
  89    with "char *const *argv" that are incorrect because getopt_long and
  90    getopt_long_only can permute argv; this is required for backward
  91    compatibility (e.g., for LSB 2.0.1).
  92
  93    This used to be '#if defined __GETOPT_PREFIX && !defined __need_getopt',
  94    but it caused redefinition warnings if both unistd.h and getopt.h were
  95    included, since unistd.h includes getopt.h having previously defined
  96    __need_getopt.
  97
  98    The only place where __getopt_argv_const is used is in definitions
  99    of getopt_long and getopt_long_only below, but these are visible
 100    only if __need_getopt is not defined, so it is quite safe to rewrite
 101    the conditional as follows:
 102 */
 103 #if !defined __need_getopt
 104 # if defined __GETOPT_PREFIX
 105 #  define __getopt_argv_const /* empty */
 106 # else
 107 #  define __getopt_argv_const const
 108 # endif
 109 #endif
 110
 111 /* If __GNU_LIBRARY__ is not already defined, either we are being used
 112    standalone, or this is the first header included in the source file.
 113    If we are being used with glibc, we need to include <features.h>, but
 114    that does not exist if we are standalone.  So: if __GNU_LIBRARY__ is
 115    not defined, include <ctype.h>, which will pull in <features.h> for us
 116    if it's from glibc.  (Why ctype.h?  It's guaranteed to exist and it
 117    doesn't flood the namespace with stuff the way some other headers do.)  */
 118 #if !defined __GNU_LIBRARY__
 119 # include <ctype.h>
 120 #endif
 121
 122 #ifndef __THROW
 123 # ifndef __GNUC_PREREQ
 124 #  define __GNUC_PREREQ(maj, min) (0)
 125 # endif
 126 # if defined __cplusplus && __GNUC_PREREQ (2,8)
 127 #  define __THROW       throw ()
 128 # else
 129 #  define __THROW
 130 # endif
 131 #endif
 132
 133 /* The definition of _GL_ARG_NONNULL is copied here.  */
 134
 135 #ifdef __cplusplus
 136 extern "C" {
 137 #endif
 138
 139 /* For communication from 'getopt' to the caller.
 140    When 'getopt' finds an option that takes an argument,
 141    the argument value is returned here.
 142    Also, when 'ordering' is RETURN_IN_ORDER,
 143    each non-option ARGV-element is returned here.  */
 144
 145 extern char *optarg;
 146
 147 /* Index in ARGV of the next element to be scanned.
 148    This is used for communication to and from the caller
 149    and for communication between successive calls to 'getopt'.
 150
 151    On entry to 'getopt', zero means this is the first call; initialize.
 152
 153    When 'getopt' returns -1, this is the index of the first of the
 154    non-option elements that the caller should itself scan.
 155
 156    Otherwise, 'optind' communicates from one call to the next
 157    how much of ARGV has been scanned so far.  */
 158
 159 extern int optind;
 160
 161 /* Callers store zero here to inhibit the error message 'getopt' prints
 162    for unrecognized options.  */
 163
 164 extern int opterr;
 165
 166 /* Set to an option character which was unrecognized.  */
 167
 168 extern int optopt;
 169
 170 #ifndef __need_getopt
 171 /* Describe the long-named options requested by the application.
 172    The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
 173    of 'struct option' terminated by an element containing a name which is
 174    zero.
 175
 176    The field 'has_arg' is:
 177    no_argument          (or 0) if the option does not take an argument,
 178    required_argument    (or 1) if the option requires an argument,
 179    optional_argument    (or 2) if the option takes an optional argument.
 180
 181    If the field 'flag' is not NULL, it points to a variable that is set
 182    to the value given in the field 'val' when the option is found, but
 183    left unchanged if the option is not found.
 184
 185    To have a long-named option do something other than set an 'int' to
 186    a compiled-in constant, such as set a value from 'optarg', set the
 187    option's 'flag' field to zero and its 'val' field to a nonzero
 188    value (the equivalent single-letter option character, if there is
 189    one).  For long options that have a zero 'flag' field, 'getopt'
 190    returns the contents of the 'val' field.  */
 191
 192 # if !GNULIB_defined_struct_option
 193 struct option
 194 {
 195   const char *name;
 196   /* has_arg can't be an enum because some compilers complain about
 197      type mismatches in all the code that assumes it is an int.  */
 198   int has_arg;
 199   int *flag;
 200   int val;
 201 };
 202 #  define GNULIB_defined_struct_option 1
 203 # endif
 204
 205 /* Names for the values of the 'has_arg' field of 'struct option'.  */
 206
 207 # define no_argument            0
 208 # define required_argument      1
 209 # define optional_argument      2
 210 #endif  /* need getopt */
 211
 212
 213 /* Get definitions and prototypes for functions to process the
 214    arguments in ARGV (ARGC of them, minus the program name) for
 215    options given in OPTS.
 216
 217    Return the option character from OPTS just read.  Return -1 when
 218    there are no more options.  For unrecognized options, or options
 219    missing arguments, 'optopt' is set to the option letter, and '?' is
 220    returned.
 221
 222    The OPTS string is a list of characters which are recognized option
 223    letters, optionally followed by colons, specifying that that letter
 224    takes an argument, to be placed in 'optarg'.
 225
 226    If a letter in OPTS is followed by two colons, its argument is
 227    optional.  This behavior is specific to the GNU 'getopt'.
 228
 229    The argument '--' causes premature termination of argument
 230    scanning, explicitly telling 'getopt' that there are no more
 231    options.
 232
 233    If OPTS begins with '-', then non-option arguments are treated as
 234    arguments to the option '\1'.  This behavior is specific to the GNU
 235    'getopt'.  If OPTS begins with '+', or POSIXLY_CORRECT is set in
 236    the environment, then do not permute arguments.  */
 237
 238 extern int getopt (int ___argc, char *const *___argv, const char *__shortopts)
 239        __THROW _GL_ARG_NONNULL ((2, 3));
 240
 241 #ifndef __need_getopt
 242 extern int getopt_long (int ___argc, char *__getopt_argv_const *___argv,
 243                         const char *__shortopts,
 244                         const struct option *__longopts, int *__longind)
 245        __THROW _GL_ARG_NONNULL ((2, 3));
 246 extern int getopt_long_only (int ___argc, char *__getopt_argv_const *___argv,
 247                              const char *__shortopts,
 248                              const struct option *__longopts, int *__longind)
 249        __THROW _GL_ARG_NONNULL ((2, 3));
 250
 251 #endif
 252
 253 #ifdef __cplusplus
 254 }
 255 #endif
 256
 257 /* Make sure we later can get all the definitions and declarations.  */
 258 #undef __need_getopt
 259
 260 #endif /* _@GUARD_PREFIX@_GETOPT_H */
 261 #endif /* _@GUARD_PREFIX@_GETOPT_H */