getopt.h
Go to the documentation of this file.00001 /* Declarations for getopt. 00002 Copyright (C) 1989, 1990, 1991, 1992, 1993 Free Software Foundation, Inc. 00003 00004 This program is free software; you can redistribute it and/or modify it 00005 under the terms of the GNU General Public License as published by the 00006 Free Software Foundation; either version 2, or (at your option) any 00007 later version. 00008 00009 This program is distributed in the hope that it will be useful, 00010 but WITHOUT ANY WARRANTY; without even the implied warranty of 00011 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00012 GNU General Public License for more details. 00013 00014 You should have received a copy of the GNU General Public License 00015 along with this program; if not, write to the Free Software 00016 Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */ 00017 00018 #ifndef _GETOPT_H 00019 #define _GETOPT_H 1 00020 00021 #ifdef __cplusplus 00022 extern "C" { 00023 #endif 00024 00025 extern const char *exec_name; 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 EOF, 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 __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 extern int getopt (int argc, char *const *argv, const char *shortopts); 00100 extern int getopt_long (int argc, char *const *argv, const char *shortopts, 00101 const struct option *longopts, int *longind); 00102 extern int getopt_long_only (int argc, char *const *argv, 00103 const char *shortopts, 00104 const struct option *longopts, int *longind); 00105 00106 /* Internal only. Users should not call this directly. */ 00107 extern int _getopt_internal (int argc, char *const *argv, 00108 const char *shortopts, 00109 const struct option *longopts, int *longind, 00110 int long_only); 00111 00112 #ifdef __cplusplus 00113 } 00114 #endif 00115 00116 #endif /* _GETOPT_H */