Mercurial > emacs
annotate lib-src/getopt.h @ 17909:7833700e2a35
thomas, not mib
author | Joel N. Weber II <devnull@gnu.org> |
---|---|
date | Wed, 21 May 1997 05:16:30 +0000 |
parents | 16c0c57e8ab2 |
children | 160c3be66a71 |
rev | line source |
---|---|
16919
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
1 /* Declarations for getopt. |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
2 Copyright (C) 1989,90,91,92,93,94,96,97 Free Software Foundation, Inc. |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
3 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
4 the C library, however. The master source lives in /gd/gnu/lib. |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
5 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
6 NOTE: The canonical source of this file is maintained with the GNU C Library. |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
7 Bugs can be reported to bug-glibc@prep.ai.mit.edu. |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
8 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
9 This program is free software; you can redistribute it and/or modify it |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
10 under the terms of the GNU General Public License as published by the |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
11 Free Software Foundation; either version 2, or (at your option) any |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
12 later version. |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
13 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
14 This program is distributed in the hope that it will be useful, |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
15 but WITHOUT ANY WARRANTY; without even the implied warranty of |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
17 GNU General Public License for more details. |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
18 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
19 You should have received a copy of the GNU General Public License |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
20 along with this program; if not, write to the Free Software |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
21 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
22 USA. */ |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
23 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
24 #ifndef _GETOPT_H |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
25 #define _GETOPT_H 1 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
26 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
27 #ifdef __cplusplus |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
28 extern "C" { |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
29 #endif |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
30 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
31 /* For communication from `getopt' to the caller. |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
32 When `getopt' finds an option that takes an argument, |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
33 the argument value is returned here. |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
34 Also, when `ordering' is RETURN_IN_ORDER, |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
35 each non-option ARGV-element is returned here. */ |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
36 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
37 extern char *optarg; |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
38 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
39 /* Index in ARGV of the next element to be scanned. |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
40 This is used for communication to and from the caller |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
41 and for communication between successive calls to `getopt'. |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
42 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
43 On entry to `getopt', zero means this is the first call; initialize. |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
44 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
45 When `getopt' returns -1, this is the index of the first of the |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
46 non-option elements that the caller should itself scan. |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
47 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
48 Otherwise, `optind' communicates from one call to the next |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
49 how much of ARGV has been scanned so far. */ |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
50 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
51 extern int optind; |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
52 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
53 /* Callers store zero here to inhibit the error message `getopt' prints |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
54 for unrecognized options. */ |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
55 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
56 extern int opterr; |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
57 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
58 /* Set to an option character which was unrecognized. */ |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
59 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
60 extern int optopt; |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
61 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
62 /* Describe the long-named options requested by the application. |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
63 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
64 of `struct option' terminated by an element containing a name which is |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
65 zero. |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
66 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
67 The field `has_arg' is: |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
68 no_argument (or 0) if the option does not take an argument, |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
69 required_argument (or 1) if the option requires an argument, |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
70 optional_argument (or 2) if the option takes an optional argument. |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
71 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
72 If the field `flag' is not NULL, it points to a variable that is set |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
73 to the value given in the field `val' when the option is found, but |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
74 left unchanged if the option is not found. |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
75 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
76 To have a long-named option do something other than set an `int' to |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
77 a compiled-in constant, such as set a value from `optarg', set the |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
78 option's `flag' field to zero and its `val' field to a nonzero |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
79 value (the equivalent single-letter option character, if there is |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
80 one). For long options that have a zero `flag' field, `getopt' |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
81 returns the contents of the `val' field. */ |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
82 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
83 struct option |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
84 { |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
85 #if defined (__STDC__) && __STDC__ |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
86 const char *name; |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
87 #else |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
88 char *name; |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
89 #endif |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
90 /* has_arg can't be an enum because some compilers complain about |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
91 type mismatches in all the code that assumes it is an int. */ |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
92 int has_arg; |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
93 int *flag; |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
94 int val; |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
95 }; |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
96 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
97 /* Names for the values of the `has_arg' field of `struct option'. */ |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
98 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
99 #define no_argument 0 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
100 #define required_argument 1 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
101 #define optional_argument 2 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
102 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
103 #if defined (__STDC__) && __STDC__ |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
104 #ifdef __GNU_LIBRARY__ |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
105 /* Many other libraries have conflicting prototypes for getopt, with |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
106 differences in the consts, in stdlib.h. To avoid compilation |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
107 errors, only prototype getopt for the GNU C library. */ |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
108 extern int getopt (int argc, char *const *argv, const char *shortopts); |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
109 #else /* not __GNU_LIBRARY__ */ |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
110 extern int getopt (); |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
111 #endif /* __GNU_LIBRARY__ */ |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
112 extern int getopt_long (int argc, char *const *argv, const char *shortopts, |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
113 const struct option *longopts, int *longind); |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
114 extern int getopt_long_only (int argc, char *const *argv, |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
115 const char *shortopts, |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
116 const struct option *longopts, int *longind); |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
117 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
118 /* Internal only. Users should not call this directly. */ |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
119 extern int _getopt_internal (int argc, char *const *argv, |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
120 const char *shortopts, |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
121 const struct option *longopts, int *longind, |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
122 int long_only); |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
123 #else /* not __STDC__ */ |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
124 extern int getopt (); |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
125 extern int getopt_long (); |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
126 extern int getopt_long_only (); |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
127 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
128 extern int _getopt_internal (); |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
129 #endif /* __STDC__ */ |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
130 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
131 #ifdef __cplusplus |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
132 } |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
133 #endif |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
134 |
16c0c57e8ab2
automatically generated from GPLed version
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
135 #endif /* _GETOPT_H */ |