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