Annotation of embedaddon/quagga/lib/getopt.h, revision 1.1
1.1 ! misho 1: /* Declarations for getopt.
! 2: Copyright (C) 1989,90,91,92,93,94,96,97 Free Software Foundation, Inc.
! 3:
! 4: NOTE: The canonical source of this file is maintained with the GNU C Library.
! 5: Bugs can be reported to bug-glibc@gnu.org.
! 6:
! 7: This program is free software; you can redistribute it and/or modify it
! 8: under the terms of the GNU General Public License as published by the
! 9: Free Software Foundation; either version 2, or (at your option) any
! 10: later version.
! 11:
! 12: This program is distributed in the hope that it will be useful,
! 13: but WITHOUT ANY WARRANTY; without even the implied warranty of
! 14: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
! 15: GNU General Public License for more details.
! 16:
! 17: You should have received a copy of the GNU General Public License
! 18: along with this program; if not, write to the Free Software
! 19: Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
! 20: USA. */
! 21:
! 22: #ifndef _GETOPT_H
! 23: #define _GETOPT_H 1
! 24:
! 25: /*
! 26: * The operating system may or may not provide getopt_long(), and if
! 27: * so it may or may not be a version we are willing to use. Our
! 28: * strategy is to declare getopt here, and then provide code unless
! 29: * the supplied version is adequate. The difficult case is when a
! 30: * declaration for getopt is provided, as our declaration must match.
! 31: *
! 32: * XXX Arguably this version should be named differently, and the
! 33: * local names defined to refer to the system version when we choose
! 34: * to use the system version.
! 35: */
! 36:
! 37: #ifdef __cplusplus
! 38: extern "C" {
! 39: #endif
! 40:
! 41: /* For communication from `getopt' to the caller.
! 42: When `getopt' finds an option that takes an argument,
! 43: the argument value is returned here.
! 44: Also, when `ordering' is RETURN_IN_ORDER,
! 45: each non-option ARGV-element is returned here. */
! 46:
! 47: extern char *optarg;
! 48:
! 49: /* Index in ARGV of the next element to be scanned.
! 50: This is used for communication to and from the caller
! 51: and for communication between successive calls to `getopt'.
! 52:
! 53: On entry to `getopt', zero means this is the first call; initialize.
! 54:
! 55: When `getopt' returns -1, this is the index of the first of the
! 56: non-option elements that the caller should itself scan.
! 57:
! 58: Otherwise, `optind' communicates from one call to the next
! 59: how much of ARGV has been scanned so far. */
! 60:
! 61: extern int optind;
! 62:
! 63: /* Callers store zero here to inhibit the error message `getopt' prints
! 64: for unrecognized options. */
! 65:
! 66: extern int opterr;
! 67:
! 68: /* Set to an option character which was unrecognized. */
! 69:
! 70: extern int optopt;
! 71:
! 72: /* Describe the long-named options requested by the application.
! 73: The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
! 74: of `struct option' terminated by an element containing a name which is
! 75: zero.
! 76:
! 77: The field `has_arg' is:
! 78: no_argument (or 0) if the option does not take an argument,
! 79: required_argument (or 1) if the option requires an argument,
! 80: optional_argument (or 2) if the option takes an optional argument.
! 81:
! 82: If the field `flag' is not NULL, it points to a variable that is set
! 83: to the value given in the field `val' when the option is found, but
! 84: left unchanged if the option is not found.
! 85:
! 86: To have a long-named option do something other than set an `int' to
! 87: a compiled-in constant, such as set a value from `optarg', set the
! 88: option's `flag' field to zero and its `val' field to a nonzero
! 89: value (the equivalent single-letter option character, if there is
! 90: one). For long options that have a zero `flag' field, `getopt'
! 91: returns the contents of the `val' field. */
! 92:
! 93: struct option
! 94: {
! 95: #if defined (__STDC__) && __STDC__
! 96: const char *name;
! 97: #else
! 98: char *name;
! 99: #endif
! 100: /* has_arg can't be an enum because some compilers complain about
! 101: type mismatches in all the code that assumes it is an int. */
! 102: int has_arg;
! 103: int *flag;
! 104: int val;
! 105: };
! 106:
! 107: /* Names for the values of the `has_arg' field of `struct option'. */
! 108:
! 109: #define no_argument 0
! 110: #define required_argument 1
! 111: #define optional_argument 2
! 112:
! 113: #if defined (__STDC__) && __STDC__
! 114:
! 115: #if REALLY_NEED_PLAIN_GETOPT
! 116:
! 117: /*
! 118: * getopt is defined in POSIX.2. Assume that if the system defines
! 119: * getopt that it complies with POSIX.2. If not, an autoconf test
! 120: * should be written to define NONPOSIX_GETOPT_DEFINITION.
! 121: */
! 122: #ifndef NONPOSIX_GETOPT_DEFINITION
! 123: extern int getopt (int argc, char *const *argv, const char *shortopts);
! 124: #else /* NONPOSIX_GETOPT_DEFINITION */
! 125: extern int getopt (void);
! 126: #endif /* NONPOSIX_GETOPT_DEFINITION */
! 127:
! 128: #endif
! 129:
! 130:
! 131: extern int getopt_long (int argc, char *const *argv, const char *shortopts,
! 132: const struct option *longopts, int *longind);
! 133: extern int getopt_long_only (int argc, char *const *argv,
! 134: const char *shortopts,
! 135: const struct option *longopts, int *longind);
! 136:
! 137: /* Internal only. Users should not call this directly. */
! 138: extern int _getopt_internal (int argc, char *const *argv,
! 139: const char *shortopts,
! 140: const struct option *longopts, int *longind,
! 141: int long_only);
! 142: #else /* not __STDC__ */
! 143:
! 144: #ifdef REALLY_NEED_PLAIN_GETOPT
! 145: extern int getopt ();
! 146: #endif /* REALLY_NEED_PLAIN_GETOPT */
! 147:
! 148: extern int getopt_long ();
! 149: extern int getopt_long_only ();
! 150:
! 151: extern int _getopt_internal ();
! 152:
! 153: #endif /* __STDC__ */
! 154:
! 155: #ifdef __cplusplus
! 156: }
! 157: #endif
! 158:
! 159: #endif /* getopt.h */
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to getopt.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / quagga / lib