getopt/getopt.h

   1 /* Declarations for getopt.
   2    Copyright (C) 1989,90,91,92,93,94,96,97,98 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Library General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Library General Public License for more details.
  14
  15    You should have received a copy of the GNU Library General Public
  16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18    Boston, MA 02111-1307, USA.  */
  19
  20 #ifndef _GETOPT_H
  21
  22 #include "../config.h"
  23
  24
  25 #ifndef __need_getopt
  26 # define _GETOPT_H 1
  27 #endif
  28
  29 #ifdef  __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /* For communication from `getopt' to the caller.
  34    When `getopt' finds an option that takes an argument,
  35    the argument value is returned here.
  36    Also, when `ordering' is RETURN_IN_ORDER,
  37    each non-option ARGV-element is returned here.  */
  38
  39 extern char *optarg;
  40
  41 /* Index in ARGV of the next element to be scanned.
  42    This is used for communication to and from the caller
  43    and for communication between successive calls to `getopt'.
  44
  45    On entry to `getopt', zero means this is the first call; initialize.
  46
  47    When `getopt' returns -1, this is the index of the first of the
  48    non-option elements that the caller should itself scan.
  49
  50    Otherwise, `optind' communicates from one call to the next
  51    how much of ARGV has been scanned so far.  */
  52
  53 extern int optind;
  54
  55 /* Callers store zero here to inhibit the error message `getopt' prints
  56    for unrecognized options.  */
  57
  58 extern int opterr;
  59
  60 /* Set to an option character which was unrecognized.  */
  61
  62 extern int optopt;
  63
  64 #ifndef __need_getopt
  65 /* Describe the long-named options requested by the application.
  66    The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
  67    of `struct option' terminated by an element containing a name which is
  68    zero.
  69
  70    The field `has_arg' is:
  71    no_argument          (or 0) if the option does not take an argument,
  72    required_argument    (or 1) if the option requires an argument,
  73    optional_argument    (or 2) if the option takes an optional argument.
  74
  75    If the field `flag' is not NULL, it points to a variable that is set
  76    to the value given in the field `val' when the option is found, but
  77    left unchanged if the option is not found.
  78
  79    To have a long-named option do something other than set an `int' to
  80    a compiled-in constant, such as set a value from `optarg', set the
  81    option's `flag' field to zero and its `val' field to a nonzero
  82    value (the equivalent single-letter option character, if there is
  83    one).  For long options that have a zero `flag' field, `getopt'
  84    returns the contents of the `val' field.  */
  85
  86 struct option
  87 {
  88 # if defined __STDC__
  89   const char *name;
  90 # else
  91   char *name;
  92 # endif
  93   /* has_arg can't be an enum because some compilers complain about
  94      type mismatches in all the code that assumes it is an int.  */
  95   int has_arg;
  96   int *flag;
  97   int val;
  98 };
  99
 100 /* Names for the values of the `has_arg' field of `struct option'.  */
 101
 102 # define no_argument            0
 103 # define required_argument      1
 104 # define optional_argument      2
 105 #endif  /* need getopt */
 106
 107
 108 /* Get definitions and prototypes for functions to process the
 109    arguments in ARGV (ARGC of them, minus the program name) for
 110    options given in OPTS.
 111
 112    Return the option character from OPTS just read.  Return -1 when
 113    there are no more options.  For unrecognized options, or options
 114    missing arguments, `optopt' is set to the option letter, and '?' is
 115    returned.
 116
 117    The OPTS string is a list of characters which are recognized option
 118    letters, optionally followed by colons, specifying that that letter
 119    takes an argument, to be placed in `optarg'.
 120
 121    If a letter in OPTS is followed by two colons, its argument is
 122    optional.  This behavior is specific to the GNU `getopt'.
 123
 124    The argument `--' causes premature termination of argument
 125    scanning, explicitly telling `getopt' that there are no more
 126    options.
 127
 128    If OPTS begins with `--', then non-option arguments are treated as
 129    arguments to the option '\0'.  This behavior is specific to the GNU
 130    `getopt'.  */
 131
 132 #if defined __STDC__
 133 # ifdef __GNU_LIBRARY__
 134 /* Many other libraries have conflicting prototypes for getopt, with
 135    differences in the consts, in stdlib.h.  To avoid compilation
 136    errors, only prototype getopt for the GNU C library.  */
 137 extern int getopt (int __argc, char *const *__argv, const char *__shortopts);
 138 # else /* not __GNU_LIBRARY__ */
 139   /* extern int getopt (); */
 140 # endif /* __GNU_LIBRARY__ */
 141
 142 # ifndef __need_getopt
 143 extern int getopt_long (int argc, char *const *argv, const char *shortopts,
 144                         const struct option *longopts, int *longind);
 145 extern int getopt_long_only (int __argc, char *const *__argv,
 146                              const char *__shortopts,
 147                              const struct option *__longopts, int *__longind);
 148
 149 /* Internal only.  Users should not call this directly.  */
 150 extern int _getopt_internal (int __argc, char *const *__argv,
 151                              const char *__shortopts,
 152                              const struct option *__longopts, int *__longind,
 153                              int __long_only);
 154 # endif
 155 #else /* not __STDC__ */
 156 extern int getopt ();
 157 # ifndef __need_getopt
 158 extern int getopt_long (int argc, char *const *argv, const char *shortopts,\r
 159                         const struct option *longopts, int *longind);\r
 160 extern int getopt_long_only (int __argc, char *const *__argv,\r
 161                              const char *__shortopts,\r
 162                              const struct option *__longopts, int *__longind);\r
 163 extern int _getopt_internal (int __argc, char *const *__argv,\r
 164                              const char *__shortopts,\r
 165                              const struct option *__longopts, int *__longind,\r
 166                              int __long_only);\r
 167 # endif
 168 #endif /* __STDC__ */
 169
 170 #ifdef  __cplusplus
 171 }
 172 #endif
 173
 174 /* Make sure we later can get all the definitions and declarations.  */
 175 #undef __need_getopt
 176
 177 #endif /* getopt.h */