lib/getopt_.h

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