user/sendip/gnugetopt.h

   1 /* Declarations for getopt.
   2    Copyright (C) 1989,90,91,92,93,94,96,97,98,99 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 __GNU_GETOPT_H
  21 #define __GNU_GETOPT_H
  22
  23 /* For communication from `getopt' to the caller.
  24    When `getopt' finds an option that takes an argument,
  25    the argument value is returned here.
  26    Also, when `ordering' is RETURN_IN_ORDER,
  27    each non-option ARGV-element is returned here.  */
  28
  29 extern char *gnuoptarg;
  30
  31 /* Index in ARGV of the next element to be scanned.
  32    This is used for communication to and from the caller
  33    and for communication between successive calls to `getopt'.
  34
  35    On entry to `getopt', zero means this is the first call; initialize.
  36
  37    When `getopt' returns -1, this is the index of the first of the
  38    non-option elements that the caller should itself scan.
  39
  40    Otherwise, `gnuoptind' communicates from one call to the next
  41    how much of ARGV has been scanned so far.  */
  42
  43 extern int gnuoptind;
  44
  45 /* Callers store zero here to inhibit the error message `getopt' prints
  46    for unrecognized options.  */
  47
  48 extern int gnuopterr;
  49
  50 /* Set to an option character which was unrecognized.  */
  51
  52 extern int gnuoptopt;
  53
  54 /* modification to getopt - allows us to skip options */
  55 extern char *nextchar;
  56
  57
  58 /* Describe the long-named options requested by the application.
  59    The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
  60    of `struct option' terminated by an element containing a name which is
  61    zero.
  62
  63    The field `has_arg' is:
  64    no_argument          (or 0) if the option does not take an argument,
  65    required_argument    (or 1) if the option requires an argument,
  66    optional_argument    (or 2) if the option takes an optional argument.
  67
  68    If the field `flag' is not NULL, it points to a variable that is set
  69    to the value given in the field `val' when the option is found, but
  70    left unchanged if the option is not found.
  71
  72    To have a long-named option do something other than set an `int' to
  73    a compiled-in constant, such as set a value from `gnuoptarg', set the
  74    option's `flag' field to zero and its `val' field to a nonzero
  75    value (the equivalent single-letter option character, if there is
  76    one).  For long options that have a zero `flag' field, `getopt'
  77    returns the contents of the `val' field.  */
  78
  79 struct option
  80 {
  81 # if defined __STDC__ && __STDC__
  82   const char *name;
  83 # else
  84   char *name;
  85 # endif
  86   /* has_arg can't be an enum because some compilers complain about
  87      type mismatches in all the code that assumes it is an int.  */
  88   int has_arg;
  89   int *flag;
  90   int val;
  91 };
  92
  93 /* Names for the values of the `has_arg' field of `struct option'.  */
  94
  95 # define no_argument            0
  96 # define required_argument      1
  97 # define optional_argument      2
  98
  99
 100 /* Get definitions and prototypes for functions to process the
 101    arguments in ARGV (ARGC of them, minus the program name) for
 102    options given in OPTS.
 103
 104    Return the option character from OPTS just read.  Return -1 when
 105    there are no more options.  For unrecognized options, or options
 106    missing arguments, `gnuoptopt' is set to the option letter, and '?' is
 107    returned.
 108
 109    The OPTS string is a list of characters which are recognized option
 110    letters, optionally followed by colons, specifying that that letter
 111    takes an argument, to be placed in `gnuoptarg'.
 112
 113    If a letter in OPTS is followed by two colons, its argument is
 114    optional.  This behavior is specific to the GNU `getopt'.
 115
 116    The argument `--' causes premature termination of argument
 117    scanning, explicitly telling `getopt' that there are no more
 118    options.
 119
 120    If OPTS begins with `--', then non-option arguments are treated as
 121    arguments to the option '\0'.  This behavior is specific to the GNU
 122    `getopt'.  */
 123
 124 extern int gnugetopt (int __argc, char *const *__argv, const char *__shortopts);
 125 extern int getopt_long (int __argc, char *const *__argv, const char *__shortopts,
 126                         const struct option *__longopts, int *__longind);
 127 extern int getopt_long_only (int __argc, char *const *__argv,
 128                              const char *__shortopts,
 129                              const struct option *__longopts, int *__longind);
 130
 131 /* Internal only.  Users should not call this directly.  */
 132 extern int _getopt_internal (int __argc, char *const *__argv,
 133                              const char *__shortopts,
 134                              const struct option *__longopts, int *__longind,
 135                              int __long_only);
 136
 137 #endif /* getopt.h */