Tue, 28 Mar 2023 21:00:33 +0200
allow NULL for allocator and comparator
universe@549 | 1 | /* |
universe@549 | 2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
universe@549 | 3 | * |
universe@549 | 4 | * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved. |
universe@549 | 5 | * |
universe@549 | 6 | * Redistribution and use in source and binary forms, with or without |
universe@549 | 7 | * modification, are permitted provided that the following conditions are met: |
universe@549 | 8 | * |
universe@549 | 9 | * 1. Redistributions of source code must retain the above copyright |
universe@549 | 10 | * notice, this list of conditions and the following disclaimer. |
universe@549 | 11 | * |
universe@549 | 12 | * 2. Redistributions in binary form must reproduce the above copyright |
universe@549 | 13 | * notice, this list of conditions and the following disclaimer in the |
universe@549 | 14 | * documentation and/or other materials provided with the distribution. |
universe@549 | 15 | * |
universe@549 | 16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
universe@549 | 17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
universe@549 | 18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
universe@549 | 19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
universe@549 | 20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
universe@549 | 21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
universe@549 | 22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
universe@549 | 23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
universe@549 | 24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
universe@549 | 25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
universe@549 | 26 | * POSSIBILITY OF SUCH DAMAGE. |
universe@549 | 27 | */ |
universe@549 | 28 | /** |
universe@549 | 29 | * \file map.h |
universe@549 | 30 | * \brief Interface for map implementations. |
universe@549 | 31 | * \author Mike Becker |
universe@549 | 32 | * \author Olaf Wintermann |
universe@549 | 33 | * \version 3.0 |
universe@549 | 34 | * \copyright 2-Clause BSD License |
universe@549 | 35 | */ |
universe@549 | 36 | |
universe@549 | 37 | #ifndef UCX_MAP_H |
universe@549 | 38 | #define UCX_MAP_H |
universe@549 | 39 | |
universe@549 | 40 | #include "common.h" |
universe@549 | 41 | #include "allocator.h" |
universe@549 | 42 | #include "iterator.h" |
universe@563 | 43 | #include "hash_key.h" |
universe@549 | 44 | |
universe@549 | 45 | #ifdef __cplusplus |
universe@549 | 46 | extern "C" { |
universe@549 | 47 | #endif |
universe@549 | 48 | |
universe@668 | 49 | #ifndef CX_STORE_POINTERS |
universe@669 | 50 | /** |
universe@669 | 51 | * Special constant used for creating collections that are storing pointers. |
universe@669 | 52 | */ |
universe@668 | 53 | #define CX_STORE_POINTERS 0 |
universe@668 | 54 | #endif |
universe@668 | 55 | |
universe@549 | 56 | /** Type for the UCX map. */ |
universe@549 | 57 | typedef struct cx_map_s CxMap; |
universe@549 | 58 | |
universe@549 | 59 | /** Type for a map entry. */ |
universe@549 | 60 | typedef struct cx_map_entry_s CxMapEntry; |
universe@549 | 61 | |
universe@549 | 62 | /** Type for map class definitions. */ |
universe@549 | 63 | typedef struct cx_map_class_s cx_map_class; |
universe@549 | 64 | |
universe@549 | 65 | /** Structure for the UCX map. */ |
universe@549 | 66 | struct cx_map_s { |
universe@549 | 67 | /** The map class definition. */ |
universe@549 | 68 | cx_map_class *cl; |
universe@549 | 69 | /** An allocator that is used for the map elements. */ |
universe@549 | 70 | CxAllocator *allocator; |
universe@549 | 71 | /** The number of elements currently stored. */ |
universe@549 | 72 | size_t size; |
universe@658 | 73 | /** |
universe@658 | 74 | * The size of an element. |
universe@658 | 75 | */ |
universe@658 | 76 | size_t itemsize; |
universe@658 | 77 | /** |
universe@658 | 78 | * True, if this map shall store pointers instead |
universe@658 | 79 | * of copies of objects. |
universe@658 | 80 | */ |
universe@658 | 81 | bool store_pointers; |
universe@549 | 82 | }; |
universe@549 | 83 | |
universe@549 | 84 | /** |
universe@549 | 85 | * The class definition for arbitrary maps. |
universe@549 | 86 | */ |
universe@549 | 87 | struct cx_map_class_s { |
universe@549 | 88 | /** |
universe@549 | 89 | * Deallocates the entire memory. |
universe@549 | 90 | */ |
universe@549 | 91 | __attribute__((__nonnull__)) |
universe@549 | 92 | void (*destructor)(struct cx_map_s *map); |
universe@549 | 93 | |
universe@549 | 94 | /** |
universe@549 | 95 | * Removes all elements. |
universe@549 | 96 | */ |
universe@549 | 97 | __attribute__((__nonnull__)) |
universe@549 | 98 | void (*clear)(struct cx_map_s *map); |
universe@549 | 99 | |
universe@549 | 100 | /** |
universe@549 | 101 | * Add or overwrite an element. |
universe@549 | 102 | */ |
universe@549 | 103 | __attribute__((__nonnull__)) |
universe@549 | 104 | int (*put)( |
universe@549 | 105 | CxMap *map, |
universe@563 | 106 | CxHashKey key, |
universe@550 | 107 | void *value |
universe@549 | 108 | ); |
universe@549 | 109 | |
universe@549 | 110 | /** |
universe@549 | 111 | * Returns an element. |
universe@549 | 112 | */ |
universe@549 | 113 | __attribute__((__nonnull__, __warn_unused_result__)) |
universe@549 | 114 | void *(*get)( |
universe@549 | 115 | CxMap const *map, |
universe@563 | 116 | CxHashKey key |
universe@549 | 117 | ); |
universe@549 | 118 | |
universe@549 | 119 | /** |
universe@549 | 120 | * Removes an element. |
universe@549 | 121 | */ |
universe@659 | 122 | __attribute__((__nonnull__)) |
universe@549 | 123 | void *(*remove)( |
universe@550 | 124 | CxMap *map, |
universe@563 | 125 | CxHashKey key |
universe@549 | 126 | ); |
universe@549 | 127 | |
universe@549 | 128 | /** |
universe@549 | 129 | * Iterator over the key/value pairs. |
universe@549 | 130 | */ |
universe@549 | 131 | __attribute__((__nonnull__, __warn_unused_result__)) |
universe@630 | 132 | CxIterator (*iterator)(CxMap const *map); |
universe@549 | 133 | |
universe@549 | 134 | /** |
universe@549 | 135 | * Iterator over the keys. |
universe@549 | 136 | */ |
universe@549 | 137 | __attribute__((__nonnull__, __warn_unused_result__)) |
universe@630 | 138 | CxIterator (*iterator_keys)(CxMap const *map); |
universe@549 | 139 | |
universe@549 | 140 | /** |
universe@549 | 141 | * Iterator over the values. |
universe@549 | 142 | */ |
universe@549 | 143 | __attribute__((__nonnull__, __warn_unused_result__)) |
universe@630 | 144 | CxIterator (*iterator_values)(CxMap const *map); |
universe@630 | 145 | |
universe@630 | 146 | /** |
universe@630 | 147 | * Mutating iterator over the key/value pairs. |
universe@630 | 148 | */ |
universe@630 | 149 | __attribute__((__nonnull__, __warn_unused_result__)) |
universe@630 | 150 | CxMutIterator (*mut_iterator)(CxMap *map); |
universe@630 | 151 | |
universe@630 | 152 | /** |
universe@630 | 153 | * Mutating iterator over the keys. |
universe@630 | 154 | */ |
universe@630 | 155 | __attribute__((__nonnull__, __warn_unused_result__)) |
universe@630 | 156 | CxMutIterator (*mut_iterator_keys)(CxMap *map); |
universe@630 | 157 | |
universe@630 | 158 | /** |
universe@630 | 159 | * Mutating iterator over the values. |
universe@630 | 160 | */ |
universe@630 | 161 | __attribute__((__nonnull__, __warn_unused_result__)) |
universe@630 | 162 | CxMutIterator (*mut_iterator_values)(CxMap *map); |
universe@549 | 163 | }; |
universe@549 | 164 | |
universe@549 | 165 | /** |
universe@549 | 166 | * A map entry. |
universe@549 | 167 | */ |
universe@549 | 168 | struct cx_map_entry_s { |
universe@549 | 169 | /** |
universe@551 | 170 | * A pointer to the key. |
universe@549 | 171 | */ |
universe@563 | 172 | CxHashKey const *key; |
universe@549 | 173 | /** |
universe@551 | 174 | * A pointer to the value. |
universe@549 | 175 | */ |
universe@551 | 176 | void *value; |
universe@549 | 177 | }; |
universe@549 | 178 | |
universe@658 | 179 | /** |
universe@658 | 180 | * Advises the map to store copies of the objects (default mode of operation). |
universe@658 | 181 | * |
universe@658 | 182 | * Retrieving objects from this map will yield pointers to the copies stored |
universe@658 | 183 | * within this list. |
universe@658 | 184 | * |
universe@658 | 185 | * @param map the map |
universe@658 | 186 | * @see cxMapStorePointers() |
universe@658 | 187 | */ |
universe@658 | 188 | __attribute__((__nonnull__)) |
universe@658 | 189 | static inline void cxMapStoreObjects(CxMap *map) { |
universe@658 | 190 | map->store_pointers = false; |
universe@658 | 191 | } |
universe@658 | 192 | |
universe@658 | 193 | /** |
universe@658 | 194 | * Advises the map to only store pointers to the objects. |
universe@658 | 195 | * |
universe@658 | 196 | * Retrieving objects from this list will yield the original pointers stored. |
universe@658 | 197 | * |
universe@658 | 198 | * @note This function forcibly sets the element size to the size of a pointer. |
universe@658 | 199 | * Invoking this function on a non-empty map that already stores copies of |
universe@658 | 200 | * objects is undefined. |
universe@658 | 201 | * |
universe@658 | 202 | * @param map the map |
universe@658 | 203 | * @see cxMapStoreObjects() |
universe@658 | 204 | */ |
universe@658 | 205 | __attribute__((__nonnull__)) |
universe@658 | 206 | static inline void cxMapStorePointers(CxMap *map) { |
universe@658 | 207 | map->store_pointers = true; |
universe@658 | 208 | map->itemsize = sizeof(void *); |
universe@658 | 209 | } |
universe@658 | 210 | |
universe@549 | 211 | |
universe@549 | 212 | /** |
universe@549 | 213 | * Deallocates the memory of the specified map. |
universe@549 | 214 | * |
universe@549 | 215 | * @param map the map to be destroyed |
universe@549 | 216 | */ |
universe@549 | 217 | __attribute__((__nonnull__)) |
universe@549 | 218 | static inline void cxMapDestroy(CxMap *map) { |
universe@549 | 219 | // TODO: likely to add auto-free feature for contents in the future |
universe@549 | 220 | map->cl->destructor(map); |
universe@549 | 221 | } |
universe@549 | 222 | |
universe@549 | 223 | |
universe@549 | 224 | /** |
universe@549 | 225 | * Clears a map by removing all elements. |
universe@549 | 226 | * |
universe@549 | 227 | * @param map the map to be cleared |
universe@549 | 228 | */ |
universe@549 | 229 | __attribute__((__nonnull__)) |
universe@549 | 230 | static inline void cxMapClear(CxMap *map) { |
universe@549 | 231 | map->cl->clear(map); |
universe@549 | 232 | } |
universe@549 | 233 | |
universe@549 | 234 | /** |
universe@549 | 235 | * Puts a key/value-pair into the map. |
universe@549 | 236 | * |
universe@549 | 237 | * @param map the map |
universe@549 | 238 | * @param key the key |
universe@549 | 239 | * @param value the value |
universe@549 | 240 | * @return 0 on success, non-zero value on failure |
universe@549 | 241 | */ |
universe@549 | 242 | __attribute__((__nonnull__)) |
universe@549 | 243 | static inline int cxMapPut( |
universe@549 | 244 | CxMap *map, |
universe@563 | 245 | CxHashKey key, |
universe@550 | 246 | void *value |
universe@549 | 247 | ) { |
universe@549 | 248 | return map->cl->put(map, key, value); |
universe@549 | 249 | } |
universe@549 | 250 | |
universe@549 | 251 | /** |
universe@549 | 252 | * Retrieves a value by using a key. |
universe@549 | 253 | * |
universe@549 | 254 | * @param map the map |
universe@549 | 255 | * @param key the key |
universe@549 | 256 | * @return the value |
universe@549 | 257 | */ |
universe@549 | 258 | __attribute__((__nonnull__, __warn_unused_result__)) |
universe@553 | 259 | static inline void *cxMapGet( |
universe@549 | 260 | CxMap const *map, |
universe@563 | 261 | CxHashKey key |
universe@549 | 262 | ) { |
universe@549 | 263 | return map->cl->get(map, key); |
universe@549 | 264 | } |
universe@549 | 265 | |
universe@549 | 266 | /** |
universe@549 | 267 | * Removes a key/value-pair from the map by using the key. |
universe@549 | 268 | * |
universe@659 | 269 | * If this map is storing pointers, you should make sure that the map |
universe@659 | 270 | * is not the last location where this pointer is stored. |
universe@659 | 271 | * Otherwise, use cxMapRemoveAndGet() to retrieve the pointer while |
universe@659 | 272 | * removing it from the map. |
universe@659 | 273 | * |
universe@549 | 274 | * @param map the map |
universe@549 | 275 | * @param key the key |
universe@659 | 276 | * @see cxMapRemoveAndGet() |
universe@659 | 277 | */ |
universe@659 | 278 | __attribute__((__nonnull__)) |
universe@659 | 279 | static inline void cxMapRemove( |
universe@659 | 280 | CxMap *map, |
universe@659 | 281 | CxHashKey key |
universe@659 | 282 | ) { |
universe@659 | 283 | (void) map->cl->remove(map, key); |
universe@659 | 284 | } |
universe@659 | 285 | |
universe@659 | 286 | /** |
universe@659 | 287 | * Removes a key/value-pair from the map by using the key. |
universe@659 | 288 | * |
universe@659 | 289 | * This function should only be used when the map is storing pointers, |
universe@659 | 290 | * in order to retrieve the pointer you are about to remove. |
universe@659 | 291 | * In any other case, cxMapRemove() is sufficient. |
universe@659 | 292 | * |
universe@659 | 293 | * @param map the map |
universe@659 | 294 | * @param key the key |
universe@659 | 295 | * @return the stored pointer or \c NULL if either the key is not present |
universe@659 | 296 | * in the map or the map is not storing pointers |
universe@658 | 297 | * @see cxMapStorePointers() |
universe@549 | 298 | */ |
universe@549 | 299 | __attribute__((__nonnull__, __warn_unused_result__)) |
universe@659 | 300 | static inline void *cxMapRemoveAndGet( |
universe@549 | 301 | CxMap *map, |
universe@563 | 302 | CxHashKey key |
universe@549 | 303 | ) { |
universe@549 | 304 | return map->cl->remove(map, key); |
universe@549 | 305 | } |
universe@549 | 306 | |
universe@549 | 307 | // TODO: set-like map operations (union, intersect, difference) |
universe@549 | 308 | |
universe@549 | 309 | /** |
universe@549 | 310 | * Creates a value iterator for a map. |
universe@549 | 311 | * |
universe@549 | 312 | * \note An iterator iterates over all elements successively. Therefore the order |
universe@549 | 313 | * highly depends on the map implementation and may change arbitrarily when the contents change. |
universe@549 | 314 | * |
universe@549 | 315 | * @param map the map to create the iterator for |
universe@549 | 316 | * @return an iterator for the currently stored values |
universe@549 | 317 | */ |
universe@549 | 318 | __attribute__((__nonnull__, __warn_unused_result__)) |
universe@551 | 319 | static inline CxIterator cxMapIteratorValues(CxMap *map) { |
universe@549 | 320 | return map->cl->iterator_values(map); |
universe@549 | 321 | } |
universe@549 | 322 | |
universe@549 | 323 | /** |
universe@549 | 324 | * Creates a key iterator for a map. |
universe@549 | 325 | * |
universe@564 | 326 | * The elements of the iterator are keys of type CxHashKey. |
universe@555 | 327 | * |
universe@549 | 328 | * \note An iterator iterates over all elements successively. Therefore the order |
universe@549 | 329 | * highly depends on the map implementation and may change arbitrarily when the contents change. |
universe@549 | 330 | * |
universe@549 | 331 | * @param map the map to create the iterator for |
universe@549 | 332 | * @return an iterator for the currently stored keys |
universe@549 | 333 | */ |
universe@549 | 334 | __attribute__((__nonnull__, __warn_unused_result__)) |
universe@551 | 335 | static inline CxIterator cxMapIteratorKeys(CxMap *map) { |
universe@549 | 336 | return map->cl->iterator_keys(map); |
universe@549 | 337 | } |
universe@549 | 338 | |
universe@549 | 339 | /** |
universe@549 | 340 | * Creates an iterator for a map. |
universe@549 | 341 | * |
universe@555 | 342 | * The elements of the iterator are key/value pairs of type CxMapEntry. |
universe@549 | 343 | * |
universe@549 | 344 | * \note An iterator iterates over all elements successively. Therefore the order |
universe@549 | 345 | * highly depends on the map implementation and may change arbitrarily when the contents change. |
universe@549 | 346 | * |
universe@549 | 347 | * @param map the map to create the iterator for |
universe@555 | 348 | * @return an iterator for the currently stored entries |
universe@549 | 349 | * @see cxMapIteratorKeys() |
universe@549 | 350 | * @see cxMapIteratorValues() |
universe@549 | 351 | */ |
universe@549 | 352 | __attribute__((__nonnull__, __warn_unused_result__)) |
universe@551 | 353 | static inline CxIterator cxMapIterator(CxMap *map) { |
universe@549 | 354 | return map->cl->iterator(map); |
universe@549 | 355 | } |
universe@549 | 356 | |
universe@630 | 357 | |
universe@630 | 358 | /** |
universe@630 | 359 | * Creates a mutating iterator over the values of a map. |
universe@630 | 360 | * |
universe@630 | 361 | * \note An iterator iterates over all elements successively. Therefore the order |
universe@630 | 362 | * highly depends on the map implementation and may change arbitrarily when the contents change. |
universe@630 | 363 | * |
universe@630 | 364 | * @param map the map to create the iterator for |
universe@630 | 365 | * @return an iterator for the currently stored values |
universe@630 | 366 | */ |
universe@630 | 367 | __attribute__((__nonnull__, __warn_unused_result__)) |
universe@630 | 368 | static inline CxMutIterator cxMapMutIteratorValues(CxMap *map) { |
universe@630 | 369 | return map->cl->mut_iterator_values(map); |
universe@630 | 370 | } |
universe@630 | 371 | |
universe@630 | 372 | /** |
universe@630 | 373 | * Creates a mutating iterator over the keys of a map. |
universe@630 | 374 | * |
universe@630 | 375 | * The elements of the iterator are keys of type CxHashKey. |
universe@630 | 376 | * |
universe@630 | 377 | * \note An iterator iterates over all elements successively. Therefore the order |
universe@630 | 378 | * highly depends on the map implementation and may change arbitrarily when the contents change. |
universe@630 | 379 | * |
universe@630 | 380 | * @param map the map to create the iterator for |
universe@630 | 381 | * @return an iterator for the currently stored keys |
universe@630 | 382 | */ |
universe@630 | 383 | __attribute__((__nonnull__, __warn_unused_result__)) |
universe@630 | 384 | static inline CxMutIterator cxMapMutIteratorKeys(CxMap *map) { |
universe@630 | 385 | return map->cl->mut_iterator_keys(map); |
universe@630 | 386 | } |
universe@630 | 387 | |
universe@630 | 388 | /** |
universe@630 | 389 | * Creates a mutating iterator for a map. |
universe@630 | 390 | * |
universe@630 | 391 | * The elements of the iterator are key/value pairs of type CxMapEntry. |
universe@630 | 392 | * |
universe@630 | 393 | * \note An iterator iterates over all elements successively. Therefore the order |
universe@630 | 394 | * highly depends on the map implementation and may change arbitrarily when the contents change. |
universe@630 | 395 | * |
universe@630 | 396 | * @param map the map to create the iterator for |
universe@630 | 397 | * @return an iterator for the currently stored entries |
universe@630 | 398 | * @see cxMapMutIteratorKeys() |
universe@630 | 399 | * @see cxMapMutIteratorValues() |
universe@630 | 400 | */ |
universe@630 | 401 | __attribute__((__nonnull__, __warn_unused_result__)) |
universe@630 | 402 | static inline CxMutIterator cxMapMutIterator(CxMap *map) { |
universe@630 | 403 | return map->cl->mut_iterator(map); |
universe@630 | 404 | } |
universe@630 | 405 | |
universe@549 | 406 | #ifdef __cplusplus |
universe@549 | 407 | } |
universe@549 | 408 | #endif |
universe@549 | 409 | |
universe@549 | 410 | #endif // UCX_MAP_H |