girara
Macros | Functions
datastructures.h File Reference
#include <stddef.h>
#include <stdbool.h>
#include <sys/types.h>
#include "macros.h"
#include "types.h"

Go to the source code of this file.

Macros

#define GIRARA_LIST_FOREACH(list, type, iter, data)
 
#define GIRARA_LIST_FOREACH_END(list, type, iter, data)
 
#define GIRARA_LIST_FOREACH_BODY_WITH_ITER(list, type, iter, data, ...)
 
#define GIRARA_LIST_FOREACH_BODY(list, type, data, ...)
 

Functions

girara_list_tgirara_list_new (void) GIRARA_VISIBLE
 
girara_list_tgirara_list_new2 (girara_free_function_t gfree) GIRARA_VISIBLE
 
girara_list_tgirara_sorted_list_new (girara_compare_function_t cmp) GIRARA_VISIBLE
 
girara_list_tgirara_sorted_list_new2 (girara_compare_function_t cmp, girara_free_function_t gfree) GIRARA_VISIBLE
 
void girara_list_set_free_function (girara_list_t *list, girara_free_function_t gfree) GIRARA_VISIBLE
 
void girara_list_clear (girara_list_t *list) GIRARA_VISIBLE
 
void girara_list_free (girara_list_t *list) GIRARA_VISIBLE
 
void girara_list_append (girara_list_t *list, void *data) GIRARA_VISIBLE
 
void girara_list_prepend (girara_list_t *list, void *data) GIRARA_VISIBLE
 
void girara_list_remove (girara_list_t *list, void *data) GIRARA_VISIBLE
 
void * girara_list_nth (girara_list_t *list, size_t n) GIRARA_VISIBLE
 
bool girara_list_contains (girara_list_t *list, void *data) GIRARA_VISIBLE
 
size_t girara_list_size (girara_list_t *list) GIRARA_VISIBLE
 
ssize_t girara_list_position (girara_list_t *list, void *data) GIRARA_VISIBLE
 
void girara_list_sort (girara_list_t *list, girara_compare_function_t compare) GIRARA_VISIBLE
 
void * girara_list_find (const girara_list_t *list, girara_compare_function_t compare, const void *data) GIRARA_VISIBLE
 
girara_list_iterator_tgirara_list_iterator (girara_list_t *list) GIRARA_VISIBLE
 
girara_list_iterator_tgirara_list_iterator_copy (girara_list_iterator_t *iter) GIRARA_VISIBLE
 
girara_list_iterator_tgirara_list_iterator_next (girara_list_iterator_t *iter) GIRARA_VISIBLE
 
bool girara_list_iterator_has_next (girara_list_iterator_t *iter) GIRARA_VISIBLE
 
girara_list_iterator_tgirara_list_iterator_previous (girara_list_iterator_t *iter) GIRARA_VISIBLE
 
bool girara_list_iterator_has_previous (girara_list_iterator_t *iter) GIRARA_VISIBLE
 
void girara_list_iterator_remove (girara_list_iterator_t *iter) GIRARA_VISIBLE
 
bool girara_list_iterator_is_valid (girara_list_iterator_t *iter) GIRARA_VISIBLE
 
void * girara_list_iterator_data (girara_list_iterator_t *iter) GIRARA_VISIBLE
 
void girara_list_iterator_set (girara_list_iterator_t *iter, void *data) GIRARA_VISIBLE
 
void girara_list_iterator_free (girara_list_iterator_t *iter) GIRARA_VISIBLE
 
void girara_list_foreach (girara_list_t *list, girara_list_callback_t callback, void *data) GIRARA_VISIBLE
 
girara_list_tgirara_list_merge (girara_list_t *list, girara_list_t *other) GIRARA_VISIBLE
 
girara_tree_node_tgirara_node_new (void *data) GIRARA_VISIBLE
 
void girara_node_set_free_function (girara_tree_node_t *node, girara_free_function_t gfree) GIRARA_VISIBLE
 
