git.gag.com Git - debian/tar/blob - gnu/getopt.in.h

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