lib/getopt.h

   1 /* Declarations for getopt.
   2
   3    Copyright (C) 1989-1994, 1996-1999, 2001, 2002 Free Software Foundation,
   4    Inc.
   5
   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 2, or (at your option)
  11    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, write to the Free Software Foundation,
  20    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  21
  22 #ifndef _GETOPT_H
  23
  24 #ifndef __need_getopt
  25 # define _GETOPT_H 1
  26 #endif
  27
  28 /* If __GNU_LIBRARY__ is not already defined, either we are being used
  29    standalone, or this is the first header included in the source file.
  30    If we are being used with glibc, we need to include <features.h>, but
  31    that does not exist if we are standalone.  So: if __GNU_LIBRARY__ is
  32    not defined, include <stdlib.h>, which will pull in <features.h> for us
  33    if it's from glibc (and will declare getopt).  Fall back on <ctype.h> if
  34    <stdlib.h> might not exist.  (Why ctype.h?  It's guaranteed to exist and it
  35    doesn't flood the namespace with stuff the way some other headers do.)  */
  36 #if !defined __GNU_LIBRARY__
  37 # if HAVE_STDLIB_H || STDC_HEADERS
  38 #  include <stdlib.h>
  39 # else
  40 #  include <ctype.h>
  41 # endif
  42 #endif
  43
  44 #ifdef  __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 /* For communication from `getopt' to the caller.
  49    When `getopt' finds an option that takes an argument,
  50    the argument value is returned here.
  51    Also, when `ordering' is RETURN_IN_ORDER,
  52    each non-option ARGV-element is returned here.  */
  53
  54 extern char *optarg;
  55
  56 /* Index in ARGV of the next element to be scanned.
  57    This is used for communication to and from the caller
  58    and for communication between successive calls to `getopt'.
  59
  60    On entry to `getopt', zero means this is the first call; initialize.
  61
  62    When `getopt' returns -1, this is the index of the first of the
  63    non-option elements that the caller should itself scan.
  64
  65    Otherwise, `optind' communicates from one call to the next
  66    how much of ARGV has been scanned so far.  */
  67
  68 extern int optind;
  69
  70 /* Callers store zero here to inhibit the error message `getopt' prints
  71    for unrecognized options.  */
  72
  73 extern int opterr;
  74
  75 /* Set to an option character which was unrecognized.  */
  76
  77 extern int optopt;
  78
  79 #ifndef __need_getopt
  80 /* Describe the long-named options requested by the application.
  81    The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
  82    of `struct option' terminated by an element containing a name which is
  83    zero.
  84
  85    The field `has_arg' is:
  86    no_argument          (or 0) if the option does not take an argument,
  87    required_argument    (or 1) if the option requires an argument,
  88    optional_argument    (or 2) if the option takes an optional argument.
  89
  90    If the field `flag' is not NULL, it points to a variable that is set
  91    to the value given in the field `val' when the option is found, but
  92    left unchanged if the option is not found.
  93
  94    To have a long-named option do something other than set an `int' to
  95    a compiled-in constant, such as set a value from `optarg', set the
  96    option's `flag' field to zero and its `val' field to a nonzero
  97    value (the equivalent single-letter option character, if there is
  98    one).  For long options that have a zero `flag' field, `getopt'
  99    returns the contents of the `val' field.  */
 100
 101 struct option
 102 {
 103 # if (defined __STDC__ && __STDC__) || defined __cplusplus
 104   const char *name;
 105 # else
 106   char *name;
 107 # endif
 108   /* has_arg can't be an enum because some compilers complain about
 109      type mismatches in all the code that assumes it is an int.  */
 110   int has_arg;
 111   int *flag;
 112   int val;
 113 };
 114
 115 /* Names for the values of the `has_arg' field of `struct option'.  */
 116
 117 # define no_argument            0
 118 # define required_argument      1
 119 # define optional_argument      2
 120 #endif  /* need getopt */
 121
 122
 123 /* Get definitions and prototypes for functions to process the
 124    arguments in ARGV (ARGC of them, minus the program name) for
 125    options given in OPTS.
 126
 127    Return the option character from OPTS just read.  Return -1 when
 128    there are no more options.  For unrecognized options, or options
 129    missing arguments, `optopt' is set to the option letter, and '?' is
 130    returned.
 131
 132    The OPTS string is a list of characters which are recognized option
 133    letters, optionally followed by colons, specifying that that letter
 134    takes an argument, to be placed in `optarg'.
 135
 136    If a letter in OPTS is followed by two colons, its argument is
 137    optional.  This behavior is specific to the GNU `getopt'.
 138
 139    The argument `--' causes premature termination of argument
 140    scanning, explicitly telling `getopt' that there are no more
 141    options.
 142
 143    If OPTS begins with `--', then non-option arguments are treated as
 144    arguments to the option '\0'.  This behavior is specific to the GNU
 145    `getopt'.  */
 146
 147 #if (defined __STDC__ && __STDC__) || defined __cplusplus
 148 # if defined HAVE_DECL_GETOPT && !HAVE_DECL_GETOPT
 149 #  ifdef __GNU_LIBRARY__
 150 /* Many other libraries have conflicting prototypes for getopt, with
 151    differences in the consts, in stdlib.h.  To avoid compilation
 152    errors, only prototype getopt for the GNU C library.  */
 153 extern int getopt (int __argc, char *const *__argv, const char *__shortopts);
 154 #  else /* not __GNU_LIBRARY__ */
 155 extern int getopt ();
 156 #  endif /* __GNU_LIBRARY__ */
 157 # endif /* defined HAVE_DECL_GETOPT && !HAVE_DECL_GETOPT */
 158
 159 # ifndef __need_getopt
 160 extern int getopt_long (int __argc, char *const *__argv, const char *__shortopts,
 161                         const struct option *__longopts, int *__longind);
 162 extern int getopt_long_only (int __argc, char *const *__argv,
 163                              const char *__shortopts,
 164                              const struct option *__longopts, int *__longind);
 165
 166 /* Internal only.  Users should not call this directly.  */
 167 extern int _getopt_internal (int __argc, char *const *__argv,
 168                              const char *__shortopts,
 169                              const struct option *__longopts, int *__longind,
 170                              int __long_only);
 171 # endif
 172 #else /* not __STDC__ */
 173 extern int getopt ();
 174 # ifndef __need_getopt
 175 extern int getopt_long ();
 176 extern int getopt_long_only ();
 177
 178 extern int _getopt_internal ();
 179 # endif
 180 #endif /* __STDC__ */
 181
 182 #ifdef  __cplusplus
 183 }
 184 #endif
 185
 186 /* Make sure we later can get all the definitions and declarations.  */
 187 #undef __need_getopt
 188
 189 #endif /* getopt.h */