00001 /* Declarations for getopt.
00002 Copyright (C) 1989,90,91,92,93,94,96,97 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 #define _GETOPT_H 1
00022
00023 #ifdef __cplusplus
00024 extern "C" {
00025 #endif
00026
00027 /* For communication from `getopt' to the caller.
00028 When `getopt' finds an option that takes an argument,
00029 the argument value is returned here.
00030 Also, when `ordering' is RETURN_IN_ORDER,
00031 each non-option ARGV-element is returned here. */
00032
00033 extern char *optarg;
00034
00035 /* Index in ARGV of the next element to be scanned.
00036 This is used for communication to and from the caller
00037 and for communication between successive calls to `getopt'.
00038
00039 On entry to `getopt', zero means this is the first call; initialize.
00040
00041 When `getopt' returns -1, this is the index of the first of the
00042 non-option elements that the caller should itself scan.
00043
00044 Otherwise, `optind' communicates from one call to the next
00045 how much of ARGV has been scanned so far. */
00046
00047 extern int optind;
00048
00049 /* Callers store zero here to inhibit the error message `getopt' prints
00050 for unrecognized options. */
00051
00052 extern int opterr;
00053
00054 /* Set to an option character which was unrecognized. */
00055
00056 extern int optopt;
00057
00058 /* Describe the long-named options requested by the application.
00059 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
00060 of `struct option' terminated by an element containing a name which is
00061 zero.
00062
00063 The field `has_arg' is:
00064 no_argument (or 0) if the option does not take an argument,
00065 required_argument (or 1) if the option requires an argument,
00066 optional_argument (or 2) if the option takes an optional argument.
00067
00068 If the field `flag' is not NULL, it points to a variable that is set
00069 to the value given in the field `val' when the option is found, but
00070 left unchanged if the option is not found.
00071
00072 To have a long-named option do something other than set an `int' to
00073 a compiled-in constant, such as set a value from `optarg', set the
00074 option's `flag' field to zero and its `val' field to a nonzero
00075 value (the equivalent single-letter option character, if there is
00076 one). For long options that have a zero `flag' field, `getopt'
00077 returns the contents of the `val' field. */
00078
00079 struct option
00080 {
00081 #if defined (__STDC__) && __STDC__
00082 const char *name;
00083 #else
00084 char *name;
00085 #endif
00086 /* has_arg can't be an enum because some compilers complain about
00087 type mismatches in all the code that assumes it is an int. */
00088 int has_arg;
00089 int *flag;
00090 int val;
00091 };
00092
00093 /* Names for the values of the `has_arg' field of `struct option'. */
00094
00095 #define no_argument 0
00096 #define required_argument 1
00097 #define optional_argument 2
00098
00099 #if defined (__STDC__) && __STDC__
00100 #ifdef __GNU_LIBRARY__
00101 /* Many other libraries have conflicting prototypes for getopt, with
00102 differences in the consts, in stdlib.h. To avoid compilation
00103 errors, only prototype getopt for the GNU C library. */
00104 extern int getopt (int argc, char *const *argv, const char *shortopts);
00105 #else /* not __GNU_LIBRARY__ */
00106 extern int getopt ();
00107 #endif /* __GNU_LIBRARY__ */
00108 extern int getopt_long (int argc, char *const *argv, const char *shortopts,
00109 const struct option *longopts, int *longind);
00110 extern int getopt_long_only (int argc, char *const *argv,
00111 const char *shortopts,
00112 const struct option *longopts, int *longind);
00113
00114 /* Internal only. Users should not call this directly. */
00115 extern int _getopt_internal (int argc, char *const *argv,
00116 const char *shortopts,
00117 const struct option *longopts, int *longind,
00118 int long_only);
00119 #else /* not __STDC__ */
00120 extern int getopt ();
00121 extern int getopt_long ();
00122 extern int getopt_long_only ();
00123
00124 extern int _getopt_internal ();
00125 #endif /* __STDC__ */
00126
00127 #ifdef __cplusplus
00128 }
00129 #endif
00130
00131
00132 /* eclipse addition: default option numbers */
00133
00134 #define OPT_LICENSE 901 /* --license */
00135 #define OPT_HELP 902 /* --help */
00136 #define OPT_VERSION 903 /* --version */
00137 #define OPT_INPUT 910 /* --in */
00138 #define OPT_OUTPUT 911 /* --out */
00139
00140
00141 #endif /* _GETOPT_H */
1.2.13.1 written by Dimitri van Heesch,
© 1997-2001