girara
datastructures.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: Zlib */
2 
3 #ifndef GIRARA_DATASTRUCTURES_H
4 #define GIRARA_DATASTRUCTURES_H
5 
6 #include <stddef.h>
7 #include <stdbool.h>
8 #include <sys/types.h>
9 #include "macros.h"
10 #include "types.h"
11 
18 
26 
34 
45 
54 
61 
68 
75 void girara_list_append(girara_list_t* list, void* data) GIRARA_VISIBLE;
76 
83 void girara_list_prepend(girara_list_t* list, void* data) GIRARA_VISIBLE;
84 
91 void girara_list_remove(girara_list_t* list, void* data) GIRARA_VISIBLE;
92 
100 void* girara_list_nth(girara_list_t* list, size_t n) GIRARA_VISIBLE;
101 
109 bool girara_list_contains(girara_list_t* list, void* data) GIRARA_VISIBLE;
110 
118 
126 ssize_t girara_list_position(girara_list_t* list, void* data) GIRARA_VISIBLE;
127 
135 
144 void* girara_list_find(const girara_list_t* list, girara_compare_function_t compare,
145  const void* data) GIRARA_VISIBLE;
146 
154 
162 
170 
178 
186 
194 
202 
210 
218 
226 
233 
242  void* data) GIRARA_VISIBLE;
243 
244 #define GIRARA_LIST_FOREACH(list, type, iter, data) \
245  do { \
246  girara_list_iterator_t* iter = girara_list_iterator(list); \
247  while (girara_list_iterator_is_valid(iter)) { \
248  type data = (type)girara_list_iterator_data(iter);
249 
250 #define GIRARA_LIST_FOREACH_END(list, type, iter, data) \
251  girara_list_iterator_next(iter); \
252  } \
253  girara_list_iterator_free(iter); \
254  } while(0)
255 
256 #define GIRARA_LIST_FOREACH_BODY_WITH_ITER(list, type, iter, data, ...) \
257  GIRARA_LIST_FOREACH(list, type, iter, data) \
258  __VA_ARGS__ \
259  GIRARA_LIST_FOREACH_END(list, type, iter, data)
260 
261 #define GIRARA_LIST_FOREACH_BODY(list, type, data, ...) \
262  GIRARA_LIST_FOREACH(list, type, girara_list_foreach_iterator, data) \
263  __VA_ARGS__ \
264  GIRARA_LIST_FOREACH_END(list, type, girara_list_foreach_iterator, data)
265 
275 
283 
292 
300 
308 
317  void* data) GIRARA_VISIBLE;
318 
326 
334 
342 
350 
358 
366 
367 #endif
girara_node_append_data
girara_tree_node_t * girara_node_append_data(girara_tree_node_t *parent, void *data) GIRARA_VISIBLE
girara_list_iterator_previous
girara_list_iterator_t * girara_list_iterator_previous(girara_list_iterator_t *iter) GIRARA_VISIBLE
girara_compare_function_t
int(* girara_compare_function_t)(const void *data1, const void *data2)
Definition: types.h:123
girara_list_set_free_function
void girara_list_set_free_function(girara_list_t *list, girara_free_function_t gfree) GIRARA_VISIBLE
girara_node_free
void girara_node_free(girara_tree_node_t *node) GIRARA_VISIBLE
GIRARA_VISIBLE
#define GIRARA_VISIBLE
Definition: macros.h:54
girara_list_free
void girara_list_free(girara_list_t *list) GIRARA_VISIBLE
types.h
girara_list_size
size_t girara_list_size(girara_list_t *list) GIRARA_VISIBLE
girara_list_iterator_free
void girara_list_iterator_free(girara_list_iterator_t *iter) GIRARA_VISIBLE
girara_tree_node_t
struct girara_tree_node_s girara_tree_node_t
Definition: types.h:9
girara_list_clear
void girara_list_clear(girara_list_t *list) GIRARA_VISIBLE
girara_list_iterator_has_previous
bool girara_list_iterator_has_previous(girara_list_iterator_t *iter) GIRARA_VISIBLE
girara_list_remove
void girara_list_remove(girara_list_t *list, void *data) GIRARA_VISIBLE
macros.h
girara_node_set_data
void girara_node_set_data(girara_tree_node_t *node, void *data) GIRARA_VISIBLE
girara_node_new
girara_tree_node_t * girara_node_new(void *data) GIRARA_VISIBLE
girara_node_set_free_function
void girara_node_set_free_function(girara_tree_node_t *node, girara_free_function_t gfree) GIRARA_VISIBLE
girara_sorted_list_new2
girara_list_t * girara_sorted_list_new2(girara_compare_function_t cmp, girara_free_function_t gfree) GIRARA_VISIBLE
girara_list_nth
void * girara_list_nth(girara_list_t *list, size_t n) GIRARA_VISIBLE
girara_sorted_list_new
girara_list_t * girara_sorted_list_new(girara_compare_function_t cmp) GIRARA_VISIBLE
girara_list_callback_t
void(* girara_list_callback_t)(void *data, void *userdata)
Definition: types.h:115
girara_list_position
ssize_t girara_list_position(girara_list_t *list, void *data) GIRARA_VISIBLE
girara_list_iterator_copy
girara_list_iterator_t * girara_list_iterator_copy(girara_list_iterator_t *iter) GIRARA_VISIBLE
girara_list_find
void * girara_list_find(const girara_list_t *list, girara_compare_function_t compare, const void *data) GIRARA_VISIBLE
girara_list_iterator_has_next
bool girara_list_iterator_has_next(girara_list_iterator_t *iter) GIRARA_VISIBLE
girara_list_new2
girara_list_t * girara_list_new2(girara_free_function_t gfree) GIRARA_VISIBLE
girara_list_iterator_remove
void girara_list_iterator_remove(girara_list_iterator_t *iter) GIRARA_VISIBLE
girara_list_sort
void girara_list_sort(girara_list_t *list, girara_compare_function_t compare) GIRARA_VISIBLE
girara_list_append
void girara_list_append(girara_list_t *list, void *data) GIRARA_VISIBLE
girara_node_get_children
girara_list_t * girara_node_get_children(girara_tree_node_t *node) GIRARA_VISIBLE
girara_node_get_data
void * girara_node_get_data(girara_tree_node_t *node) GIRARA_VISIBLE
girara_list_merge
girara_list_t * girara_list_merge(girara_list_t *list, girara_list_t *other) GIRARA_VISIBLE
girara_list_foreach
void girara_list_foreach(girara_list_t *list, girara_list_callback_t callback, void *data) GIRARA_VISIBLE
girara_list_iterator_is_valid
bool girara_list_iterator_is_valid(girara_list_iterator_t *iter) GIRARA_VISIBLE
girara_node_get_root
girara_tree_node_t * girara_node_get_root(girara_tree_node_t *node) GIRARA_VISIBLE
girara_list_new
girara_list_t * girara_list_new(void) GIRARA_VISIBLE
girara_list_iterator_next
girara_list_iterator_t * girara_list_iterator_next(girara_list_iterator_t *iter) GIRARA_VISIBLE
girara_list_iterator_t
struct girara_list_iterator_s girara_list_iterator_t
Definition: types.h:11
girara_list_t
struct girara_list_s girara_list_t
Definition: types.h:10
girara_free_function_t
void(* girara_free_function_t)(void *data)
Definition: types.h:107
girara_list_iterator_data
void * girara_list_iterator_data(girara_list_iterator_t *iter) GIRARA_VISIBLE
girara_list_prepend
void girara_list_prepend(girara_list_t *list, void *data) GIRARA_VISIBLE
girara_list_contains
bool girara_list_contains(girara_list_t *list, void *data) GIRARA_VISIBLE
girara_list_iterator
girara_list_iterator_t * girara_list_iterator(girara_list_t *list) GIRARA_VISIBLE
girara_node_get_parent
girara_tree_node_t * girara_node_get_parent(girara_tree_node_t *node) GIRARA_VISIBLE
girara_node_get_num_children
size_t girara_node_get_num_children(girara_tree_node_t *node) GIRARA_VISIBLE
girara_list_iterator_set
void girara_list_iterator_set(girara_list_iterator_t *iter, void *data) GIRARA_VISIBLE
girara_node_append
void girara_node_append(girara_tree_node_t *parent, girara_tree_node_t *child) GIRARA_VISIBLE