|
|
1.1 root 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, 675 Mass Ave, Cambridge, MA 02139, USA. */
17:
18: #ifndef _GETOPT_H
19: #define _GETOPT_H 1
20:
21: #ifdef __cplusplus
22: extern "C" {
23: #endif
24:
25: /* For communication from `getopt' to the caller.
26: When `getopt' finds an option that takes an argument,
27: the argument value is returned here.
28: Also, when `ordering' is RETURN_IN_ORDER,
29: each non-option ARGV-element is returned here. */
30:
31: extern char *optarg;
32:
33: /* Index in ARGV of the next element to be scanned.
34: This is used for communication to and from the caller
35: and for communication between successive calls to `getopt'.
36:
37: On entry to `getopt', zero means this is the first call; initialize.
38:
39: When `getopt' returns EOF, this is the index of the first of the
40: non-option elements that the caller should itself scan.
41:
42: Otherwise, `optind' communicates from one call to the next
43: how much of ARGV has been scanned so far. */
44:
45: extern int optind;
46:
47: /* Callers store zero here to inhibit the error message `getopt' prints
48: for unrecognized options. */
49:
50: extern int opterr;
51:
52: /* Describe the long-named options requested by the application.
53: The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
54: of `struct option' terminated by an element containing a name which is
55: zero.
56:
57: The field `has_arg' is:
58: no_argument (or 0) if the option does not take an argument,
59: required_argument (or 1) if the option requires an argument,
60: optional_argument (or 2) if the option takes an optional argument.
61:
62: If the field `flag' is not NULL, it points to a variable that is set
63: to the value given in the field `val' when the option is found, but
64: left unchanged if the option is not found.
65:
66: To have a long-named option do something other than set an `int' to
67: a compiled-in constant, such as set a value from `optarg', set the
68: option's `flag' field to zero and its `val' field to a nonzero
69: value (the equivalent single-letter option character, if there is
70: one). For long options that have a zero `flag' field, `getopt'
71: returns the contents of the `val' field. */
72:
73: struct option
74: {
75: #if __STDC__
76: const char *name;
77: #else
78: char *name;
79: #endif
80: /* has_arg can't be an enum because some compilers complain about
81: type mismatches in all the code that assumes it is an int. */
82: int has_arg;
83: int *flag;
84: int val;
85: };
86:
87: /* Names for the values of the `has_arg' field of `struct option'. */
88:
89: enum _argtype
90: {
91: no_argument,
92: required_argument,
93: optional_argument
94: };
95:
96: #if __STDC__ || defined(PROTO)
97: #if defined(__GNU_LIBRARY__)
98: /* Many other libraries have conflicting prototypes for getopt, with
99: differences in the consts, in stdlib.h. To avoid compilation
100: errors, only prototype getopt for the GNU C library. */
101: extern int getopt (int argc, char *const *argv, const char *shortopts);
102: #else /* not __GNU_LIBRARY__ */
103: extern int getopt ();
104: #endif /* not __GNU_LIBRARY__ */
105: extern int getopt_long (int argc, char *const *argv, const char *shortopts,
106: const struct option *longopts, int *longind);
107: extern int getopt_long_only (int argc, char *const *argv,
108: const char *shortopts,
109: const struct option *longopts, int *longind);
110:
111: /* Internal only. Users should not call this directly. */
112: extern int _getopt_internal (int argc, char *const *argv,
113: const char *shortopts,
114: const struct option *longopts, int *longind,
115: int long_only);
116: #else /* not __STDC__ */
117: extern int getopt ();
118: extern int getopt_long ();
119: extern int getopt_long_only ();
120:
121: extern int _getopt_internal ();
122: #endif /* not __STDC__ */
123:
124: #ifdef __cplusplus
125: }
126: #endif
127:
128: #endif /* _GETOPT_H */
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.