mcl_list.h
Go to the documentation of this file.
1 /*!**********************************************************************
2 *
3 * @copyright Copyright (C) 2017 Siemens Aktiengesellschaft.\n
4 * All rights reserved.
5 *
6 *************************************************************************
7 *
8 * @file mcl_list.h
9 * @date Oct 30, 2017
10 * @brief List module interface file.
11 *
12 * The list interface provides mcl_list_t data structure for linked lists
13 * and functions for list operations.
14 *
15 ************************************************************************/
16 
17 #ifndef MCL_LIST_H_
18 #define MCL_LIST_H_
19 
20 #include "mcl/mcl_common.h"
21 
22 #ifdef __cplusplus
23 extern "C"
24 {
25 #endif
26 
30  typedef struct mcl_list_node_t
31  {
32  void *data;
33  struct mcl_list_node_t *prev;
34  struct mcl_list_node_t *next;
35  } mcl_list_node_t;
36 
40  typedef struct mcl_list_t
41  {
42  mcl_list_node_t *head;
43  mcl_list_node_t *last;
44  mcl_list_node_t *current;
45  mcl_size_t count;
46  } mcl_list_t;
47 
59  typedef E_MCL_ERROR_CODE (*mcl_list_compare_callback)(void *reference_item, const void *item_to_compare);
60 
66  typedef void (*mcl_list_item_destroy_callback)(void **item);
67 
79  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_list_initialize(mcl_list_t **list);
80 
97  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_list_add(mcl_list_t *list, void *data);
98 
114  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_list_next(mcl_list_t *list, mcl_list_node_t **node);
115 
131  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_list_remove(mcl_list_t *list, mcl_list_node_t *node);
132 
148  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_list_remove_with_content(mcl_list_t *list, mcl_list_node_t *node, mcl_list_item_destroy_callback callback);
149 
164  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_list_exist(mcl_list_t *list, const void *item_to_find, mcl_list_compare_callback compare_function, void **item);
165 
173  extern MCL_EXPORT void mcl_list_reset(mcl_list_t *list);
174 
185  extern MCL_EXPORT void mcl_list_destroy(mcl_list_t **list);
186 
196  extern MCL_EXPORT void mcl_list_destroy_with_content(mcl_list_t **list, mcl_list_item_destroy_callback callback);
197 
198 #ifdef __cplusplus
199 }
200 #endif
201 
202 #endif //MCL_LIST_H_
mcl_list_remove_with_content
MCL_EXPORT E_MCL_ERROR_CODE mcl_list_remove_with_content(mcl_list_t *list, mcl_list_node_t *node, mcl_list_item_destroy_callback callback)
Removes a node from the list and destroys the removed item with the provided callback function...
Definition: list.c:81
mcl_list_initialize
MCL_EXPORT E_MCL_ERROR_CODE mcl_list_initialize(mcl_list_t **list)
Initializes a list with zero items in it.
Definition: list.c:19
MCL_EXPORT
#define MCL_EXPORT
Definition: mcl_config_setup.h:43
mcl_list_node_t
Definition: mcl_list.h:30
mcl_common.h
Common module interface header file.
mcl_list_destroy
MCL_EXPORT void mcl_list_destroy(mcl_list_t **list)
Destroys the list.
Definition: list.c:121
mcl_list_reset
MCL_EXPORT void mcl_list_reset(mcl_list_t *list)
Reset the current node to head node.
Definition: list.c:112
mcl_list_remove
MCL_EXPORT E_MCL_ERROR_CODE mcl_list_remove(mcl_list_t *list, mcl_list_node_t *node)
Removes a node from the list.
Definition: list.c:67
mcl_list_item_destroy_callback
void(* mcl_list_item_destroy_callback)(void **item)
Definition: mcl_list.h:66
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
mcl_list_node_t::next
struct mcl_list_node_t * next
Next node in the list.
Definition: mcl_list.h:34
mcl_list_t::head
mcl_list_node_t * head
Head node of the list.
Definition: mcl_list.h:42
mcl_list_exist
MCL_EXPORT E_MCL_ERROR_CODE mcl_list_exist(mcl_list_t *list, const void *item_to_find, mcl_list_compare_callback compare_function, void **item)
Searches item_to_find in the list.
Definition: list.c:96
mcl_list_add
MCL_EXPORT E_MCL_ERROR_CODE mcl_list_add(mcl_list_t *list, void *data)
Adds a new item to list.
Definition: list.c:32
mcl_list_t
Definition: mcl_list.h:40
mcl_list_node_t::prev
struct mcl_list_node_t * prev
Previous node in the list.
Definition: mcl_list.h:33
mcl_list_t::last
mcl_list_node_t * last
Last node of the list.
Definition: mcl_list.h:43
mcl_size_t
size_t mcl_size_t
Definition: mcl_common.h:38
mcl_list_next
MCL_EXPORT E_MCL_ERROR_CODE mcl_list_next(mcl_list_t *list, mcl_list_node_t **node)
Gets the next node from the list.
Definition: list.c:46
mcl_list_t::current
mcl_list_node_t * current
Current node of the list.
Definition: mcl_list.h:44
mcl_list_destroy_with_content
MCL_EXPORT void mcl_list_destroy_with_content(mcl_list_t **list, mcl_list_item_destroy_callback callback)
Destroys the list and its items with a given callback function.
Definition: list.c:130
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
mcl_list_t::count
mcl_size_t count
Node count of the list.
Definition: mcl_list.h:45
mcl_list_node_t::data
void * data
Data of the node.
Definition: mcl_list.h:32