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
|
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>Open SCAP Library: list.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Open SCAP Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_fdedb0aba14d44ce9d99bc100e026e6a.html">common</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">list.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright 2009 Red Hat Inc., Durham, North Carolina.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All Rights Reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * This library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * License along with this library; if not, write to the Free Software</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * Authors:</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * Lukas Kuklinek <lkuklinek@redhat.com></span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * @file</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * @internal</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * @{</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifndef OSCAP_LIST_</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"></span><span class="preprocessor">#define OSCAP_LIST_</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <stdlib.h></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <stdbool.h></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include "util.h"</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include "<a class="code" href="oscap_8h.html" title="General OpenScap functions and types.">public/oscap.h</a>"</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include "<a class="code" href="oscap__text_8h.html" title="Multilingual text processing interface.">public/oscap_text.h</a>"</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> OSCAP_HIDDEN_START;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// list item dump function type</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">typedef</span> void (*oscap_dump_func) ();</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// generic comparison function type</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">typedef</span> bool (*oscap_cmp_func) (<span class="keywordtype">void</span> *, <span class="keywordtype">void</span> *);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * Linear linked list.</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="code" href="structoscap__list__item.html"> 49</a></span> <span class="keyword">struct </span><a class="code" href="structoscap__list__item.html">oscap_list_item</a> {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">void</span> *data;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">struct </span><a class="code" href="structoscap__list__item.html">oscap_list_item</a> *next;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> };</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="code" href="structoscap__list.html"> 54</a></span> <span class="keyword">struct </span><a class="code" href="structoscap__list.html">oscap_list</a> {</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">struct </span><a class="code" href="structoscap__list__item.html">oscap_list_item</a> *first;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">struct </span><a class="code" href="structoscap__list__item.html">oscap_list_item</a> *last;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">size_t</span> itemcount;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> };</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">// FIXME: SCE engine uses these</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> OSCAP_HIDDEN_END;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">struct </span><a class="code" href="structoscap__list.html">oscap_list</a> *oscap_list_new(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keywordtype">void</span> oscap_create_lists(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> **first, ...);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keywordtype">bool</span> oscap_list_add(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list, <span class="keywordtype">void</span> *value);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keywordtype">bool</span> oscap_list_push(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list, <span class="keywordtype">void</span> *value);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keywordtype">bool</span> oscap_list_pop(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list, oscap_destruct_func destructor);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keywordtype">bool</span> oscap_list_remove(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list, <span class="keywordtype">void</span> *value, oscap_cmp_func compare, oscap_destruct_func destructor);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">struct </span><a class="code" href="structoscap__list.html">oscap_list</a> *oscap_list_clone(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> * list, oscap_clone_func cloner);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keywordtype">void</span> oscap_list_free(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list, oscap_destruct_func destructor);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keywordtype">void</span> oscap_list_free0(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keywordtype">void</span> oscap_list_dump(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list, oscap_dump_func dumper, <span class="keywordtype">int</span> depth);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">int</span> oscap_list_get_itemcount(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keywordtype">bool</span> oscap_list_contains(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list, <span class="keywordtype">void</span> *what, oscap_cmp_func compare);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">struct </span><a class="code" href="structoscap__list.html">oscap_list</a> *oscap_list_destructive_join(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list1, <span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list2);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> OSCAP_HIDDEN_START;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">/* Linked List iterator. */</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">typedef</span> bool(*oscap_filter_func) (<span class="keywordtype">void</span> *, <span class="keywordtype">void</span> *);</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a name="l00084"></a><span class="lineno"><a class="code" href="structoscap__iterator.html"> 84</a></span> <span class="keyword">struct </span><a class="code" href="structoscap__iterator.html">oscap_iterator</a> {</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">struct </span><a class="code" href="structoscap__list__item.html">oscap_list_item</a> *cur;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">struct </span><a class="code" href="structoscap__list.html">oscap_list</a> *list;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  oscap_filter_func filter;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">void</span> *user_data;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> };</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">// FIXME: SCE engine uses these</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> OSCAP_HIDDEN_END;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="keywordtype">void</span> *oscap_iterator_new(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="keywordtype">void</span> *oscap_iterator_new_filter(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list, oscap_filter_func filter, <span class="keywordtype">void</span> *user_data);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keywordtype">void</span> *oscap_iterator_next(<span class="keyword">struct</span> <a class="code" href="structoscap__iterator.html">oscap_iterator</a> *it);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="keywordtype">size_t</span> oscap_iterator_get_itemcount(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoscap__iterator.html">oscap_iterator</a> *it);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keywordtype">bool</span> oscap_iterator_has_more(<span class="keyword">struct</span> <a class="code" href="structoscap__iterator.html">oscap_iterator</a> *it);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="keywordtype">void</span> oscap_iterator_reset(<span class="keyword">struct</span> <a class="code" href="structoscap__iterator.html">oscap_iterator</a> *it);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="keywordtype">void</span> *oscap_iterator_detach(<span class="keyword">struct</span> <a class="code" href="structoscap__iterator.html">oscap_iterator</a> *it);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="keywordtype">void</span> oscap_iterator_free(<span class="keyword">struct</span> <a class="code" href="structoscap__iterator.html">oscap_iterator</a> *it);</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> OSCAP_HIDDEN_START;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="keywordtype">void</span> *oscap_list_find(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list, <span class="keywordtype">void</span> *what, oscap_cmp_func compare);</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor">#define OSCAP_FOREACH_GENERIC(itype, vtype, val, init_val, code) \</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor"> { \</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor"> struct itype##_iterator *val##_iter = (init_val); \</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor"> vtype val; \</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor"> while (itype##_iterator_has_more(val##_iter)) { \</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor"> val = itype##_iterator_next(val##_iter); \</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor"> code \</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor"> } \</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor"> itype##_iterator_free(val##_iter); \</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="preprocessor"> }</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="preprocessor">#define OSCAP_FOREACH(type, val, init_val, code) \</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor"> OSCAP_FOREACH_GENERIC(type, struct type *, val, init_val, code)</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="preprocessor">#define OSCAP_FOR_GENERIC(itype, vtype, val, init_val) \</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="preprocessor"> vtype val = NULL; struct itype##_iterator *val##_iter = (init_val); \</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="preprocessor"> while (itype##_iterator_has_more(val##_iter) \</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="preprocessor"> ? (val = itype##_iterator_next(val##_iter), true) \</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="preprocessor"> : (itype##_iterator_free(val##_iter), val##_iter = NULL, false))</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="preprocessor">#define OSCAP_FOR(type, val, init_val) OSCAP_FOR_GENERIC(type, struct type *, val, init_val)</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="preprocessor">#define OSCAP_FOR_STR(val, init_val) OSCAP_FOR_GENERIC(oscap_string, const char *, val, init_val)</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * Hash table</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment">// Comparison function.</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="keyword">typedef</span> int (*oscap_compare_func) (<span class="keyword">const</span> <span class="keywordtype">char</span> *, <span class="keyword">const</span> <span class="keywordtype">char</span> *);</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment">// Hash table item.</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"><a class="code" href="structoscap__htable__item.html"> 176</a></span> <span class="keyword">struct </span><a class="code" href="structoscap__htable__item.html">oscap_htable_item</a> {</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <span class="keyword">struct </span><a class="code" href="structoscap__htable__item.html">oscap_htable_item</a> *next; <span class="comment">// Next item.</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keywordtype">char</span> *key; <span class="comment">// Item key.</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keywordtype">void</span> *value; <span class="comment">// Item value.</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> };</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment">// Hash table.</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"><a class="code" href="structoscap__htable.html"> 183</a></span> <span class="keyword">struct </span><a class="code" href="structoscap__htable.html">oscap_htable</a> {</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keywordtype">size_t</span> hsize; <span class="comment">// Size of the hash table.</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="keywordtype">size_t</span> itemcount; <span class="comment">// Number of elements in the hash table.</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keyword">struct </span><a class="code" href="structoscap__htable__item.html">oscap_htable_item</a> **table; <span class="comment">// The table itself.</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  oscap_compare_func cmp; <span class="comment">// Funcion used to compare keys (e.g. strcmp).</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> };</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * Create a new hash table.</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> * @param cmp Pointer to a function used as the key comparator.</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> * @hsize Size of the hash table.</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> * @internal</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> * @return new hash table</span></div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="keyword">struct </span><a class="code" href="structoscap__htable.html">oscap_htable</a> *oscap_htable_new1(oscap_compare_func cmp, <span class="keywordtype">size_t</span> hsize);</div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> * Create a new hash table.</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * The table will use strcmp() as the comparison function and will have default table size.</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> * @see oscap_htable_new1()</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> * @return new hash table</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="keyword">struct </span><a class="code" href="structoscap__htable.html">oscap_htable</a> *oscap_htable_new(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> * Do a Deep Copy of a hashtable and all of its items</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> * @return deep copy of hash table</span></div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="keyword">struct </span><a class="code" href="structoscap__htable.html">oscap_htable</a> * oscap_htable_clone(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoscap__htable.html">oscap_htable</a> * table, oscap_clone_func cloner);</div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> * Add an item to the hash table.</span></div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> * @return True on success, false if the key already exists.</span></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="keywordtype">bool</span> oscap_htable_add(<span class="keyword">struct</span> <a class="code" href="structoscap__htable.html">oscap_htable</a> *htable, <span class="keyword">const</span> <span class="keywordtype">char</span> *key, <span class="keywordtype">void</span> *item);</div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> </div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> * Get a hash table item.</span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> * @return An item, NULL if item with specified key is not present in the hash table.</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="keywordtype">void</span> *oscap_htable_get(<span class="keyword">struct</span> <a class="code" href="structoscap__htable.html">oscap_htable</a> *htable, <span class="keyword">const</span> <span class="keywordtype">char</span> *key);</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> </div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="keywordtype">void</span> *oscap_htable_detach(<span class="keyword">struct</span> <a class="code" href="structoscap__htable.html">oscap_htable</a> *htable, <span class="keyword">const</span> <span class="keywordtype">char</span> *key);</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> </div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="keywordtype">void</span> oscap_htable_dump(<span class="keyword">struct</span> <a class="code" href="structoscap__htable.html">oscap_htable</a> *htable, oscap_dump_func dumper, <span class="keywordtype">int</span> depth);</div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> </div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> * Delete the hash table.</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> * @param htable Hash table to be deleted.</span></div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> * @param destructor Function used to delete individual items.</span></div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="keywordtype">void</span> oscap_htable_free(<span class="keyword">struct</span> <a class="code" href="structoscap__htable.html">oscap_htable</a> *htable, oscap_destruct_func destructor);</div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> * Dispose the hash table -- do not dispose individial items.</span></div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> * @param htable Hash table to be deleted.</span></div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="keywordtype">void</span> oscap_htable_free0(<span class="keyword">struct</span> <a class="code" href="structoscap__htable.html">oscap_htable</a> *htable);</div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> </div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> </div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="keyword">struct </span><a class="code" href="structoscap__htable__iterator.html">oscap_htable_iterator</a>;</div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> </div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="keyword">struct </span><a class="code" href="structoscap__htable__iterator.html">oscap_htable_iterator</a> *oscap_htable_iterator_new(<span class="keyword">struct</span> <a class="code" href="structoscap__htable.html">oscap_htable</a> *htable);</div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> </div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="keywordtype">bool</span> oscap_htable_iterator_has_more(<span class="keyword">struct</span> <a class="code" href="structoscap__htable__iterator.html">oscap_htable_iterator</a> *hit);</div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span> </div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="keyword">const</span> <span class="keyword">struct </span><a class="code" href="structoscap__htable__item.html">oscap_htable_item</a> *oscap_htable_iterator_next(<span class="keyword">struct</span> <a class="code" href="structoscap__htable__iterator.html">oscap_htable_iterator</a> *hit);</div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> </div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *oscap_htable_iterator_next_key(<span class="keyword">struct</span> <a class="code" href="structoscap__htable__iterator.html">oscap_htable_iterator</a> *hit);</div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> </div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="keywordtype">void</span> *oscap_htable_iterator_next_value(<span class="keyword">struct</span> <a class="code" href="structoscap__htable__iterator.html">oscap_htable_iterator</a> *hit);</div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span> </div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="keywordtype">void</span> oscap_htable_iterator_next_kv(<span class="keyword">struct</span> <a class="code" href="structoscap__htable__iterator.html">oscap_htable_iterator</a> *hit, <span class="keyword">const</span> <span class="keywordtype">char</span> **key, <span class="keywordtype">void</span> **value);</div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> </div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="keywordtype">void</span> oscap_htable_iterator_reset(<span class="keyword">struct</span> <a class="code" href="structoscap__htable__iterator.html">oscap_htable_iterator</a> *hit);</div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span> </div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="keywordtype">void</span> oscap_htable_iterator_free(<span class="keyword">struct</span> <a class="code" href="structoscap__htable__iterator.html">oscap_htable_iterator</a> *hit);</div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span> </div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="keywordtype">void</span> oscap_print_depth(<span class="keywordtype">int</span> depth);</div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span> </div>
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span> OSCAP_HIDDEN_END;</div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span> </div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
|
