Sun, 06 Oct 2024 19:02:32 +0200
add functions to start iteration in a subtree
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
1 | /* |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
3 | * |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
4 | * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
5 | * |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
6 | * Redistribution and use in source and binary forms, with or without |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
7 | * modification, are permitted provided that the following conditions are met: |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
8 | * |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
9 | * 1. Redistributions of source code must retain the above copyright |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
10 | * notice, this list of conditions and the following disclaimer. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
11 | * |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
12 | * 2. Redistributions in binary form must reproduce the above copyright |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
13 | * notice, this list of conditions and the following disclaimer in the |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
14 | * documentation and/or other materials provided with the distribution. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
15 | * |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
26 | * POSSIBILITY OF SUCH DAMAGE. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
27 | */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
28 | /** |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
29 | * \file map.h |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
30 | * \brief Interface for map implementations. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
31 | * \author Mike Becker |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
32 | * \author Olaf Wintermann |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
33 | * \copyright 2-Clause BSD License |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
34 | */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
35 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
36 | #ifndef UCX_MAP_H |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
37 | #define UCX_MAP_H |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
38 | |
681
502105523db7
fix common.h include problems - fixes #255
Mike Becker <universe@uap-core.de>
parents:
677
diff
changeset
|
39 | #include "common.h" |
677
b09aae58bba4
refactoring of collections to make use of destructors in map implementations
Mike Becker <universe@uap-core.de>
parents:
669
diff
changeset
|
40 | #include "collection.h" |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
41 | #include "string.h" |
563
69a83fad8a35
improve hash key handling
Mike Becker <universe@uap-core.de>
parents:
558
diff
changeset
|
42 | #include "hash_key.h" |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
43 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
44 | #ifdef __cplusplus |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
45 | extern "C" { |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
46 | #endif |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
47 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
48 | /** Type for the UCX map. */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
49 | typedef struct cx_map_s CxMap; |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
50 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
51 | /** Type for a map entry. */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
52 | typedef struct cx_map_entry_s CxMapEntry; |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
53 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
54 | /** Type for map class definitions. */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
55 | typedef struct cx_map_class_s cx_map_class; |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
56 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
57 | /** Structure for the UCX map. */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
58 | struct cx_map_s { |
854
fe0d69d72bcd
fix members inherited by macro or include are not documented
Mike Becker <universe@uap-core.de>
parents:
853
diff
changeset
|
59 | /** |
fe0d69d72bcd
fix members inherited by macro or include are not documented
Mike Becker <universe@uap-core.de>
parents:
853
diff
changeset
|
60 | * Base attributes. |
fe0d69d72bcd
fix members inherited by macro or include are not documented
Mike Becker <universe@uap-core.de>
parents:
853
diff
changeset
|
61 | */ |
fe0d69d72bcd
fix members inherited by macro or include are not documented
Mike Becker <universe@uap-core.de>
parents:
853
diff
changeset
|
62 | CX_COLLECTION_BASE; |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
63 | /** The map class definition. */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
64 | cx_map_class *cl; |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
65 | }; |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
66 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
67 | /** |
709
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
68 | * The type of iterator for a map. |
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
69 | */ |
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
70 | enum cx_map_iterator_type { |
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
71 | /** |
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
72 | * Iterates over key/value pairs. |
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
73 | */ |
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
74 | CX_MAP_ITERATOR_PAIRS, |
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
75 | /** |
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
76 | * Iterates over keys only. |
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
77 | */ |
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
78 | CX_MAP_ITERATOR_KEYS, |
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
79 | /** |
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
80 | * Iterates over values only. |
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
81 | */ |
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
82 | CX_MAP_ITERATOR_VALUES |
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
83 | }; |
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
84 | |
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
85 | /** |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
86 | * The class definition for arbitrary maps. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
87 | */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
88 | struct cx_map_class_s { |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
89 | /** |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
90 | * Deallocates the entire memory. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
91 | */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
92 | __attribute__((__nonnull__)) |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
93 | void (*destructor)(struct cx_map_s *map); |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
94 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
95 | /** |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
96 | * Removes all elements. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
97 | */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
98 | __attribute__((__nonnull__)) |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
99 | void (*clear)(struct cx_map_s *map); |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
100 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
101 | /** |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
102 | * Add or overwrite an element. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
103 | */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
104 | __attribute__((__nonnull__)) |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
105 | int (*put)( |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
106 | CxMap *map, |
563
69a83fad8a35
improve hash key handling
Mike Becker <universe@uap-core.de>
parents:
558
diff
changeset
|
107 | CxHashKey key, |
550
89b2a83728b1
#189 basic map implementation
Mike Becker <universe@uap-core.de>
parents:
549
diff
changeset
|
108 | void *value |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
109 | ); |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
110 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
111 | /** |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
112 | * Returns an element. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
113 | */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
114 | __attribute__((__nonnull__, __warn_unused_result__)) |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
115 | void *(*get)( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
116 | const CxMap *map, |
563
69a83fad8a35
improve hash key handling
Mike Becker <universe@uap-core.de>
parents:
558
diff
changeset
|
117 | CxHashKey key |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
118 | ); |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
119 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
120 | /** |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
121 | * Removes an element. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
122 | */ |
659
4a06fd63909a
split cxMapRemove() to cxMapRemoveAndGet()
Mike Becker <universe@uap-core.de>
parents:
658
diff
changeset
|
123 | __attribute__((__nonnull__)) |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
124 | void *(*remove)( |
550
89b2a83728b1
#189 basic map implementation
Mike Becker <universe@uap-core.de>
parents:
549
diff
changeset
|
125 | CxMap *map, |
686
64919f63f059
add destructor functions for maps - fixes #253
Mike Becker <universe@uap-core.de>
parents:
685
diff
changeset
|
126 | CxHashKey key, |
64919f63f059
add destructor functions for maps - fixes #253
Mike Becker <universe@uap-core.de>
parents:
685
diff
changeset
|
127 | bool destroy |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
128 | ); |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
129 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
130 | /** |
709
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
131 | * Creates an iterator for this map. |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
132 | */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
133 | __attribute__((__nonnull__, __warn_unused_result__)) |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
134 | CxIterator (*iterator)(const CxMap *map, enum cx_map_iterator_type type); |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
135 | }; |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
136 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
137 | /** |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
138 | * A map entry. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
139 | */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
140 | struct cx_map_entry_s { |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
141 | /** |
551
2946e13c89a4
#189 implement map iterators
Mike Becker <universe@uap-core.de>
parents:
550
diff
changeset
|
142 | * A pointer to the key. |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
143 | */ |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
144 | const CxHashKey *key; |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
145 | /** |
551
2946e13c89a4
#189 implement map iterators
Mike Becker <universe@uap-core.de>
parents:
550
diff
changeset
|
146 | * A pointer to the value. |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
147 | */ |
551
2946e13c89a4
#189 implement map iterators
Mike Becker <universe@uap-core.de>
parents:
550
diff
changeset
|
148 | void *value; |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
149 | }; |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
150 | |
714
34565d898f1f
add missing docs for cxEmptyMap
Mike Becker <universe@uap-core.de>
parents:
710
diff
changeset
|
151 | /** |
34565d898f1f
add missing docs for cxEmptyMap
Mike Becker <universe@uap-core.de>
parents:
710
diff
changeset
|
152 | * A shared instance of an empty map. |
34565d898f1f
add missing docs for cxEmptyMap
Mike Becker <universe@uap-core.de>
parents:
710
diff
changeset
|
153 | * |
34565d898f1f
add missing docs for cxEmptyMap
Mike Becker <universe@uap-core.de>
parents:
710
diff
changeset
|
154 | * Writing to that map is undefined. |
34565d898f1f
add missing docs for cxEmptyMap
Mike Becker <universe@uap-core.de>
parents:
710
diff
changeset
|
155 | */ |
706
8c6edaccaef1
add empty map implementation - fixes #259
Mike Becker <universe@uap-core.de>
parents:
694
diff
changeset
|
156 | extern CxMap *const cxEmptyMap; |
8c6edaccaef1
add empty map implementation - fixes #259
Mike Becker <universe@uap-core.de>
parents:
694
diff
changeset
|
157 | |
658
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
158 | /** |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
159 | * Advises the map to store copies of the objects (default mode of operation). |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
160 | * |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
161 | * Retrieving objects from this map will yield pointers to the copies stored |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
162 | * within this list. |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
163 | * |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
164 | * @param map the map |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
165 | * @see cxMapStorePointers() |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
166 | */ |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
167 | __attribute__((__nonnull__)) |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
168 | static inline void cxMapStoreObjects(CxMap *map) { |
856
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
169 | map->collection.store_pointer = false; |
658
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
170 | } |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
171 | |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
172 | /** |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
173 | * Advises the map to only store pointers to the objects. |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
174 | * |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
175 | * Retrieving objects from this list will yield the original pointers stored. |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
176 | * |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
177 | * @note This function forcibly sets the element size to the size of a pointer. |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
178 | * Invoking this function on a non-empty map that already stores copies of |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
179 | * objects is undefined. |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
180 | * |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
181 | * @param map the map |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
182 | * @see cxMapStoreObjects() |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
183 | */ |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
184 | __attribute__((__nonnull__)) |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
185 | static inline void cxMapStorePointers(CxMap *map) { |
856
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
186 | map->collection.store_pointer = true; |
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
187 | map->collection.elem_size = sizeof(void *); |
658
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
188 | } |
56c62780582e
make hashmap store objects instead of pointers by default - fixes #239
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
189 | |
857
4d12e34bb130
add missing convenience functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
190 | /** |
4d12e34bb130
add missing convenience functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
191 | * Returns true, if this map is storing pointers instead of the actual data. |
4d12e34bb130
add missing convenience functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
192 | * |
4d12e34bb130
add missing convenience functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
193 | * @param map |
4d12e34bb130
add missing convenience functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
194 | * @return true, if this map is storing pointers |
4d12e34bb130
add missing convenience functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
195 | * @see cxMapStorePointers() |
4d12e34bb130
add missing convenience functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
196 | */ |
4d12e34bb130
add missing convenience functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
197 | __attribute__((__nonnull__)) |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
198 | static inline bool cxMapIsStoringPointers(const CxMap *map) { |
857
4d12e34bb130
add missing convenience functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
199 | return map->collection.store_pointer; |
4d12e34bb130
add missing convenience functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
200 | } |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
201 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
202 | /** |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
203 | * Deallocates the memory of the specified map. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
204 | * |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
205 | * @param map the map to be destroyed |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
206 | */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
207 | __attribute__((__nonnull__)) |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
208 | static inline void cxMapDestroy(CxMap *map) { |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
209 | map->cl->destructor(map); |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
210 | } |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
211 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
212 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
213 | /** |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
214 | * Clears a map by removing all elements. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
215 | * |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
216 | * @param map the map to be cleared |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
217 | */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
218 | __attribute__((__nonnull__)) |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
219 | static inline void cxMapClear(CxMap *map) { |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
220 | map->cl->clear(map); |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
221 | } |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
222 | |
856
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
223 | /** |
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
224 | * Returns the number of elements in this map. |
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
225 | * |
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
226 | * @param map the map |
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
227 | * @return the number of stored elements |
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
228 | */ |
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
229 | __attribute__((__nonnull__)) |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
230 | static inline size_t cxMapSize(const CxMap *map) { |
856
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
231 | return map->collection.size; |
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
232 | } |
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
233 | |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
234 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
235 | // TODO: set-like map operations (union, intersect, difference) |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
236 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
237 | /** |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
238 | * Creates a value iterator for a map. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
239 | * |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
240 | * \note An iterator iterates over all elements successively. Therefore the order |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
241 | * highly depends on the map implementation and may change arbitrarily when the contents change. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
242 | * |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
243 | * @param map the map to create the iterator for |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
244 | * @return an iterator for the currently stored values |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
245 | */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
246 | __attribute__((__nonnull__, __warn_unused_result__)) |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
247 | static inline CxIterator cxMapIteratorValues(const CxMap *map) { |
709
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
248 | return map->cl->iterator(map, CX_MAP_ITERATOR_VALUES); |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
249 | } |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
250 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
251 | /** |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
252 | * Creates a key iterator for a map. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
253 | * |
564
5d8ad7a0ff71
fix obsolete documentation
Mike Becker <universe@uap-core.de>
parents:
563
diff
changeset
|
254 | * The elements of the iterator are keys of type CxHashKey. |
555
d79fbd028e26
fix documentation for map iterators
Mike Becker <universe@uap-core.de>
parents:
553
diff
changeset
|
255 | * |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
256 | * \note An iterator iterates over all elements successively. Therefore the order |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
257 | * highly depends on the map implementation and may change arbitrarily when the contents change. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
258 | * |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
259 | * @param map the map to create the iterator for |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
260 | * @return an iterator for the currently stored keys |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
261 | */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
262 | __attribute__((__nonnull__, __warn_unused_result__)) |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
263 | static inline CxIterator cxMapIteratorKeys(const CxMap *map) { |
709
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
264 | return map->cl->iterator(map, CX_MAP_ITERATOR_KEYS); |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
265 | } |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
266 | |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
267 | /** |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
268 | * Creates an iterator for a map. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
269 | * |
555
d79fbd028e26
fix documentation for map iterators
Mike Becker <universe@uap-core.de>
parents:
553
diff
changeset
|
270 | * The elements of the iterator are key/value pairs of type CxMapEntry. |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
271 | * |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
272 | * \note An iterator iterates over all elements successively. Therefore the order |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
273 | * highly depends on the map implementation and may change arbitrarily when the contents change. |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
274 | * |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
275 | * @param map the map to create the iterator for |
555
d79fbd028e26
fix documentation for map iterators
Mike Becker <universe@uap-core.de>
parents:
553
diff
changeset
|
276 | * @return an iterator for the currently stored entries |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
277 | * @see cxMapIteratorKeys() |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
278 | * @see cxMapIteratorValues() |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
279 | */ |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
280 | __attribute__((__nonnull__, __warn_unused_result__)) |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
281 | static inline CxIterator cxMapIterator(const CxMap *map) { |
709
1e8ba59e7911
simplify map class structure
Mike Becker <universe@uap-core.de>
parents:
706
diff
changeset
|
282 | return map->cl->iterator(map, CX_MAP_ITERATOR_PAIRS); |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
283 | } |
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
284 | |
630
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
285 | |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
286 | /** |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
287 | * Creates a mutating iterator over the values of a map. |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
288 | * |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
289 | * \note An iterator iterates over all elements successively. Therefore the order |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
290 | * highly depends on the map implementation and may change arbitrarily when the contents change. |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
291 | * |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
292 | * @param map the map to create the iterator for |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
293 | * @return an iterator for the currently stored values |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
294 | */ |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
295 | __attribute__((__nonnull__, __warn_unused_result__)) |
853
d4baf4dd55c3
simplify iterator structures
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
296 | CxIterator cxMapMutIteratorValues(CxMap *map); |
630
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
297 | |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
298 | /** |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
299 | * Creates a mutating iterator over the keys of a map. |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
300 | * |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
301 | * The elements of the iterator are keys of type CxHashKey. |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
302 | * |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
303 | * \note An iterator iterates over all elements successively. Therefore the order |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
304 | * highly depends on the map implementation and may change arbitrarily when the contents change. |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
305 | * |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
306 | * @param map the map to create the iterator for |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
307 | * @return an iterator for the currently stored keys |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
308 | */ |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
309 | __attribute__((__nonnull__, __warn_unused_result__)) |
853
d4baf4dd55c3
simplify iterator structures
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
310 | CxIterator cxMapMutIteratorKeys(CxMap *map); |
630
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
311 | |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
312 | /** |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
313 | * Creates a mutating iterator for a map. |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
314 | * |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
315 | * The elements of the iterator are key/value pairs of type CxMapEntry. |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
316 | * |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
317 | * \note An iterator iterates over all elements successively. Therefore the order |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
318 | * highly depends on the map implementation and may change arbitrarily when the contents change. |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
319 | * |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
320 | * @param map the map to create the iterator for |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
321 | * @return an iterator for the currently stored entries |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
322 | * @see cxMapMutIteratorKeys() |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
323 | * @see cxMapMutIteratorValues() |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
324 | */ |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
325 | __attribute__((__nonnull__, __warn_unused_result__)) |
853
d4baf4dd55c3
simplify iterator structures
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
326 | CxIterator cxMapMutIterator(CxMap *map); |
630
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
564
diff
changeset
|
327 | |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
328 | #ifdef __cplusplus |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
329 | } // end the extern "C" block here, because we want to start overloading |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
330 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
331 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
332 | * Puts a key/value-pair into the map. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
333 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
334 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
335 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
336 | * @param value the value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
337 | * @return 0 on success, non-zero value on failure |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
338 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
339 | __attribute__((__nonnull__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
340 | static inline int cxMapPut( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
341 | CxMap *map, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
342 | CxHashKey const &key, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
343 | void *value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
344 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
345 | return map->cl->put(map, key, value); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
346 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
347 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
348 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
349 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
350 | * Puts a key/value-pair into the map. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
351 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
352 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
353 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
354 | * @param value the value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
355 | * @return 0 on success, non-zero value on failure |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
356 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
357 | __attribute__((__nonnull__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
358 | static inline int cxMapPut( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
359 | CxMap *map, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
360 | cxstring const &key, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
361 | void *value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
362 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
363 | return map->cl->put(map, cx_hash_key_cxstr(key), value); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
364 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
365 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
366 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
367 | * Puts a key/value-pair into the map. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
368 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
369 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
370 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
371 | * @param value the value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
372 | * @return 0 on success, non-zero value on failure |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
373 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
374 | __attribute__((__nonnull__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
375 | static inline int cxMapPut( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
376 | CxMap *map, |
692
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
377 | cxmutstr const &key, |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
378 | void *value |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
379 | ) { |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
380 | return map->cl->put(map, cx_hash_key_cxstr(key), value); |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
381 | } |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
382 | |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
383 | /** |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
384 | * Puts a key/value-pair into the map. |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
385 | * |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
386 | * @param map the map |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
387 | * @param key the key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
388 | * @param value the value |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
389 | * @return 0 on success, non-zero value on failure |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
390 | */ |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
391 | __attribute__((__nonnull__)) |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
392 | static inline int cxMapPut( |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
393 | CxMap *map, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
394 | const char *key, |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
395 | void *value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
396 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
397 | return map->cl->put(map, cx_hash_key_str(key), value); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
398 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
399 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
400 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
401 | * Retrieves a value by using a key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
402 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
403 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
404 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
405 | * @return the value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
406 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
407 | __attribute__((__nonnull__, __warn_unused_result__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
408 | static inline void *cxMapGet( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
409 | const CxMap *map, |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
410 | CxHashKey const &key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
411 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
412 | return map->cl->get(map, key); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
413 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
414 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
415 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
416 | * Retrieves a value by using a key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
417 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
418 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
419 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
420 | * @return the value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
421 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
422 | __attribute__((__nonnull__, __warn_unused_result__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
423 | static inline void *cxMapGet( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
424 | const CxMap *map, |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
425 | cxstring const &key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
426 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
427 | return map->cl->get(map, cx_hash_key_cxstr(key)); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
428 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
429 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
430 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
431 | * Retrieves a value by using a key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
432 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
433 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
434 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
435 | * @return the value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
436 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
437 | __attribute__((__nonnull__, __warn_unused_result__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
438 | static inline void *cxMapGet( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
439 | const CxMap *map, |
692
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
440 | cxmutstr const &key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
441 | ) { |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
442 | return map->cl->get(map, cx_hash_key_cxstr(key)); |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
443 | } |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
444 | |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
445 | /** |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
446 | * Retrieves a value by using a key. |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
447 | * |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
448 | * @param map the map |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
449 | * @param key the key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
450 | * @return the value |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
451 | */ |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
452 | __attribute__((__nonnull__, __warn_unused_result__)) |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
453 | static inline void *cxMapGet( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
454 | const CxMap *map, |
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
455 | const char *key |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
456 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
457 | return map->cl->get(map, cx_hash_key_str(key)); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
458 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
459 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
460 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
461 | * Removes a key/value-pair from the map by using the key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
462 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
463 | * Always invokes the destructor function, if any, on the removed element. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
464 | * If this map is storing pointers and you just want to retrieve the pointer |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
465 | * without invoking the destructor, use cxMapRemoveAndGet(). |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
466 | * If you just want to detach the element from the map without invoking the |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
467 | * destructor or returning the element, use cxMapDetach(). |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
468 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
469 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
470 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
471 | * @see cxMapRemoveAndGet() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
472 | * @see cxMapDetach() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
473 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
474 | __attribute__((__nonnull__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
475 | static inline void cxMapRemove( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
476 | CxMap *map, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
477 | CxHashKey const &key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
478 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
479 | (void) map->cl->remove(map, key, true); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
480 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
481 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
482 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
483 | * Removes a key/value-pair from the map by using the key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
484 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
485 | * Always invokes the destructor function, if any, on the removed element. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
486 | * If this map is storing pointers and you just want to retrieve the pointer |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
487 | * without invoking the destructor, use cxMapRemoveAndGet(). |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
488 | * If you just want to detach the element from the map without invoking the |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
489 | * destructor or returning the element, use cxMapDetach(). |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
490 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
491 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
492 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
493 | * @see cxMapRemoveAndGet() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
494 | * @see cxMapDetach() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
495 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
496 | __attribute__((__nonnull__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
497 | static inline void cxMapRemove( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
498 | CxMap *map, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
499 | cxstring const &key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
500 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
501 | (void) map->cl->remove(map, cx_hash_key_cxstr(key), true); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
502 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
503 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
504 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
505 | * Removes a key/value-pair from the map by using the key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
506 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
507 | * Always invokes the destructor function, if any, on the removed element. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
508 | * If this map is storing pointers and you just want to retrieve the pointer |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
509 | * without invoking the destructor, use cxMapRemoveAndGet(). |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
510 | * If you just want to detach the element from the map without invoking the |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
511 | * destructor or returning the element, use cxMapDetach(). |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
512 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
513 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
514 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
515 | * @see cxMapRemoveAndGet() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
516 | * @see cxMapDetach() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
517 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
518 | __attribute__((__nonnull__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
519 | static inline void cxMapRemove( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
520 | CxMap *map, |
692
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
521 | cxmutstr const &key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
522 | ) { |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
523 | (void) map->cl->remove(map, cx_hash_key_cxstr(key), true); |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
524 | } |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
525 | |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
526 | /** |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
527 | * Removes a key/value-pair from the map by using the key. |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
528 | * |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
529 | * Always invokes the destructor function, if any, on the removed element. |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
530 | * If this map is storing pointers and you just want to retrieve the pointer |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
531 | * without invoking the destructor, use cxMapRemoveAndGet(). |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
532 | * If you just want to detach the element from the map without invoking the |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
533 | * destructor or returning the element, use cxMapDetach(). |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
534 | * |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
535 | * @param map the map |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
536 | * @param key the key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
537 | * @see cxMapRemoveAndGet() |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
538 | * @see cxMapDetach() |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
539 | */ |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
540 | __attribute__((__nonnull__)) |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
541 | static inline void cxMapRemove( |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
542 | CxMap *map, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
543 | const char *key |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
544 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
545 | (void) map->cl->remove(map, cx_hash_key_str(key), true); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
546 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
547 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
548 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
549 | * Detaches a key/value-pair from the map by using the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
550 | * without invoking the destructor. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
551 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
552 | * In general, you should only use this function if the map does not own |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
553 | * the data and there is a valid reference to the data somewhere else |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
554 | * in the program. In all other cases it is preferable to use |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
555 | * cxMapRemove() or cxMapRemoveAndGet(). |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
556 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
557 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
558 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
559 | * @see cxMapRemove() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
560 | * @see cxMapRemoveAndGet() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
561 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
562 | __attribute__((__nonnull__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
563 | static inline void cxMapDetach( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
564 | CxMap *map, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
565 | CxHashKey const &key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
566 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
567 | (void) map->cl->remove(map, key, false); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
568 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
569 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
570 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
571 | * Detaches a key/value-pair from the map by using the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
572 | * without invoking the destructor. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
573 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
574 | * In general, you should only use this function if the map does not own |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
575 | * the data and there is a valid reference to the data somewhere else |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
576 | * in the program. In all other cases it is preferable to use |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
577 | * cxMapRemove() or cxMapRemoveAndGet(). |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
578 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
579 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
580 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
581 | * @see cxMapRemove() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
582 | * @see cxMapRemoveAndGet() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
583 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
584 | __attribute__((__nonnull__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
585 | static inline void cxMapDetach( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
586 | CxMap *map, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
587 | cxstring const &key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
588 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
589 | (void) map->cl->remove(map, cx_hash_key_cxstr(key), false); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
590 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
591 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
592 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
593 | * Detaches a key/value-pair from the map by using the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
594 | * without invoking the destructor. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
595 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
596 | * In general, you should only use this function if the map does not own |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
597 | * the data and there is a valid reference to the data somewhere else |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
598 | * in the program. In all other cases it is preferable to use |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
599 | * cxMapRemove() or cxMapRemoveAndGet(). |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
600 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
601 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
602 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
603 | * @see cxMapRemove() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
604 | * @see cxMapRemoveAndGet() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
605 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
606 | __attribute__((__nonnull__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
607 | static inline void cxMapDetach( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
608 | CxMap *map, |
692
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
609 | cxmutstr const &key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
610 | ) { |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
611 | (void) map->cl->remove(map, cx_hash_key_cxstr(key), false); |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
612 | } |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
613 | |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
614 | /** |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
615 | * Detaches a key/value-pair from the map by using the key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
616 | * without invoking the destructor. |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
617 | * |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
618 | * In general, you should only use this function if the map does not own |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
619 | * the data and there is a valid reference to the data somewhere else |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
620 | * in the program. In all other cases it is preferable to use |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
621 | * cxMapRemove() or cxMapRemoveAndGet(). |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
622 | * |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
623 | * @param map the map |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
624 | * @param key the key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
625 | * @see cxMapRemove() |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
626 | * @see cxMapRemoveAndGet() |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
627 | */ |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
628 | __attribute__((__nonnull__)) |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
629 | static inline void cxMapDetach( |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
630 | CxMap *map, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
631 | const char *key |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
632 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
633 | (void) map->cl->remove(map, cx_hash_key_str(key), false); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
634 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
635 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
636 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
637 | * Removes a key/value-pair from the map by using the key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
638 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
639 | * This function can be used when the map is storing pointers, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
640 | * in order to retrieve the pointer from the map without invoking |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
641 | * any destructor function. Sometimes you do not want the pointer |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
642 | * to be returned - in that case (instead of suppressing the "unused |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
643 | * result" warning) you can use cxMapDetach(). |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
644 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
645 | * If this map is not storing pointers, this function behaves like |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
646 | * cxMapRemove() and returns \c NULL. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
647 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
648 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
649 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
650 | * @return the stored pointer or \c NULL if either the key is not present |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
651 | * in the map or the map is not storing pointers |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
652 | * @see cxMapStorePointers() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
653 | * @see cxMapDetach() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
654 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
655 | __attribute__((__nonnull__, __warn_unused_result__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
656 | static inline void *cxMapRemoveAndGet( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
657 | CxMap *map, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
658 | CxHashKey key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
659 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
660 | return map->cl->remove(map, key, !map->store_pointer); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
661 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
662 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
663 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
664 | * Removes a key/value-pair from the map by using the key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
665 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
666 | * This function can be used when the map is storing pointers, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
667 | * in order to retrieve the pointer from the map without invoking |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
668 | * any destructor function. Sometimes you do not want the pointer |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
669 | * to be returned - in that case (instead of suppressing the "unused |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
670 | * result" warning) you can use cxMapDetach(). |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
671 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
672 | * If this map is not storing pointers, this function behaves like |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
673 | * cxMapRemove() and returns \c NULL. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
674 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
675 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
676 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
677 | * @return the stored pointer or \c NULL if either the key is not present |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
678 | * in the map or the map is not storing pointers |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
679 | * @see cxMapStorePointers() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
680 | * @see cxMapDetach() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
681 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
682 | __attribute__((__nonnull__, __warn_unused_result__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
683 | static inline void *cxMapRemoveAndGet( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
684 | CxMap *map, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
685 | cxstring key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
686 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
687 | return map->cl->remove(map, cx_hash_key_cxstr(key), !map->store_pointer); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
688 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
689 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
690 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
691 | * Removes a key/value-pair from the map by using the key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
692 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
693 | * This function can be used when the map is storing pointers, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
694 | * in order to retrieve the pointer from the map without invoking |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
695 | * any destructor function. Sometimes you do not want the pointer |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
696 | * to be returned - in that case (instead of suppressing the "unused |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
697 | * result" warning) you can use cxMapDetach(). |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
698 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
699 | * If this map is not storing pointers, this function behaves like |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
700 | * cxMapRemove() and returns \c NULL. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
701 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
702 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
703 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
704 | * @return the stored pointer or \c NULL if either the key is not present |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
705 | * in the map or the map is not storing pointers |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
706 | * @see cxMapStorePointers() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
707 | * @see cxMapDetach() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
708 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
709 | __attribute__((__nonnull__, __warn_unused_result__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
710 | static inline void *cxMapRemoveAndGet( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
711 | CxMap *map, |
692
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
712 | cxmutstr key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
713 | ) { |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
714 | return map->cl->remove(map, cx_hash_key_cxstr(key), !map->store_pointer); |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
715 | } |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
716 | |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
717 | /** |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
718 | * Removes a key/value-pair from the map by using the key. |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
719 | * |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
720 | * This function can be used when the map is storing pointers, |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
721 | * in order to retrieve the pointer from the map without invoking |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
722 | * any destructor function. Sometimes you do not want the pointer |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
723 | * to be returned - in that case (instead of suppressing the "unused |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
724 | * result" warning) you can use cxMapDetach(). |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
725 | * |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
726 | * If this map is not storing pointers, this function behaves like |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
727 | * cxMapRemove() and returns \c NULL. |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
728 | * |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
729 | * @param map the map |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
730 | * @param key the key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
731 | * @return the stored pointer or \c NULL if either the key is not present |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
732 | * in the map or the map is not storing pointers |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
733 | * @see cxMapStorePointers() |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
734 | * @see cxMapDetach() |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
735 | */ |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
736 | __attribute__((__nonnull__, __warn_unused_result__)) |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
737 | static inline void *cxMapRemoveAndGet( |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
738 | CxMap *map, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
739 | const char *key |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
740 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
741 | return map->cl->remove(map, cx_hash_key_str(key), !map->store_pointer); |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
742 | } |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
743 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
744 | #else // __cplusplus |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
745 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
746 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
747 | * Puts a key/value-pair into the map. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
748 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
749 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
750 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
751 | * @param value the value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
752 | * @return 0 on success, non-zero value on failure |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
753 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
754 | __attribute__((__nonnull__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
755 | static inline int cx_map_put( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
756 | CxMap *map, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
757 | CxHashKey key, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
758 | void *value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
759 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
760 | return map->cl->put(map, key, value); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
761 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
762 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
763 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
764 | * Puts a key/value-pair into the map. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
765 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
766 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
767 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
768 | * @param value the value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
769 | * @return 0 on success, non-zero value on failure |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
770 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
771 | __attribute__((__nonnull__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
772 | static inline int cx_map_put_cxstr( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
773 | CxMap *map, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
774 | cxstring key, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
775 | void *value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
776 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
777 | return map->cl->put(map, cx_hash_key_cxstr(key), value); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
778 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
779 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
780 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
781 | * Puts a key/value-pair into the map. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
782 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
783 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
784 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
785 | * @param value the value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
786 | * @return 0 on success, non-zero value on failure |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
787 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
788 | __attribute__((__nonnull__)) |
692
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
789 | static inline int cx_map_put_mustr( |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
790 | CxMap *map, |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
791 | cxmutstr key, |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
792 | void *value |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
793 | ) { |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
794 | return map->cl->put(map, cx_hash_key_cxstr(key), value); |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
795 | } |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
796 | |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
797 | /** |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
798 | * Puts a key/value-pair into the map. |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
799 | * |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
800 | * @param map the map |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
801 | * @param key the key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
802 | * @param value the value |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
803 | * @return 0 on success, non-zero value on failure |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
804 | */ |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
805 | __attribute__((__nonnull__)) |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
806 | static inline int cx_map_put_str( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
807 | CxMap *map, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
808 | const char *key, |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
809 | void *value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
810 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
811 | return map->cl->put(map, cx_hash_key_str(key), value); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
812 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
813 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
814 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
815 | * Puts a key/value-pair into the map. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
816 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
817 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
818 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
819 | * @param value the value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
820 | * @return 0 on success, non-zero value on failure |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
821 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
822 | #define cxMapPut(map, key, value) _Generic((key), \ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
823 | CxHashKey: cx_map_put, \ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
824 | cxstring: cx_map_put_cxstr, \ |
692
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
825 | cxmutstr: cx_map_put_mustr, \ |
694
ac827d873c17
fix missing controlling-expression for char const*
Mike Becker <universe@uap-core.de>
parents:
692
diff
changeset
|
826 | char*: cx_map_put_str, \ |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
827 | const char*: cx_map_put_str) \ |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
828 | (map, key, value) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
829 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
830 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
831 | * Retrieves a value by using a key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
832 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
833 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
834 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
835 | * @return the value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
836 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
837 | __attribute__((__nonnull__, __warn_unused_result__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
838 | static inline void *cx_map_get( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
839 | const CxMap *map, |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
840 | CxHashKey key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
841 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
842 | return map->cl->get(map, key); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
843 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
844 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
845 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
846 | * Retrieves a value by using a key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
847 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
848 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
849 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
850 | * @return the value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
851 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
852 | __attribute__((__nonnull__, __warn_unused_result__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
853 | static inline void *cx_map_get_cxstr( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
854 | const CxMap *map, |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
855 | cxstring key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
856 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
857 | return map->cl->get(map, cx_hash_key_cxstr(key)); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
858 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
859 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
860 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
861 | * Retrieves a value by using a key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
862 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
863 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
864 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
865 | * @return the value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
866 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
867 | __attribute__((__nonnull__, __warn_unused_result__)) |
692
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
868 | static inline void *cx_map_get_mustr( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
869 | const CxMap *map, |
692
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
870 | cxmutstr key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
871 | ) { |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
872 | return map->cl->get(map, cx_hash_key_cxstr(key)); |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
873 | } |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
874 | |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
875 | /** |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
876 | * Retrieves a value by using a key. |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
877 | * |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
878 | * @param map the map |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
879 | * @param key the key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
880 | * @return the value |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
881 | */ |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
882 | __attribute__((__nonnull__, __warn_unused_result__)) |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
883 | static inline void *cx_map_get_str( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
884 | const CxMap *map, |
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
885 | const char *key |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
886 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
887 | return map->cl->get(map, cx_hash_key_str(key)); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
888 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
889 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
890 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
891 | * Retrieves a value by using a key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
892 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
893 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
894 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
895 | * @return the value |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
896 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
897 | #define cxMapGet(map, key) _Generic((key), \ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
898 | CxHashKey: cx_map_get, \ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
899 | cxstring: cx_map_get_cxstr, \ |
692
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
900 | cxmutstr: cx_map_get_mustr, \ |
694
ac827d873c17
fix missing controlling-expression for char const*
Mike Becker <universe@uap-core.de>
parents:
692
diff
changeset
|
901 | char*: cx_map_get_str, \ |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
902 | const char*: cx_map_get_str) \ |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
903 | (map, key) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
904 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
905 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
906 | * Removes a key/value-pair from the map by using the key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
907 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
908 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
909 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
910 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
911 | __attribute__((__nonnull__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
912 | static inline void cx_map_remove( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
913 | CxMap *map, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
914 | CxHashKey key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
915 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
916 | (void) map->cl->remove(map, key, true); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
917 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
918 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
919 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
920 | * Removes a key/value-pair from the map by using the key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
921 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
922 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
923 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
924 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
925 | __attribute__((__nonnull__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
926 | static inline void cx_map_remove_cxstr( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
927 | CxMap *map, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
928 | cxstring key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
929 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
930 | (void) map->cl->remove(map, cx_hash_key_cxstr(key), true); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
931 | } |
549
d7f0b5a9a985
#189 declare basic map functions
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
932 | |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
933 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
934 | * Removes a key/value-pair from the map by using the key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
935 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
936 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
937 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
938 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
939 | __attribute__((__nonnull__)) |
692
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
940 | static inline void cx_map_remove_mustr( |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
941 | CxMap *map, |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
942 | cxmutstr key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
943 | ) { |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
944 | (void) map->cl->remove(map, cx_hash_key_cxstr(key), true); |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
945 | } |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
946 | |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
947 | /** |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
948 | * Removes a key/value-pair from the map by using the key. |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
949 | * |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
950 | * @param map the map |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
951 | * @param key the key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
952 | */ |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
953 | __attribute__((__nonnull__)) |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
954 | static inline void cx_map_remove_str( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
955 | CxMap *map, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
956 | const char *key |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
957 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
958 | (void) map->cl->remove(map, cx_hash_key_str(key), true); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
959 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
960 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
961 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
962 | * Removes a key/value-pair from the map by using the key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
963 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
964 | * Always invokes the destructor function, if any, on the removed element. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
965 | * If this map is storing pointers and you just want to retrieve the pointer |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
966 | * without invoking the destructor, use cxMapRemoveAndGet(). |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
967 | * If you just want to detach the element from the map without invoking the |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
968 | * destructor or returning the element, use cxMapDetach(). |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
969 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
970 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
971 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
972 | * @see cxMapRemoveAndGet() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
973 | * @see cxMapDetach() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
974 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
975 | #define cxMapRemove(map, key) _Generic((key), \ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
976 | CxHashKey: cx_map_remove, \ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
977 | cxstring: cx_map_remove_cxstr, \ |
692
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
978 | cxmutstr: cx_map_remove_mustr, \ |
694
ac827d873c17
fix missing controlling-expression for char const*
Mike Becker <universe@uap-core.de>
parents:
692
diff
changeset
|
979 | char*: cx_map_remove_str, \ |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
980 | const char*: cx_map_remove_str) \ |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
981 | (map, key) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
982 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
983 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
984 | * Detaches a key/value-pair from the map by using the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
985 | * without invoking the destructor. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
986 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
987 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
988 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
989 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
990 | __attribute__((__nonnull__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
991 | static inline void cx_map_detach( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
992 | CxMap *map, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
993 | CxHashKey key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
994 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
995 | (void) map->cl->remove(map, key, false); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
996 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
997 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
998 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
999 | * Detaches a key/value-pair from the map by using the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1000 | * without invoking the destructor. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1001 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1002 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1003 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1004 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1005 | __attribute__((__nonnull__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1006 | static inline void cx_map_detach_cxstr( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1007 | CxMap *map, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1008 | cxstring key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1009 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1010 | (void) map->cl->remove(map, cx_hash_key_cxstr(key), false); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1011 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1012 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1013 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1014 | * Detaches a key/value-pair from the map by using the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1015 | * without invoking the destructor. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1016 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1017 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1018 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1019 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1020 | __attribute__((__nonnull__)) |
692
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1021 | static inline void cx_map_detach_mustr( |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1022 | CxMap *map, |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1023 | cxmutstr key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1024 | ) { |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1025 | (void) map->cl->remove(map, cx_hash_key_cxstr(key), false); |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1026 | } |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1027 | |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1028 | /** |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1029 | * Detaches a key/value-pair from the map by using the key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1030 | * without invoking the destructor. |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1031 | * |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1032 | * @param map the map |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1033 | * @param key the key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1034 | */ |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1035 | __attribute__((__nonnull__)) |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1036 | static inline void cx_map_detach_str( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1037 | CxMap *map, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
1038 | const char *key |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1039 | ) { |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1040 | (void) map->cl->remove(map, cx_hash_key_str(key), false); |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1041 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1042 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1043 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1044 | * Detaches a key/value-pair from the map by using the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1045 | * without invoking the destructor. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1046 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1047 | * In general, you should only use this function if the map does not own |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1048 | * the data and there is a valid reference to the data somewhere else |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1049 | * in the program. In all other cases it is preferable to use |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1050 | * cxMapRemove() or cxMapRemoveAndGet(). |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1051 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1052 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1053 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1054 | * @see cxMapRemove() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1055 | * @see cxMapRemoveAndGet() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1056 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1057 | #define cxMapDetach(map, key) _Generic((key), \ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1058 | CxHashKey: cx_map_detach, \ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1059 | cxstring: cx_map_detach_cxstr, \ |
692
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1060 | cxmutstr: cx_map_detach_mustr, \ |
694
ac827d873c17
fix missing controlling-expression for char const*
Mike Becker <universe@uap-core.de>
parents:
692
diff
changeset
|
1061 | char*: cx_map_detach_str, \ |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
1062 | const char*: cx_map_detach_str) \ |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1063 | (map, key) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1064 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1065 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1066 | * Removes a key/value-pair from the map by using the key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1067 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1068 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1069 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1070 | * @return the stored pointer or \c NULL if either the key is not present |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1071 | * in the map or the map is not storing pointers |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1072 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1073 | __attribute__((__nonnull__, __warn_unused_result__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1074 | static inline void *cx_map_remove_and_get( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1075 | CxMap *map, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1076 | CxHashKey key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1077 | ) { |
856
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
1078 | return map->cl->remove(map, key, !map->collection.store_pointer); |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1079 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1080 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1081 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1082 | * Removes a key/value-pair from the map by using the key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1083 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1084 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1085 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1086 | * @return the stored pointer or \c NULL if either the key is not present |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1087 | * in the map or the map is not storing pointers |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1088 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1089 | __attribute__((__nonnull__, __warn_unused_result__)) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1090 | static inline void *cx_map_remove_and_get_cxstr( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1091 | CxMap *map, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1092 | cxstring key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1093 | ) { |
856
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
1094 | return map->cl->remove(map, cx_hash_key_cxstr(key), !map->collection.store_pointer); |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1095 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1096 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1097 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1098 | * Removes a key/value-pair from the map by using the key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1099 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1100 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1101 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1102 | * @return the stored pointer or \c NULL if either the key is not present |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1103 | * in the map or the map is not storing pointers |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1104 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1105 | __attribute__((__nonnull__, __warn_unused_result__)) |
692
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1106 | static inline void *cx_map_remove_and_get_mustr( |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1107 | CxMap *map, |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1108 | cxmutstr key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1109 | ) { |
856
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
1110 | return map->cl->remove(map, cx_hash_key_cxstr(key), !map->collection.store_pointer); |
692
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1111 | } |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1112 | |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1113 | /** |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1114 | * Removes a key/value-pair from the map by using the key. |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1115 | * |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1116 | * @param map the map |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1117 | * @param key the key |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1118 | * @return the stored pointer or \c NULL if either the key is not present |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1119 | * in the map or the map is not storing pointers |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1120 | */ |
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1121 | __attribute__((__nonnull__, __warn_unused_result__)) |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1122 | static inline void *cx_map_remove_and_get_str( |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1123 | CxMap *map, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
1124 | const char *key |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1125 | ) { |
856
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
1126 | return map->cl->remove(map, cx_hash_key_str(key), !map->collection.store_pointer); |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1127 | } |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1128 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1129 | /** |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1130 | * Removes a key/value-pair from the map by using the key. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1131 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1132 | * This function can be used when the map is storing pointers, |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1133 | * in order to retrieve the pointer from the map without invoking |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1134 | * any destructor function. Sometimes you do not want the pointer |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1135 | * to be returned - in that case (instead of suppressing the "unused |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1136 | * result" warning) you can use cxMapDetach(). |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1137 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1138 | * If this map is not storing pointers, this function behaves like |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1139 | * cxMapRemove() and returns \c NULL. |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1140 | * |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1141 | * @param map the map |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1142 | * @param key the key |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1143 | * @return the stored pointer or \c NULL if either the key is not present |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1144 | * in the map or the map is not storing pointers |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1145 | * @see cxMapStorePointers() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1146 | * @see cxMapDetach() |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1147 | */ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1148 | #define cxMapRemoveAndGet(map, key) _Generic((key), \ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1149 | CxHashKey: cx_map_remove_and_get, \ |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1150 | cxstring: cx_map_remove_and_get_cxstr, \ |
692
6ac92936cd44
add cxmutstr to the map generics
Mike Becker <universe@uap-core.de>
parents:
691
diff
changeset
|
1151 | cxmutstr: cx_map_remove_and_get_mustr, \ |
694
ac827d873c17
fix missing controlling-expression for char const*
Mike Becker <universe@uap-core.de>
parents:
692
diff
changeset
|
1152 | char*: cx_map_remove_and_get_str, \ |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
857
diff
changeset
|
1153 | const char*: cx_map_remove_and_get_str) \ |
691
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1154 | (map, key) |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1155 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1156 | #endif // __cplusplus |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1157 | |
65baf7f45ac8
bring a generic interface to CxMap
Mike Becker <universe@uap-core.de>
parents:
689
diff
changeset
|
1158 | #endif // UCX_MAP_H |