ucx: comparison src/cx/iterator.h

-:0ac4aa1737fd
+:6e0c3a8a914a
 /**
 * Original implementation in case the function needs to be wrapped.
 */
 void *(*current_impl)(const void *);
 /**
 * Advances the iterator.
 *
 * When valid returns false, the behavior of this function is undefined.
 */
 */
 void (*next_impl)(void *);
 /**
 * Indicates whether this iterator may remove elements.
 */
-bool mutating;
+bool allow_remove;
 /**
 * Internal flag for removing the current element when advancing.
 */
 bool remove;
 };
 void *elem_handle;
 /**
 * Handle for the source collection, if any.
 */
-union {
+void *src_handle;
-/**
-* Access for mutating iterators.
-*/
-void *m;
-/**
-* Access for normal iterators.
-*/
-const void *c;
-} src_handle;
 /**
 * If the iterator is position-aware, contains the index of the element in the underlying collection.
 * Otherwise, this field is usually uninitialized.
 */
 * An iterator points to a certain element in a (possibly unbounded) chain of elements.
 * Iterators that are based on collections (which have a defined "first" element) are supposed
 * 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 obsolete,
 * and it must not be used anymore.
 */
 typedef struct cx_iterator_s CxIterator;
 /**
 * @param iter the iterator
 */
 #define cxIteratorNext(iter) (iter).base.next(&iter)
 /**
-* Flags the current element for removal if this iterator is mutating.
+* Flags the current element for removal if the iterator allows it.
 *
-* Does nothing for non-mutating iterators.
+* @param iter the iterator
-*
+* @return @c true if removal is allowed, @c false otherwise
-* @param iter the iterator
+*/
-*/
+#define cxIteratorFlagRemoval(iter) ((iter).base.remove = (iter).base.allow_remove)
-#define cxIteratorFlagRemoval(iter) (iter).base.remove |= (iter).base.mutating
 /**
 * Obtains a reference to an arbitrary iterator.
 *
 * This is useful for APIs that expect some iterator as an argument.
 * 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 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_EXPORT CxIterator cxIterator(const void *array,
-size_t elem_size, size_t elem_count);
-/**
-* Creates a mutating iterator for the specified plain array.
-*
 * While the iterator is in use, the array may only be altered by removing
 * 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
 * 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.
-*
-* 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 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
 * when removing an element
 * @return an iterator for the specified array
+* @see cxIteratorPtr()
 */
 cx_attr_nodiscard
-CX_EXPORT CxIterator cxMutIterator(void *array,
+CX_EXPORT CxIterator cxIterator(const void *array,
 size_t elem_size, size_t elem_count, bool remove_keeps_order);
 /**
 * Creates an iterator for the specified plain pointer array.
 *
 * This iterator assumes that every element in the array is a pointer
 * and yields exactly those pointers during iteration (on the other
 * hand, 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)
+* While the iterator is in use, the array may only be altered by removing
-* @param elem_count the number of elements in the array
+* elements through #cxIteratorFlagRemoval(). Every other change to the array
-* @return an iterator for the specified array
+* will bring this iterator to an undefined state.
-* @see cxIterator()
+*
-*/
+* When @p remove_keeps_order is set to @c false, removing an element will only
-cx_attr_nodiscard
+* move the last element to the position of the removed element, instead of
-CX_EXPORT CxIterator cxIteratorPtr(const void *array, size_t elem_count);
+* moving all subsequent elements by one. Usually, when the order of elements is
+* not important, this parameter should be set to @c false.
-/**
-* Creates a mutating iterator for the specified plain pointer array.
-*
-* This is the mutating variant of cxIteratorPtr(). See also
-* cxMutIterator().
 *
 * @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
 * when removing an element
 * @return an iterator for the specified array
-* @see cxMutIterator()
+* @see cxIterator()
-* @see cxIteratorPtr()
 */
 cx_attr_nodiscard
-CX_EXPORT CxIterator cxMutIteratorPtr(void *array,
+CX_EXPORT CxIterator cxIteratorPtr(const void *array, size_t elem_count,
-size_t elem_count, bool remove_keeps_order);
+bool remove_keeps_order);
 #ifdef __cplusplus
 } // extern "C"
 #endif

Mercurial > hg > ucx / file comparison

comparison: src/cx/iterator.h

src/cx/iterator.h