src/texsourc/getopt.h

   1 /* Declarations for getopt.
   2    Copyright (C) 1989, 1990, 1991, 1992 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful, but
  10    WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software
  16    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17    02110-1301 USA.  */
  18
  19 #ifndef _GETOPT_H
  20 #define _GETOPT_H 1
  21
  22 #ifdef  __cplusplus
  23 extern "C" {
  24 #endif
  25
  26 /* For communication from `getopt' to the caller.
  27    When `getopt' finds an option that takes an argument,
  28    the argument value is returned here.
  29    Also, when `ordering' is RETURN_IN_ORDER,
  30    each non-option ARGV-element is returned here.  */
  31
  32 extern char *optarg;
  33
  34 /* Index in ARGV of the next element to be scanned.
  35    This is used for communication to and from the caller
  36    and for communication between successive calls to `getopt'.
  37
  38    On entry to `getopt', zero means this is the first call; initialize.
  39
  40    When `getopt' returns EOF, this is the index of the first of the
  41    non-option elements that the caller should itself scan.
  42
  43    Otherwise, `optind' communicates from one call to the next
  44    how much of ARGV has been scanned so far.  */
  45
  46 extern int optind;
  47
  48 /* Callers store zero here to inhibit the error message `getopt' prints
  49    for unrecognized options.  */
  50
  51 extern int opterr;
  52
  53 /* Describe the long-named options requested by the application.
  54    The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
  55    of `struct option' terminated by an element containing a name which is
  56    zero.
  57
  58    The field `has_arg' is:
  59    no_argument          (or 0) if the option does not take an argument,
  60    required_argument    (or 1) if the option requires an argument,
  61    optional_argument    (or 2) if the option takes an optional argument.
  62
  63    If the field `flag' is not NULL, it points to a variable that is set
  64    to the value given in the field `val' when the option is found, but
  65    left unchanged if the option is not found.
  66
  67    To have a long-named option do something other than set an `int' to
  68    a compiled-in constant, such as set a value from `optarg', set the
  69    option's `flag' field to zero and its `val' field to a nonzero
  70    value (the equivalent single-letter option character, if there is
  71    one).  For long options that have a zero `flag' field, `getopt'
  72    returns the contents of the `val' field.  */
  73
  74 struct option
  75 {
  76 #if     __STDC__
  77   const char *name;
  78 #else
  79   char *name;
  80 #endif
  81   /* has_arg can't be an enum because some compilers complain about
  82      type mismatches in all the code that assumes it is an int.  */
  83   int has_arg;
  84   int *flag;
  85   int val;
  86 };
  87
  88 /* Names for the values of the `has_arg' field of `struct option'.  */
  89
  90 #define no_argument             0
  91 #define required_argument       1
  92 #define optional_argument       2
  93
  94 #if __STDC__
  95 #if defined(__GNU_LIBRARY__)
  96 /* Many other libraries have conflicting prototypes for getopt, with
  97    differences in the consts, in stdlib.h.  To avoid compilation
  98    errors, only prototype getopt for the GNU C library.  */
  99 extern int getopt (int argc, char *const *argv, const char *shortopts);
 100 #else /* not __GNU_LIBRARY__ */
 101 extern int getopt();
 102 #endif /* not __GNU_LIBRARY__ */
 103 extern int getopt_long (int argc, char *const *argv, const char *shortopts,
 104                         const struct option *longopts, int *longind);
 105 extern int getopt_long_only (int argc, char *const *argv,
 106                              const char *shortopts,
 107                              const struct option *longopts, int *longind);
 108
 109 /* Internal only.  Users should not call this directly.  */
 110 extern int _getopt_internal (int argc, char *const *argv,
 111                              const char *shortopts,
 112                              const struct option *longopts, int *longind,
 113                              int long_only);
 114 #else /* not __STDC__ */
 115 extern int getopt();
 116 extern int getopt_long();
 117 extern int getopt_long_only();
 118
 119 extern int _getopt_internal();
 120 #endif /* not __STDC__ */
 121
 122 #ifdef  __cplusplus
 123 }
 124 #endif
 125
 126 #endif /* _GETOPT_H */