toolkit: comparison ucx/cx/map.h

-:38cb8e3992e8
+:ce13a778654a
 /** Type for map class definitions. */
 typedef struct cx_map_class_s cx_map_class;
 /** Structure for the UCX map. */
 struct cx_map_s {
-CX_COLLECTION_MEMBERS
+/**
+* Base attributes.
+*/
+CX_COLLECTION_BASE;
 /** The map class definition. */
 cx_map_class *cl;
 };
 /**
 /**
 * Returns an element.
 */
 __attribute__((__nonnull__, __warn_unused_result__))
 void *(*get)(
-CxMap const *map,
+const CxMap *map,
 CxHashKey key
 );
 /**
 * Removes an element.
 /**
 * Creates an iterator for this map.
 */
 __attribute__((__nonnull__, __warn_unused_result__))
-CxIterator (*iterator)(CxMap const *map, enum cx_map_iterator_type type);
+CxIterator (*iterator)(const CxMap *map, enum cx_map_iterator_type type);
 };
 /**
 * A map entry.
 */
 struct cx_map_entry_s {
 /**
 * A pointer to the key.
 */
-CxHashKey const *key;
+const CxHashKey *key;
 /**
 * A pointer to the value.
 */
 void *value;
 };
 * @param map the map
 * @see cxMapStorePointers()
 */
 __attribute__((__nonnull__))
 static inline void cxMapStoreObjects(CxMap *map) {
-map->store_pointer = false;
+map->collection.store_pointer = false;
 }
 /**
 * Advises the map to only store pointers to the objects.
 *
 * @param map the map
 * @see cxMapStoreObjects()
 */
 __attribute__((__nonnull__))
 static inline void cxMapStorePointers(CxMap *map) {
-map->store_pointer = true;
+map->collection.store_pointer = true;
-map->item_size = sizeof(void *);
+map->collection.elem_size = sizeof(void *);
 }
+/**
+* Returns true, if this map is storing pointers instead of the actual data.
+*
+* @param map
+* @return true, if this map is storing pointers
+* @see cxMapStorePointers()
+*/
+__attribute__((__nonnull__))
+static inline bool cxMapIsStoringPointers(const CxMap *map) {
+return map->collection.store_pointer;
+}
 /**
 * Deallocates the memory of the specified map.
 *
 * @param map the map to be destroyed
 __attribute__((__nonnull__))
 static inline void cxMapClear(CxMap *map) {
 map->cl->clear(map);
 }
+/**
+* Returns the number of elements in this map.
+*
+* @param map the map
+* @return the number of stored elements
+*/
+__attribute__((__nonnull__))
+static inline size_t cxMapSize(const CxMap *map) {
+return map->collection.size;
+}
 // TODO: set-like map operations (union, intersect, difference)
 /**
 * Creates a value iterator for a map.
 *
 * @param map the map to create the iterator for
 * @return an iterator for the currently stored values
 */
 __attribute__((__nonnull__, __warn_unused_result__))
