00001 /* Declarations for getopt.
00002    Copyright (C) 1989,90,91,92,93,94,96,97,98 Free Software Foundation, Inc.
00003    This file is part of the GNU C Library.
00004 
00005    The GNU C Library is free software; you can redistribute it and/or
00006    modify it under the terms of the GNU Library General Public License as
00007    published by the Free Software Foundation; either version 2 of the
00008    License, or (at your option) any later version.
00009 
00010    The GNU C Library is distributed in the hope that it will be useful,
00011    but WITHOUT ANY WARRANTY; without even the implied warranty of
00012    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013    Library General Public License for more details.
00014 
00015    You should have received a copy of the GNU Library General Public
00016    License along with the GNU C Library; see the file COPYING.LIB.  If not,
00017    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00018    Boston, MA 02111-1307, USA.  */
00019 
00020 #ifndef _GETOPT_H
00021 
00022 #ifndef __need_getopt
00023 # define _GETOPT_H 1
00024 #endif
00025 
00026 #ifdef  __cplusplus
00027 extern "C" {
00028 #endif
00029 
00030 /* For communication from `getopt' to the caller.
00031    When `getopt' finds an option that takes an argument,
00032    the argument value is returned here.
00033    Also, when `ordering' is RETURN_IN_ORDER,
00034    each non-option ARGV-element is returned here.  */
00035 
00036 extern char *optarg;
00037 
00038 /* Index in ARGV of the next element to be scanned.
00039    This is used for communication to and from the caller
00040    and for communication between successive calls to `getopt'.
00041 
00042    On entry to `getopt', zero means this is the first call; initialize.
00043 
00044    When `getopt' returns -1, this is the index of the first of the
00045    non-option elements that the caller should itself scan.
00046 
00047    Otherwise, `optind' communicates from one call to the next
00048    how much of ARGV has been scanned so far.  */
00049 
00050 extern int optind;
00051 
00052 /* Callers store zero here to inhibit the error message `getopt' prints
00053    for unrecognized options.  */
00054 
00055 extern int opterr;
00056 
00057 /* Set to an option character which was unrecognized.  */
00058 
00059 extern int optopt;
00060 
00061 #ifndef __need_getopt
00062 /* Describe the long-named options requested by the application.
00063    The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
00064    of `struct option' terminated by an element containing a name which is
00065    zero.
00066 
00067    The field `has_arg' is:
00068    no_argument          (or 0) if the option does not take an argument,
00069    required_argument    (or 1) if the option requires an argument,
00070    optional_argument    (or 2) if the option takes an optional argument.
00071 
00072    If the field `flag' is not NULL, it points to a variable that is set
00073    to the value given in the field `val' when the option is found, but
00074    left unchanged if the option is not found.
00075 
00076    To have a long-named option do something other than set an `int' to
00077    a compiled-in constant, such as set a value from `optarg', set the
00078    option's `flag' field to zero and its `val' field to a nonzero
00079    value (the equivalent single-letter option character, if there is
00080    one).  For long options that have a zero `flag' field, `getopt'
00081    returns the contents of the `val' field.  */
00082 
00083 struct option
00084 {
00085 # if defined __STDC__ && __STDC__
00086   const char *name;
00087 # else
00088   char *name;
00089 # endif
00090   /* has_arg can't be an enum because some compilers complain about
00091      type mismatches in all the code that assumes it is an int.  */
00092   int has_arg;
00093   int *flag;
00094   int val;
00095 };
00096 
00097 /* Names for the values of the `has_arg' field of `struct option'.  */
00098 
00099 # define no_argument            0
00100 # define required_argument      1
00101 # define optional_argument      2
00102 #endif  /* need getopt */
00103 
00104 
00105 /* Get definitions and prototypes for functions to process the
00106    arguments in ARGV (ARGC of them, minus the program name) for
00107    options given in OPTS.
00108 
00109    Return the option character from OPTS just read.  Return -1 when
00110    there are no more options.  For unrecognized options, or options
00111    missing arguments, `optopt' is set to the option letter, and '?' is
00112    returned.
00113 
00114    The OPTS string is a list of characters which are recognized option
00115    letters, optionally followed by colons, specifying that that letter
00116    takes an argument, to be placed in `optarg'.
00117 
00118    If a letter in OPTS is followed by two colons, its argument is
00119    optional.  This behavior is specific to the GNU `getopt'.
00120 
00121    The argument `--' causes premature termination of argument
00122    scanning, explicitly telling `getopt' that there are no more
00123    options.
00124 
00125    If OPTS begins with `--', then non-option arguments are treated as
00126    arguments to the option '\0'.  This behavior is specific to the GNU
00127    `getopt'.  */
00128 
00129 #if defined __STDC__ && __STDC__
00130 # ifdef __GNU_LIBRARY__
00131 /* Many other libraries have conflicting prototypes for getopt, with
00132    differences in the consts, in stdlib.h.  To avoid compilation
00133    errors, only prototype getopt for the GNU C library.  */
00134 extern int getopt (int __argc, char *const *__argv, const char *__shortopts);
00135 # else /* not __GNU_LIBRARY__ */
00136 extern int getopt ();
00137 # endif /* __GNU_LIBRARY__ */
00138 
00139 # ifndef __need_getopt
00140 extern int getopt_long (int __argc, char *const *__argv, const char *__shortopts,
00141                         const struct option *__longopts, int *__longind);
00142 extern int getopt_long_only (int __argc, char *const *__argv,
00143                              const char *__shortopts,
00144                              const struct option *__longopts, int *__longind);
00145 
00146 /* Internal only.  Users should not call this directly.  */
00147 extern int _getopt_internal (int __argc, char *const *__argv,
00148                              const char *__shortopts,
00149                              const struct option *__longopts, int *__longind,
00150                              int __long_only);
00151 # endif
00152 #else /* not __STDC__ */
00153 extern int getopt ();
00154 # ifndef __need_getopt
00155 extern int getopt_long ();
00156 extern int getopt_long_only ();
00157 
00158 extern int _getopt_internal ();
00159 # endif
00160 #endif /* __STDC__ */
00161 
00162 #ifdef  __cplusplus
00163 }
00164 #endif
00165 
00166 /* Make sure we later can get all the definitions and declarations.  */
00167 #undef __need_getopt
00168 
00169 #endif /* getopt.h */