-
Notifications
You must be signed in to change notification settings - Fork 525
/
zlist.c
315 lines (253 loc) · 7.63 KB
/
zlist.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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
/* =========================================================================
zlist - singly-linked list container
-------------------------------------------------------------------------
Copyright (c) 1991-2011 iMatix Corporation <www.imatix.com>
Copyright other contributors as noted in the AUTHORS file.
This file is part of libzapi, the high-level C binding for 0MQ:
http://libzapi.zeromq.org.
This is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 3 of the License, or (at
your option) any later version.
This software is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this program. If not, see
<http://www.gnu.org/licenses/>.
=========================================================================
*/
/*
@header
Provides a generic container implementing a fast singly-linked list. You
can use this to construct multi-dimensional lists, and other structures
together with other generic containers like zhash.
@discuss
@end
*/
#include "../include/zapi_prelude.h"
#include "../include/zlist.h"
// List node, used internally only
struct node_t {
struct node_t
*next;
void
*item;
};
// Actual list object
struct _zlist {
struct node_t
*head, *tail;
struct node_t
*cursor;
size_t
size;
};
// --------------------------------------------------------------------------
// List constructor
zlist_t *
zlist_new (void)
{
zlist_t *self = (zlist_t *) zmalloc (sizeof (zlist_t));
return self;
}
// --------------------------------------------------------------------------
// List destructor
void
zlist_destroy (zlist_t **self_p)
{
assert (self_p);
if (*self_p) {
zlist_t *self = *self_p;
struct node_t *node, *next;
for (node = (*self_p)->head; node != NULL; node = next) {
next = node->next;
free (node);
}
free (self);
*self_p = NULL;
}
}
// --------------------------------------------------------------------------
// Return the item at the head of list. If the list is empty, returns NULL.
// Leaves cursor pointing at the head item, or NULL if the list is empty.
void *
zlist_first (zlist_t *self)
{
assert (self);
self->cursor = self->head;
if (self->cursor)
return self->cursor->item;
else
return NULL;
}
// --------------------------------------------------------------------------
// Return the next item. If the list is empty, returns NULL. To move to
// the start of the list call zlist_first(). Advances the cursor.
void *
zlist_next (zlist_t *self)
{
assert (self);
if (self->cursor)
self->cursor = self->cursor->next;
else
self->cursor = self->head;
if (self->cursor)
return self->cursor->item;
else
return NULL;
}
// --------------------------------------------------------------------------
// Add item to the end of the list
void
zlist_append (zlist_t *self, void *item)
{
struct node_t *node;
node = (struct node_t *) zmalloc (sizeof (struct node_t));
node->item = item;
if (self->tail)
self->tail->next = node;
else
self->head = node;
self->tail = node;
node->next = NULL;
self->size++;
self->cursor = NULL;
}
// --------------------------------------------------------------------------
// Insert item at the beginning of the list
void
zlist_push (zlist_t *self, void *item)
{
struct node_t *node;
node = (struct node_t *) zmalloc (sizeof (struct node_t));
node->item = item;
node->next = self->head;
self->head = node;
if (self->tail == NULL)
self->tail = node;
self->size++;
self->cursor = NULL;
}
// --------------------------------------------------------------------------
// Remove item from the beginning of the list, returns NULL if none
void *
zlist_pop (zlist_t *self)
{
struct node_t *node = self->head;
void *item = NULL;
if (node) {
item = node->item;
self->head = node->next;
if (self->tail == node)
self->tail = NULL;
free (node);
self->size--;
}
self->cursor = NULL;
return item;
}
// --------------------------------------------------------------------------
// Remove the item from the list, if present. Safe to call on items that
// are not in the list.
void
zlist_remove (zlist_t *self, void *item)
{
struct node_t *node, *prev = NULL;
// First off, we need to find the list node.
for (node = self->head; node != NULL; node = node->next) {
if (node->item == item)
break;
prev = node;
}
if (node) {
if (prev)
prev->next = node->next;
else
self->head = node->next;
if (node->next == NULL)
self->tail = prev;
free (node);
self->size--;
self->cursor = NULL;
}
}
// --------------------------------------------------------------------------
// Make copy of itself
zlist_t *
zlist_copy (zlist_t *self)
{
if (!self)
return NULL;
zlist_t *copy = zlist_new ();
assert (copy);
struct node_t *node;
for (node = self->head; node; node = node->next)
zlist_append (copy, node->item);
return copy;
}
// --------------------------------------------------------------------------
// Return the number of items in the list
size_t
zlist_size (zlist_t *self)
{
return self->size;
}
// --------------------------------------------------------------------------
// Runs selftest of class
void
zlist_test (int verbose)
{
printf (" * zlist: ");
// @selftest
zlist_t *list = zlist_new ();
assert (list);
assert (zlist_size (list) == 0);
// Three items we'll use as test data
// List items are void *, not particularly strings
char *cheese = "boursin";
char *bread = "baguette";
char *wine = "bordeaux";
zlist_append (list, cheese);
assert (zlist_size (list) == 1);
zlist_append (list, bread);
assert (zlist_size (list) == 2);
zlist_append (list, wine);
assert (zlist_size (list) == 3);
assert (zlist_first (list) == cheese);
assert (zlist_next (list) == bread);
assert (zlist_next (list) == wine);
assert (zlist_size (list) == 3);
zlist_remove (list, wine);
assert (zlist_size (list) == 2);
assert (zlist_first (list) == cheese);
zlist_remove (list, cheese);
assert (zlist_size (list) == 1);
assert (zlist_first (list) == bread);
zlist_remove (list, bread);
assert (zlist_size (list) == 0);
zlist_push (list, cheese);
assert (zlist_size (list) == 1);
assert (zlist_first (list) == cheese);
zlist_push (list, bread);
assert (zlist_size (list) == 2);
assert (zlist_first (list) == bread);
zlist_append (list, wine);
assert (zlist_size (list) == 3);
assert (zlist_first (list) == bread);
char *item;
item = (char *) zlist_pop (list);
assert (item == bread);
item = (char *) zlist_pop (list);
assert (item == cheese);
item = (char *) zlist_pop (list);
assert (item == wine);
assert (zlist_size (list) == 0);
// Destructor should be safe to call twice
zlist_destroy (&list);
zlist_destroy (&list);
assert (list == NULL);
// @end
printf ("OK\n");
}