dlvhex  2.5.0
vs10/getopt.h
Go to the documentation of this file.
00001 /* Declarations for getopt.
00002    Copyright (C) 1989, 90, 91, 92, 93, 94 Free Software Foundation, Inc.
00003 
00004 This file is part of the GNU C Library.  Its master source is NOT part of
00005 the C library, however.  The master source lives in /gd/gnu/lib.
00006 
00007 The GNU C Library is free software; you can redistribute it and/or
00008 modify it under the terms of the GNU Library General Public License as
00009 published by the Free Software Foundation; either version 2 of the
00010 License, or (at your option) any later version.
00011 
00012 The GNU C Library is distributed in the hope that it will be useful,
00013 but WITHOUT ANY WARRANTY; without even the implied warranty of
00014 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015 Library General Public License for more details.
00016 
00017 You should have received a copy of the GNU Library General Public
00018 License along with the GNU C Library; see the file COPYING.LIB.  If
00019 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
00020 Cambridge, MA 02139, USA.  */
00021 
00022 #ifndef _GETOPT_H
00023 #define _GETOPT_H 1
00024 
00025 #ifdef  __cplusplus
00026 extern "C" {
00027 #endif
00028 
00029 /* For communication from `getopt' to the caller.
00030    When `getopt' finds an option that takes an argument,
00031    the argument value is returned here.
00032    Also, when `ordering' is RETURN_IN_ORDER,
00033    each non-option ARGV-element is returned here.  */
00034 
00035 extern char *optarg;
00036 
00037 /* Index in ARGV of the next element to be scanned.
00038    This is used for communication to and from the caller
00039    and for communication between successive calls to `getopt'.
00040 
00041    On entry to `getopt', zero means this is the first call; initialize.
00042 
00043    When `getopt' returns EOF, this is the index of the first of the
00044    non-option elements that the caller should itself scan.
00045 
00046    Otherwise, `optind' communicates from one call to the next
00047    how much of ARGV has been scanned so far.  */
00048 
00049 extern int optind;
00050 
00051 /* Callers store zero here to inhibit the error message `getopt' prints
00052    for unrecognized options.  */
00053 
00054 extern int opterr;
00055 
00056 /* Set to an option character which was unrecognized.  */
00057 
00058 extern int optopt;
00059 
00060 /* Describe the long-named options requested by the application.
00061    The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
00062    of `struct option' terminated by an element containing a name which is
00063    zero.
00064 
00065    The field `has_arg' is:
00066    no_argument      (or 0) if the option does not take an argument,
00067    required_argument    (or 1) if the option requires an argument,
00068    optional_argument    (or 2) if the option takes an optional argument.
00069 
00070    If the field `flag' is not NULL, it points to a variable that is set
00071    to the value given in the field `val' when the option is found, but
00072    left unchanged if the option is not found.
00073 
00074    To have a long-named option do something other than set an `int' to
00075    a compiled-in constant, such as set a value from `optarg', set the
00076    option's `flag' field to zero and its `val' field to a nonzero
00077    value (the equivalent single-letter option character, if there is
00078    one).  For long options that have a zero `flag' field, `getopt'
00079    returns the contents of the `val' field.  */
00080 
00081 struct option
00082 {
00083 #if defined (__STDC__) && __STDC__
00084   const char *name;
00085 #else
00086   char *name;
00087 #endif
00088   /* has_arg can't be an enum because some compilers complain about
00089      type mismatches in all the code that assumes it is an int.  */
00090   int has_arg;
00091   int *flag;
00092   int val;
00093 };
00094 
00095 /* Names for the values of the `has_arg' field of `struct option'.  */
00096 
00097 #define no_argument     0
00098 #define required_argument   1
00099 #define optional_argument   2
00100 
00101 #ifdef __GNU_LIBRARY__
00102 /* Many other libraries have conflicting prototypes for getopt, with
00103    differences in the consts, in stdlib.h.  To avoid compilation
00104    errors, only prototype getopt for the GNU C library.  */
00105 extern int getopt (int argc, char *const *argv, const char *shortopts);
00106 #else /* not __GNU_LIBRARY__ */
00107 extern int getopt ();
00108 #endif /* __GNU_LIBRARY__ */
00109 extern int getopt_long (int argc, char *const *argv, const char *shortopts,
00110                 const struct option *longopts, int *longind);
00111 extern int getopt_long_only (int argc, char *const *argv,
00112                  const char *shortopts,
00113                      const struct option *longopts, int *longind);
00114 
00115 /* Internal only.  Users should not call this directly.  */
00116 extern int _getopt_internal (int argc, char *const *argv,
00117                  const char *shortopts,
00118                      const struct option *longopts, int *longind,
00119                  int long_only);
00120 
00121 
00122 #ifdef  __cplusplus
00123 }
00124 #endif
00125 
00126 #endif /* _GETOPT_H */