dav: comparison ucx/cx/map.h

-:591377a27fa3
+:da79af4baec8
 */
 void (*clear)(struct cx_map_s *map);
 /**
 * Add or overwrite an element.
-*/
+* If the @p value is @c NULL, the implementation
-int (*put)(
+* shall only allocate memory instead of adding an existing value to the map.
+* Returns a pointer to the allocated memory or @c NULL if allocation fails.
+*/
+void *(*put)(
 CxMap *map,
 CxHashKey key,
 void *value
 );
 * respective elements are stored.
 *
 * @note An iterator iterates over all elements successively. Therefore, the order
 * highly depends on the map implementation and may change arbitrarily when the contents change.
 *
-* @param map the map to create the iterator for
+* @param map the map to create the iterator for (can be @c NULL)
 * @return an iterator for the currently stored values
 */
-cx_attr_nonnull
 cx_attr_nodiscard
 static inline CxMapIterator cxMapIteratorValues(const CxMap *map) {
+if (map == NULL) map = cxEmptyMap;
 return map->cl->iterator(map, CX_MAP_ITERATOR_VALUES);
 }
 /**
 * Creates a key iterator for a map.
 * during iterator shall be treated as @c const @c CxHashKey* .
 *
 * @note An iterator iterates over all elements successively. Therefore, the order
 * highly depends on the map implementation and may change arbitrarily when the contents change.
 *
-* @param map the map to create the iterator for
+* @param map the map to create the iterator for (can be @c NULL)
 * @return an iterator for the currently stored keys
 */
-cx_attr_nonnull
 cx_attr_nodiscard
 static inline CxMapIterator cxMapIteratorKeys(const CxMap *map) {
+if (map == NULL) map = cxEmptyMap;
 return map->cl->iterator(map, CX_MAP_ITERATOR_KEYS);
 }
 /**
 * Creates an iterator for a map.
 * during iterator shall be treated as @c const @c CxMapEntry* .
 *
 * @note An iterator iterates over all elements successively. Therefore, the order
 * highly depends on the map implementation and may change arbitrarily when the contents change.
 *
-* @param map the map to create the iterator for
+* @param map the map to create the iterator for (can be @c NULL)
 * @return an iterator for the currently stored entries
 * @see cxMapIteratorKeys()
 * @see cxMapIteratorValues()
 */
-cx_attr_nonnull
 cx_attr_nodiscard
 static inline CxMapIterator cxMapIterator(const CxMap *map) {
+if (map == NULL) map = cxEmptyMap;
 return map->cl->iterator(map, CX_MAP_ITERATOR_PAIRS);
 }
 /**
 * respective elements are stored.
 *
 * @note An iterator iterates over all elements successively. Therefore, the order
 * highly depends on the map implementation and may change arbitrarily when the contents change.
 *
-* @param map the map to create the iterator for
+* @param map the map to create the iterator for (can be @c NULL)
 * @return an iterator for the currently stored values
 */
-cx_attr_nonnull
 cx_attr_nodiscard
 cx_attr_export
 CxMapIterator cxMapMutIteratorValues(CxMap *map);
 /**
 * during iterator shall be treated as @c const @c CxHashKey* .
 *
 * @note An iterator iterates over all elements successively. Therefore, the order
 * highly depends on the map implementation and may change arbitrarily when the contents change.
 *
-* @param map the map to create the iterator for
+* @param map the map to create the iterator for (can be @c NULL)
 * @return an iterator for the currently stored keys
 */
-cx_attr_nonnull
 cx_attr_nodiscard
 cx_attr_export
 CxMapIterator cxMapMutIteratorKeys(CxMap *map);
 /**
 * during iterator shall be treated as @c const @c CxMapEntry* .
 *
 * @note An iterator iterates over all elements successively. Therefore, the order
 * highly depends on the map implementation and may change arbitrarily when the contents change.
 *
-* @param map the map to create the iterator for
+* @param map the map to create the iterator for (can be @c NULL)
 * @return an iterator for the currently stored entries
 * @see cxMapMutIteratorKeys()
 * @see cxMapMutIteratorValues()
 */
-cx_attr_nonnull
 cx_attr_nodiscard
 cx_attr_export
 CxMapIterator cxMapMutIterator(CxMap *map);
 #ifdef __cplusplus
 static inline int cxMapPut(
 CxMap *map,
 CxHashKey const &key,
 void *value
 ) {
-return map->cl->put(map, key, value);
+return map->cl->put(map, key, value) == NULL;
 }
 cx_attr_nonnull
 static inline int cxMapPut(
 CxMap *map,
 cxstring const &key,
 void *value
 ) {
-return map->cl->put(map, cx_hash_key_cxstr(key), value);
+return map->cl->put(map, cx_hash_key_cxstr(key), value) == NULL;
 }
 cx_attr_nonnull
 static inline int cxMapPut(
 CxMap *map,
 cxmutstr const &key,
 void *value
 ) {
-return map->cl->put(map, cx_hash_key_cxstr(key), value);
+return map->cl->put(map, cx_hash_key_cxstr(key), value) == NULL;
 }
 cx_attr_nonnull
 cx_attr_cstr_arg(2)
 static inline int cxMapPut(
 CxMap *map,
 const char *key,
 void *value
 ) {
-return map->cl->put(map, cx_hash_key_str(key), value);
+return map->cl->put(map, cx_hash_key_str(key), value) == NULL;
+}
+cx_attr_nonnull
+static inline void *cxMapEmplace(
+CxMap *map,
+CxHashKey const &key
+) {
+return map->cl->put(map, key, NULL);
+}
+cx_attr_nonnull
+static inline void *cxMapEmplace(
+CxMap *map,
+cxstring const &key
+) {
+return map->cl->put(map, cx_hash_key_cxstr(key), NULL);
+}
+cx_attr_nonnull
+static inline void *cxMapEmplace(
+CxMap *map,
+cxmutstr const &key
+) {
+return map->cl->put(map, cx_hash_key_cxstr(key), NULL);
+}
+cx_attr_nonnull
+cx_attr_cstr_arg(2)
+static inline void *cxMapEmplace(
+CxMap *map,
+const char *key
+) {
+return map->cl->put(map, cx_hash_key_str(key), NULL);
 }
 cx_attr_nonnull
 cx_attr_nodiscard
 static inline void *cxMapGet(
 static inline int cx_map_put(
 CxMap *map,
 CxHashKey key,
 void *value
 ) {
-return map->cl->put(map, key, value);
+return map->cl->put(map, key, value) == NULL;
 }
 /**
 * @copydoc cxMapPut()
 */
 static inline int cx_map_put_cxstr(
 CxMap *map,
 cxstring key,
 void *value
 ) {
-return map->cl->put(map, cx_hash_key_cxstr(key), value);
+return map->cl->put(map, cx_hash_key_cxstr(key), value) == NULL;
 }
 /**
 * @copydoc cxMapPut()
 */
 static inline int cx_map_put_mustr(
 CxMap *map,
 cxmutstr key,
 void *value
 ) {
-return map->cl->put(map, cx_hash_key_cxstr(key), value);
+return map->cl->put(map, cx_hash_key_cxstr(key), value) == NULL;
 }
 /**
 * @copydoc cxMapPut()
 */
 static inline int cx_map_put_str(
 CxMap *map,
 const char *key,
 void *value
 ) {
-return map->cl->put(map, cx_hash_key_str(key), value);
+return map->cl->put(map, cx_hash_key_str(key), value) == NULL;
 }
 /**
 * Puts a key/value-pair into the map.
 *
 char*: cx_map_put_str,                        \
 const char*: cx_map_put_str)                  \
 (map, key, value)
 /**
+* @copydoc cxMapEmplace()
+*/
+cx_attr_nonnull
+static inline void *cx_map_emplace(
+CxMap *map,
+CxHashKey key
+) {
+return map->cl->put(map, key, NULL);
+}
+/**
+* @copydoc cxMapEmplace()
+*/
+cx_attr_nonnull
+static inline void *cx_map_emplace_cxstr(
+CxMap *map,
+cxstring key
+) {
+return map->cl->put(map, cx_hash_key_cxstr(key), NULL);
+}
+/**
+* @copydoc cxMapEmplace()
+*/
+cx_attr_nonnull
+static inline void *cx_map_emplace_mustr(
+CxMap *map,
+cxmutstr key
+) {
+return map->cl->put(map, cx_hash_key_cxstr(key), NULL);
+}
+/**
+* @copydoc cxMapEmplace()
+*/
+cx_attr_nonnull
+cx_attr_cstr_arg(2)
+static inline void *cx_map_emplace_str(
+CxMap *map,
+const char *key
+) {
+return map->cl->put(map, cx_hash_key_str(key), NULL);
+}
+/**
+* Allocates memory for a value in the map associated with the specified key.
+*
+* A possible existing value will be overwritten.
+* If destructor functions are specified, they are called for
+* the overwritten element.
+*
+* If the map is storing pointers, this function returns a @c void** pointer,
+* meaning a pointer to that pointer.
+*
+* The @p key is always copied.
+*
+* @param map (@c CxMap*) the map
+* @param key (@c CxHashKey, @c char*, @c cxstring, or @c cxmutstr) the key
+* @return the pointer to the allocated memory or @c NULL if allocation fails
+* @retval zero success
+* @retval non-zero value on memory allocation failure
+*/
+#define cxMapEmplace(map, key) _Generic((key), \
+CxHashKey: cx_map_emplace,                 \
+cxstring: cx_map_emplace_cxstr,            \
+cxmutstr: cx_map_emplace_mustr,            \
+char*: cx_map_emplace_str,                 \
+const char*: cx_map_emplace_str)           \
+(map, key)
+/**
 * @copydoc cxMapGet()
 */
 cx_attr_nonnull
 cx_attr_nodiscard
 static inline void *cx_map_get(

Mercurial > hg > dav / file comparison

comparison: ucx/cx/map.h

ucx/cx/map.h