dbutils: comparison ucx/cx/map.h

-:80f9d007cb52
+:0aa8cbd7912e
 */
 struct cx_map_class_s {
 /**
 * Deallocates the entire memory.
 */
-__attribute__((__nonnull__))
+cx_attr_nonnull
-void (*destructor)(struct cx_map_s *map);
+void (*deallocate)(struct cx_map_s *map);
 /**
 * Removes all elements.
 */
-__attribute__((__nonnull__))
+cx_attr_nonnull
 void (*clear)(struct cx_map_s *map);
 /**
 * Add or overwrite an element.
 */
-__attribute__((__nonnull__))
+cx_attr_nonnull
 int (*put)(
 CxMap *map,
 CxHashKey key,
 void *value
 );
 /**
 * Returns an element.
 */
-__attribute__((__nonnull__, __warn_unused_result__))
+cx_attr_nonnull
+cx_attr_nodiscard
 void *(*get)(
-CxMap const *map,
+const CxMap *map,
 CxHashKey key
 );
 /**
 * Removes an element.
-*/
+*
-__attribute__((__nonnull__))
+* Implementations SHALL check if \p targetbuf is set and copy the elements
-void *(*remove)(
+* to the buffer without invoking any destructor.
+* When \p targetbuf is not set, the destructors SHALL be invoked.
+*
+* The function SHALL return zero when the \p key was found and
+* non-zero, otherwise.
+*/
+cx_attr_nonnull_arg(1)
+cx_attr_access_w(3)
+int (*remove)(
 CxMap *map,
 CxHashKey key,
-bool destroy
+void *targetbuf
 );
 /**
 * Creates an iterator for this map.
 */
-__attribute__((__nonnull__, __warn_unused_result__))
+cx_attr_nonnull
-CxIterator (*iterator)(CxMap const *map, enum cx_map_iterator_type type);
+cx_attr_nodiscard
+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;
 };
 /**
 * A shared instance of an empty map.
 *
-* Writing to that map is undefined.
+* Writing to that map is not allowed.
 */
 extern CxMap *const cxEmptyMap;
 /**
 * Advises the map to store copies of the objects (default mode of operation).
 * within this list.
 *
 * @param map the map
 * @see cxMapStorePointers()
 */
-__attribute__((__nonnull__))
+cx_attr_nonnull
 static inline void cxMapStoreObjects(CxMap *map) {
 map->collection.store_pointer = false;
 }
 /**
 * objects is undefined.
 *
 * @param map the map
 * @see cxMapStoreObjects()
 */
-__attribute__((__nonnull__))
+cx_attr_nonnull
 static inline void cxMapStorePointers(CxMap *map) {
 map->collection.store_pointer = true;
 map->collection.elem_size = sizeof(void *);
 }
 *
 * @param map
 * @return true, if this map is storing pointers
 * @see cxMapStorePointers()
 */
-__attribute__((__nonnull__))
+cx_attr_nonnull
-static inline bool cxMapIsStoringPointers(CxMap const *map) {
+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
+* @param map the map to be freed
 */
-__attribute__((__nonnull__))
+static inline void cxMapFree(CxMap *map) {
-static inline void cxMapDestroy(CxMap *map) {
+if (map == NULL) return;
-map->cl->destructor(map);
+map->cl->deallocate(map);
 }
 /**
 * Clears a map by removing all elements.
 *
 * @param map the map to be cleared
 */
-__attribute__((__nonnull__))
+cx_attr_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__))
+cx_attr_nonnull
-static inline size_t cxMapSize(CxMap const *map) {
+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.
 *
-* \note An iterator iterates over all elements successively. Therefore the order
+* \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
 * @return an iterator for the currently stored values
 */
-__attribute__((__nonnull__, __warn_unused_result__))
+cx_attr_nonnull
-static inline CxIterator cxMapIteratorValues(CxMap const *map) {
+cx_attr_nodiscard
+static inline CxIterator cxMapIteratorValues(const CxMap *map) {
 return map->cl->iterator(map, CX_MAP_ITERATOR_VALUES);
 }
 /**
 * Creates a key iterator for a map.
 *
 * The elements of the iterator are keys of type CxHashKey.
 *
-* \note An iterator iterates over all elements successively. Therefore the order
+* \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
 * @return an iterator for the currently stored keys
 */
-__attribute__((__nonnull__, __warn_unused_result__))
+cx_attr_nonnull
-static inline CxIterator cxMapIteratorKeys(CxMap const *map) {
+cx_attr_nodiscard
+static inline CxIterator cxMapIteratorKeys(const CxMap *map) {
 return map->cl->iterator(map, CX_MAP_ITERATOR_KEYS);
 }
 /**
 * Creates an iterator for a map.
 *
 * The elements of the iterator are key/value pairs of type CxMapEntry.
 *
-* \note An iterator iterates over all elements successively. Therefore the order
+* \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
 * @return an iterator for the currently stored entries
 * @see cxMapIteratorKeys()
 * @see cxMapIteratorValues()
 */
-__attribute__((__nonnull__, __warn_unused_result__))
+cx_attr_nonnull
-static inline CxIterator cxMapIterator(CxMap const *map) {
+cx_attr_nodiscard
+static inline CxIterator cxMapIterator(const CxMap *map) {
 return map->cl->iterator(map, CX_MAP_ITERATOR_PAIRS);
 }
 /**
 * Creates a mutating iterator over the values of a map.
 *
-* \note An iterator iterates over all elements successively. Therefore the order
+* \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
 * @return an iterator for the currently stored values
 */
-__attribute__((__nonnull__, __warn_unused_result__))
+cx_attr_nonnull
+cx_attr_nodiscard
 CxIterator cxMapMutIteratorValues(CxMap *map);
 /**
 * Creates a mutating iterator over the keys of a map.
 *
 * The elements of the iterator are keys of type CxHashKey.
 *
-* \note An iterator iterates over all elements successively. Therefore the order
+* \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
 * @return an iterator for the currently stored keys
 */
-__attribute__((__nonnull__, __warn_unused_result__))
+cx_attr_nonnull
+cx_attr_nodiscard
 CxIterator cxMapMutIteratorKeys(CxMap *map);
 /**
 * Creates a mutating iterator for a map.
 *
 * The elements of the iterator are key/value pairs of type CxMapEntry.
 *
-* \note An iterator iterates over all elements successively. Therefore the order
+* \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
 * @return an iterator for the currently stored entries
 * @see cxMapMutIteratorKeys()
 * @see cxMapMutIteratorValues()
 */
-__attribute__((__nonnull__, __warn_unused_result__))
+cx_attr_nonnull
+cx_attr_nodiscard
 CxIterator cxMapMutIterator(CxMap *map);
 #ifdef __cplusplus
 } // end the extern "C" block here, because we want to start overloading
 * @param map the map
 * @param key the key
 * @param value the value
 * @return 0 on success, non-zero value on failure
 */
-__attribute__((__nonnull__))
+cx_attr_nonnull
 static inline int cxMapPut(
 CxMap *map,
 CxHashKey const &key,
 void *value
 ) {
 * @param map the map
 * @param key the key
 * @param value the value
 * @return 0 on success, non-zero value on failure
 */
-__attribute__((__nonnull__))
+cx_attr_nonnull
 static inline int cxMapPut(
 CxMap *map,
 cxstring const &key,
 void *value
 ) {
 * @param map the map
 * @param key the key
 * @param value the value
 * @return 0 on success, non-zero value on failure
 */
-__attribute__((__nonnull__))
+cx_attr_nonnull
 static inline int cxMapPut(
 CxMap *map,
 cxmutstr const &key,
 void *value
 ) {
 * @param map the map
 * @param key the key
 * @param value the value
 * @return 0 on success, non-zero value on failure
 */
-__attribute__((__nonnull__))
+cx_attr_nonnull
+cx_attr_cstr_arg(2)
 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 map the map
 * @param key the key
 * @return the value
 */
-__attribute__((__nonnull__, __warn_unused_result__))
+cx_attr_nonnull
+cx_attr_nodiscard
 static inline void *cxMapGet(
-CxMap const *map,
+const CxMap *map,
 CxHashKey const &key
 ) {
 return map->cl->get(map, key);
 }
 *
 * @param map the map
 * @param key the key
 * @return the value
 */
-__attribute__((__nonnull__, __warn_unused_result__))
+cx_attr_nonnull
+cx_attr_nodiscard
 static inline void *cxMapGet(
-CxMap const *map,
+const CxMap *map,
 cxstring const &key
 ) {
 return map->cl->get(map, cx_hash_key_cxstr(key));
 }
 *
 * @param map the map
 * @param key the key
 * @return the value
 */
-__attribute__((__nonnull__, __warn_unused_result__))
+cx_attr_nonnull
+cx_attr_nodiscard
 static inline void *cxMapGet(
-CxMap const *map,
+const CxMap *map,
 cxmutstr const &key
 ) {
 return map->cl->get(map, cx_hash_key_cxstr(key));
 }
 *
 * @param map the map
 * @param key the key
 * @return the value
 */
-__attribute__((__nonnull__, __warn_unused_result__))
+cx_attr_nonnull
+cx_attr_nodiscard
+cx_attr_cstr_arg(2)
 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));
 }
 /**
 * Removes a key/value-pair from the map by using the key.
 *
-* Always invokes the destructor function, if any, on the removed element.
+* Always invokes the destructors functions, if any, on the removed element.
-* If this map is storing pointers and you just want to retrieve the pointer
+*
-* without invoking the destructor, use cxMapRemoveAndGet().
+* @param map the map
-* If you just want to detach the element from the map without invoking the
+* @param key the key
-* destructor or returning the element, use cxMapDetach().
+* @return zero on success, non-zero if the key was not found
 *
-* @param map the map
-* @param key the key
 * @see cxMapRemoveAndGet()
-* @see cxMapDetach()
+*/
-*/
+cx_attr_nonnull
-__attribute__((__nonnull__))
+static inline int cxMapRemove(
-static inline void cxMapRemove(
 CxMap *map,
 CxHashKey const &key
 ) {
-(void) map->cl->remove(map, key, true);
+return map->cl->remove(map, key, nullptr);
 }
 /**
 * Removes a key/value-pair from the map by using the key.
 *
-* Always invokes the destructor function, if any, on the removed element.
+* Always invokes the destructors functions, if any, on the removed element.
-* If this map is storing pointers and you just want to retrieve the pointer
+*
-* without invoking the destructor, use cxMapRemoveAndGet().
+* @param map the map
-* If you just want to detach the element from the map without invoking the
+* @param key the key
-* destructor or returning the element, use cxMapDetach().
+* @return zero on success, non-zero if the key was not found
 *
-* @param map the map
-* @param key the key
 * @see cxMapRemoveAndGet()
-* @see cxMapDetach()
+*/
-*/
+cx_attr_nonnull
-__attribute__((__nonnull__))
+static inline int cxMapRemove(
-static inline void cxMapRemove(
 CxMap *map,
 cxstring const &key
 ) {
-(void) map->cl->remove(map, cx_hash_key_cxstr(key), true);
+return map->cl->remove(map, cx_hash_key_cxstr(key), nullptr);
 }
 /**
 * Removes a key/value-pair from the map by using the key.
 *
-* Always invokes the destructor function, if any, on the removed element.
+* Always invokes the destructors functions, if any, on the removed element.
-* If this map is storing pointers and you just want to retrieve the pointer
+*
-* without invoking the destructor, use cxMapRemoveAndGet().
+* @param map the map
-* If you just want to detach the element from the map without invoking the
+* @param key the key
-* destructor or returning the element, use cxMapDetach().
+* @return zero on success, non-zero if the key was not found
 *
-* @param map the map
-* @param key the key
 * @see cxMapRemoveAndGet()
-* @see cxMapDetach()
+*/
-*/
+cx_attr_nonnull
-__attribute__((__nonnull__))
+static inline int cxMapRemove(
-static inline void cxMapRemove(
 CxMap *map,
 cxmutstr const &key
 ) {
-(void) map->cl->remove(map, cx_hash_key_cxstr(key), true);
+return map->cl->remove(map, cx_hash_key_cxstr(key), nullptr);
 }
 /**
 * Removes a key/value-pair from the map by using the key.
 *
-* Always invokes the destructor function, if any, on the removed element.
+* Always invokes the destructors functions, if any, on the removed element.
-* If this map is storing pointers and you just want to retrieve the pointer
+*
-* without invoking the destructor, use cxMapRemoveAndGet().
+* @param map the map
-* If you just want to detach the element from the map without invoking the
+* @param key the key
-* destructor or returning the element, use cxMapDetach().
+* @return zero on success, non-zero if the key was not found
 *
-* @param map the map
-* @param key the key
 * @see cxMapRemoveAndGet()
-* @see cxMapDetach()
+*/
-*/
+cx_attr_nonnull
-__attribute__((__nonnull__))
+cx_attr_cstr_arg(2)
-static inline void cxMapRemove(
+static inline int cxMapRemove(
 CxMap *map,
-char const *key
+const char *key
 ) {
-(void) map->cl->remove(map, cx_hash_key_str(key), true);
+return map->cl->remove(map, cx_hash_key_str(key), nullptr);
 }
 /**
-* Detaches a key/value-pair from the map by using the key
+* Removes a key/value-pair from the map by using the key.
-* without invoking the destructor.
+*
-*
+* This function will copy the contents to the target buffer
-* In general, you should only use this function if the map does not own
+* which must be guaranteed to be large enough to hold the element.
-* the data and there is a valid reference to the data somewhere else
+* The destructor functions, if any, will \em not be called.
-* in the program. In all other cases it is preferable to use
+*
-* cxMapRemove() or cxMapRemoveAndGet().
+* If this map is storing pointers, the element is the pointer itself
-*
+* and not the object it points to.
-* @param map the map
+*
-* @param key the key
+* @param map the map
+* @param key the key
+* @param targetbuf the buffer where the element shall be copied to
+* @return zero on success, non-zero if the key was not found
+*
+* @see cxMapStorePointers()
 * @see cxMapRemove()
-* @see cxMapRemoveAndGet()
+*/
-*/
+cx_attr_nonnull
-__attribute__((__nonnull__))
+cx_attr_access_w(3)
-static inline void cxMapDetach(
+static inline int cxMapRemoveAndGet(
 CxMap *map,
-CxHashKey const &key
+CxHashKey key,
-) {
+void *targetbuf
-(void) map->cl->remove(map, key, false);
+) {
-}
+return map->cl->remove(map, key, targetbuf);
+}
-/**
-* Detaches a key/value-pair from the map by using the key
+/**
-* without invoking the destructor.
+* Removes a key/value-pair from the map by using the key.
 *
-* In general, you should only use this function if the map does not own
+* This function will copy the contents to the target buffer
-* the data and there is a valid reference to the data somewhere else
+* which must be guaranteed to be large enough to hold the element.
-* in the program. In all other cases it is preferable to use
+* The destructor functions, if any, will \em not be called.
-* cxMapRemove() or cxMapRemoveAndGet().
+*
-*
+* If this map is storing pointers, the element is the pointer itself
-* @param map the map
+* and not the object it points to.
-* @param key the key
+*
+* @param map the map
+* @param key the key
+* @param targetbuf the buffer where the element shall be copied to
+* @return zero on success, non-zero if the key was not found
+*
+* @see cxMapStorePointers()
 * @see cxMapRemove()
-* @see cxMapRemoveAndGet()
+*/
-*/
+cx_attr_nonnull
-__attribute__((__nonnull__))
+cx_attr_access_w(3)
-static inline void cxMapDetach(
+static inline int cxMapRemoveAndGet(
 CxMap *map,
-cxstring const &key
+cxstring key,
-) {
+void *targetbuf
-(void) map->cl->remove(map, cx_hash_key_cxstr(key), false);
+) {
-}
+return map->cl->remove(map, cx_hash_key_cxstr(key), targetbuf);
+}
-/**
-* Detaches a key/value-pair from the map by using the key
+/**
-* without invoking the destructor.
+* Removes a key/value-pair from the map by using the key.
 *
-* In general, you should only use this function if the map does not own
+* This function will copy the contents to the target buffer
-* the data and there is a valid reference to the data somewhere else
+* which must be guaranteed to be large enough to hold the element.
-* in the program. In all other cases it is preferable to use
+* The destructor functions, if any, will \em not be called.
-* cxMapRemove() or cxMapRemoveAndGet().
+*
-*
+* If this map is storing pointers, the element is the pointer itself
-* @param map the map
+* and not the object it points to.
-* @param key the key
+*
+* @param map the map
+* @param key the key
+* @param targetbuf the buffer where the element shall be copied to
+* @return zero on success, non-zero if the key was not found
+*
+* @see cxMapStorePointers()
 * @see cxMapRemove()
-* @see cxMapRemoveAndGet()
+*/
-*/
+cx_attr_nonnull
-__attribute__((__nonnull__))
+cx_attr_access_w(3)
-static inline void cxMapDetach(
+static inline int cxMapRemoveAndGet(
 CxMap *map,
-cxmutstr const &key
+cxmutstr key,
-) {
+void *targetbuf
-(void) map->cl->remove(map, cx_hash_key_cxstr(key), false);
+) {
-}
+return map->cl->remove(map, cx_hash_key_cxstr(key), targetbuf);
+}
-/**
-* Detaches a key/value-pair from the map by using the key
+/**
-* without invoking the destructor.
+* Removes a key/value-pair from the map by using the key.
 *
-* In general, you should only use this function if the map does not own
+* This function will copy the contents to the target buffer
-* the data and there is a valid reference to the data somewhere else
+* which must be guaranteed to be large enough to hold the element.
-* in the program. In all other cases it is preferable to use
+* The destructor functions, if any, will \em not be called.
-* cxMapRemove() or cxMapRemoveAndGet().
+*
-*
+* If this map is storing pointers, the element is the pointer itself
-* @param map the map
+* and not the object it points to.
-* @param key the key
+*
+* @param map the map
+* @param key the key
+* @param targetbuf the buffer where the element shall be copied to
+* @return zero on success, non-zero if the key was not found
+*
+* @see cxMapStorePointers()
 * @see cxMapRemove()
-* @see cxMapRemoveAndGet()
+*/
-*/
+cx_attr_nonnull
-__attribute__((__nonnull__))
+cx_attr_access_w(3)
-static inline void cxMapDetach(
+cx_attr_cstr_arg(2)
-CxMap *map,
+static inline int cxMapRemoveAndGet(
-char const *key
+CxMap *map,
-) {
+const char *key,
-(void) map->cl->remove(map, cx_hash_key_str(key), false);
+void *targetbuf
-}
+) {
+return map->cl->remove(map, cx_hash_key_str(key), targetbuf);
-/**
-* Removes a key/value-pair from the map by using the key.
-*
-* This function can be used when the map is storing pointers,
-* in order to retrieve the pointer from the map without invoking
-* any destructor function. Sometimes you do not want the pointer
-* to be returned - in that case (instead of suppressing the "unused
-* result" warning) you can use cxMapDetach().
-*
-* If this map is not storing pointers, this function behaves like
-* cxMapRemove() and returns \c NULL.
-*
-* @param map the map
-* @param key the key
-* @return the stored pointer or \c NULL if either the key is not present
-* in the map or the map is not storing pointers
-* @see cxMapStorePointers()
-* @see cxMapDetach()
-*/
-__attribute__((__nonnull__, __warn_unused_result__))
-static inline void *cxMapRemoveAndGet(
-CxMap *map,
-CxHashKey key
-) {
-return map->cl->remove(map, key, !map->store_pointer);
-}
-/**
-* Removes a key/value-pair from the map by using the key.
-*
-* This function can be used when the map is storing pointers,
-* in order to retrieve the pointer from the map without invoking
-* any destructor function. Sometimes you do not want the pointer
-* to be returned - in that case (instead of suppressing the "unused
-* result" warning) you can use cxMapDetach().
-*
-* If this map is not storing pointers, this function behaves like
-* cxMapRemove() and returns \c NULL.
-*
-* @param map the map
-* @param key the key
-* @return the stored pointer or \c NULL if either the key is not present
-* in the map or the map is not storing pointers
-* @see cxMapStorePointers()
-* @see cxMapDetach()
-*/
-__attribute__((__nonnull__, __warn_unused_result__))
-static inline void *cxMapRemoveAndGet(
-CxMap *map,
-cxstring key
-) {
-return map->cl->remove(map, cx_hash_key_cxstr(key), !map->store_pointer);
-}
-/**
-* Removes a key/value-pair from the map by using the key.
-*
-* This function can be used when the map is storing pointers,
-* in order to retrieve the pointer from the map without invoking
-* any destructor function. Sometimes you do not want the pointer
-* to be returned - in that case (instead of suppressing the "unused
-* result" warning) you can use cxMapDetach().
-*
-* If this map is not storing pointers, this function behaves like
-* cxMapRemove() and returns \c NULL.
-*
-* @param map the map
-* @param key the key
-* @return the stored pointer or \c NULL if either the key is not present
-* in the map or the map is not storing pointers
-* @see cxMapStorePointers()
-* @see cxMapDetach()
-*/
-__attribute__((__nonnull__, __warn_unused_result__))
-static inline void *cxMapRemoveAndGet(
-CxMap *map,
-cxmutstr key
-) {
-return map->cl->remove(map, cx_hash_key_cxstr(key), !map->store_pointer);
-}
-/**
-* Removes a key/value-pair from the map by using the key.
-*
-* This function can be used when the map is storing pointers,
-* in order to retrieve the pointer from the map without invoking
-* any destructor function. Sometimes you do not want the pointer
-* to be returned - in that case (instead of suppressing the "unused
-* result" warning) you can use cxMapDetach().
-*
-* If this map is not storing pointers, this function behaves like
-* cxMapRemove() and returns \c NULL.
-*
-* @param map the map
-* @param key the key
-* @return the stored pointer or \c NULL if either the key is not present
-* in the map or the map is not storing pointers
-* @see cxMapStorePointers()
-* @see cxMapDetach()
-*/
-__attribute__((__nonnull__, __warn_unused_result__))
-static inline void *cxMapRemoveAndGet(
-CxMap *map,
-char const *key
-) {
-return map->cl->remove(map, cx_hash_key_str(key), !map->store_pointer);
 }
 #else // __cplusplus
 /**
 * @param map the map
 * @param key the key
 * @param value the value
 * @return 0 on success, non-zero value on failure
 */
-__attribute__((__nonnull__))
+cx_attr_nonnull
 static inline int cx_map_put(
 CxMap *map,
 CxHashKey key,
 void *value
 ) {
 * @param map the map
 * @param key the key
 * @param value the value
 * @return 0 on success, non-zero value on failure
 */
-__attribute__((__nonnull__))
+cx_attr_nonnull
 static inline int cx_map_put_cxstr(
 CxMap *map,
 cxstring key,
 void *value
 ) {
 * @param map the map
 * @param key the key
 * @param value the value
 * @return 0 on success, non-zero value on failure
 */
-__attribute__((__nonnull__))
+cx_attr_nonnull
 static inline int cx_map_put_mustr(
 CxMap *map,
 cxmutstr key,
 void *value
 ) {
 * @param map the map
 * @param key the key
 * @param value the value
 * @return 0 on success, non-zero value on failure
 */
-__attribute__((__nonnull__))
+cx_attr_nonnull
+cx_attr_cstr_arg(2)
 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 map the map
 * @param key the key
 * @return the value
 */
-__attribute__((__nonnull__, __warn_unused_result__))
+cx_attr_nonnull
+cx_attr_nodiscard
 static inline void *cx_map_get(
-CxMap const *map,
+const CxMap *map,
 CxHashKey key
 ) {
 return map->cl->get(map, key);
 }
 *
 * @param map the map
 * @param key the key
 * @return the value
 */
-__attribute__((__nonnull__, __warn_unused_result__))
+cx_attr_nonnull
+cx_attr_nodiscard
 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 map the map
 * @param key the key
 * @return the value
 */
-__attribute__((__nonnull__, __warn_unused_result__))
+cx_attr_nonnull
+cx_attr_nodiscard
 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 map the map
 * @param key the key
 * @return the value
 */
-__attribute__((__nonnull__, __warn_unused_result__))
+cx_attr_nonnull
+cx_attr_nodiscard
+cx_attr_cstr_arg(2)
 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 map the map
+* Always invokes the destructors functions, if any, on the removed element.
-* @param key the key
+*
-*/
+* @param map the map
-__attribute__((__nonnull__))
+* @param key the key
-static inline void cx_map_remove(
+* @return zero on success, non-zero if the key was not found
+*/
+cx_attr_nonnull
+static inline int cx_map_remove(
 CxMap *map,
 CxHashKey key
 ) {
-(void) map->cl->remove(map, key, true);
+return map->cl->remove(map, key, NULL);
 }
 /**
 * Removes a key/value-pair from the map by using the key.
 *
-* @param map the map
+* Always invokes the destructors functions, if any, on the removed element.
-* @param key the key
+*
-*/
+* @param map the map
-__attribute__((__nonnull__))
+* @param key the key
-static inline void cx_map_remove_cxstr(
+* @return zero on success, non-zero if the key was not found
+*/
+cx_attr_nonnull
+static inline int cx_map_remove_cxstr(
 CxMap *map,
 cxstring key
 ) {
-(void) map->cl->remove(map, cx_hash_key_cxstr(key), true);
+return map->cl->remove(map, cx_hash_key_cxstr(key), NULL);
 }
 /**
 * Removes a key/value-pair from the map by using the key.
 *
-* @param map the map
+* Always invokes the destructors functions, if any, on the removed element.
-* @param key the key
+*
-*/
+* @param map the map
-__attribute__((__nonnull__))
+* @param key the key
-static inline void cx_map_remove_mustr(
+* @return zero on success, non-zero if the key was not found
+*/
+cx_attr_nonnull
+static inline int cx_map_remove_mustr(
 CxMap *map,
 cxmutstr key
 ) {
-(void) map->cl->remove(map, cx_hash_key_cxstr(key), true);
+return map->cl->remove(map, cx_hash_key_cxstr(key), NULL);
 }
 /**
 * Removes a key/value-pair from the map by using the key.
 *
-* @param map the map
+* Always invokes the destructors functions, if any, on the removed element.
-* @param key the key
+*
-*/
+* @param map the map
-__attribute__((__nonnull__))
+* @param key the key
-static inline void cx_map_remove_str(
+* @return zero on success, non-zero if the key was not found
-CxMap *map,
+*/
-char const *key
+cx_attr_nonnull
-) {
+cx_attr_cstr_arg(2)
-(void) map->cl->remove(map, cx_hash_key_str(key), true);
+static inline int cx_map_remove_str(
-}
+CxMap *map,
+const char *key
-/**
+) {
-* Removes a key/value-pair from the map by using the key.
+return map->cl->remove(map, cx_hash_key_str(key), NULL);
-*
+}
-* Always invokes the destructor function, if any, on the removed element.
-* If this map is storing pointers and you just want to retrieve the pointer
+/**
-* without invoking the destructor, use cxMapRemoveAndGet().
+* Removes a key/value-pair from the map by using the key.
-* If you just want to detach the element from the map without invoking the
+*
-* destructor or returning the element, use cxMapDetach().
+* Always invokes the destructors functions, if any, on the removed element.
 *
 * @param map the map
 * @param key the key
+* @return zero on success, non-zero if the key was not found
+*
 * @see cxMapRemoveAndGet()
-* @see cxMapDetach()
 */
 #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
+* Removes a key/value-pair from the map by using the key.
-* without invoking the destructor.
+*
-*
+* This function will copy the contents to the target buffer
-* @param map the map
+* which must be guaranteed to be large enough to hold the element.
-* @param key the key
+* The destructor functions, if any, will \em not be called.
-*/
+*
-__attribute__((__nonnull__))
+* If this map is storing pointers, the element is the pointer itself
-static inline void cx_map_detach(
+* and not the object it points to.
-CxMap *map,
+*
-CxHashKey key
+* @param map the map
-) {
+* @param key the key
-(void) map->cl->remove(map, key, false);
+* @param targetbuf the buffer where the element shall be copied to
-}
+* @return zero on success, non-zero if the key was not found
+*/
-/**
+cx_attr_nonnull
-* Detaches a key/value-pair from the map by using the key
+cx_attr_access_w(3)
-* without invoking the destructor.
+static inline int cx_map_remove_and_get(
-*
+CxMap *map,
-* @param map the map
+CxHashKey key,
-* @param key the key
+void *targetbuf
-*/
+) {
-__attribute__((__nonnull__))
+return map->cl->remove(map, key, targetbuf);
-static inline void cx_map_detach_cxstr(
+}
-CxMap *map,
-cxstring key
+/**
-) {
+* Removes a key/value-pair from the map by using the key.
-(void) map->cl->remove(map, cx_hash_key_cxstr(key), false);
+*
-}
+* This function will copy the contents to the target buffer
+* which must be guaranteed to be large enough to hold the element.
-/**
+* The destructor functions, if any, will \em not be called.
-* Detaches a key/value-pair from the map by using the key
+*
-* without invoking the destructor.
+* If this map is storing pointers, the element is the pointer itself
-*
+* and not the object it points to.
-* @param map the map
+*
-* @param key the key
+* @param map the map
-*/
+* @param key the key
-__attribute__((__nonnull__))
+* @param targetbuf the buffer where the element shall be copied to
-static inline void cx_map_detach_mustr(
+* @return zero on success, non-zero if the key was not found
-CxMap *map,
+*/
-cxmutstr key
+cx_attr_nonnull
-) {
+cx_attr_access_w(3)
-(void) map->cl->remove(map, cx_hash_key_cxstr(key), false);
+static inline int cx_map_remove_and_get_cxstr(
-}
+CxMap *map,
+cxstring key,
-/**
+void *targetbuf
-* Detaches a key/value-pair from the map by using the key
+) {
-* without invoking the destructor.
+return map->cl->remove(map, cx_hash_key_cxstr(key), targetbuf);
-*
+}
-* @param map the map
-* @param key the key
+/**
-*/
+* Removes a key/value-pair from the map by using the key.
-__attribute__((__nonnull__))
+*
-static inline void cx_map_detach_str(
+* This function will copy the contents to the target buffer
-CxMap *map,
+* which must be guaranteed to be large enough to hold the element.
-char const *key
+* The destructor functions, if any, will \em not be called.
-) {
+*
-(void) map->cl->remove(map, cx_hash_key_str(key), false);
+* If this map is storing pointers, the element is the pointer itself
-}
+* and not the object it points to.
+*
-/**
+* @param map the map
-* Detaches a key/value-pair from the map by using the key
+* @param key the key
-* without invoking the destructor.
+* @param targetbuf the buffer where the element shall be copied to
-*
+* @return zero on success, non-zero if the key was not found
-* In general, you should only use this function if the map does not own
+*/
-* the data and there is a valid reference to the data somewhere else
+cx_attr_nonnull
-* in the program. In all other cases it is preferable to use
+cx_attr_access_w(3)
-* cxMapRemove() or cxMapRemoveAndGet().
+static inline int cx_map_remove_and_get_mustr(
-*
+CxMap *map,
-* @param map the map
+cxmutstr key,
-* @param key the key
+void *targetbuf
+) {
+return map->cl->remove(map, cx_hash_key_cxstr(key), targetbuf);
+}
+/**
+* Removes a key/value-pair from the map by using the key.
+*
+* This function will copy the contents to the target buffer
+* which must be guaranteed to be large enough to hold the element.
+* The destructor functions, if any, will \em not be called.
+*
+* If this map is storing pointers, the element is the pointer itself
+* and not the object it points to.
+*
+* @param map the map
+* @param key the key
+* @param targetbuf the buffer where the element shall be copied to
+* @return zero on success, non-zero if the key was not found
+*/
+cx_attr_nonnull
+cx_attr_access_w(3)
+cx_attr_cstr_arg(2)
+static inline int cx_map_remove_and_get_str(
+CxMap *map,
+const char *key,
+void *targetbuf
+) {
+return map->cl->remove(map, cx_hash_key_str(key), targetbuf);
+}
+/**
+* Removes a key/value-pair from the map by using the key.
+*
+* This function will copy the contents to the target buffer
+* which must be guaranteed to be large enough to hold the element.
+* The destructor functions, if any, will \em not be called.
+*
+* If this map is storing pointers, the element is the pointer itself
+* and not the object it points to.
+*
+* @param map the map
+* @param key the key
+* @param targetbuf the buffer where the element shall be copied to
+* @return zero on success, non-zero if the key was not found
+*
+* @see cxMapStorePointers()
 * @see cxMapRemove()
-* @see cxMapRemoveAndGet()
+*/
-*/
+#define cxMapRemoveAndGet(map, key, targetbuf) _Generic((key), \
-#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)           \
-(map, key)
-/**
-* Removes a key/value-pair from the map by using the key.
-*
-* @param map the map
-* @param key the key
-* @return the stored pointer or \c NULL if either the key is not present
-* in the map or the map is not storing pointers
-*/
-__attribute__((__nonnull__, __warn_unused_result__))
-static inline void *cx_map_remove_and_get(
-CxMap *map,
-CxHashKey key
-) {
-return map->cl->remove(map, key, !map->collection.store_pointer);
-}
-/**
-* Removes a key/value-pair from the map by using the key.
-*
-* @param map the map
-* @param key the key
-* @return the stored pointer or \c NULL if either the key is not present
-* in the map or the map is not storing pointers
-*/
-__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->collection.store_pointer);
-}
-/**
-* Removes a key/value-pair from the map by using the key.
-*
-* @param map the map
-* @param key the key
-* @return the stored pointer or \c NULL if either the key is not present
-* in the map or the map is not storing pointers
-*/
-__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->collection.store_pointer);
-}
-/**
-* Removes a key/value-pair from the map by using the key.
-*
-* @param map the map
-* @param key the key
-* @return the stored pointer or \c NULL if either the key is not present
-* 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
-) {
-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.
-*
-* This function can be used when the map is storing pointers,
-* in order to retrieve the pointer from the map without invoking
-* any destructor function. Sometimes you do not want the pointer
-* to be returned - in that case (instead of suppressing the "unused
-* result" warning) you can use cxMapDetach().
-*
-* If this map is not storing pointers, this function behaves like
-* cxMapRemove() and returns \c NULL.
-*
-* @param map the map
-* @param key the key
-* @return the stored pointer or \c NULL if either the key is not present
-* in the map or the map is not storing pointers
-* @see cxMapStorePointers()
-* @see cxMapDetach()
-*/
-#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)
+(map, key, targetbuf)
 #endif // __cplusplus
 #endif // UCX_MAP_H

Mercurial > hg > dbutils / file comparison

comparison: ucx/cx/map.h

ucx/cx/map.h