libprelude2 1.0.0-11ubuntu4 / usr / share / doc / libprelude2 / html / libprelude-prelude-list.html

This file is indexed.

/usr/share/doc/libprelude2/html/libprelude-prelude-list.html is in libprelude2 1.0.0-11ubuntu4.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>prelude-list</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Prelude library Reference Manual">
<link rel="up" href="ch04.html" title="Others">
<link rel="prev" href="libprelude-prelude-async.html" title="prelude-async">
<link rel="next" href="libprelude-prelude-inttypes.html" title="prelude-inttypes">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="pt01.html" title="Part I. Using libprelude to interoperate with prelude-manager">
<link rel="part" href="pt02.html" title="Part II. Sending events with libprelude">
<link rel="chapter" href="ch01.html" title="The low level IDMEF API">
<link rel="chapter" href="ch02.html" title="The high level IDMEF API">
<link rel="part" href="pt03.html" title="Part III. Reading events from the collector">
<link rel="part" href="pt04.html" title="Part IV. Filtering operation on IDMEF messages">
<link rel="chapter" href="ch03.html" title="Utility functions">
<link rel="chapter" href="ch04.html" title="Others">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libprelude-prelude-async.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Prelude library Reference Manual</th>
<td><a accesskey="n" href="libprelude-prelude-inttypes.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libprelude-prelude-list.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#libprelude-prelude-list.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="prelude-list">
<a name="libprelude-prelude-list"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libprelude-prelude-list.top_of_page"></a>prelude-list</span></h2>
<p>prelude-list</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libprelude-prelude-list.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#define             <a class="link" href="libprelude-prelude-list.html#PRELUDE-LIST--CAPS" title="PRELUDE_LIST()">PRELUDE_LIST</a>                        (item)
                    <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t">prelude_list_t</a>;
