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