1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>LibOFX: gnugetopt.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<h1>gnugetopt.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Declarations for getopt.</span>
<a name="l00002"></a>00002 <span class="comment"> Copyright (C) 1989-1994, 1996-1999, 2001 Free Software Foundation, Inc.</span>
<a name="l00003"></a>00003 <span class="comment"> This file is part of the GNU C Library.</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment"> The GNU C Library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment"> modify it under the terms of the GNU Lesser General Public</span>
<a name="l00007"></a>00007 <span class="comment"> License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment"> version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> The GNU C Library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00013"></a>00013 <span class="comment"> Lesser General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment"> You should have received a copy of the GNU Lesser General Public</span>
<a name="l00016"></a>00016 <span class="comment"> License along with the GNU C Library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment"> Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA</span>
<a name="l00018"></a>00018 <span class="comment"> 02111-1307 USA. */</span>
<a name="l00019"></a>00019
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef _GETOPT_H</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef __need_getopt</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor"># define _GETOPT_H 1</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="comment">/* If __GNU_LIBRARY__ is not already defined, either we are being used</span>
<a name="l00027"></a>00027 <span class="comment"> standalone, or this is the first header included in the source file.</span>
<a name="l00028"></a>00028 <span class="comment"> If we are being used with glibc, we need to include <features.h>, but</span>
<a name="l00029"></a>00029 <span class="comment"> that does not exist if we are standalone. So: if __GNU_LIBRARY__ is</span>
<a name="l00030"></a>00030 <span class="comment"> not defined, include <ctype.h>, which will pull in <features.h> for us</span>
<a name="l00031"></a>00031 <span class="comment"> if it's from glibc. (Why ctype.h? It's guaranteed to exist and it</span>
<a name="l00032"></a>00032 <span class="comment"> doesn't flood the namespace with stuff the way some other headers do.) */</span>
<a name="l00033"></a>00033 <span class="preprocessor">#if !defined __GNU_LIBRARY__</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor"># include <ctype.h></span>
<a name="l00035"></a>00035 <span class="preprocessor">#endif</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span>
<a name="l00037"></a>00037 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00039"></a>00039 <span class="preprocessor">#endif</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span>
<a name="l00041"></a>00041 <span class="comment">/* For communication from `getopt' to the caller.</span>
<a name="l00042"></a>00042 <span class="comment"> When `getopt' finds an option that takes an argument,</span>
<a name="l00043"></a>00043 <span class="comment"> the argument value is returned here.</span>
<a name="l00044"></a>00044 <span class="comment"> Also, when `ordering' is RETURN_IN_ORDER,</span>
<a name="l00045"></a>00045 <span class="comment"> each non-option ARGV-element is returned here. */</span>
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keyword">extern</span> <span class="keywordtype">char</span> *optarg;
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="comment">/* Index in ARGV of the next element to be scanned.</span>
<a name="l00050"></a>00050 <span class="comment"> This is used for communication to and from the caller</span>
<a name="l00051"></a>00051 <span class="comment"> and for communication between successive calls to `getopt'.</span>
<a name="l00052"></a>00052 <span class="comment"></span>
<a name="l00053"></a>00053 <span class="comment"> On entry to `getopt', zero means this is the first call; initialize.</span>
<a name="l00054"></a>00054 <span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment"> When `getopt' returns -1, this is the index of the first of the</span>
<a name="l00056"></a>00056 <span class="comment"> non-option elements that the caller should itself scan.</span>
<a name="l00057"></a>00057 <span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment"> Otherwise, `optind' communicates from one call to the next</span>
<a name="l00059"></a>00059 <span class="comment"> how much of ARGV has been scanned so far. */</span>
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="keyword">extern</span> <span class="keywordtype">int</span> optind;
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="comment">/* Callers store zero here to inhibit the error message `getopt' prints</span>
<a name="l00064"></a>00064 <span class="comment"> for unrecognized options. */</span>
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keyword">extern</span> <span class="keywordtype">int</span> opterr;
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="comment">/* Set to an option character which was unrecognized. */</span>
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keyword">extern</span> <span class="keywordtype">int</span> optopt;
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="preprocessor">#ifndef __need_getopt</span>
<a name="l00073"></a>00073 <span class="preprocessor"></span><span class="comment">/* Describe the long-named options requested by the application.</span>
<a name="l00074"></a>00074 <span class="comment"> The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector</span>
<a name="l00075"></a>00075 <span class="comment"> of `struct option' terminated by an element containing a name which is</span>
<a name="l00076"></a>00076 <span class="comment"> zero.</span>
<a name="l00077"></a>00077 <span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment"> The field `has_arg' is:</span>
<a name="l00079"></a>00079 <span class="comment"> no_argument (or 0) if the option does not take an argument,</span>
<a name="l00080"></a>00080 <span class="comment"> required_argument (or 1) if the option requires an argument,</span>
<a name="l00081"></a>00081 <span class="comment"> optional_argument (or 2) if the option takes an optional argument.</span>
<a name="l00082"></a>00082 <span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment"> If the field `flag' is not NULL, it points to a variable that is set</span>
<a name="l00084"></a>00084 <span class="comment"> to the value given in the field `val' when the option is found, but</span>
<a name="l00085"></a>00085 <span class="comment"> left unchanged if the option is not found.</span>
<a name="l00086"></a>00086 <span class="comment"></span>
<a name="l00087"></a>00087 <span class="comment"> To have a long-named option do something other than set an `int' to</span>
<a name="l00088"></a>00088 <span class="comment"> a compiled-in constant, such as set a value from `optarg', set the</span>
<a name="l00089"></a>00089 <span class="comment"> option's `flag' field to zero and its `val' field to a nonzero</span>
<a name="l00090"></a>00090 <span class="comment"> value (the equivalent single-letter option character, if there is</span>
<a name="l00091"></a>00091 <span class="comment"> one). For long options that have a zero `flag' field, `getopt'</span>
<a name="l00092"></a>00092 <span class="comment"> returns the contents of the `val' field. */</span>
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="keyword">struct </span><a class="code" href="structoption.html">option</a>
<a name="l00095"></a>00095 {
<a name="l00096"></a>00096 <span class="preprocessor"># if (defined __STDC__ && __STDC__) || defined __cplusplus</span>
<a name="l00097"></a>00097 <span class="preprocessor"></span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structoption.html#92c850a23c7828c1dba453bf8d15e1f0">name</a>;
<a name="l00098"></a>00098 <span class="preprocessor"># else</span>
<a name="l00099"></a><a class="code" href="structoption.html#92c850a23c7828c1dba453bf8d15e1f0">00099</a> <span class="preprocessor"></span> <span class="keywordtype">char</span> *<a class="code" href="structoption.html#92c850a23c7828c1dba453bf8d15e1f0">name</a>;
<a name="l00100"></a>00100 <span class="preprocessor"># endif</span>
<a name="l00101"></a>00101 <span class="preprocessor"></span> <span class="comment">/* has_arg can't be an enum because some compilers complain about</span>
<a name="l00102"></a>00102 <span class="comment"> type mismatches in all the code that assumes it is an int. */</span>
<a name="l00103"></a>00103 <span class="keywordtype">int</span> <a class="code" href="structoption.html#90d7ee9a51eea5c002682dbd0af149e4">has_arg</a>;
<a name="l00104"></a><a class="code" href="structoption.html#b366eea5fe7be25c1928328ba715e353">00104</a> <span class="keywordtype">int</span> *<a class="code" href="structoption.html#b366eea5fe7be25c1928328ba715e353">flag</a>;
<a name="l00105"></a>00105 <span class="keywordtype">int</span> <a class="code" href="structoption.html#13bd155ec3b405d29c41ab8d0793be11">val</a>;
<a name="l00106"></a>00106 };
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="comment">/* Names for the values of the `has_arg' field of `struct option'. */</span>
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="preprocessor"># define no_argument 0</span>
<a name="l00111"></a>00111 <span class="preprocessor"></span><span class="preprocessor"># define required_argument 1</span>
<a name="l00112"></a>00112 <span class="preprocessor"></span><span class="preprocessor"># define optional_argument 2</span>
<a name="l00113"></a>00113 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* need getopt */</span>
<a name="l00114"></a>00114
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <span class="comment">/* Get definitions and prototypes for functions to process the</span>
<a name="l00117"></a>00117 <span class="comment"> arguments in ARGV (ARGC of them, minus the program name) for</span>
<a name="l00118"></a>00118 <span class="comment"> options given in OPTS.</span>
<a name="l00119"></a>00119 <span class="comment"></span>
<a name="l00120"></a>00120 <span class="comment"> Return the option character from OPTS just read. Return -1 when</span>
<a name="l00121"></a>00121 <span class="comment"> there are no more options. For unrecognized options, or options</span>
<a name="l00122"></a>00122 <span class="comment"> missing arguments, `optopt' is set to the option letter, and '?' is</span>
<a name="l00123"></a>00123 <span class="comment"> returned.</span>
<a name="l00124"></a>00124 <span class="comment"></span>
<a name="l00125"></a>00125 <span class="comment"> The OPTS string is a list of characters which are recognized option</span>
<a name="l00126"></a>00126 <span class="comment"> letters, optionally followed by colons, specifying that that letter</span>
<a name="l00127"></a>00127 <span class="comment"> takes an argument, to be placed in `optarg'.</span>
<a name="l00128"></a>00128 <span class="comment"></span>
<a name="l00129"></a>00129 <span class="comment"> If a letter in OPTS is followed by two colons, its argument is</span>
<a name="l00130"></a>00130 <span class="comment"> optional. This behavior is specific to the GNU `getopt'.</span>
<a name="l00131"></a>00131 <span class="comment"></span>
<a name="l00132"></a>00132 <span class="comment"> The argument `--' causes premature termination of argument</span>
<a name="l00133"></a>00133 <span class="comment"> scanning, explicitly telling `getopt' that there are no more</span>
<a name="l00134"></a>00134 <span class="comment"> options.</span>
<a name="l00135"></a>00135 <span class="comment"></span>
<a name="l00136"></a>00136 <span class="comment"> If OPTS begins with `--', then non-option arguments are treated as</span>
<a name="l00137"></a>00137 <span class="comment"> arguments to the option '\0'. This behavior is specific to the GNU</span>
<a name="l00138"></a>00138 <span class="comment"> `getopt'. */</span>
<a name="l00139"></a>00139
<a name="l00140"></a>00140 <span class="preprocessor">#if (defined __STDC__ && __STDC__) || defined __cplusplus</span>
<a name="l00141"></a>00141 <span class="preprocessor"></span><span class="preprocessor"># ifdef __GNU_LIBRARY__</span>
<a name="l00142"></a>00142 <span class="preprocessor"></span><span class="comment">/* Many other libraries have conflicting prototypes for getopt, with</span>
<a name="l00143"></a>00143 <span class="comment"> differences in the consts, in stdlib.h. To avoid compilation</span>
<a name="l00144"></a>00144 <span class="comment"> errors, only prototype getopt for the GNU C library. */</span>
<a name="l00145"></a>00145 <span class="keyword">extern</span> <span class="keywordtype">int</span> getopt (<span class="keywordtype">int</span> __argc, <span class="keywordtype">char</span> *<span class="keyword">const</span> *__argv, <span class="keyword">const</span> <span class="keywordtype">char</span> *__shortopts);
<a name="l00146"></a>00146 <span class="preprocessor"># else </span><span class="comment">/* not __GNU_LIBRARY__ */</span>
<a name="l00147"></a>00147 <span class="keyword">extern</span> <span class="keywordtype">int</span> getopt ();
<a name="l00148"></a>00148 <span class="preprocessor"># endif </span><span class="comment">/* __GNU_LIBRARY__ */</span>
<a name="l00149"></a>00149
<a name="l00150"></a>00150 <span class="preprocessor"># ifndef __need_getopt</span>
<a name="l00151"></a>00151 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="keywordtype">int</span> getopt_long (<span class="keywordtype">int</span> __argc, <span class="keywordtype">char</span> *<span class="keyword">const</span> *__argv, <span class="keyword">const</span> <span class="keywordtype">char</span> *__shortopts,
<a name="l00152"></a>00152 <span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoption.html">option</a> *__longopts, <span class="keywordtype">int</span> *__longind);
<a name="l00153"></a>00153 <span class="keyword">extern</span> <span class="keywordtype">int</span> getopt_long_only (<span class="keywordtype">int</span> __argc, <span class="keywordtype">char</span> *<span class="keyword">const</span> *__argv,
<a name="l00154"></a>00154 <span class="keyword">const</span> <span class="keywordtype">char</span> *__shortopts,
<a name="l00155"></a>00155 <span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoption.html">option</a> *__longopts, <span class="keywordtype">int</span> *__longind);
<a name="l00156"></a>00156
<a name="l00157"></a>00157 <span class="comment">/* Internal only. Users should not call this directly. */</span>
<a name="l00158"></a>00158 <span class="keyword">extern</span> <span class="keywordtype">int</span> _getopt_internal (<span class="keywordtype">int</span> __argc, <span class="keywordtype">char</span> *<span class="keyword">const</span> *__argv,
<a name="l00159"></a>00159 <span class="keyword">const</span> <span class="keywordtype">char</span> *__shortopts,
<a name="l00160"></a>00160 <span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoption.html">option</a> *__longopts, <span class="keywordtype">int</span> *__longind,
<a name="l00161"></a>00161 <span class="keywordtype">int</span> __long_only);
<a name="l00162"></a>00162 <span class="preprocessor"># endif</span>
<a name="l00163"></a>00163 <span class="preprocessor"></span><span class="preprocessor">#else </span><span class="comment">/* not __STDC__ */</span>
<a name="l00164"></a>00164 <span class="keyword">extern</span> <span class="keywordtype">int</span> getopt ();
<a name="l00165"></a>00165 <span class="preprocessor"># ifndef __need_getopt</span>
<a name="l00166"></a>00166 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="keywordtype">int</span> getopt_long ();
<a name="l00167"></a>00167 <span class="keyword">extern</span> <span class="keywordtype">int</span> getopt_long_only ();
<a name="l00168"></a>00168
<a name="l00169"></a>00169 <span class="keyword">extern</span> <span class="keywordtype">int</span> _getopt_internal ();
<a name="l00170"></a>00170 <span class="preprocessor"># endif</span>
<a name="l00171"></a>00171 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* __STDC__ */</span>
<a name="l00172"></a>00172
<a name="l00173"></a>00173 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00174"></a>00174 <span class="preprocessor"></span>}
<a name="l00175"></a>00175 <span class="preprocessor">#endif</span>
<a name="l00176"></a>00176 <span class="preprocessor"></span>
<a name="l00177"></a>00177 <span class="comment">/* Make sure we later can get all the definitions and declarations. */</span>
<a name="l00178"></a>00178 <span class="preprocessor">#undef __need_getopt</span>
<a name="l00179"></a>00179 <span class="preprocessor"></span>
<a name="l00180"></a>00180 <span class="preprocessor">#endif </span><span class="comment">/* getopt.h */</span>
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Mon Nov 19 20:27:58 2007 for LibOFX by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>
|
