src/rrd_getopt.h

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