void girara_node_free (girara_tree_node_t *node) GIRARA_VISIBLE
 
void girara_node_append (girara_tree_node_t *parent, girara_tree_node_t *child) GIRARA_VISIBLE
 
girara_tree_node_tgirara_node_append_data (girara_tree_node_t *parent, void *data) GIRARA_VISIBLE
 
girara_tree_node_tgirara_node_get_parent (girara_tree_node_t *node) GIRARA_VISIBLE
 
girara_tree_node_tgirara_node_get_root (girara_tree_node_t *node) GIRARA_VISIBLE
 
girara_list_tgirara_node_get_children (girara_tree_node_t *node) GIRARA_VISIBLE
 
size_t girara_node_get_num_children (girara_tree_node_t *node) GIRARA_VISIBLE
 
void * girara_node_get_data (girara_tree_node_t *node) GIRARA_VISIBLE
 
void girara_node_set_data (girara_tree_node_t *node, void *data) GIRARA_VISIBLE
 

Macro Definition Documentation

◆ GIRARA_LIST_FOREACH

#define GIRARA_LIST_FOREACH (   list,
  type,
  iter,
  data 
)
Value:
do { \
girara_list_iterator_t* iter = girara_list_iterator(list); \
type data = (type)girara_list_iterator_data(iter);
girara_list_iterator_t * girara_list_iterator(girara_list_t *list) GIRARA_VISIBLE
void * girara_list_iterator_data(girara_list_iterator_t *iter) GIRARA_VISIBLE
bool girara_list_iterator_is_valid(girara_list_iterator_t *iter) GIRARA_VISIBLE

Definition at line 244 of file datastructures.h.

◆ GIRARA_LIST_FOREACH_BODY

#define GIRARA_LIST_FOREACH_BODY (   list,
  type,
  data,
  ... 
)
Value:
GIRARA_LIST_FOREACH(list, type, girara_list_foreach_iterator, data) \
GIRARA_LIST_FOREACH_END(list, type, girara_list_foreach_iterator, data)
#define GIRARA_LIST_FOREACH_END(list, type, iter, data)
#define GIRARA_LIST_FOREACH(list, type, iter, data)

Definition at line 261 of file datastructures.h.

◆ GIRARA_LIST_FOREACH_BODY_WITH_ITER

#define GIRARA_LIST_FOREACH_BODY_WITH_ITER (   list,
  type,
  iter,
  data,
  ... 
)
Value:
GIRARA_LIST_FOREACH(list, type, iter, data) \
GIRARA_LIST_FOREACH_END(list, type, iter, data)

Definition at line 256 of file datastructures.h.

◆ GIRARA_LIST_FOREACH_END

#define GIRARA_LIST_FOREACH_END (   list,
  type,
  iter,
  data 
)
Value:
} \
girara_list_iterator_free(iter); \
} while(0)
girara_list_iterator_t * girara_list_iterator_next(girara_list_iterator_t *iter) GIRARA_VISIBLE

Definition at line 250 of file datastructures.h.

Function Documentation

◆ girara_list_append()

void girara_list_append ( girara_list_t list,
void *  data 
)

Append an element to the list.

Parameters
listThe girara list object
dataThe element

◆ girara_list_clear()

void girara_list_clear ( girara_list_t list)

Remove all elements from a list.

Parameters
listThe girara list object

◆ girara_list_contains()

bool girara_list_contains ( girara_list_t list,
void *  data 
)

Checks if the list contains the given element

Parameters
listThe girara list object
dataThe element
Returns
true if the list contains the element

◆ girara_list_find()

void * girara_list_find ( const girara_list_t list,
girara_compare_function_t  compare,
const void *  data 
)

Find an element

Parameters
listThe list
comparecompare function
datadata passed as the second argument to the compare function
Returns
the element if found or NULL

◆ girara_list_foreach()