#define             <a class="link" href="libprelude-prelude-list.html#prelude-list-entry" title="prelude_list_entry()">prelude_list_entry</a>                  (item, type, member)
#define             <a class="link" href="libprelude-prelude-list.html#prelude-list-for-each" title="prelude_list_for_each()">prelude_list_for_each</a>               (list, pos)
#define             <a class="link" href="libprelude-prelude-list.html#prelude-list-for-each-safe" title="prelude_list_for_each_safe()">prelude_list_for_each_safe</a>          (list, pos, bkp)
#define             <a class="link" href="libprelude-prelude-list.html#prelude-list-for-each-reversed" title="prelude_list_for_each_reversed()">prelude_list_for_each_reversed</a>      (list, pos)
#define             <a class="link" href="libprelude-prelude-list.html#prelude-list-for-each-reversed-safe" title="prelude_list_for_each_reversed_safe()">prelude_list_for_each_reversed_safe</a> (list, pos, bkp)
#define             <a class="link" href="libprelude-prelude-list.html#prelude-list-for-each-continue" title="prelude_list_for_each_continue()">prelude_list_for_each_continue</a>      (list, pos)
#define             <a class="link" href="libprelude-prelude-list.html#prelude-list-for-each-continue-safe" title="prelude_list_for_each_continue_safe()">prelude_list_for_each_continue_safe</a> (list, pos, bkp)
#define             <a class="link" href="libprelude-prelude-list.html#prelude-list-get-next" title="prelude_list_get_next()">prelude_list_get_next</a>               (list, pos, class, member)
#define             <a class="link" href="libprelude-prelude-list.html#prelude-list-get-next-safe" title="prelude_list_get_next_safe()">prelude_list_get_next_safe</a>          (list, pos, bkp, class, member)
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libprelude-prelude-list.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="libprelude-prelude-list.details"></a><h2>Details</h2>
<div class="refsect2" title="PRELUDE_LIST()">
<a name="PRELUDE-LIST--CAPS"></a><h3>PRELUDE_LIST()</h3>
<pre class="programlisting">#define PRELUDE_LIST(item) prelude_list_t (item) = { &amp;(item), &amp;(item) }
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="prelude_list_t">
<a name="prelude-list-t"></a><h3>prelude_list_t</h3>
<pre class="programlisting">typedef struct {
        struct prelude_list *next;
        struct prelude_list *prev;
} prelude_list_t;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="prelude_list_entry()">
<a name="prelude-list-entry"></a><h3>prelude_list_entry()</h3>
<pre class="programlisting">#define             prelude_list_entry(item, type, member)</pre>
<p>
Retrieve the entry of type <em class="parameter"><code>type</code></em> from the <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> object <em class="parameter"><code>tmp</code></em>,
using the item list member <em class="parameter"><code>member</code></em>. Returns the entry associated with <em class="parameter"><code>item</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Pointer to a <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> object to retrieve the entry from.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> Type of the entry to retrieve.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>member</code></em> :</span></p></td>
<td> List member in <em class="parameter"><code>type</code></em> used to link it to a list.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="prelude_list_for_each()">
<a name="prelude-list-for-each"></a><h3>prelude_list_for_each()</h3>
<pre class="programlisting">#define             prelude_list_for_each(list, pos)</pre>
<p>
Iterate through all <em class="parameter"><code>list</code></em> entry. <a class="link" href="libprelude-prelude-list.html#prelude-list-entry" title="prelude_list_entry()"><code class="function">prelude_list_entry()</code></a> can be used to retrieve
and entry from the <em class="parameter"><code>pos</code></em> pointer. It is not safe to call <code class="function">prelude_list_del()</code> while
iterating using this function, see <a class="link" href="libprelude-prelude-list.html#prelude-list-for-each-safe" title="prelude_list_for_each_safe()"><code class="function">prelude_list_for_each_safe()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td> Pointer to a <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> list.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pos</code></em> :</span></p></td>
<td> Pointer to a <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> object pointing to the current list member.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="prelude_list_for_each_safe()">
<a name="prelude-list-for-each-safe"></a><h3>prelude_list_for_each_safe()</h3>
<pre class="programlisting">#define             prelude_list_for_each_safe(list, pos, bkp)</pre>
<p>
Iterate through all <em class="parameter"><code>list</code></em> entry. <a class="link" href="libprelude-prelude-list.html#prelude-list-entry" title="prelude_list_entry()"><code class="function">prelude_list_entry()</code></a> can be used to retrieve
and entry from the <em class="parameter"><code>pos</code></em> pointer. Calling <code class="function">prelude_list_del()</code> while iterating the
list is safe.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td> Pointer to a <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> list.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pos</code></em> :</span></p></td>
<td> Pointer to a <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> object pointing to the current list member.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bkp</code></em> :</span></p></td>
<td> Pointer to a <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> object pointing to the next list member.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="prelude_list_for_each_reversed()">
<a name="prelude-list-for-each-reversed"></a><h3>prelude_list_for_each_reversed()</h3>
<pre class="programlisting">#define             prelude_list_for_each_reversed(list, pos)</pre>
<p>
Iterate through all <em class="parameter"><code>list</code></em> entry in reverse order. <a class="link" href="libprelude-prelude-list.html#prelude-list-entry" title="prelude_list_entry()"><code class="function">prelude_list_entry()</code></a> can be
used to retrieve and entry from the <em class="parameter"><code>pos</code></em> pointer. It is not safe to call
<code class="function">prelude_list_del()</code> while iterating using this function, see
<a class="link" href="libprelude-prelude-list.html#prelude-list-for-each-reversed-safe" title="prelude_list_for_each_reversed_safe()"><code class="function">prelude_list_for_each_reversed_safe()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td> Pointer to a <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> list.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pos</code></em> :</span></p></td>
<td> Pointer to a <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> object pointing to the current list member.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="prelude_list_for_each_reversed_safe()">
<a name="prelude-list-for-each-reversed-safe"></a><h3>prelude_list_for_each_reversed_safe()</h3>
<pre class="programlisting">#define             prelude_list_for_each_reversed_safe(list, pos, bkp)</pre>
<p>
Iterate through all <em class="parameter"><code>list</code></em> entry in reverse order. <a class="link" href="libprelude-prelude-list.html#prelude-list-entry" title="prelude_list_entry()"><code class="function">prelude_list_entry()</code></a> can be used to retrieve
and entry from the <em class="parameter"><code>pos</code></em> pointer. Calling <code class="function">prelude_list_del()</code> while iterating the
list is safe.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td> Pointer to a <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> list.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pos</code></em> :</span></p></td>
<td> Pointer to a <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> object pointing to the current list member.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bkp</code></em> :</span></p></td>
<td> Pointer to a <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> object pointing to the next list member.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="prelude_list_for_each_continue()">
<a name="prelude-list-for-each-continue"></a><h3>prelude_list_for_each_continue()</h3>
<pre class="programlisting">#define             prelude_list_for_each_continue(list, pos)</pre>
<p>
Iterate through all <em class="parameter"><code>list</code></em> entry starting from <em class="parameter"><code>pos</code></em> if it is not NULL, or from
the start of <em class="parameter"><code>list</code></em> if it is. <a class="link" href="libprelude-prelude-list.html#prelude-list-entry" title="prelude_list_entry()"><code class="function">prelude_list_entry()</code></a> can be used to retrieve
and entry from the <em class="parameter"><code>pos</code></em> pointer. Calling <code class="function">prelude_list_del()</code> while iterating the
list is not safe.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td> Pointer to a <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> list.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pos</code></em> :</span></p></td>
<td> Pointer to a <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> object pointing to the current list member.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="prelude_list_for_each_continue_safe()">
<a name="prelude-list-for-each-continue-safe"></a><h3>prelude_list_for_each_continue_safe()</h3>
<pre class="programlisting">#define             prelude_list_for_each_continue_safe(list, pos, bkp)</pre>
<p>
Iterate through all <em class="parameter"><code>list</code></em> entry starting from <em class="parameter"><code>pos</code></em> if it is not NULL, or from
the start of <em class="parameter"><code>list</code></em> if it is. <a class="link" href="libprelude-prelude-list.html#prelude-list-entry" title="prelude_list_entry()"><code class="function">prelude_list_entry()</code></a> can be used to retrieve
and entry from the <em class="parameter"><code>pos</code></em> pointer. Calling <code class="function">prelude_list_del()</code> while iterating the
list is safe.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td> Pointer to a <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> list.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pos</code></em> :</span></p></td>
<td> Pointer to a <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> object pointing to the current list member.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bkp</code></em> :</span></p></td>
<td> Pointer to a <a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> object pointing to the next list member.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="prelude_list_get_next()">
<a name="prelude-list-get-next"></a><h3>prelude_list_get_next()</h3>
<pre class="programlisting">#define             prelude_list_get_next(list, pos, class, member)</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pos</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>class</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>member</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="prelude_list_get_next_safe()">
<a name="prelude-list-get-next-safe"></a><h3>prelude_list_get_next_safe()</h3>
<pre class="programlisting">#define             prelude_list_get_next_safe(list, pos, bkp, class, member)</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pos</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bkp</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>class</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>member</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.