src/sgetopt.h

   1 /* Declarations for getopt.
   2    Copyright (C) 1989-1994, 1996-1999, 2001 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5  * This library is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU Lesser General Public License as published by
   7  * the Free Software Foundation; either version 2.1 of the License, or (at
   8  * your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public License
  16  * along with this library; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  18  */
  19
  20 #ifndef _SGETOPT_H
  21 #if defined __GNUC__
  22   #pragma GCC system_header
  23 #elif defined __SUNPRO_CC
  24   #pragma disable_warn
  25 #elif defined _MSC_VER
  26   #pragma warning(push, 1)
  27 #endif
  28
  29 #ifndef __need_getopt
  30 # define _GETOPT_H 1
  31 #endif
  32
  33 /* If __GNU_LIBRARY__ is not already defined, either we are being used
  34    standalone, or this is the first header included in the source file.
  35    If we are being used with glibc, we need to include <features.h>, but
  36    that does not exist if we are standalone.  So: if __GNU_LIBRARY__ is
  37    not defined, include <ctype.h>, which will pull in <features.h> for us
  38    if it's from glibc.  (Why ctype.h?  It's guaranteed to exist and it
  39    doesn't flood the namespace with stuff the way some other headers do.)  */
  40 #if !defined __GNU_LIBRARY__
  41 # include <ctype.h>
  42 #endif
  43
  44 #ifdef  __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 /* For communication from `getopt' to the caller.
  49    When `getopt' finds an option that takes an argument,
  50    the argument value is returned here.
  51    Also, when `ordering' is RETURN_IN_ORDER,
  52    each non-option ARGV-element is returned here.  */
  53
  54 extern char *lsx_optarg;
  55
  56 /* Index in ARGV of the next element to be scanned.
  57    This is used for communication to and from the caller
  58    and for communication between successive calls to `getopt'.
  59
  60    On entry to `getopt', zero means this is the first call; initialize.
  61
  62    When `getopt' returns -1, this is the index of the first of the
  63    non-option elements that the caller should itself scan.
  64
  65    Otherwise, `optind' communicates from one call to the next
  66    how much of ARGV has been scanned so far.  */
  67
  68 extern int lsx_optind;
  69
  70 /* Callers store zero here to inhibit the error message `getopt' prints
  71    for unrecognized options.  */
  72
  73 extern int opterr;
  74
  75 /* Set to an option character which was unrecognized.  */
  76
  77 extern int optopt;
  78
  79 #ifndef __need_getopt
  80 /* Describe the long-named options requested by the application.
  81    The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
  82    of `struct option' terminated by an element containing a name which is
  83    zero.
  84
  85    The field `has_arg' is:
  86    no_argument          (or 0) if the option does not take an argument,
  87    required_argument    (or 1) if the option requires an argument,
  88    optional_argument    (or 2) if the option takes an optional argument.
  89
  90    If the field `flag' is not NULL, it points to a variable that is set
  91    to the value given in the field `val' when the option is found, but
  92    left unchanged if the option is not found.
  93
  94    To have a long-named option do something other than set an `int' to
  95    a compiled-in constant, such as set a value from `optarg', set the
  96    option's `flag' field to zero and its `val' field to a nonzero
  97    value (the equivalent single-letter option character, if there is
  98    one).  For long options that have a zero `flag' field, `getopt'
  99    returns the contents of the `val' field.  */
 100
 101 struct option
 102 {
 103 # if (defined __STDC__ && __STDC__) || defined __cplusplus
 104   const char *name;
 105 # else
 106   char *name;
 107 # endif
 108   /* has_arg can't be an enum because some compilers complain about
 109      type mismatches in all the code that assumes it is an int.  */
 110   int has_arg;
 111   int *flag;
 112   int val;
 113 };
 114
 115 /* Names for the values of the `has_arg' field of `struct option'.  */
 116
 117 # define no_argument            0
 118 # define required_argument      1
 119 # define optional_argument      2
 120 #endif  /* need getopt */
 121
 122
 123 /* Get definitions and prototypes for functions to process the
 124    arguments in ARGV (ARGC of them, minus the program name) for
 125    options given in OPTS.
 126
 127    Return the option character from OPTS just read.  Return -1 when
 128    there are no more options.  For unrecognized options, or options
 129    missing arguments, `optopt' is set to the option letter, and '?' is
 130    returned.
 131
 132    The OPTS string is a list of characters which are recognized option
 133    letters, optionally followed by colons, specifying that that letter
 134    takes an argument, to be placed in `optarg'.
 135
 136    If a letter in OPTS is followed by two colons, its argument is
 137    optional.  This behavior is specific to the GNU `getopt'.
 138
 139    The argument `--' causes premature termination of argument
 140    scanning, explicitly telling `getopt' that there are no more
 141    options.
 142
 143    If OPTS begins with `--', then non-option arguments are treated as
 144    arguments to the option '\0'.  This behavior is specific to the GNU
 145    `getopt'.  */
 146
 147 #if (defined __STDC__ && __STDC__) || defined __cplusplus
 148 # ifdef __GNU_LIBRARY__
 149 /* Many other libraries have conflicting prototypes for getopt, with
 150    differences in the consts, in stdlib.h.  To avoid compilation
 151    errors, only prototype getopt for the GNU C library.  */
 152 extern int lsx_getopt (int ___argc, char *const *___argv, const char *__shortopts);
 153 # else /* not __GNU_LIBRARY__ */
 154 extern int lsx_getopt ();
 155 # endif /* __GNU_LIBRARY__ */
 156
 157 # ifndef __need_getopt
 158 extern int lsx_getopt_long (int ___argc, char *const *___argv,
 159                         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
 165 /* Internal only.  Users should not call this directly.  */
 166 extern int _getopt_internal (int ___argc, char *const *___argv,
 167                              const char *__shortopts,
 168                              const struct option *__longopts, int *__longind,
 169                              int __long_only);
 170 # endif
 171 #else /* not __STDC__ */
 172 extern int lsx_getopt ();
 173 # ifndef __need_getopt
 174 extern int lsx_getopt_long ();
 175 extern int getopt_long_only ();
 176
 177 extern int _getopt_internal ();
 178 # endif
 179 #endif /* __STDC__ */
 180
 181 #ifdef  __cplusplus
 182 }
 183 #endif
 184
 185 /* Make sure we later can get all the definitions and declarations.  */
 186 #undef __need_getopt
 187
 188 #endif /* getopt.h */
 189
 190 #if defined __SUNPRO_CC
 191   #pragma enable_warn
 192 #elif defined _MSC_VER
 193   #pragma warning(pop)
 194 #endif
 195