pintos-os.org Git - pspp/blob - lib/getopt.in.h

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