Open SCAP Library
list.h
1 /*
2  * Copyright 2009 Red Hat Inc., Durham, North Carolina.
3  * All Rights Reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Authors:
20  * Lukas Kuklinek <lkuklinek@redhat.com>
21  */
22 
23 /*
24  * @file
25  * @internal
26  * @{
27  */
28 #ifndef OSCAP_LIST_
29 #define OSCAP_LIST_
30 
31 #include <stdlib.h>
32 #include <stdbool.h>
33 
34 #include "util.h"
35 #include "public/oscap.h"
36 #include "public/oscap_text.h"
37 
38 OSCAP_HIDDEN_START;
39 
40 // list item dump function type
41 typedef void (*oscap_dump_func) ();
42 // generic comparison function type
43 typedef bool (*oscap_cmp_func) (void *, void *);
44 
45 /*
46  * Linear linked list.
47  */
48 
50  void *data;
51  struct oscap_list_item *next;
52 };
53 
54 struct oscap_list {
55  struct oscap_list_item *first;
56  struct oscap_list_item *last;
57  size_t itemcount;
58 };
59 
60 struct oscap_list *oscap_list_new(void);
61 void oscap_create_lists(struct oscap_list **first, ...);
62 bool oscap_list_add(struct oscap_list *list, void *value);
63 bool oscap_list_push(struct oscap_list *list, void *value);
64 bool oscap_list_pop(struct oscap_list *list, oscap_destruct_func destructor);
65 struct oscap_list *oscap_list_clone(const struct oscap_list * list, oscap_clone_func cloner);
66 void oscap_list_free(struct oscap_list *list, oscap_destruct_func destructor);
67 void oscap_list_free0(struct oscap_list *list);
68 void oscap_list_dump(struct oscap_list *list, oscap_dump_func dumper, int depth);
69 int oscap_list_get_itemcount(struct oscap_list *list);
70 bool oscap_list_contains(struct oscap_list *list, void *what, oscap_cmp_func compare);
71 struct oscap_list *oscap_list_destructive_join(struct oscap_list *list1, struct oscap_list *list2);
72 
73 
74 /* Linked List iterator. */
75 
76 typedef bool(*oscap_filter_func) (void *, void *);
77 
79  struct oscap_list_item *cur;
80  struct oscap_list *list;
81  oscap_filter_func filter;
82  void *user_data;
83 };
84 
85 void *oscap_iterator_new(struct oscap_list *list);
86 void *oscap_iterator_new_filter(struct oscap_list *list, oscap_filter_func filter, void *user_data);
87 void *oscap_iterator_next(struct oscap_iterator *it);
88 size_t oscap_iterator_get_itemcount(const struct oscap_iterator *it);
89 bool oscap_iterator_has_more(struct oscap_iterator *it);
90 void oscap_iterator_reset(struct oscap_iterator *it);
91 void *oscap_iterator_detach(struct oscap_iterator *it);
92 void oscap_iterator_free(struct oscap_iterator *it);
93 
94 void *oscap_list_find(struct oscap_list *list, void *what, oscap_cmp_func compare);
95 
102 #define OSCAP_FOREACH_GENERIC(itype, vtype, val, init_val, code) \
103  { \
104  struct itype##_iterator *val##_iter = (init_val); \
105  vtype val; \
106  while (itype##_iterator_has_more(val##_iter)) { \
107  val = itype##_iterator_next(val##_iter); \
108  code \
109  } \
110  itype##_iterator_free(val##_iter); \
111  }
112 
121 #define OSCAP_FOREACH(type, val, init_val, code) \
122  OSCAP_FOREACH_GENERIC(type, struct type *, val, init_val, code)
123 
135 #define OSCAP_FOR_GENERIC(itype, vtype, val, init_val) \
136  vtype val = NULL; struct itype##_iterator *val##_iter = (init_val); \
137  while (itype##_iterator_has_more(val##_iter) \
138  ? (val = itype##_iterator_next(val##_iter), true) \
139  : (itype##_iterator_free(val##_iter), val##_iter = NULL, false))
140 
148 #define OSCAP_FOR(type, val, init_val) OSCAP_FOR_GENERIC(type, struct type *, val, init_val)
149 
156 #define OSCAP_FOR_STR(val, init_val) OSCAP_FOR_GENERIC(oscap_string, const char *, val, init_val)
157 
158 /*
159  * Hash table
160  */
161 
162 // Comparison function.
163 typedef int (*oscap_compare_func) (const char *, const char *);
164 // Hash table item.
166  struct oscap_htable_item *next; // Next item.
167  char *key; // Item key.
168  void *value; // Item value.
169 };
170 
171 // Hash table.
172 struct oscap_htable {
173  size_t hsize; // Size of the hash table.
174  size_t itemcount; // Number of elements in the hash table.
175  struct oscap_htable_item **table; // The table itself.
176  oscap_compare_func cmp; // Funcion used to compare keys (e.g. strcmp).
177 };
178 
179 /*
180  * Create a new hash table.
181  * @param cmp Pointer to a function used as the key comparator.
182  * @hsize Size of the hash table.
183  * @internal
184  * @return new hash table
185  */
186 struct oscap_htable *oscap_htable_new1(oscap_compare_func cmp, size_t hsize);
187 
188 /*
189  * Create a new hash table.
190  *
191  * The table will use strcmp() as the comparison function and will have default table size.
192  * @see oscap_htable_new1()
193  * @return new hash table
194  */
195 struct oscap_htable *oscap_htable_new(void);
196 
197 /*
198  * Do a Deep Copy of a hashtable and all of its items
199  *
200  * @return deep copy of hash table
201  */
202 struct oscap_htable * oscap_htable_clone(const struct oscap_htable * table, oscap_clone_func cloner);
203 
204 /*
205  * Add an item to the hash table.
206  * @return True on success, false if the key already exists.
207  */
208 bool oscap_htable_add(struct oscap_htable *htable, const char *key, void *item);
209 
210 /*
211  * Get a hash table item.
212  * @return An item, NULL if item with specified key is not present in the hash table.
213  */
214 void *oscap_htable_get(struct oscap_htable *htable, const char *key);
215 
216 void *oscap_htable_detach(struct oscap_htable *htable, const char *key);
217 
218 void oscap_htable_dump(struct oscap_htable *htable, oscap_dump_func dumper, int depth);
219 
220 /*
221  * Delete the hash table.
222  * @param htable Hash table to be deleted.
223  * @param destructor Function used to delete individual items.
224  */
225 void oscap_htable_free(struct oscap_htable *htable, oscap_destruct_func destructor);
226 /*
227  * Dispose the hash table -- do not dispose individial items.
228  * @param htable Hash table to be deleted.
229  */
230 void oscap_htable_free0(struct oscap_htable *htable);
231 
232 
236 struct oscap_htable_iterator;
237 
243 struct oscap_htable_iterator *oscap_htable_iterator_new(struct oscap_htable *htable);
244 
250 bool oscap_htable_iterator_has_more(struct oscap_htable_iterator *hit);
251 
257 const struct oscap_htable_item *oscap_htable_iterator_next(struct oscap_htable_iterator *hit);
258 
264 const char *oscap_htable_iterator_next_key(struct oscap_htable_iterator *hit);
265 
271 void *oscap_htable_iterator_next_value(struct oscap_htable_iterator *hit);
272 
280 void oscap_htable_iterator_next_kv(struct oscap_htable_iterator *hit, const char **key, void **value);
281 
286 void oscap_htable_iterator_reset(struct oscap_htable_iterator *hit);
287 
292 void oscap_htable_iterator_free(struct oscap_htable_iterator *hit);
293 
294 void oscap_print_depth(int depth);
295 
296 OSCAP_HIDDEN_END;
297 
298 #endif