-static inline CxIterator cxMapIteratorValues(CxMap const *map) {
+static inline CxIterator cxMapIteratorValues(const CxMap *map) {
 return map->cl->iterator(map, CX_MAP_ITERATOR_VALUES);
 }
 /**
 * Creates a key iterator for a map.
 *
 * @param map the map to create the iterator for
 * @return an iterator for the currently stored keys
 */
 __attribute__((__nonnull__, __warn_unused_result__))
-static inline CxIterator cxMapIteratorKeys(CxMap const *map) {
+static inline CxIterator cxMapIteratorKeys(const CxMap *map) {
 return map->cl->iterator(map, CX_MAP_ITERATOR_KEYS);
 }
 /**
 * Creates an iterator for a map.
 * @return an iterator for the currently stored entries
 * @see cxMapIteratorKeys()
 * @see cxMapIteratorValues()
 */
 __attribute__((__nonnull__, __warn_unused_result__))
-static inline CxIterator cxMapIterator(CxMap const *map) {
+static inline CxIterator cxMapIterator(const CxMap *map) {
 return map->cl->iterator(map, CX_MAP_ITERATOR_PAIRS);
 }
 /**
 *
 * @param map the map to create the iterator for
 * @return an iterator for the currently stored values
 */
 __attribute__((__nonnull__, __warn_unused_result__))
-CxMutIterator cxMapMutIteratorValues(CxMap *map);
+CxIterator cxMapMutIteratorValues(CxMap *map);
 /**
 * Creates a mutating iterator over the keys of a map.
 *
 * The elements of the iterator are keys of type CxHashKey.
 *
 * @param map the map to create the iterator for
 * @return an iterator for the currently stored keys
 */
 __attribute__((__nonnull__, __warn_unused_result__))
-CxMutIterator cxMapMutIteratorKeys(CxMap *map);
+CxIterator cxMapMutIteratorKeys(CxMap *map);
 /**
 * Creates a mutating iterator for a map.
 *
 * The elements of the iterator are key/value pairs of type CxMapEntry.
 * @return an iterator for the currently stored entries
 * @see cxMapMutIteratorKeys()
 * @see cxMapMutIteratorValues()
 */
 __attribute__((__nonnull__, __warn_unused_result__))
-CxMutIterator cxMapMutIterator(CxMap *map);
+CxIterator cxMapMutIterator(CxMap *map);
 #ifdef __cplusplus
 } // end the extern "C" block here, because we want to start overloading
 /**
 * @return 0 on success, non-zero value on failure
 */
 __attribute__((__nonnull__))
 static inline int cxMapPut(
 CxMap *map,
-char const *key,
+const char *key,
 void *value
 ) {
 return map->cl->put(map, cx_hash_key_str(key), value);
 }
 * @param key the key
 * @return the value
 */
 __attribute__((__nonnull__, __warn_unused_result__))
 static inline void *cxMapGet(
-CxMap const *map,
+const CxMap *map,
 CxHashKey const &key
 ) {
 return map->cl->get(map, key);
 }
 * @param key the key
 * @return the value
 */
 __attribute__((__nonnull__, __warn_unused_result__))
 static inline void *cxMapGet(
-CxMap const *map,
+const CxMap *map,
 cxstring const &key
 ) {
 return map->cl->get(map, cx_hash_key_cxstr(key));
 }
 * @param key the key
 * @return the value
 */
 __attribute__((__nonnull__, __warn_unused_result__))
 static inline void *cxMapGet(
-CxMap const *map,
+const CxMap *map,
 cxmutstr const &key
 ) {
 return map->cl->get(map, cx_hash_key_cxstr(key));
 }
 * @param key the key
 * @return the value
 */
 __attribute__((__nonnull__, __warn_unused_result__))
 static inline void *cxMapGet(
-CxMap const *map,
+const CxMap *map,
-char const *key
+const char *key
 ) {
 return map->cl->get(map, cx_hash_key_str(key));
 }
 /**
 * @see cxMapDetach()
 */
 __attribute__((__nonnull__))
 static inline void cxMapRemove(
 CxMap *map,
-char const *key
+const char *key
 ) {
 (void) map->cl->remove(map, cx_hash_key_str(key), true);
 }
 /**
 * @see cxMapRemoveAndGet()
 */
 __attribute__((__nonnull__))
 static inline void cxMapDetach(
 CxMap *map,
-char const *key
+const char *key
 ) {
 (void) map->cl->remove(map, cx_hash_key_str(key), false);
 }
 /**
 * @see cxMapDetach()
 */
 __attribute__((__nonnull__, __warn_unused_result__))
 static inline void *cxMapRemoveAndGet(
 CxMap *map,
-char const *key
+const char *key
 ) {
 return map->cl->remove(map, cx_hash_key_str(key), !map->store_pointer);
 }
 #else // __cplusplus
 * @return 0 on success, non-zero value on failure
 */
 __attribute__((__nonnull__))
 static inline int cx_map_put_str(
 CxMap *map,
-char const *key,
+const char *key,
 void *value
 ) {
 return map->cl->put(map, cx_hash_key_str(key), value);
 }
 #define cxMapPut(map, key, value) _Generic((key), \
 CxHashKey: cx_map_put,                        \
 cxstring: cx_map_put_cxstr,                   \
 cxmutstr: cx_map_put_mustr,                   \
 char*: cx_map_put_str,                        \
-char const*: cx_map_put_str)                  \
+const char*: cx_map_put_str)                  \
 (map, key, value)
 /**
 * Retrieves a value by using a key.
 *
 * @param key the key
 * @return the value
 */
 __attribute__((__nonnull__, __warn_unused_result__))
 static inline void *cx_map_get(
-CxMap const *map,
+const CxMap *map,
 CxHashKey key
 ) {
 return map->cl->get(map, key);
 }
 * @param key the key
 * @return the value
 */
 __attribute__((__nonnull__, __warn_unused_result__))
 static inline void *cx_map_get_cxstr(
-CxMap const *map,
+const CxMap *map,
 cxstring key
 ) {
 return map->cl->get(map, cx_hash_key_cxstr(key));
 }
 * @param key the key
 * @return the value
 */
 __attribute__((__nonnull__, __warn_unused_result__))
 static inline void *cx_map_get_mustr(
-CxMap const *map,
+const CxMap *map,
 cxmutstr key
 ) {
 return map->cl->get(map, cx_hash_key_cxstr(key));
 }
 * @param key the key
 * @return the value
 */
 __attribute__((__nonnull__, __warn_unused_result__))
 static inline void *cx_map_get_str(
-CxMap const *map,
+const CxMap *map,
-char const *key
+const char *key
 ) {
 return map->cl->get(map, cx_hash_key_str(key));
 }
 /**
 #define cxMapGet(map, key) _Generic((key), \
 CxHashKey: cx_map_get,                 \
 cxstring: cx_map_get_cxstr,            \
 cxmutstr: cx_map_get_mustr,            \
 char*: cx_map_get_str,                 \
-char const*: cx_map_get_str)           \
+const char*: cx_map_get_str)           \
 (map, key)
 /**
 * Removes a key/value-pair from the map by using the key.
 *
 * @param key the key
 */
 __attribute__((__nonnull__))
 static inline void cx_map_remove_str(
 CxMap *map,
-char const *key
+const char *key
 ) {
 (void) map->cl->remove(map, cx_hash_key_str(key), true);
 }
 /**
 #define cxMapRemove(map, key) _Generic((key), \
 CxHashKey: cx_map_remove,                 \
 cxstring: cx_map_remove_cxstr,            \
 cxmutstr: cx_map_remove_mustr,            \
 char*: cx_map_remove_str,                 \
-char const*: cx_map_remove_str)           \
+const char*: cx_map_remove_str)           \
 (map, key)
 /**
 * Detaches a key/value-pair from the map by using the key
 * without invoking the destructor.
 * @param key the key
 */
 __attribute__((__nonnull__))
 static inline void cx_map_detach_str(
 CxMap *map,
-char const *key
+const char *key
 ) {
 (void) map->cl->remove(map, cx_hash_key_str(key), false);
 }
 /**
 #define cxMapDetach(map, key) _Generic((key), \
 CxHashKey: cx_map_detach,                 \
 cxstring: cx_map_detach_cxstr,            \
 cxmutstr: cx_map_detach_mustr,            \
 char*: cx_map_detach_str,                 \
-char const*: cx_map_detach_str)           \
+const char*: cx_map_detach_str)           \
 (map, key)
 /**
 * Removes a key/value-pair from the map by using the key.
 *
 __attribute__((__nonnull__, __warn_unused_result__))
 static inline void *cx_map_remove_and_get(
 CxMap *map,
 CxHashKey key
 ) {
-return map->cl->remove(map, key, !map->store_pointer);
+return map->cl->remove(map, key, !map->collection.store_pointer);
 }
 /**
 * Removes a key/value-pair from the map by using the key.
 *
 __attribute__((__nonnull__, __warn_unused_result__))
 static inline void *cx_map_remove_and_get_cxstr(
 CxMap *map,
 cxstring key
 ) {
-return map->cl->remove(map, cx_hash_key_cxstr(key), !map->store_pointer);
+return map->cl->remove(map, cx_hash_key_cxstr(key), !map->collection.store_pointer);
 }
 /**
 * Removes a key/value-pair from the map by using the key.
 *
 __attribute__((__nonnull__, __warn_unused_result__))
 static inline void *cx_map_remove_and_get_mustr(
 CxMap *map,
 cxmutstr key
 ) {
-return map->cl->remove(map, cx_hash_key_cxstr(key), !map->store_pointer);
+return map->cl->remove(map, cx_hash_key_cxstr(key), !map->collection.store_pointer);
 }
 /**
 * Removes a key/value-pair from the map by using the key.
 *
 * in the map or the map is not storing pointers
 */
 __attribute__((__nonnull__, __warn_unused_result__))
 static inline void *cx_map_remove_and_get_str(
 CxMap *map,
-char const *key
+const char *key
 ) {
-return map->cl->remove(map, cx_hash_key_str(key), !map->store_pointer);
+return map->cl->remove(map, cx_hash_key_str(key), !map->collection.store_pointer);
 }
 /**
 * Removes a key/value-pair from the map by using the key.
 *
 #define cxMapRemoveAndGet(map, key) _Generic((key), \
 CxHashKey: cx_map_remove_and_get,               \
 cxstring: cx_map_remove_and_get_cxstr,          \
 cxmutstr: cx_map_remove_and_get_mustr,          \
 char*: cx_map_remove_and_get_str,               \
-char const*: cx_map_remove_and_get_str)         \
+const char*: cx_map_remove_and_get_str)         \
 (map, key)
 #endif // __cplusplus
 #endif // UCX_MAP_H

Mercurial > hg > toolkit / file comparison

comparison: ucx/cx/map.h

ucx/cx/map.h