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__
00022
00023 #if defined(__NeXT__) || defined(__APPLE__)
00024 // NeXT already has a valid getopt; avoid link errors.
00025 #define getopt __getopt
00026 #define optarg __optarg
00027 #define opterr __opterr
00028 #define optind __optind
00029 #define optopt __optopt
00030 #endif
00031
00032 /* For communication from `getopt' to the caller.
00033 When `getopt' finds an option that takes an argument,
00034 the argument value is returned here.
00035 Also, when `ordering' is RETURN_IN_ORDER,
00036 each non-option ARGV-element is returned here. */
00037
00038 extern char *optarg;
00039
00040 /* Index in ARGV of the next element to be scanned.
00041 This is used for communication to and from the caller
00042 and for communication between successive calls to `getopt'.
00043
00044 On entry to `getopt', zero means this is the first call; initialize.
00045
00046 When `getopt' returns -1, this is the index of the first of the
00047 non-option elements that the caller should itself scan.
00048
00049 Otherwise, `optind' communicates from one call to the next
00050 how much of ARGV has been scanned so far. */
00051
00052 extern int optind;
00053
00054 /* Callers store zero here to inhibit the error message `getopt' prints
00055 for unrecognized options. */
00056
00057 extern int opterr;
00058
00059 /* Set to an option character which was unrecognized. */
00060
00061 extern int optopt;
00062
00063 /* Describe the long-named options requested by the application.
00064 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
00065 of `struct option' terminated by an element containing a name which is
00066 zero.
00067
00068 The field `has_arg' is:
00069 no_argument (or 0) if the option does not take an argument,
00070 required_argument (or 1) if the option requires an argument,
00071 optional_argument (or 2) if the option takes an optional argument.
00072
00073 If the field `flag' is not NULL, it points to a variable that is set
00074 to the value given in the field `val' when the option is found, but
00075 left unchanged if the option is not found.
00076
00077 To have a long-named option do something other than set an `int' to
00078 a compiled-in constant, such as set a value from `optarg', set the
00079 option's `flag' field to zero and its `val' field to a nonzero
00080 value (the equivalent single-letter option character, if there is
00081 one). For long options that have a zero `flag' field, `getopt'
00082 returns the contents of the `val' field. */
00083
00084 struct option
00085 {
00086 #if defined (__STDC__) && __STDC__
00087 const char *name;
00088 #else
00089 char *name;
00090 #endif
00091 /* has_arg can't be an enum because some compilers complain about
00092 type mismatches in all the code that assumes it is an int. */
00093 int has_arg;
00094 int *flag;
00095 int val;
00096 };
00097
00098 /* Names for the values of the `has_arg' field of `struct option'. */
00099
00100 #define no_argument 0
00101 #define required_argument 1
00102 #define optional_argument 2
00103
00104 extern int getopt (int argc, char *const *argv, const char *shortopts);
00105 extern int getopt_long (int argc, char *const *argv, const char *shortopts,
00106 const struct option *longopts, int *longind);
00107 extern int getopt_long_only (int argc, char *const *argv,
00108 const char *shortopts,
00109 const struct option *longopts, int *longind);
00110
00111 /* Internal only. Users should not call this directly. */
00112 extern int _getopt_internal (int argc, char *const *argv,
00113 const char *shortopts,
00114 const struct option *longopts, int *longind,
00115 int long_only);
00116
00117 #endif // __GETOPT_H__