1/* 2 * our_getopt.h 3 * 4 * Header file for the getopt_long deprived. 5 * 6 * $Id: our_getopt.h,v 1.1.1.1 2002/06/21 08:52:00 fenix_nl Exp $ 7 */ 8 9/* Declarations for getopt. 10 Copyright (C) 1989,90,91,92,93,94,96,97,98 Free Software Foundation, Inc. 11 This file is part of the GNU C Library. 12 13 The GNU C Library is free software; you can redistribute it and/or 14 modify it under the terms of the GNU Library General Public License as 15 published by the Free Software Foundation; either version 2 of the 16 License, or (at your option) any later version. 17 18 The GNU C Library is distributed in the hope that it will be useful, 19 but WITHOUT ANY WARRANTY; without even the implied warranty of 20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 21 Library General Public License for more details. 22 23 You should have received a copy of the GNU Library General Public 24 License along with the GNU C Library; see the file COPYING.LIB. If not, 25 write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 26 Boston, MA 02111-1307, USA. */ 27 28#ifndef _GETOPT_H 29 30#ifndef __need_getopt 31# define _GETOPT_H 1 32#endif 33 34#ifdef __cplusplus 35extern "C" { 36#endif 37 38/* For communication from `getopt' to the caller. 39 When `getopt' finds an option that takes an argument, 40 the argument value is returned here. 41 Also, when `ordering' is RETURN_IN_ORDER, 42 each non-option ARGV-element is returned here. */ 43 44extern char *optarg; 45 46/* Index in ARGV of the next element to be scanned. 47 This is used for communication to and from the caller 48 and for communication between successive calls to `getopt'. 49 50 On entry to `getopt', zero means this is the first call; initialize. 51 52 When `getopt' returns -1, this is the index of the first of the 53 non-option elements that the caller should itself scan. 54 55 Otherwise, `optind' communicates from one call to the next 56 how much of ARGV has been scanned so far. */ 57 58extern int optind; 59 60/* Callers store zero here to inhibit the error message `getopt' prints 61 for unrecognized options. */ 62 63extern int opterr; 64 65/* Set to an option character which was unrecognized. */ 66 67extern int optopt; 68 69#ifndef __need_getopt 70/* Describe the long-named options requested by the application. 71 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector 72 of `struct option' terminated by an element containing a name which is 73 zero. 74 75 The field `has_arg' is: 76 no_argument (or 0) if the option does not take an argument, 77 required_argument (or 1) if the option requires an argument, 78 optional_argument (or 2) if the option takes an optional argument. 79 80 If the field `flag' is not NULL, it points to a variable that is set 81 to the value given in the field `val' when the option is found, but 82 left unchanged if the option is not found. 83 84 To have a long-named option do something other than set an `int' to 85 a compiled-in constant, such as set a value from `optarg', set the 86 option's `flag' field to zero and its `val' field to a nonzero 87 value (the equivalent single-letter option character, if there is 88 one). For long options that have a zero `flag' field, `getopt' 89 returns the contents of the `val' field. */ 90 91struct option 92{ 93# if defined __STDC__ && __STDC__ 94 const char *name; 95# else 96 char *name; 97# endif 98 /* has_arg can't be an enum because some compilers complain about 99 type mismatches in all the code that assumes it is an int. */ 100 int has_arg; 101 int *flag; 102 int val; 103}; 104 105/* Names for the values of the `has_arg' field of `struct option'. */ 106 107# define no_argument 0 108# define required_argument 1 109# define optional_argument 2 110#endif /* need getopt */ 111 112 113/* Get definitions and prototypes for functions to process the 114 arguments in ARGV (ARGC of them, minus the program name) for 115 options given in OPTS. 116 117 Return the option character from OPTS just read. Return -1 when 118 there are no more options. For unrecognized options, or options 119 missing arguments, `optopt' is set to the option letter, and '?' is 120 returned. 121 122 The OPTS string is a list of characters which are recognized option 123 letters, optionally followed by colons, specifying that that letter 124 takes an argument, to be placed in `optarg'. 125 126 If a letter in OPTS is followed by two colons, its argument is 127 optional. This behavior is specific to the GNU `getopt'. 128 129 The argument `--' causes premature termination of argument 130 scanning, explicitly telling `getopt' that there are no more 131 options. 132 133 If OPTS begins with `--', then non-option arguments are treated as 134 arguments to the option '\0'. This behavior is specific to the GNU 135 `getopt'. */ 136 137#if defined __STDC__ && __STDC__ 138# ifdef __GNU_LIBRARY__ 139/* Many other libraries have conflicting prototypes for getopt, with 140 differences in the consts, in stdlib.h. To avoid compilation 141 errors, only prototype getopt for the GNU C library. */ 142extern int getopt (int __argc, char *const *__argv, const char *__shortopts); 143# else /* not __GNU_LIBRARY__ */ 144extern int getopt (); 145# endif /* __GNU_LIBRARY__ */ 146 147# ifndef __need_getopt 148extern int getopt_long (int __argc, char *const *__argv, const char *__shortopts, 149 const struct option *__longopts, int *__longind); 150extern int getopt_long_only (int __argc, char *const *__argv, 151 const char *__shortopts, 152 const struct option *__longopts, int *__longind); 153 154/* Internal only. Users should not call this directly. */ 155extern int _getopt_internal (int __argc, char *const *__argv, 156 const char *__shortopts, 157 const struct option *__longopts, int *__longind, 158 int __long_only); 159# endif 160#else /* not __STDC__ */ 161extern int getopt (); 162# ifndef __need_getopt 163extern int getopt_long (); 164extern int getopt_long_only (); 165 166extern int _getopt_internal (); 167# endif 168#endif /* __STDC__ */ 169 170#ifdef __cplusplus 171} 172#endif 173 174/* Make sure we later can get all the definitions and declarations. */ 175#undef __need_getopt 176 177#endif /* getopt.h */ 178