-
Notifications
You must be signed in to change notification settings - Fork 0
/
queueC.c
224 lines (197 loc) · 6.11 KB
/
queueC.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
/**
* @file queueC.c
* @author Hidekela (rhidekela@gmail.com)
* @brief Queue manager library in C
*
* MIT LICENSE
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*
* @version 1.0
* @date 2022-06-12
*
* @copyright Copyright (c) 2022
*
*/
#include <stdio.h>
#include <stdlib.h>
#include "queueC.h"
/**
* @brief Check the existence of a queue
*
* @param queue the queue
* @return true if exist
* @return false
*/
bool queue_exist(Queue *queue)
{
return queue != NULL;
}
/**
* @brief Init the queue
*
* @param queue the queue
* @return Queue* a pointer to the queue (needed if you want to allocate the queue dynamically,
* and if it is, then you must quit the queue by queue_quit() in order to free it in the end)
*/
Queue* queue_init(Queue *queue)
{
/* Create the queue if it doesn't exist */
if(!queue_exist(queue))
{
queue = malloc(sizeof(*queue));
if(!queue_exist(queue))
exit(EXIT_FAILURE);
queue->isDynamicallyAllocated = true;
}
else
queue->isDynamicallyAllocated = false;
/* Fill the queue properties */
queue->current = NULL;
queue->last = NULL;
queue->dataManagement = false;
/* Another properties: length, etc... */
return queue;
}
/**
* @brief Check if the queue doesn't contain anything
*
* @param queue the queue
* @return true if the queue is empty
* @return false
*/
bool queue_isEmpty(Queue *queue)
{
return queue->current == NULL;
}
/**
* @brief Destroy the queue
*
* @param queue the queue
* @return Queue* NULL (needed if you allocated dynamically the queue and want
* to secure the pointer to the queue)
*/
Queue* queue_quit(Queue *queue)
{
if(!queue_exist(queue))
return NULL;
while (!queue_isEmpty(queue))
{
queue_pop(queue);
}
if(queue->isDynamicallyAllocated)
{
free(queue);
}
return NULL;
}
/**
* @brief Delete the first element of the queue. Warning! If you have used queue_createData() and
* the type of your data structure contain dynamically allocated variables, free those variables
* before using this function
*
* @param queue the queue
*/
void queue_pop(Queue *queue)
{
if(!queue_exist(queue))
return;
if(queue_isEmpty(queue))
return;
Queue_Cell *toDelete = queue->current;
/* Free the data if it should be */
if(queue->dataManagement)
free(toDelete->data);
/* Free the Queue_Cell */
queue->current = queue->current->next;
free(toDelete);
/* Secure the last Queue_Cell */
if(queue->current == NULL)
queue->last = NULL;
}
/**
* @brief Add an element in the last of the queue. The data of element must be already
* dynamically allocated (by queue_createData() or malloc()) and filled by yourself.
* Note that if you don't manage yourself the data allocation and freeing, you must use
* queue_createData() in order to tell the library to manage it (allocation and freeing).
* You can create a new function of push costumized in your need for creation of data
* (allocation), add of the data items (fill properties) and call queue_pushData() in the end.
*
* For example:
* bool queue_push(Queue *queue, int age, const char *name)
* where data is an instance of a structure containing 'age' and 'name':
* struct{int age, char name[20]}
*
* @param queue the queue
* @param data the data of the new element
* @return true if the operation succeed
* @return false
*/
bool queue_pushData(Queue *queue, void *data)
{
if(!queue_exist(queue)) // Should be warning
{
puts("Error: queue doesn't exist!\n");
exit(EXIT_FAILURE);
}
/* Create a new Queue_Cell */
Queue_Cell *newQueue_Cell = malloc(sizeof(Queue_Cell));
/* If the creation of Queue_Cell fails */
if(newQueue_Cell == NULL)
{
if(queue->dataManagement)
free(data);
return false;
}
/* Fill the properties of the Queue_Cell */
newQueue_Cell->data = data;
newQueue_Cell->next = NULL;
if(queue_isEmpty(queue))
queue->current = newQueue_Cell;
else
queue->last->next = newQueue_Cell;
queue->last = newQueue_Cell;
return true;
}
/**
* @brief Allocate (dynamically) memory spaces for a new data. Warning! If you manage yourself the allocation
* and freeing of the data, so never use this function for the concerned queue.
*
* @param queue the queue
* @param sizeofDataType the size of the data type
* @param numberofData the number of data (length of the array if it is an array, 1 otherwise)
* @return void* pointer of the new data
*/
void* queue_createData(Queue *queue, size_t sizeofDataType, unsigned int numberofData)
{
if(!queue->dataManagement)
queue->dataManagement = true;
return malloc(sizeof(sizeofDataType)*numberofData);
}
/**
* @brief Return the first element of the queue
*
* @param queue the queue
* @return void* the pointer to the first data
*/
void* queue_getFirst(Queue *queue)
{
return queue->current->data;
}