void girara_list_foreach ( girara_list_t list,
girara_list_callback_t  callback,
void *  data 
)

Call function for each element in the list.

Parameters
listThe list
callbackThe function to call.
dataPassed to the callback as second argument.

◆ girara_list_free()

void girara_list_free ( girara_list_t list)

Destroy list.

Parameters
listThe girara list object

◆ girara_list_iterator()

girara_list_iterator_t * girara_list_iterator ( girara_list_t list)

Create an iterator pointing at the start of list.

Parameters
listThe girara list object
Returns
The list iterator or NULL if an error occurred

◆ girara_list_iterator_copy()

girara_list_iterator_t * girara_list_iterator_copy ( girara_list_iterator_t iter)

Create an iterator pointing to the same element as iter.

Parameters
iterThe girara list iterator to be copied
Returns
The list iterator or NULL if an error occurred

◆ girara_list_iterator_data()

void * girara_list_iterator_data ( girara_list_iterator_t iter)

Get data from the element pointed to by the iterator.

Parameters
iterThe list iterator
Returns
The data of the current element

◆ girara_list_iterator_free()

void girara_list_iterator_free ( girara_list_iterator_t iter)

Destroy the iterator.

Parameters
iterThe list iterator

◆ girara_list_iterator_has_next()

bool girara_list_iterator_has_next ( girara_list_iterator_t iter)

Check if iterator has next element.

Parameters
iterThe list iterator
Returns
true if iterator has a next element, false otherwise

◆ girara_list_iterator_has_previous()

bool girara_list_iterator_has_previous ( girara_list_iterator_t iter)

Check if iterator has previous element.

Parameters
iterThe list iterator
Returns
true if iterator has a previous element, false otherwise

◆ girara_list_iterator_is_valid()

bool girara_list_iterator_is_valid ( girara_list_iterator_t iter)

Check if iterator is valid

Parameters
iterThe list iterator
Returns
true if iterator is valid, false otherwise

◆ girara_list_iterator_next()

girara_list_iterator_t * girara_list_iterator_next ( girara_list_iterator_t iter)

Move iterator to next element.

Parameters
iterThe list iterator
Returns
The moved iterator or NULL if an error occurred

◆ girara_list_iterator_previous()

girara_list_iterator_t * girara_list_iterator_previous ( girara_list_iterator_t iter)

Move iterator to previous element.

Parameters
iterThe list iterator
Returns
The moved iterator or NULL if an error occurred

◆ girara_list_iterator_remove()

void girara_list_iterator_remove ( girara_list_iterator_t iter)

Remove element pointed by the iterator, and updates the iterator to the next element

Parameters
iterThe list iterator

◆ girara_list_iterator_set()

void girara_list_iterator_set ( girara_list_iterator_t iter,
void *  data 
)

Set data from the element pointed to by the iterator.

Parameters
iterThe list iterator
dataSets the list iterator to a specific element

◆ girara_list_merge()

girara_list_t * girara_list_merge ( girara_list_t list,
girara_list_t other 
)

Merge a list into another one. Both lists need to have the same free function. If other has a source free function set it will be set to NULL as the elements then belong to list.

Parameters
listthe target list
otherthe source list
Returns
list with the elements from other.

◆ girara_list_new()

girara_list_t * girara_list_new ( void  )

Create a new list.

Returns
The girara list object or NULL if an error occurred

◆ girara_list_new2()

girara_list_t * girara_list_new2 ( girara_free_function_t  gfree)

Create a new list.

Parameters
gfreePointer to the free function
Returns
The girara list object or NULL if an error occurred.

◆ girara_list_nth()

void * girara_list_nth ( girara_list_t list,
size_t  n 
)

Returns nth entry

Parameters
listThe girara list object
nIndex of the entry
Returns
The nth element or NULL if an error occurred

◆ girara_list_position()

ssize_t girara_list_position ( girara_list_t list,
void *  data 
)

Returns the position of the element in the list

