1/* Declarations for getopt. 2 Copyright (C) 1989, 1990, 1991, 1992 Free Software Foundation, Inc. 3 4 This program is free software; you can redistribute it and/or modify it 5 under the terms of the GNU General Public License as published by the 6 Free Software Foundation; either version 2, or (at your option) any 7 later version. 8 9 This program is distributed in the hope that it will be useful, 10 but WITHOUT ANY WARRANTY; without even the implied warranty of 11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 GNU General Public License for more details. 13 14 You should have received a copy of the GNU General Public License 15 along with this program; if not, write to the Free Software 16 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 17 18 This file was modified slightly by Ian Lance Taylor, November 1992, 19 for Taylor UUCP, and again in June, 1995. */ 20 21#ifndef _GETOPT_H 22#define _GETOPT_H 1 23 24#ifdef __cplusplus 25extern "C" { 26#endif 27 28/* Ian Lance Taylor <ian@airs.com> added the following defines for 29 Taylor UUCP. This avoids reported conflicts with system getopt 30 definitions. */ 31#define getopt gnu_getopt 32#define optarg gnu_optarg 33#define optind gnu_optind 34#define opterr gnu_opterr 35 36/* For communication from `getopt' to the caller. 37 When `getopt' finds an option that takes an argument, 38 the argument value is returned here. 39 Also, when `ordering' is RETURN_IN_ORDER, 40 each non-option ARGV-element is returned here. */ 41 42extern char *optarg; 43 44/* Index in ARGV of the next element to be scanned. 45 This is used for communication to and from the caller 46 and for communication between successive calls to `getopt'. 47 48 On entry to `getopt', zero means this is the first call; initialize. 49 50 When `getopt' returns EOF, this is the index of the first of the 51 non-option elements that the caller should itself scan. 52 53 Otherwise, `optind' communicates from one call to the next 54 how much of ARGV has been scanned so far. */ 55 56extern int optind; 57 58/* Callers store zero here to inhibit the error message `getopt' prints 59 for unrecognized options. */ 60 61extern int opterr; 62 63/* Describe the long-named options requested by the application. 64 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector 65 of `struct option' terminated by an element containing a name which is 66 zero. 67 68 The field `has_arg' is: 69 no_argument (or 0) if the option does not take an argument, 70 required_argument (or 1) if the option requires an argument, 71 optional_argument (or 2) if the option takes an optional argument. 72 73 If the field `flag' is not NULL, it points to a variable that is set 74 to the value given in the field `val' when the option is found, but 75 left unchanged if the option is not found. 76 77 To have a long-named option do something other than set an `int' to 78 a compiled-in constant, such as set a value from `optarg', set the 79 option's `flag' field to zero and its `val' field to a nonzero 80 value (the equivalent single-letter option character, if there is 81 one). For long options that have a zero `flag' field, `getopt' 82 returns the contents of the `val' field. */ 83 84struct option 85{ 86 const char *name; 87 /* has_arg can't be an enum because some compilers complain about 88 type mismatches in all the code that assumes it is an int. */ 89 int has_arg; 90 int *flag; 91 int val; 92}; 93 94/* Names for the values of the `has_arg' field of `struct option'. */ 95 96enum _argtype 97{ 98 no_argument, 99 required_argument, 100 optional_argument 101}; 102 103#ifndef P 104/* On some systems, <stdio.h> includes getopt.h before P is defined by 105 uucp.h, and the -I arguments cause this version of getopt.h to be 106 included. Work around that here. */ 107#define P(x) () 108#define UNDEFINE_P 109#endif 110 111extern int getopt P((int argc, char *const *argv, const char *shortopts)); 112extern int getopt_long P((int argc, char *const *argv, const char *shortopts, 113 const struct option *longopts, int *longind)); 114extern int getopt_long_only P((int argc, char *const *argv, 115 const char *shortopts, 116 const struct option *longopts, int *longind)); 117 118/* Internal only. Users should not call this directly. */ 119extern int _getopt_internal P((int argc, char *const *argv, 120 const char *shortopts, 121 const struct option *longopts, int *longind, 122 int long_only)); 123 124#ifdef UNDEFINE_P 125#undef P 126#undef UNDEFINE_P 127#endif 128 129#ifdef __cplusplus 130} 131#endif 132 133#endif /* _GETOPT_H */ 134