--- a/ucx/cx/array_list.h Sat Apr 20 13:01:58 2024 +0200
+++ b/ucx/cx/array_list.h Thu May 23 22:35:45 2024 +0200
@@ -31,7 +31,6 @@
* \details Also provides several low-level functions for custom array list implementations.
* \author Mike Becker
* \author Olaf Wintermann
- * \version 3.0
* \copyright 2-Clause BSD License
*/
@@ -46,16 +45,46 @@
#endif
/**
+ * The maximum item size in an array list that fits into stack buffer when swapped.
+ */
+extern unsigned cx_array_swap_sbo_size;
+
+/**
+ * Declares variables for an array that can be used with the convenience macros.
+ *
+ * @see cx_array_simple_add()
+ * @see cx_array_simple_copy()
+ * @see cx_array_initialize()
+ */
+#define CX_ARRAY_DECLARE(type, name) \
+ type * name; \
+ size_t name##_size; \
+ size_t name##_capacity
+
+/**
+ * Initializes an array declared with CX_ARRAY_DECLARE().
+ *
+ * The memory for the array is allocated with stdlib malloc().
+ * @param array the array
+ * @param capacity the initial capacity
+ */
+#define cx_array_initialize(array, capacity) \
+ array##_capacity = capacity; \
+ array##_size = 0; \
+ array = malloc(sizeof(array[0]) * capacity)
+
+/**
* Defines a reallocation mechanism for arrays.
*/
struct cx_array_reallocator_s {
/**
- * Re-allocates space for the given array.
+ * Reallocates space for the given array.
*
* Implementations are not required to free the original array.
- * This allows re-allocation of static memory by allocating heap memory
- * and copying the array contents. The information in \p data can keep
- * track of the state of the memory or other additional allocator info.
+ * This allows reallocation of static memory by allocating heap memory
+ * and copying the array contents. The information in the custom fields of
+ * the referenced allocator can be used to track the state of the memory
+ * or to transport other additional data.
*
* @param array the array to reallocate
* @param capacity the new capacity (number of elements)
@@ -89,12 +118,17 @@
};
/**
- * Return codes for cx_array_copy().
+ * A default stdlib-based array reallocator.
*/
-enum cx_array_copy_result {
- CX_ARRAY_COPY_SUCCESS,
- CX_ARRAY_COPY_REALLOC_NOT_SUPPORTED,
- CX_ARRAY_COPY_REALLOC_FAILED,
+extern struct cx_array_reallocator_s *cx_array_default_reallocator;
+
+/**
+ * Return codes for array functions.
+ */
+enum cx_array_result {
+ CX_ARRAY_SUCCESS,
+ CX_ARRAY_REALLOC_NOT_SUPPORTED,
+ CX_ARRAY_REALLOC_FAILED,
};
/**
@@ -107,10 +141,10 @@
* capacity is used.
*
* If the capacity is insufficient to hold the new data, a reallocation
- * attempt is made, unless the allocator is set to \c NULL, in which case
+ * attempt is made, unless the \p reallocator is set to \c NULL, in which case
* this function ultimately returns a failure.
*
- * @param target the target array
+ * @param target a pointer to the target array
* @param size a pointer to the size of the target array
* @param capacity a pointer to the target array's capacity -
* \c NULL if only the size shall be used to bound the array
@@ -118,11 +152,11 @@
* @param src the source array
* @param elem_size the size of one element
* @param elem_count the number of elements to copy
- * @param reallocator the array re-allocator to use, or \c NULL
- * if re-allocation shall not happen
+ * @param reallocator the array reallocator to use, or \c NULL
+ * if reallocation shall not happen
* @return zero on success, non-zero error code on failure
*/
-enum cx_array_copy_result cx_array_copy(
+enum cx_array_result cx_array_copy(
void **target,
size_t *size,
size_t *capacity,
@@ -133,6 +167,48 @@
struct cx_array_reallocator_s *reallocator
) __attribute__((__nonnull__(1, 2, 5)));
+/**
+ * Convenience macro that uses cx_array_copy() with a default layout and the default reallocator.
+ *
+ * @param array the name of the array (NOT a pointer to the array)
+ * @param index the index where the copied elements shall be placed
+ * @param src the source array
+ * @param count the number of elements to copy
+ */
+#define cx_array_simple_copy(array, index, src, count) \
+ cx_array_copy((void**)&(array), &(array##_size), &(array##_capacity), \
+ index, src, sizeof((array)[0]), count, cx_array_default_reallocator)
+
+/**
+ * Adds an element to an array with the possibility of allocating more space.
+ *
+ * The element \p elem is added to the end of the \p target array which containing
+ * \p size elements, already. The \p capacity must not be \c NULL and point a
+ * variable holding the current maximum number of elements the array can hold.
+ *
+ * If the capacity is insufficient to hold the new element, and the optional
+ * \p reallocator is not \c NULL, an attempt increase the \p capacity is made
+ * and the new capacity is written back.
+ *
+ * @param target a pointer to the target array
+ * @param size a pointer to the size of the target array
+ * @param capacity a pointer to the target array's capacity - must not be \c NULL
+ * @param elem_size the size of one element
+ * @param elem a pointer to the element to add
+ * @param reallocator the array reallocator to use, or \c NULL if reallocation shall not happen
+ * @return zero on success, non-zero error code on failure
+ */
+#define cx_array_add(target, size, capacity, elem_size, elem, reallocator) \
+ cx_array_copy((void**)(target), size, capacity, *(size), elem, elem_size, 1, reallocator)
+
+/**
+ * Convenience macro that uses cx_array_add() with a default layout and the default reallocator.
+ *
+ * @param array the name of the array (NOT a pointer to the array)
+ * @param elem the element to add (NOT a pointer, address is automatically taken)
+ */
+#define cx_array_simple_add(array, elem) \
+ cx_array_simple_copy(array, array##_size, &(elem), 1)
/**
* Swaps two array elements.
@@ -150,42 +226,45 @@
) __attribute__((__nonnull__));
/**
- * Allocates an array list for storing elements with \p item_size bytes each.
+ * Allocates an array list for storing elements with \p elem_size bytes each.
*
- * If \p item_size is CX_STORE_POINTERS, the created list will be created as if
- * cxListStorePointers() was called immediately after creation.
+ * If \p elem_size is CX_STORE_POINTERS, the created list will be created as if
+ * cxListStorePointers() was called immediately after creation and the compare
+ * function will be automatically set to cx_cmp_ptr(), if none is given.
*
* @param allocator the allocator for allocating the list memory
* (if \c NULL the cxDefaultAllocator will be used)
* @param comparator the comparator for the elements
- * (if \c NULL sort and find functions will not work)
- * @param item_size the size of each element in bytes
+ * (if \c NULL, and the list is not storing pointers, sort and find
+ * functions will not work)
+ * @param elem_size the size of each element in bytes
* @param initial_capacity the initial number of elements the array can store
* @return the created list
*/
CxList *cxArrayListCreate(
CxAllocator const *allocator,
cx_compare_func comparator,
- size_t item_size,
+ size_t elem_size,
size_t initial_capacity
);
/**
- * Allocates an array list for storing elements with \p item_size bytes each.
+ * Allocates an array list for storing elements with \p elem_size bytes each.
*
* The list will use the cxDefaultAllocator and \em NO compare function.
* If you want to call functions that need a compare function, you have to
* set it immediately after creation or use cxArrayListCreate().
*
- * If \p item_size is CX_STORE_POINTERS, the created list will be created as if
- * cxListStorePointers() was called immediately after creation.
+ * If \p elem_size is CX_STORE_POINTERS, the created list will be created as if
+ * cxListStorePointers() was called immediately after creation and the compare
+ * function will be automatically set to cx_cmp_ptr().
*
- * @param item_size the size of each element in bytes
+ * @param elem_size the size of each element in bytes
* @param initial_capacity the initial number of elements the array can store
* @return the created list
*/
-#define cxArrayListCreateSimple(item_size, initial_capacity) \
- cxArrayListCreate(NULL, NULL, item_size, initial_capacity)
+#define cxArrayListCreateSimple(elem_size, initial_capacity) \
+ cxArrayListCreate(NULL, NULL, elem_size, initial_capacity)
#ifdef __cplusplus
} // extern "C"