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