git.tinc-vpn.org Git - tinc/blob - src/getopt.h

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