source: mainline/uspace/lib/c/include/adt/int_map.h@ 736a330

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 736a330 was 70ce016, checked in by Jakub Jermar <jakub@…>, 15 years ago

Cstyle fixes of int map.
  • Property mode set to 100644
File size: 6.8 KB
Line 
1/*
2 * Copyright (c) 2009 Lukas Mejdrech
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup libc
30 * @{
31 */
32
33/** @file
34 * Integer to generic type map.
35 */
36
37#ifndef LIBC_INT_MAP_H_
38#define LIBC_INT_MAP_H_
39
40#include <errno.h>
41#include <malloc.h>
42#include <mem.h>
43#include <unistd.h>
44
45/** Internal magic value for a map consistency check. */
46#define INT_MAP_MAGIC_VALUE 0x11223344
47
48/** Internal magic value for an item consistency check. */
49#define INT_MAP_ITEM_MAGIC_VALUE 0x55667788
50
51/** Integer to generic type map declaration.
52 *
53 * @param[in] name Name of the map.
54 * @param[in] type Inner object type.
55 */
56#define INT_MAP_DECLARE(name, type) \
57 typedef struct name name##_t; \
58 typedef name##_t *name##_ref; \
59 typedef struct name##_item name##_item_t; \
60 typedef name##_item_t *name##_item_ref; \
61 \
62 struct name##_item { \
63 int key; \
64 type *value; \
65 int magic; \
66 }; \
67 \
68 struct name { \
69 int size; \
70 int next; \
71 name##_item_ref items; \
72 int magic; \
73 }; \
74 \
75 int name##_add(name##_ref, int, type *); \
76 void name##_clear(name##_ref); \
77 int name##_count(name##_ref); \
78 void name##_destroy(name##_ref); \
79 void name##_exclude(name##_ref, int); \
80 void name##_exclude_index(name##_ref, int); \
81 type *name##_find(name##_ref, int); \
82 int name##_update(name##_ref, int, int); \
83 type *name##_get_index(name##_ref, int); \
84 int name##_initialize(name##_ref); \
85 int name##_is_valid(name##_ref); \
86 void name##_item_destroy(name##_item_ref); \
87 int name##_item_is_valid(name##_item_ref);
88
89/** Integer to generic type map implementation.
90 *
91 * Should follow declaration with the same parameters.
92 *
93 * @param[in] name Name of the map.
94 * @param[in] type Inner object type.
95 */
96#define INT_MAP_IMPLEMENT(name, type) \
97 int name##_add(name##_ref map, int key, type *value) \
98 { \
99 if (name##_is_valid(map)) { \
100 if (map->next == (map->size - 1)) { \
101 name##_item_ref tmp; \
102 tmp = (name##_item_ref) realloc(map->items, \
103 sizeof(name##_item_t) * 2 * map->size); \
104 if (!tmp) \
105 return ENOMEM; \
106 map->size *= 2; \
107 map->items = tmp; \
108 } \
109 map->items[map->next].key = key; \
110 map->items[map->next].value = value; \
111 map->items[map->next].magic = INT_MAP_ITEM_MAGIC_VALUE; \
112 ++map->next; \
113 map->items[map->next].magic = 0; \
114 return map->next - 1; \
115 } \
116 return EINVAL; \
117 } \
118 \
119 void name##_clear(name##_ref map) \
120 { \
121 if (name##_is_valid(map)) { \
122 int index; \
123 for (index = 0; index < map->next; ++index) { \
124 if (name##_item_is_valid(&map->items[index])) { \
125 name##_item_destroy( \
126 &map->items[index]); \
127 } \
128 } \
129 map->next = 0; \
130 map->items[map->next].magic = 0; \
131 } \
132 } \
133 \
134 int name##_count(name##_ref map) \
135 { \
136 return name##_is_valid(map) ? map->next : -1; \
137 } \
138 \
139 void name##_destroy(name##_ref map) \
140 { \
141 if (name##_is_valid(map)) { \
142 int index; \
143 map->magic = 0; \
144 for (index = 0; index < map->next; ++index) { \
145 if (name##_item_is_valid(&map->items[index])) { \
146 name##_item_destroy( \
147 &map->items[index]); \
148 } \
149 } \
150 free(map->items); \
151 } \
152 } \
153 \
154 void name##_exclude(name##_ref map, int key) \
155 { \
156 if (name##_is_valid(map)) { \
157 int index; \
158 for (index = 0; index < map->next; ++index) { \
159 if (name##_item_is_valid(&map->items[index]) && \
160 (map->items[index].key == key)) { \
161 name##_item_destroy( \
162 &map->items[index]); \
163 } \
164 } \
165 } \
166 } \
167 \
168 void name##_exclude_index(name##_ref map, int index) \
169 { \
170 if (name##_is_valid(map) && (index >= 0) && \
171 (index < map->next) && \
172 name##_item_is_valid(&map->items[index])) { \
173 name##_item_destroy(&map->items[index]); \
174 } \
175 } \
176 \
177 type *name##_find(name##_ref map, int key) \
178 { \
179 if (name##_is_valid(map)) { \
180 int index; \
181 for (index = 0; index < map->next; ++index) { \
182 if (name##_item_is_valid(&map->items[index]) && \
183 (map->items[index].key == key)) { \
184 return map->items[index].value; \
185 } \
186 } \
187 } \
188 return NULL; \
189 } \
190 \
191 int name##_update(name##_ref map, int key, int new_key) \
192 { \
193 if (name##_is_valid(map)) { \
194 int index; \
195 for (index = 0; index < map->next; ++index) { \
196 if (name##_item_is_valid(&map->items[index])) { \
197 if (map->items[index].key == new_key) \
198 return EEXIST; \
199 if (map->items[index].key == key) { \
200 map->items[index].key = \
201 new_key; \
202 return EOK; \
203 } \
204 } \
205 } \
206 } \
207 return ENOENT; \
208 } \
209 \
210 type *name##_get_index(name##_ref map, int index) \
211 { \
212 if (name##_is_valid(map) && (index >= 0) && \
213 (index < map->next) && \
214 name##_item_is_valid(&map->items[index])) { \
215 return map->items[index].value; \
216 } \
217 return NULL; \
218 } \
219 \
220 int name##_initialize(name##_ref map) \
221 { \
222 if (!map) \
223 return EINVAL; \
224 map->size = 2; \
225 map->next = 0; \
226 map->items = (name##_item_ref) malloc(sizeof(name##_item_t) * \
227 map->size); \
228 if (!map->items) \
229 return ENOMEM; \
230 map->items[map->next].magic = 0; \
231 map->magic = INT_MAP_MAGIC_VALUE; \
232 return EOK; \
233 } \
234 \
235 int name##_is_valid(name##_ref map) \
236 { \
237 return map && (map->magic == INT_MAP_MAGIC_VALUE); \
238 } \
239 \
240 void name##_item_destroy(name##_item_ref item) \
241 { \
242 if (name##_item_is_valid(item)) { \
243 item->magic = 0; \
244 if (item->value) { \
245 free(item->value); \
246 item->value = NULL; \
247 } \
248 } \
249 } \
250 \
251 int name##_item_is_valid(name##_item_ref item) \
252 { \
253 return item && (item->magic == INT_MAP_ITEM_MAGIC_VALUE); \
254 }
255
256#endif
257
258/** @}
259 */
260
Note: See TracBrowser for help on using the repository browser.