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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Open SCAP Library: ITER</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>ITER<br/>
<small>
[<a class="el" href="group__COMMON.html">COMMON</a>]</small>
</h1>
<p>Iterators concept.
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#gaea98dedf8ff9418609496bb11ff8c66c">OSCAP_FOREACH_GENERIC</a>(itype, vtype, val, init_val, code)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array, given an iterator. <a href="#gaea98dedf8ff9418609496bb11ff8c66c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#ga252a13d8be22bb101a8732987eb4e828">OSCAP_FOREACH</a>(type, val, init_val, code) OSCAP_FOREACH_GENERIC(type, struct type *, val, init_val, code)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array, given an iterator. <a href="#ga252a13d8be22bb101a8732987eb4e828"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#gafdd9cc9b1ae693c07dd4ff9727cfb019">OSCAP_FOREACH_STR</a>(val, init_val, code) OSCAP_FOREACH_GENERIC(oscap_string, const char *, val, init_val, code)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array of strings, given an iterator. <a href="#gafdd9cc9b1ae693c07dd4ff9727cfb019"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#gae94ba5c82c04c4119b11bbf8be56ed69">OSCAP_FOR_GENERIC</a>(itype, vtype, val, init_val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array, given an iterator. <a href="#gae94ba5c82c04c4119b11bbf8be56ed69"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#ga4531eed65f8744afef6718920525395c">OSCAP_FOR</a>(type, val, init_val) OSCAP_FOR_GENERIC(type, struct type *, val, init_val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array, given an iterator. <a href="#ga4531eed65f8744afef6718920525395c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ITER.html#ga9f9c24f232e5ad2aeeeed602b7b0008c">OSCAP_FOR_STR</a>(val, init_val) OSCAP_FOR_GENERIC(oscap_string, const char *, val, init_val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over an array of strings, given an iterator. <a href="#ga9f9c24f232e5ad2aeeeed602b7b0008c"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Iterators concept. </p>
<p>Any iterator name takes a form of <code>struct OBJECT_iterator</code>, where <code>OBJECT</code> is a name of particular datatype the iterator iterates over.</p>
<p>Each iterator type defines several manipulation functions, namely:</p>
<ul>
<li><code>OBJECT_iterator_has_more</code> - returns true if there is anything left to iterate over</li>
<li><code>OBJECT_iterator_next</code> - returns next item in the collection</li>
<li><code>OBJECT_iterator_free</code> - destroys the iterator</li>
</ul>
<p>You can also use <a class="el" href="group__ITER.html#ga252a13d8be22bb101a8732987eb4e828">OSCAP_FOREACH</a> convience macro. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga4531eed65f8744afef6718920525395c"></a><!-- doxytag: member="oscap.h::OSCAP_FOR" ref="ga4531eed65f8744afef6718920525395c" args="(type, val, init_val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OSCAP_FOR</td>
<td>(</td>
<td class="paramtype">type, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">val, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">init_val </td>
<td class="paramname"></td>
<td> ) </td>
<td> OSCAP_FOR_GENERIC(type, struct type *, val, init_val)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Iterate over an array, given an iterator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>type of array elements (w/o the struct keyword) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>name of an variable the member will be sequentially stored in </td></tr>
<tr><td valign="top"></td><td valign="top"><em>init_val</em> </td><td>initial member value (i.e. an iterator pointing to the start element) </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__ITER.html#gae94ba5c82c04c4119b11bbf8be56ed69" title="Iterate over an array, given an iterator.">OSCAP_FOR_GENERIC</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gae94ba5c82c04c4119b11bbf8be56ed69"></a><!-- doxytag: member="oscap.h::OSCAP_FOR_GENERIC" ref="gae94ba5c82c04c4119b11bbf8be56ed69" args="(itype, vtype, val, init_val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OSCAP_FOR_GENERIC</td>
<td>(</td>
<td class="paramtype">itype, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vtype, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">val, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">init_val </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">vtype val = NULL; <span class="keyword">struct </span>itype##_iterator *val##_iter = (init_val); \
<span class="keywordflow">while</span> (itype##_iterator_has_more(val##_iter) \
? (val = itype##_iterator_next(val##_iter), <span class="keyword">true</span>) \
: (itype##_iterator_free(val##_iter), val##_iter = NULL, <span class="keyword">false</span>))
</pre></div>
<p>Iterate over an array, given an iterator. </p>
<p>It is generally not safe to use break, return or goto inside the loop (iterator wouldn't be properly freed otherwise). Two variables, named VAL and VAL_iter (substitute VAL for actual macro argument) will be added to current variable scope. You can free the iterator explicitly after previous unusual escape from the loop (e.g. using break). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>name of an variable the string will be sequentially stored in </td></tr>
<tr><td valign="top"></td><td valign="top"><em>init_val</em> </td><td>initial member value (i.e. an iterator pointing to the start element) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>code to be executed for each string the iterator hits </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga9f9c24f232e5ad2aeeeed602b7b0008c"></a><!-- doxytag: member="oscap.h::OSCAP_FOR_STR" ref="ga9f9c24f232e5ad2aeeeed602b7b0008c" args="(val, init_val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OSCAP_FOR_STR</td>
<td>(</td>
<td class="paramtype">val, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">init_val </td>
<td class="paramname"></td>
<td> ) </td>
<td> OSCAP_FOR_GENERIC(oscap_string, const char *, val, init_val)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Iterate over an array of strings, given an iterator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>name of an variable the member will be sequentially stored in </td></tr>
<tr><td valign="top"></td><td valign="top"><em>init_val</em> </td><td>initial member value (i.e. an iterator pointing to the start element) </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__ITER.html#gae94ba5c82c04c4119b11bbf8be56ed69" title="Iterate over an array, given an iterator.">OSCAP_FOR_GENERIC</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga252a13d8be22bb101a8732987eb4e828"></a><!-- doxytag: member="oscap.h::OSCAP_FOREACH" ref="ga252a13d8be22bb101a8732987eb4e828" args="(type, val, init_val, code)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OSCAP_FOREACH</td>
<td>(</td>
<td class="paramtype">type, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">val, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">init_val, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">code </td>
<td class="paramname"></td>
<td> ) </td>
<td> OSCAP_FOREACH_GENERIC(type, struct type *, val, init_val, code)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Iterate over an array, given an iterator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>type of array elements (w/o the struct keyword) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>name of an variable the member will be sequentially stored in </td></tr>
<tr><td valign="top"></td><td valign="top"><em>init_val</em> </td><td>initial member value (i.e. an iterator pointing to the start element) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>code to be executed for each element the iterator hits </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__ITER.html#gaea98dedf8ff9418609496bb11ff8c66c" title="Iterate over an array, given an iterator.">OSCAP_FOREACH_GENERIC</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaea98dedf8ff9418609496bb11ff8c66c"></a><!-- doxytag: member="oscap.h::OSCAP_FOREACH_GENERIC" ref="gaea98dedf8ff9418609496bb11ff8c66c" args="(itype, vtype, val, init_val, code)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OSCAP_FOREACH_GENERIC</td>
<td>(</td>
<td class="paramtype">itype, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vtype, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">val, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">init_val, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">code </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">{ \
<span class="keyword">struct </span>itype##_iterator *val##_iter = (init_val); \
vtype val; \
<span class="keywordflow">while</span> (itype##_iterator_has_more(val##_iter)) { \
val = itype##_iterator_next(val##_iter); \
code \
} \
itype##_iterator_free(val##_iter); \
}
</pre></div>
<p>Iterate over an array, given an iterator. </p>
<p>Execute <em>code</em> for each array member stored in <em>val</em>. It is NOT safe to use return or goto inside of the <em>code</em> or iterator will not be freed properly. </p>
</div>
</div>
<a class="anchor" id="gafdd9cc9b1ae693c07dd4ff9727cfb019"></a><!-- doxytag: member="oscap.h::OSCAP_FOREACH_STR" ref="gafdd9cc9b1ae693c07dd4ff9727cfb019" args="(val, init_val, code)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OSCAP_FOREACH_STR</td>
<td>(</td>
<td class="paramtype">val, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">init_val, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">code </td>
<td class="paramname"></td>
<td> ) </td>
<td> OSCAP_FOREACH_GENERIC(oscap_string, const char *, val, init_val, code)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Iterate over an array of strings, given an iterator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>name of an variable the string will be sequentially stored in </td></tr>
<tr><td valign="top"></td><td valign="top"><em>init_val</em> </td><td>initial member value (i.e. an iterator pointing to the start element) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>code to be executed for each string the iterator hits </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__ITER.html#gaea98dedf8ff9418609496bb11ff8c66c" title="Iterate over an array, given an iterator.">OSCAP_FOREACH_GENERIC</a> </dd></dl>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 30 Jun 2010 for Open SCAP Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|
