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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
39// list item dump function type
40typedef void (*oscap_dump_func) ();
41// generic comparison function type
42typedef bool (*oscap_cmp_func) (void *, void *);
43
44/*
45 * Linear linked list.
46 */
47
49 void *data;
50 struct oscap_list_item *next;
51};
52
53struct oscap_list {
54 struct oscap_list_item *first;
55 struct oscap_list_item *last;
56 size_t itemcount;
57};
58
59// FIXME: SCE engine uses these
60
61struct oscap_list *oscap_list_new(void);
62void oscap_create_lists(struct oscap_list **first, ...);
63bool oscap_list_add(struct oscap_list *list, void *value);
64bool oscap_list_push(struct oscap_list *list, void *value);
65bool oscap_list_pop(struct oscap_list *list, oscap_destruct_func destructor);
66bool oscap_list_remove(struct oscap_list *list, void *value, oscap_cmp_func compare, oscap_destruct_func destructor);
67struct oscap_list *oscap_list_clone(const struct oscap_list * list, oscap_clone_func cloner);
68void oscap_list_free(struct oscap_list *list, oscap_destruct_func destructor);
69void oscap_list_free0(struct oscap_list *list);
70void oscap_list_dump(struct oscap_list *list, oscap_dump_func dumper, int depth);
71int oscap_list_get_itemcount(struct oscap_list *list);
72bool oscap_list_contains(struct oscap_list *list, void *what, oscap_cmp_func compare);
73struct oscap_list *oscap_list_destructive_join(struct oscap_list *list1, struct oscap_list *list2);
74
75
76
77/* Linked List iterator. */
78
79typedef bool(*oscap_filter_func) (void *, void *);
80
82 struct oscap_list_item *cur;
83 struct oscap_list *list;
84 oscap_filter_func filter;
85 void *user_data;
86};
87
88// FIXME: SCE engine uses these
89
90void *oscap_iterator_new(struct oscap_list *list);
91void *oscap_iterator_new_filter(struct oscap_list *list, oscap_filter_func filter, void *user_data);
92void *oscap_iterator_next(struct oscap_iterator *it);
93size_t oscap_iterator_get_itemcount(const struct oscap_iterator *it);
94bool oscap_iterator_has_more(struct oscap_iterator *it);
95void oscap_iterator_reset(struct oscap_iterator *it);
96void *oscap_iterator_detach(struct oscap_iterator *it);
97void oscap_iterator_free(struct oscap_iterator *it);
98
99
100void *oscap_list_find(struct oscap_list *list, void *what, oscap_cmp_func compare);
101
108#define OSCAP_FOREACH_GENERIC(itype, vtype, val, init_val, code) \
109 { \
110 struct itype##_iterator *val##_iter = (init_val); \
111 vtype val; \
112 while (itype##_iterator_has_more(val##_iter)) { \
113 val = itype##_iterator_next(val##_iter); \
114 code \
115 } \
116 itype##_iterator_free(val##_iter); \
117 }
118
127#define OSCAP_FOREACH(type, val, init_val, code) \
128 OSCAP_FOREACH_GENERIC(type, struct type *, val, init_val, code)
129
141#define OSCAP_FOR_GENERIC(itype, vtype, val, init_val) \
142 vtype val = NULL; struct itype##_iterator *val##_iter = (init_val); \
143 while (itype##_iterator_has_more(val##_iter) \
144 ? (val = itype##_iterator_next(val##_iter), true) \
145 : (itype##_iterator_free(val##_iter), val##_iter = NULL, false))
146
154#define OSCAP_FOR(type, val, init_val) OSCAP_FOR_GENERIC(type, struct type *, val, init_val)
155
162#define OSCAP_FOR_STR(val, init_val) OSCAP_FOR_GENERIC(oscap_string, const char *, val, init_val)
163
164/*
165 * Hash table
166 */
167
168// Comparison function.
169typedef int (*oscap_compare_func) (const char *, const char *);
170// Hash table item.
172 struct oscap_htable_item *next; // Next item.
173 char *key; // Item key.
174 void *value; // Item value.
175};
176
177// Hash table.
179 size_t hsize; // Size of the hash table.
180 size_t itemcount; // Number of elements in the hash table.
181 struct oscap_htable_item **table; // The table itself.
182 oscap_compare_func cmp; // Funcion used to compare keys (e.g. strcmp).
183};
184
185/*
186 * Create a new hash table.
187 * @param cmp Pointer to a function used as the key comparator.
188 * @hsize Size of the hash table.
189 * @internal
190 * @return new hash table
191 */
192struct oscap_htable *oscap_htable_new1(oscap_compare_func cmp, size_t hsize);
193
194/*
195 * Create a new hash table.
196 *
197 * The table will use strcmp() as the comparison function and will have default table size.
198 * @see oscap_htable_new1()
199 * @return new hash table
200 */
201struct oscap_htable *oscap_htable_new(void);
202
203/*
204 * Do a Deep Copy of a hashtable and all of its items
205 *
206 * @return deep copy of hash table
207 */
208struct oscap_htable * oscap_htable_clone(const struct oscap_htable * table, oscap_clone_func cloner);
209
210/*
211 * Add an item to the hash table.
212 * @return True on success, false if the key already exists.
213 */
214bool oscap_htable_add(struct oscap_htable *htable, const char *key, void *item);
215
216/*
217 * Get a hash table item.
218 * @return An item, NULL if item with specified key is not present in the hash table.
219 */
220void *oscap_htable_get(struct oscap_htable *htable, const char *key);
221
222void *oscap_htable_detach(struct oscap_htable *htable, const char *key);
223
224void oscap_htable_dump(struct oscap_htable *htable, oscap_dump_func dumper, int depth);
225
226/*
227 * Delete the hash table.
228 * @param htable Hash table to be deleted.
229 * @param destructor Function used to delete individual items.
230 */
231void oscap_htable_free(struct oscap_htable *htable, oscap_destruct_func destructor);
232/*
233 * Dispose the hash table -- do not dispose individial items.
234 * @param htable Hash table to be deleted.
235 */
236void oscap_htable_free0(struct oscap_htable *htable);
237
238
243
249struct oscap_htable_iterator *oscap_htable_iterator_new(struct oscap_htable *htable);
250
256bool oscap_htable_iterator_has_more(struct oscap_htable_iterator *hit);
257
263const struct oscap_htable_item *oscap_htable_iterator_next(struct oscap_htable_iterator *hit);
264
270const char *oscap_htable_iterator_next_key(struct oscap_htable_iterator *hit);
271
277void *oscap_htable_iterator_next_value(struct oscap_htable_iterator *hit);
278
286void oscap_htable_iterator_next_kv(struct oscap_htable_iterator *hit, const char **key, void **value);
287
292void oscap_htable_iterator_reset(struct oscap_htable_iterator *hit);
293
298void oscap_htable_iterator_free(struct oscap_htable_iterator *hit);
299
300void oscap_print_depth(int depth);
301
302
303#endif
General OpenScap functions and types.
Multilingual text processing interface.
Definition: list.h:171
Definition: list.c:548
Definition: list.h:178
Definition: list.h:81
Definition: list.h:48
Definition: list.h:53