gnu/dist/gettext/gettext-tools/lib/getopt_.h

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