--- a/ucx/cx/iterator.h Sun Feb 16 17:38:07 2025 +0100
+++ b/ucx/cx/iterator.h Tue Feb 25 21:12:11 2025 +0100
@@ -26,11 +26,11 @@
* POSSIBILITY OF SUCH DAMAGE.
*/
/**
- * \file iterator.h
- * \brief Interface for iterator implementations.
- * \author Mike Becker
- * \author Olaf Wintermann
- * \copyright 2-Clause BSD License
+ * @file iterator.h
+ * @brief Interface for iterator implementations.
+ * @author Mike Becker
+ * @author Olaf Wintermann
+ * @copyright 2-Clause BSD License
*/
#ifndef UCX_ITERATOR_H
@@ -47,9 +47,8 @@
*/
struct cx_iterator_base_s {
/**
- * True iff the iterator points to valid data.
+ * True if the iterator points to valid data.
*/
- cx_attr_nonnull
bool (*valid)(const void *);
/**
@@ -57,15 +56,11 @@
*
* When valid returns false, the behavior of this function is undefined.
*/
- cx_attr_nonnull
- cx_attr_nodiscard
void *(*current)(const void *);
/**
* Original implementation in case the function needs to be wrapped.
*/
- cx_attr_nonnull
- cx_attr_nodiscard
void *(*current_impl)(const void *);
/**
@@ -73,7 +68,6 @@
*
* When valid returns false, the behavior of this function is undefined.
*/
- cx_attr_nonnull
void (*next)(void *);
/**
* Indicates whether this iterator may remove elements.
@@ -86,6 +80,12 @@
};
/**
+ * Convenience type definition for the base structure of an iterator.
+ * @see #CX_ITERATOR_BASE
+ */
+typedef struct cx_iterator_base_s CxIteratorBase;
+
+/**
* Declares base attributes for an iterator.
* Must be the first member of an iterator structure.
*/
@@ -120,27 +120,6 @@
} src_handle;
/**
- * Field for storing a key-value pair.
- * May be used by iterators that iterate over k/v-collections.
- */
- struct {
- /**
- * A pointer to the key.
- */
- const void *key;
- /**
- * A pointer to the value.
- */
- void *value;
- } kv_data;
-
- /**
- * Field for storing a slot number.
- * May be used by iterators that iterate over multi-bucket collections.
- */
- size_t slot;
-
- /**
* If the iterator is position-aware, contains the index of the element in the underlying collection.
* Otherwise, this field is usually uninitialized.
*/
@@ -153,7 +132,7 @@
/**
* May contain the total number of elements, if known.
- * Shall be set to \c SIZE_MAX when the total number is unknown during iteration.
+ * Shall be set to @c SIZE_MAX when the total number is unknown during iteration.
*/
size_t elem_count;
};
@@ -166,7 +145,7 @@
* to be "position-aware", which means that they keep track of the current index within the collection.
*
* @note Objects that are pointed to by an iterator are always mutable through that iterator. However,
- * any concurrent mutation of the collection other than by this iterator makes this iterator invalid
+ * any concurrent mutation of the collection other than by this iterator makes this iterator invalid,
* and it must not be used anymore.
*/
typedef struct cx_iterator_s CxIterator;
@@ -174,10 +153,9 @@
/**
* Checks if the iterator points to valid data.
*
- * This is especially false for past-the-end iterators.
- *
* @param iter the iterator
- * @return true iff the iterator points to valid data
+ * @retval true if the iterator points to valid data
+ * @retval false if the iterator already moved past the end
*/
#define cxIteratorValid(iter) (iter).base.valid(&(iter))
@@ -188,6 +166,7 @@
*
* @param iter the iterator
* @return a pointer to the current element
+ * @see cxIteratorValid()
*/
#define cxIteratorCurrent(iter) (iter).base.current(&iter)
@@ -201,6 +180,8 @@
/**
* Flags the current element for removal, if this iterator is mutating.
*
+ * Does nothing for non-mutating iterators.
+ *
* @param iter the iterator
*/
#define cxIteratorFlagRemoval(iter) (iter).base.remove |= (iter).base.mutating
@@ -211,11 +192,13 @@
* This is useful for APIs that expect some iterator as an argument.
*
* @param iter the iterator
+ * @return (@c struct @c cx_iterator_base_s*) a pointer to the iterator
*/
#define cxIteratorRef(iter) &((iter).base)
/**
* Loops over an iterator.
+ *
* @param type the type of the elements
* @param elem the name of the iteration variable
* @param iter the iterator
@@ -227,21 +210,22 @@
/**
* Creates an iterator for the specified plain array.
*
- * The \p array can be \c NULL in which case the iterator will be immediately
- * initialized such that #cxIteratorValid() returns \c false.
+ * The @p array can be @c NULL in which case the iterator will be immediately
+ * initialized such that #cxIteratorValid() returns @c false.
*
* This iterator yields the addresses of the array elements.
* If you want to iterator over an array of pointers, you can
* use cxIteratorPtr() to create an iterator which directly
* yields the stored pointers.
*
- * @param array a pointer to the array (can be \c NULL)
+ * @param array a pointer to the array (can be @c NULL)
* @param elem_size the size of one array element
* @param elem_count the number of elements in the array
* @return an iterator for the specified array
* @see cxIteratorPtr()
*/
cx_attr_nodiscard
+cx_attr_export
CxIterator cxIterator(
const void *array,
size_t elem_size,
@@ -255,23 +239,24 @@
* elements through #cxIteratorFlagRemoval(). Every other change to the array
* will bring this iterator to an undefined state.
*
- * When \p remove_keeps_order is set to \c false, removing an element will only
+ * When @p remove_keeps_order is set to @c false, removing an element will only
* move the last element to the position of the removed element, instead of
* moving all subsequent elements by one. Usually, when the order of elements is
- * not important, this parameter should be set to \c false.
+ * not important, this parameter should be set to @c false.
*
- * The \p array can be \c NULL in which case the iterator will be immediately
- * initialized such that #cxIteratorValid() returns \c false.
+ * The @p array can be @c NULL in which case the iterator will be immediately
+ * initialized such that #cxIteratorValid() returns @c false.
*
*
- * @param array a pointer to the array (can be \c NULL)
+ * @param array a pointer to the array (can be @c NULL)
* @param elem_size the size of one array element
* @param elem_count the number of elements in the array
- * @param remove_keeps_order \c true if the order of elements must be preserved
+ * @param remove_keeps_order @c true if the order of elements must be preserved
* when removing an element
* @return an iterator for the specified array
*/
cx_attr_nodiscard
+cx_attr_export
CxIterator cxMutIterator(
void *array,
size_t elem_size,
@@ -287,12 +272,13 @@
* an iterator created with cxIterator() would return the addresses
* of those pointers within the array).
*
- * @param array a pointer to the array (can be \c NULL)
+ * @param array a pointer to the array (can be @c NULL)
* @param elem_count the number of elements in the array
* @return an iterator for the specified array
* @see cxIterator()
*/
cx_attr_nodiscard
+cx_attr_export
CxIterator cxIteratorPtr(
const void *array,
size_t elem_count
@@ -304,15 +290,16 @@
* This is the mutating variant of cxIteratorPtr(). See also
* cxMutIterator().
*
- * @param array a pointer to the array (can be \c NULL)
+ * @param array a pointer to the array (can be @c NULL)
* @param elem_count the number of elements in the array
- * @param remove_keeps_order \c true if the order of elements must be preserved
+ * @param remove_keeps_order @c true if the order of elements must be preserved
* when removing an element
* @return an iterator for the specified array
* @see cxMutIterator()
* @see cxIteratorPtr()
*/
cx_attr_nodiscard
+cx_attr_export
CxIterator cxMutIteratorPtr(
void *array,
size_t elem_count,