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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libprelude-prelude-list">
<refmeta>
<refentrytitle id="top_of_page">prelude-list</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBPRELUDE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>prelude-list</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>
<synopsis>
#define <link linkend="PRELUDE-LIST:CAPS">PRELUDE_LIST</link> (item)
<link linkend="prelude-list-t">prelude_list_t</link>;
#define <link linkend="prelude-list-entry">prelude_list_entry</link> (item, type, member)
#define <link linkend="prelude-list-for-each">prelude_list_for_each</link> (list, pos)
#define <link linkend="prelude-list-for-each-safe">prelude_list_for_each_safe</link> (list, pos, bkp)
#define <link linkend="prelude-list-for-each-reversed">prelude_list_for_each_reversed</link> (list, pos)
#define <link linkend="prelude-list-for-each-reversed-safe">prelude_list_for_each_reversed_safe</link>(list, pos, bkp)
#define <link linkend="prelude-list-for-each-continue">prelude_list_for_each_continue</link> (list, pos)
#define <link linkend="prelude-list-for-each-continue-safe">prelude_list_for_each_continue_safe</link>(list, pos, bkp)
#define <link linkend="prelude-list-get-next">prelude_list_get_next</link> (list, pos, class, member)
#define <link linkend="prelude-list-get-next-safe">prelude_list_get_next_safe</link> (list, pos, bkp, class, member)
</synopsis>
</refsynopsisdiv>
<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="PRELUDE-LIST:CAPS" role="macro"/>PRELUDE_LIST()</title>
<indexterm><primary>PRELUDE_LIST</primary></indexterm><programlisting>#define PRELUDE_LIST(item) prelude_list_t (item) = { &(item), &(item) }
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>item</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-list-t" role="struct"/>prelude_list_t</title>
<indexterm><primary>prelude_list_t</primary></indexterm><programlisting>typedef struct {
struct prelude_list *next;
struct prelude_list *prev;
} prelude_list_t;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="prelude-list-entry" role="macro"/>prelude_list_entry()</title>
<indexterm><primary>prelude_list_entry</primary></indexterm><programlisting>#define prelude_list_entry(item, type, member)</programlisting>
<para>
Retrieve the entry of type <parameter>type</parameter> from the <link linkend="prelude-list-t"><type>prelude_list_t</type></link> object <parameter>tmp</parameter>,
using the item list member <parameter>member</parameter>. Returns the entry associated with <parameter>item</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>item</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-list-t"><type>prelude_list_t</type></link> object to retrieve the entry from.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> Type of the entry to retrieve.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member</parameter> :</term>
<listitem><simpara> List member in <parameter>type</parameter> used to link it to a list.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-list-for-each" role="macro"/>prelude_list_for_each()</title>
<indexterm><primary>prelude_list_for_each</primary></indexterm><programlisting>#define prelude_list_for_each(list, pos)</programlisting>
<para>
Iterate through all <parameter>list</parameter> entry. <link linkend="prelude-list-entry"><function>prelude_list_entry()</function></link> can be used to retrieve
and entry from the <parameter>pos</parameter> pointer. It is not safe to call <link linkend="prelude-list-del"><function>prelude_list_del()</function></link> while
iterating using this function, see <link linkend="prelude-list-for-each-safe"><function>prelude_list_for_each_safe()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-list-t"><type>prelude_list_t</type></link> list.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pos</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-list-t"><type>prelude_list_t</type></link> object pointing to the current list member.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-list-for-each-safe" role="macro"/>prelude_list_for_each_safe()</title>
<indexterm><primary>prelude_list_for_each_safe</primary></indexterm><programlisting>#define prelude_list_for_each_safe(list, pos, bkp)</programlisting>
<para>
Iterate through all <parameter>list</parameter> entry. <link linkend="prelude-list-entry"><function>prelude_list_entry()</function></link> can be used to retrieve
and entry from the <parameter>pos</parameter> pointer. Calling <link linkend="prelude-list-del"><function>prelude_list_del()</function></link> while iterating the
list is safe.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-list-t"><type>prelude_list_t</type></link> list.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pos</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-list-t"><type>prelude_list_t</type></link> object pointing to the current list member.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>bkp</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-list-t"><type>prelude_list_t</type></link> object pointing to the next list member.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-list-for-each-reversed" role="macro"/>prelude_list_for_each_reversed()</title>
<indexterm><primary>prelude_list_for_each_reversed</primary></indexterm><programlisting>#define prelude_list_for_each_reversed(list, pos)</programlisting>
<para>
Iterate through all <parameter>list</parameter> entry in reverse order. <link linkend="prelude-list-entry"><function>prelude_list_entry()</function></link> can be
used to retrieve and entry from the <parameter>pos</parameter> pointer. It is not safe to call
<link linkend="prelude-list-del"><function>prelude_list_del()</function></link> while iterating using this function, see
<link linkend="prelude-list-for-each-reversed-safe"><function>prelude_list_for_each_reversed_safe()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-list-t"><type>prelude_list_t</type></link> list.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pos</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-list-t"><type>prelude_list_t</type></link> object pointing to the current list member.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-list-for-each-reversed-safe" role="macro"/>prelude_list_for_each_reversed_safe()</title>
<indexterm><primary>prelude_list_for_each_reversed_safe</primary></indexterm><programlisting>#define prelude_list_for_each_reversed_safe(list, pos, bkp)</programlisting>
<para>
Iterate through all <parameter>list</parameter> entry in reverse order. <link linkend="prelude-list-entry"><function>prelude_list_entry()</function></link> can be used to retrieve
and entry from the <parameter>pos</parameter> pointer. Calling <link linkend="prelude-list-del"><function>prelude_list_del()</function></link> while iterating the
list is safe.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-list-t"><type>prelude_list_t</type></link> list.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pos</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-list-t"><type>prelude_list_t</type></link> object pointing to the current list member.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>bkp</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-list-t"><type>prelude_list_t</type></link> object pointing to the next list member.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-list-for-each-continue" role="macro"/>prelude_list_for_each_continue()</title>
<indexterm><primary>prelude_list_for_each_continue</primary></indexterm><programlisting>#define prelude_list_for_each_continue(list, pos)</programlisting>
<para>
Iterate through all <parameter>list</parameter> entry starting from <parameter>pos</parameter> if it is not NULL, or from
the start of <parameter>list</parameter> if it is. <link linkend="prelude-list-entry"><function>prelude_list_entry()</function></link> can be used to retrieve
and entry from the <parameter>pos</parameter> pointer. Calling <link linkend="prelude-list-del"><function>prelude_list_del()</function></link> while iterating the
list is not safe.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-list-t"><type>prelude_list_t</type></link> list.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pos</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-list-t"><type>prelude_list_t</type></link> object pointing to the current list member.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-list-for-each-continue-safe" role="macro"/>prelude_list_for_each_continue_safe()</title>
<indexterm><primary>prelude_list_for_each_continue_safe</primary></indexterm><programlisting>#define prelude_list_for_each_continue_safe(list, pos, bkp)</programlisting>
<para>
Iterate through all <parameter>list</parameter> entry starting from <parameter>pos</parameter> if it is not NULL, or from
the start of <parameter>list</parameter> if it is. <link linkend="prelude-list-entry"><function>prelude_list_entry()</function></link> can be used to retrieve
and entry from the <parameter>pos</parameter> pointer. Calling <link linkend="prelude-list-del"><function>prelude_list_del()</function></link> while iterating the
list is safe.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-list-t"><type>prelude_list_t</type></link> list.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pos</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-list-t"><type>prelude_list_t</type></link> object pointing to the current list member.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>bkp</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-list-t"><type>prelude_list_t</type></link> object pointing to the next list member.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-list-get-next" role="macro"/>prelude_list_get_next()</title>
<indexterm><primary>prelude_list_get_next</primary></indexterm><programlisting>#define prelude_list_get_next(list, pos, class, member)</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pos</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>class</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-list-get-next-safe" role="macro"/>prelude_list_get_next_safe()</title>
<indexterm><primary>prelude_list_get_next_safe</primary></indexterm><programlisting>#define prelude_list_get_next_safe(list, pos, bkp, class, member)</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pos</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>bkp</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>class</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
