MentOS  0.8.0
The Mentoring Operating System
list.h
Go to the documentation of this file.
1 
6 #pragma once
7 
9 typedef struct listnode_t {
11  void *value;
13  struct listnode_t *prev;
15  struct listnode_t *next;
16 } listnode_t;
17 
19 typedef struct list_t {
21  listnode_t *head;
23  listnode_t *tail;
25  unsigned int size;
26 } list_t;
27 
29 #define listnode_foreach(it, list) \
30  for (listnode_t * (it) = (list)->head; (it) != NULL; (it) = (it)->next)
31 
34 list_t *list_create(void);
35 
39 unsigned int list_size(list_t *list);
40 
44 int list_empty(list_t *list);
45 
50 listnode_t *list_insert_front(list_t *list, void *value);
51 
56 listnode_t *list_insert_back(list_t *list, void *value);
57 
62 void *list_remove_node(list_t *list, listnode_t *node);
63 
67 void *list_remove_front(list_t *list);
68 
72 void *list_remove_back(list_t *list);
73 
78 listnode_t *list_find(list_t *list, void *value);
79 
83 void list_push_back(list_t *list, void *value);
84 
89 listnode_t *list_pop_back(list_t *list);
90 
94 void list_push_front(list_t *list, void *value);
95 
100 listnode_t *list_pop_front(list_t *list);
101 
105 void *list_peek_front(list_t *list);
106 
110 void *list_peek_back(list_t *list);
111 
114 void list_destroy(list_t *list);
115 
120 int list_get_index_of_value(list_t *list, void *value);
121 
126 listnode_t *list_get_node_by_index(list_t *list, unsigned int index);
127 
132 void *list_remove_by_index(list_t *list, unsigned int index);
133 
138 void list_merge(list_t *target, list_t *source);
list_empty
int list_empty(list_t *list)
Checks if the list is empty.
Definition: list.c:60
list_t
struct list_t list_t
Represent the list.
list_create
list_t * list_create(void)
Create a list and set head, tail to NULL, and size to 0.
Definition: list.c:48
list_insert_back
listnode_t * list_insert_back(list_t *list, void *value)
Insert a value at the back of list.
Definition: list.c:94
list_pop_front
listnode_t * list_pop_front(list_t *list)
Remove and return the head of the list.
Definition: list.c:220
list_get_index_of_value
int list_get_index_of_value(list_t *list, void *value)
Checks if the given value is contained inside the list.
Definition: list.c:265
list_merge
void list_merge(list_t *target, list_t *source)
Append source at the end of target.
Definition: list.c:329
list_find
listnode_t * list_find(list_t *list, void *value)
Searches the node of the list which points at the given value.
Definition: list.c:180
list_remove_by_index
void * list_remove_by_index(list_t *list, unsigned int index)
Removes a node from the list at the given index.
Definition: list.c:301
list_push_back
void list_push_back(list_t *list, void *value)
Insert after tail of list(same as insert back).
Definition: list.c:192
list_size
unsigned int list_size(list_t *list)
Get list size.
Definition: list.c:53
list_push_front
void list_push_front(list_t *list, void *value)
Insert before head of list(same as insert front).
Definition: list.c:235
list_peek_back
void * list_peek_back(list_t *list)
Get the value of the last element but not remove it.
Definition: list.c:254
list_get_node_by_index
listnode_t * list_get_node_by_index(list_t *list, unsigned int index)
Returns the node at the given index.
Definition: list.c:282
list_remove_front
void * list_remove_front(list_t *list)
Remove a value at the front of list.
Definition: list.c:138
list_insert_front
listnode_t * list_insert_front(list_t *list, void *value)
Insert a value at the front of list.
Definition: list.c:71
list_remove_node
void * list_remove_node(list_t *list, listnode_t *node)
Given a listnode, remove it from list.
Definition: list.c:117
list_remove_back
void * list_remove_back(list_t *list)
Remove a value at the back of list.
Definition: list.c:159
list_pop_back
listnode_t * list_pop_back(list_t *list)
Remove and return the tail of the list.
Definition: list.c:200
listnode_t
struct listnode_t listnode_t
Represent the node of a list.
list_peek_front
void * list_peek_front(list_t *list)
Get the value of the first element but not remove it.
Definition: list.c:243
list_destroy
void list_destroy(list_t *list)
Destroy a list.
Definition: list.c:313
list_t
Represent the list.
Definition: list.h:19
list_t::tail
listnode_t * tail
The last element of the list.
Definition: list.h:23
list_t::size
unsigned int size
The size of the list.
Definition: list.h:25
list_t::head
listnode_t * head
The first element of the list.
Definition: list.h:21
listnode_t
Represent the node of a list.
Definition: list.h:9
listnode_t::next
struct listnode_t * next
The next node.
Definition: list.h:15
listnode_t::value
void * value
A pointer to the value.
Definition: list.h:11
listnode_t::prev
struct listnode_t * prev
The previous node.
Definition: list.h:13
Generated by doxygen 1.9.1