Jack2 1.9.12

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