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 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: /home/pvrabec/project/openscap/openscap-0.5.12/src/common/list.h Source File</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 class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>/home/pvrabec/project/openscap/openscap-0.5.12/src/common/list.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright 2009 Red Hat Inc., Durham, North Carolina.</span>
<a name="l00003"></a>00003 <span class="comment"> * All Rights Reserved.</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * This 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"> * This 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 this library; if not, write to the Free Software </span>
<a name="l00017"></a>00017 <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> * Authors:</span>
<a name="l00020"></a>00020 <span class="comment"> * Lukas Kuklinek <lkuklinek@redhat.com></span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="comment">/*</span>
<a name="l00024"></a>00024 <span class="comment"> * @file</span>
<a name="l00025"></a>00025 <span class="comment"> * @internal</span>
<a name="l00026"></a>00026 <span class="comment"> * @{</span>
<a name="l00027"></a>00027 <span class="comment"> */</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef OSCAP_LIST_</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define OSCAP_LIST_</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <stdlib.h></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <stdbool.h></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="preprocessor">#include "util.h"</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include "<a class="code" href="oscap_8h.html" title="General OpenScap functions and types.">public/oscap.h</a>"</span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037 OSCAP_HIDDEN_START;
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="comment">// list item dump function type</span>
<a name="l00040"></a>00040 <span class="keyword">typedef</span> void (*oscap_dump_func) ();
<a name="l00041"></a>00041 <span class="comment">// generic comparison function type</span>
<a name="l00042"></a>00042 <span class="keyword">typedef</span> bool (*oscap_cmp_func) (<span class="keywordtype">void</span> *, <span class="keywordtype">void</span> *);
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="comment">/*</span>
<a name="l00045"></a>00045 <span class="comment"> * Linear linked list.</span>
<a name="l00046"></a>00046 <span class="comment"> */</span>
<a name="l00047"></a>00047
<a name="l00048"></a><a class="code" href="structoscap__list__item.html">00048</a> <span class="keyword">struct </span><a class="code" href="structoscap__list__item.html">oscap_list_item</a> {
<a name="l00049"></a>00049 <span class="keywordtype">void</span> *data;
<a name="l00050"></a>00050 <span class="keyword">struct </span><a class="code" href="structoscap__list__item.html">oscap_list_item</a> *next;
<a name="l00051"></a>00051 };
<a name="l00052"></a>00052
<a name="l00053"></a><a class="code" href="structoscap__list.html">00053</a> <span class="keyword">struct </span><a class="code" href="structoscap__list.html">oscap_list</a> {
<a name="l00054"></a>00054 <span class="keyword">struct </span><a class="code" href="structoscap__list__item.html">oscap_list_item</a> *first;
<a name="l00055"></a>00055 <span class="keyword">struct </span><a class="code" href="structoscap__list__item.html">oscap_list_item</a> *last;
<a name="l00056"></a>00056 <span class="keywordtype">size_t</span> itemcount;
<a name="l00057"></a>00057 };
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="keyword">struct </span><a class="code" href="structoscap__list.html">oscap_list</a> *oscap_list_new(<span class="keywordtype">void</span>);
<a name="l00060"></a>00060 <span class="keywordtype">void</span> oscap_create_lists(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> **first, ...);
<a name="l00061"></a>00061 <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);
<a name="l00062"></a>00062 <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);
<a name="l00063"></a>00063 <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);
<a name="l00064"></a>00064 <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);
<a name="l00065"></a>00065 <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);
<a name="l00066"></a>00066 <span class="keywordtype">void</span> oscap_list_free0(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list);
<a name="l00067"></a>00067 <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);
<a name="l00068"></a>00068 <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);
<a name="l00069"></a>00069 <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);
<a name="l00070"></a>00070 <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);
<a name="l00071"></a>00071
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="comment">/* Linked List iterator. */</span>
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="keyword">typedef</span> bool(*oscap_filter_func) (<span class="keywordtype">void</span> *, <span class="keywordtype">void</span> *);
<a name="l00076"></a>00076
<a name="l00077"></a><a class="code" href="structoscap__iterator.html">00077</a> <span class="keyword">struct </span><a class="code" href="structoscap__iterator.html">oscap_iterator</a> {
<a name="l00078"></a>00078 <span class="keyword">struct </span><a class="code" href="structoscap__list__item.html">oscap_list_item</a> *cur;
<a name="l00079"></a>00079 <span class="keyword">struct </span><a class="code" href="structoscap__list.html">oscap_list</a> *list;
<a name="l00080"></a>00080 oscap_filter_func filter;
<a name="l00081"></a>00081 <span class="keywordtype">void</span> *user_data;
<a name="l00082"></a>00082 };
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="keywordtype">void</span> *oscap_iterator_new(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list);
<a name="l00085"></a>00085 <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);
<a name="l00086"></a>00086 <span class="keywordtype">void</span> *oscap_iterator_next(<span class="keyword">struct</span> <a class="code" href="structoscap__iterator.html">oscap_iterator</a> *it);
<a name="l00087"></a>00087 <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);
<a name="l00088"></a>00088 <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);
<a name="l00089"></a>00089 <span class="keywordtype">void</span> oscap_iterator_reset(<span class="keyword">struct</span> <a class="code" href="structoscap__iterator.html">oscap_iterator</a> *it);
<a name="l00090"></a>00090 <span class="keywordtype">void</span> *oscap_iterator_detach(<span class="keyword">struct</span> <a class="code" href="structoscap__iterator.html">oscap_iterator</a> *it);
<a name="l00091"></a>00091 <span class="keywordtype">void</span> oscap_iterator_free(<span class="keyword">struct</span> <a class="code" href="structoscap__iterator.html">oscap_iterator</a> *it);
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <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);
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="comment">/*</span>
<a name="l00096"></a>00096 <span class="comment"> * Hash table</span>
<a name="l00097"></a>00097 <span class="comment"> */</span>
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="comment">// Comparison function.</span>
<a name="l00100"></a>00100 <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> *);
<a name="l00101"></a>00101 <span class="comment">// Hash table item.</span>
<a name="l00102"></a><a class="code" href="structoscap__htable__item.html">00102</a> <span class="keyword">struct </span><a class="code" href="structoscap__htable__item.html">oscap_htable_item</a> {
<a name="l00103"></a>00103 <span class="keyword">struct </span><a class="code" href="structoscap__htable__item.html">oscap_htable_item</a> *next; <span class="comment">// Next item.</span>
<a name="l00104"></a>00104 <span class="keywordtype">char</span> *key; <span class="comment">// Item key.</span>
<a name="l00105"></a>00105 <span class="keywordtype">void</span> *value; <span class="comment">// Item value.</span>
<a name="l00106"></a>00106 };
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="comment">// Hash table.</span>
<a name="l00109"></a><a class="code" href="structoscap__htable.html">00109</a> <span class="keyword">struct </span><a class="code" href="structoscap__htable.html">oscap_htable</a> {
<a name="l00110"></a>00110 <span class="keywordtype">size_t</span> hsize; <span class="comment">// Size of the hash table.</span>
<a name="l00111"></a>00111 <span class="keywordtype">size_t</span> itemcount; <span class="comment">// Number of elements in the hash table.</span>
<a name="l00112"></a>00112 <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>
<a name="l00113"></a>00113 oscap_compare_func cmp; <span class="comment">// Funcion used to compare keys (e.g. strcmp).</span>
<a name="l00114"></a>00114 };
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <span class="comment">/*</span>
<a name="l00117"></a>00117 <span class="comment"> * Create a new hash table.</span>
<a name="l00118"></a>00118 <span class="comment"> * @param cmp Pointer to a function used as the key comparator.</span>
<a name="l00119"></a>00119 <span class="comment"> * @hsize Size of the hash table.</span>
<a name="l00120"></a>00120 <span class="comment"> * @internal</span>
<a name="l00121"></a>00121 <span class="comment"> * @return new hash table</span>
<a name="l00122"></a>00122 <span class="comment"> */</span>
<a name="l00123"></a>00123 <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);
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="comment">/*</span>
<a name="l00126"></a>00126 <span class="comment"> * Create a new hash table.</span>
<a name="l00127"></a>00127 <span class="comment"> *</span>
<a name="l00128"></a>00128 <span class="comment"> * The table will use strcmp() as the comparison function and will have default table size.</span>
<a name="l00129"></a>00129 <span class="comment"> * @see oscap_htable_new1()</span>
<a name="l00130"></a>00130 <span class="comment"> * @return new hash table</span>
<a name="l00131"></a>00131 <span class="comment"> */</span>
<a name="l00132"></a>00132 <span class="keyword">struct </span><a class="code" href="structoscap__htable.html">oscap_htable</a> *oscap_htable_new(<span class="keywordtype">void</span>);
<a name="l00133"></a>00133
<a name="l00134"></a>00134 <span class="comment">/*</span>
<a name="l00135"></a>00135 <span class="comment"> * Do a Deep Copy of a hashtable and all of its items</span>
<a name="l00136"></a>00136 <span class="comment"> *</span>
<a name="l00137"></a>00137 <span class="comment"> * @return deep copy of hash table</span>
<a name="l00138"></a>00138 <span class="comment"> */</span>
<a name="l00139"></a>00139 <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);
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <span class="comment">/*</span>
<a name="l00142"></a>00142 <span class="comment"> * Add an item to the hash table.</span>
<a name="l00143"></a>00143 <span class="comment"> * @return True on success, false if the key already exists.</span>
<a name="l00144"></a>00144 <span class="comment"> */</span>
<a name="l00145"></a>00145 <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);
<a name="l00146"></a>00146
<a name="l00147"></a>00147 <span class="comment">/*</span>
<a name="l00148"></a>00148 <span class="comment"> * Get a hash table item.</span>
<a name="l00149"></a>00149 <span class="comment"> * @return An item, NULL if item with specified key is not present in the hash table.</span>
<a name="l00150"></a>00150 <span class="comment"> */</span>
<a name="l00151"></a>00151 <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);
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <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);
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <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);
<a name="l00156"></a>00156
<a name="l00157"></a>00157 <span class="comment">/*</span>
<a name="l00158"></a>00158 <span class="comment"> * Delete the hash table.</span>
<a name="l00159"></a>00159 <span class="comment"> * @param htable Hash table to be deleted.</span>
<a name="l00160"></a>00160 <span class="comment"> * @param destructor Function used to delete individual items.</span>
<a name="l00161"></a>00161 <span class="comment"> */</span>
<a name="l00162"></a>00162 <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);
<a name="l00163"></a>00163
<a name="l00164"></a>00164 <span class="keywordtype">void</span> oscap_print_depth(<span class="keywordtype">int</span> depth);
<a name="l00165"></a>00165
<a name="l00166"></a>00166 OSCAP_HIDDEN_END;
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <span class="preprocessor">#endif</span>
</pre></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>
|