Parameters
listThe girara list object
dataThe element
Returns
The position or -1 if the data is not found

◆ girara_list_prepend()

void girara_list_prepend ( girara_list_t list,
void *  data 
)

Prepend an element to the list.

Parameters
listThe girara list object
dataThe element

◆ girara_list_remove()

void girara_list_remove ( girara_list_t list,
void *  data 
)

Remove an element of the list

Parameters
listThe girara list object
dataThe element

◆ girara_list_set_free_function()

void girara_list_set_free_function ( girara_list_t list,
girara_free_function_t  gfree 
)

Set the function which should be called if the stored data should be freed.

Parameters
listThe girara list object
gfreePointer to the free function

◆ girara_list_size()

size_t girara_list_size ( girara_list_t list)

Get size of the list.

Parameters
listThe girara list object
Returns
The size of the list

◆ girara_list_sort()

void girara_list_sort ( girara_list_t list,
girara_compare_function_t  compare 
)

Sort a list

Parameters
listThe list to sort
comparecompare function

◆ girara_node_append()

void girara_node_append ( girara_tree_node_t parent,
girara_tree_node_t child 
)

Append a node to another node.

Parameters
parentThe parent node
childThe child node

◆ girara_node_append_data()

girara_tree_node_t * girara_node_append_data ( girara_tree_node_t parent,
void *  data 
)

Append data as new node to another node.

Parameters
parentThe parent node
dataThe data of the node
Returns
The node object or NULL if an error occurred

◆ girara_node_free()

void girara_node_free ( girara_tree_node_t node)

Free a node. This will remove the node from its' parent and will destroy all its' children.

Parameters
nodeThe girara node object

◆ girara_node_get_children()

girara_list_t * girara_node_get_children ( girara_tree_node_t node)

Get list of children.

Parameters
nodeThe girara node object
Returns
List object containing all child nodes or NULL if an error occurred

◆ girara_node_get_data()

void * girara_node_get_data ( girara_tree_node_t node)

Get data.

Parameters
nodeThe girara node object
Returns
The data of the node

◆ girara_node_get_num_children()

size_t girara_node_get_num_children ( girara_tree_node_t node)

Get number of children.

Parameters
nodeThe girara node object
Returns
The number of child nodes

◆ girara_node_get_parent()

girara_tree_node_t * girara_node_get_parent ( girara_tree_node_t node)

Get parent node.

Parameters
nodeThe girara node object
Returns
The parent node or NULL if an error occurred or no parent exists

◆ girara_node_get_root()

girara_tree_node_t * girara_node_get_root ( girara_tree_node_t node)

Get root node.

Parameters
nodeThe girara node object
Returns
The root node or NULL if an error occurred

◆ girara_node_new()

girara_tree_node_t * girara_node_new ( void *  data)

Create a new node.

Parameters
dataData of the new node
Returns
A girara node object or NULL if an error occurred

◆ girara_node_set_data()

void girara_node_set_data ( girara_tree_node_t node,
void *  data 
)

Set data.

Parameters
nodeThe girara node object
dataThe new data of the object

◆ girara_node_set_free_function()

void girara_node_set_free_function ( girara_tree_node_t node,
girara_free_function_t  gfree 
)

Set the function which should be called if the stored data should be freed.

Parameters
nodeThe girara node object
gfreePointer to the free function

◆ girara_sorted_list_new()

girara_list_t * girara_sorted_list_new ( girara_compare_function_t  cmp)

Create a new (sorted) list.

Parameters
cmpPointer to the compare function.
Returns
The girara list object or NULL if an error occurred.

◆ girara_sorted_list_new2()

girara_list_t * girara_sorted_list_new2 ( girara_compare_function_t  cmp,
girara_free_function_t  gfree 
)

Create a new (sorted) list.

Parameters
cmpPointer to the compare function.
gfreePointer to the free function
Returns
The girara list object or NULL if an error occurred.