|
11
|
1 /* |
|
|
2 * lists.h -- function to manipulate linked lists |
|
|
3 * |
|
|
4 * Copyright (c) 2011, David Demelier <markand@malikania.fr> |
|
|
5 * |
|
|
6 * Permission to use, copy, modify, and/or distribute this software for any |
|
|
7 * purpose with or without fee is hereby granted, provided that the above |
|
|
8 * copyright notice and this permission notice appear in all copies. |
|
|
9 * |
|
|
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
|
|
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
|
|
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
|
|
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
|
|
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
|
|
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
|
|
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|
|
17 */ |
|
|
18 |
|
|
19 #ifndef _LISTS_H_ |
|
|
20 #define _LISTS_H_ |
|
|
21 |
|
|
22 /* |
|
|
23 * Available function for single linked lists : |
|
|
24 * |
|
|
25 * <prefix> refers to the prefix argument given to the LIST_IMPLEMENTS macro. |
|
|
26 * all function will use this prefix to determine the correct function. |
|
|
27 * |
|
|
28 * <type> refers to the data type used as template. |
|
|
29 * |
|
|
30 * o void slist_<prefix>_init(struct slist *sls); |
|
|
31 * Initialize the `ls' list structure. |
|
|
32 * |
|
|
33 * o void slist_<prefix>_push(struct slist *sls, <type> *var) |
|
|
34 * Add the `var' to the beginning of the list, if the list is empty |
|
|
35 * the tail also refers to the head. |
|
|
36 * |
|
|
37 * o void slist_<prefix>_pop(struct slist *sls) |
|
|
38 * Remove the first element from the list. |
|
|
39 * |
|
|
40 * o void slist_<prefix>_after(struct slist *sls, <type> *after, <type> *var) |
|
|
41 * Insert after the object referenced by `after'. |
|
|
42 * |
|
|
43 * o void slist_<prefix>_remove(struct slist *sls, <type> *var) |
|
|
44 * Remove the var element from the list. |
|
|
45 * |
|
|
46 * o <type> *slist_<prefix>_head(const struct slist *sls) |
|
|
47 * Returns the first list element. |
|
|
48 */ |
|
|
49 |
|
|
50 struct slist { |
|
|
51 int length; |
|
|
52 void *head; |
|
|
53 }; |
|
|
54 |
|
|
55 /* |
|
|
56 * This declare prototype function, to prevent reimplementing function |
|
|
57 * that already exists somewhere. |
|
|
58 */ |
|
|
59 |
|
|
60 #define SLIST_HEADER(attr, prefix, type) \ |
|
|
61 attr void slist_##prefix##_init(struct slist *); \ |
|
|
62 attr void slist_##prefix##_push(struct slist *, type *); \ |
|
|
63 attr void slist_##prefix##_pop(struct slist *); \ |
|
|
64 attr void slist_##prefix##_after(struct slist *, type *, type *); \ |
|
|
65 attr void slist_##prefix##_remove(struct slist *, type *); \ |
|
|
66 attr type *slist_##prefix##_head(const struct slist *); |
|
|
67 |
|
|
68 /* |
|
|
69 * Generate available function with the specified prefix. Name argument |
|
|
70 * is the next pointer entry in the `type' structure used to go through |
|
|
71 * the list. |
|
|
72 */ |
|
|
73 |
|
|
74 #define SLIST_IMPLEMENTS(attr, prefix, type, field) \ |
|
|
75 attr void \ |
|
|
76 slist_##prefix##_init(struct slist *sls) \ |
|
|
77 { \ |
|
|
78 sls->length = 0; \ |
|
|
79 sls->head = NULL; \ |
|
|
80 } \ |
|
|
81 \ |
|
|
82 attr void \ |
|
|
83 slist_##prefix##_push(struct slist *sls, type *var) \ |
|
|
84 { \ |
|
|
85 var->field = sls->head; \ |
|
|
86 sls->head = var; \ |
|
|
87 sls->length++; \ |
|
|
88 } \ |
|
|
89 \ |
|
|
90 attr void \ |
|
|
91 slist_##prefix##_pop(struct slist *sls) \ |
|
|
92 { \ |
|
|
93 if (sls->head) { \ |
|
|
94 sls->head = ((type *)sls->head)->field; \ |
|
|
95 sls->length--; \ |
|
|
96 } \ |
|
|
97 } \ |
|
|
98 \ |
|
|
99 attr void \ |
|
|
100 slist_##prefix##_after(struct slist *sls, type *after, type *var) \ |
|
|
101 { \ |
|
|
102 var->field = after->field; \ |
|
|
103 after->field = var; \ |
|
|
104 sls->length++; \ |
|
|
105 } \ |
|
|
106 \ |
|
|
107 attr type * \ |
|
|
108 slist_##prefix##_head(const struct slist *sls) \ |
|
|
109 { \ |
|
|
110 return (type *) sls->head; \ |
|
|
111 } |
|
|
112 |
|
|
113 #define SLIST_FOREACH(list, entry, field) \ |
|
|
114 for (entry = (list)->head; \ |
|
|
115 entry; \ |
|
|
116 entry = entry->field) |
|
|
117 |
|
|
118 #endif /* _LISTS_H_ */ |
