list.h
Go to the documentation of this file.
1 /*!**********************************************************************
2  *
3  * @copyright Copyright (C) 2016 Siemens Aktiengesellschaft.\n
4  * All rights reserved.
5  *
6  *************************************************************************
7  *
8  * @file list.h
9  * @date Jul 20, 2016
10  * @brief List module header file.
11  *
12  * This module is used for double linked list handling.
13  *
14  ************************************************************************/
15 
16 #ifndef LIST_H_
17 #define LIST_H_
18 
19 #include "mcl/mcl_list.h"
20 
21 typedef mcl_list_node_t list_node_t;
22 typedef mcl_list_t list_t;
23 typedef mcl_list_compare_callback list_compare_callback;
24 typedef mcl_list_item_destroy_callback list_item_destroy_callback;
25 
38 E_MCL_ERROR_CODE list_initialize(list_t **list);
39 
55 E_MCL_ERROR_CODE list_add(list_t *list, void *data);
56 
71 E_MCL_ERROR_CODE list_remove(list_t *list, list_node_t *node);
72 
88 E_MCL_ERROR_CODE list_remove_with_content(list_t *list, list_node_t *node, list_item_destroy_callback callback);
89 
99 list_node_t *list_next(list_t *list);
100 
114 E_MCL_ERROR_CODE list_exist(list_t *list, const void *item_to_find, list_compare_callback compare_function, void **item);
115 
123 void list_reset(list_t *list);
124 
135 void list_destroy(list_t **list);
136 
146 void list_destroy_with_content(list_t **list, list_item_destroy_callback callback);
147 
148 #endif //LIST_H_
list_remove
E_MCL_ERROR_CODE list_remove(list_t *list, list_node_t *node)
Removes a node from the list.
Definition: list.c:214
list_initialize
E_MCL_ERROR_CODE list_initialize(list_t **list)
Initializes the list.
Definition: list.c:139
mcl_list_node_t
Definition: mcl_list.h:30
list_remove_with_content
E_MCL_ERROR_CODE list_remove_with_content(list_t *list, list_node_t *node, list_item_destroy_callback callback)
Removes a node from the list and destroys the removed item with the provided callback function...
Definition: list.c:195
list_next
list_node_t * list_next(list_t *list)
Get the next node from the list.
Definition: list.c:309
mcl_list_item_destroy_callback
void(* mcl_list_item_destroy_callback)(void **item)
Definition: mcl_list.h:66
list_compare_callback
mcl_list_compare_callback list_compare_callback
Definition: list.h:23
list_t
mcl_list_t list_t
Definition: list.h:22
E_MCL_ERROR_CODE
E_MCL_ERROR_CODE
MCL Error code definitions. Every function returning an error code uses this enum values...
Definition: mcl_common.h:137
list_destroy_with_content
void list_destroy_with_content(list_t **list, list_item_destroy_callback callback)
To destroy the list and its items with a given callback function.
Definition: list.c:373
mcl_list.h
List module interface file.
list_add
E_MCL_ERROR_CODE list_add(list_t *list, void *data)
Adds a new list item.
Definition: list.c:159
mcl_list_t
Definition: mcl_list.h:40
list_exist
E_MCL_ERROR_CODE list_exist(list_t *list, const void *item_to_find, list_compare_callback compare_function, void **item)
Searches item_to_find in the list.
Definition: list.c:346
list_destroy
void list_destroy(list_t **list)
To destroy the list.
Definition: list.c:409
mcl_list_compare_callback
E_MCL_ERROR_CODE(* mcl_list_compare_callback)(void *reference_item, const void *item_to_compare)
Definition: mcl_list.h:59
list_reset
void list_reset(list_t *list)
Reset the current node to head node.
Definition: list.c:329
list_item_destroy_callback
mcl_list_item_destroy_callback list_item_destroy_callback
Definition: list.h:24
list_node_t
mcl_list_node_t list_node_t
Definition: list.h:21