universe@606: /* universe@606: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. universe@606: * universe@606: * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved. universe@606: * universe@606: * Redistribution and use in source and binary forms, with or without universe@606: * modification, are permitted provided that the following conditions are met: universe@606: * universe@606: * 1. Redistributions of source code must retain the above copyright universe@606: * notice, this list of conditions and the following disclaimer. universe@606: * universe@606: * 2. Redistributions in binary form must reproduce the above copyright universe@606: * notice, this list of conditions and the following disclaimer in the universe@606: * documentation and/or other materials provided with the distribution. universe@606: * universe@606: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" universe@606: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE universe@606: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE universe@606: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE universe@606: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR universe@606: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF universe@606: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS universe@606: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN universe@606: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) universe@606: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE universe@606: * POSSIBILITY OF SUCH DAMAGE. universe@606: */ universe@606: /** universe@606: * \file array_list.h universe@606: * \brief Array list implementation. universe@606: * \details Also provides several low-level functions for custom array list implementations. universe@606: * \author Mike Becker universe@606: * \author Olaf Wintermann universe@606: * \copyright 2-Clause BSD License universe@606: */ universe@606: universe@606: universe@606: #ifndef UCX_ARRAY_LIST_H universe@606: #define UCX_ARRAY_LIST_H universe@606: olaf@617: #include "list.h" universe@606: universe@606: #ifdef __cplusplus universe@606: extern "C" { universe@606: #endif universe@606: universe@606: /** universe@807: * The maximum item size in an array list that fits into stack buffer when swapped. universe@804: */ universe@807: extern unsigned cx_array_swap_sbo_size; universe@804: universe@804: /** universe@831: * Declares variables for an array that can be used with the convenience macros. universe@831: * universe@831: * @see cx_array_simple_add() universe@831: * @see cx_array_simple_copy() universe@834: * @see cx_array_initialize() universe@831: */ universe@834: #define CX_ARRAY_DECLARE(type, name) \ universe@831: type * name; \ universe@831: size_t name##_size; \ universe@831: size_t name##_capacity; universe@831: universe@831: /** universe@834: * Initializes an array declared with CX_ARRAY_DECLARE(). universe@832: * universe@832: * The memory for the array is allocated with stdlib malloc(). universe@832: * @param array the array universe@832: * @param capacity the initial capacity universe@832: */ universe@832: #define cx_array_initialize(array, capacity) \ universe@832: array##_capacity = capacity; \ universe@832: array##_size = 0; \ universe@843: array = malloc(sizeof(array[0]) * capacity) universe@832: universe@832: /** universe@608: * Defines a reallocation mechanism for arrays. universe@608: */ universe@608: struct cx_array_reallocator_s { universe@608: /** universe@831: * Reallocates space for the given array. universe@608: * universe@608: * Implementations are not required to free the original array. universe@831: * This allows reallocation of static memory by allocating heap memory universe@795: * and copying the array contents. The information in the custom fields of universe@795: * the referenced allocator can be used to track the state of the memory universe@795: * or to transport other additional data. universe@608: * universe@608: * @param array the array to reallocate universe@608: * @param capacity the new capacity (number of elements) universe@608: * @param elem_size the size of each element universe@609: * @param alloc a reference to this allocator universe@608: * @return a pointer to the reallocated memory or \c NULL on failure universe@608: */ universe@608: void *(*realloc)( universe@608: void *array, universe@608: size_t capacity, universe@608: size_t elem_size, universe@609: struct cx_array_reallocator_s *alloc universe@608: ); universe@608: universe@608: /** universe@609: * Custom data pointer. universe@608: */ universe@609: void *ptr1; universe@609: /** universe@609: * Custom data pointer. universe@609: */ universe@609: void *ptr2; universe@609: /** universe@609: * Custom data integer. universe@609: */ universe@609: size_t int1; universe@609: /** universe@609: * Custom data integer. universe@609: */ universe@609: size_t int2; universe@608: }; universe@608: universe@608: /** universe@817: * A default stdlib-based array reallocator. universe@817: */ universe@818: extern struct cx_array_reallocator_s *cx_array_default_reallocator; universe@817: universe@817: /** universe@819: * Return codes for array functions. universe@610: */ universe@819: enum cx_array_result { universe@819: CX_ARRAY_SUCCESS, universe@819: CX_ARRAY_REALLOC_NOT_SUPPORTED, universe@819: CX_ARRAY_REALLOC_FAILED, universe@610: }; universe@610: universe@610: /** universe@608: * Copies elements from one array to another. universe@608: * universe@608: * The elements are copied to the \p target array at the specified \p index, universe@637: * overwriting possible elements. The \p index does not need to be in range of universe@637: * the current array \p size. If the new index plus the number of elements added universe@637: * would extend the array's size, and \p capacity is not \c NULL, the remaining universe@637: * capacity is used. universe@608: * universe@608: * If the capacity is insufficient to hold the new data, a reallocation universe@818: * attempt is made, unless the \p reallocator is set to \c NULL, in which case universe@608: * this function ultimately returns a failure. universe@608: * universe@831: * @param target a pointer to the target array universe@608: * @param size a pointer to the size of the target array universe@608: * @param capacity a pointer to the target array's capacity - universe@608: * \c NULL if only the size shall be used to bound the array universe@608: * @param index the index where the copied elements shall be placed universe@608: * @param src the source array universe@608: * @param elem_size the size of one element universe@608: * @param elem_count the number of elements to copy universe@831: * @param reallocator the array reallocator to use, or \c NULL universe@831: * if reallocation shall not happen universe@610: * @return zero on success, non-zero error code on failure universe@608: */ universe@819: enum cx_array_result cx_array_copy( universe@608: void **target, universe@608: size_t *size, universe@608: size_t *capacity, universe@608: size_t index, universe@608: void const *src, universe@608: size_t elem_size, universe@608: size_t elem_count, universe@610: struct cx_array_reallocator_s *reallocator universe@608: ) __attribute__((__nonnull__(1, 2, 5))); universe@608: universe@818: /** universe@831: * Convenience macro that uses cx_array_copy() with a default layout and the default reallocator. universe@831: * universe@831: * @param array the name of the array (NOT a pointer to the array) universe@831: * @param index the index where the copied elements shall be placed universe@831: * @param src the source array universe@831: * @param count the number of elements to copy universe@831: */ universe@831: #define cx_array_simple_copy(array, index, src, count) \ universe@831: cx_array_copy((void**)&(array), &(array##_size), &(array##_capacity), \ universe@831: index, src, sizeof((array)[0]), count, cx_array_default_reallocator) universe@831: universe@831: /** universe@818: * Adds an element to an array with the possibility of allocating more space. universe@818: * universe@818: * The element \p elem is added to the end of the \p target array which containing universe@818: * \p size elements, already. The \p capacity must not be \c NULL and point a universe@818: * variable holding the current maximum number of elements the array can hold. universe@818: * universe@818: * If the capacity is insufficient to hold the new element, and the optional universe@818: * \p reallocator is not \c NULL, an attempt increase the \p capacity is made universe@818: * and the new capacity is written back. universe@818: * universe@831: * @param target a pointer to the target array universe@818: * @param size a pointer to the size of the target array universe@818: * @param capacity a pointer to the target array's capacity - must not be \c NULL universe@818: * @param elem_size the size of one element universe@832: * @param elem a pointer to the element to add universe@831: * @param reallocator the array reallocator to use, or \c NULL if reallocation shall not happen universe@818: * @return zero on success, non-zero error code on failure universe@818: */ universe@818: #define cx_array_add(target, size, capacity, elem_size, elem, reallocator) \ universe@818: cx_array_copy((void**)(target), size, capacity, *(size), elem, elem_size, 1, reallocator) universe@623: universe@623: /** universe@831: * Convenience macro that uses cx_array_add() with a default layout and the default reallocator. universe@831: * universe@831: * @param array the name of the array (NOT a pointer to the array) universe@832: * @param elem the element to add (NOT a pointer, address is automatically taken) universe@831: */ universe@831: #define cx_array_simple_add(array, elem) \ universe@832: cx_array_simple_copy(array, array##_size, &(elem), 1) universe@831: universe@831: /** universe@623: * Swaps two array elements. universe@623: * universe@623: * @param arr the array universe@623: * @param elem_size the element size universe@623: * @param idx1 index of first element universe@623: * @param idx2 index of second element universe@623: */ universe@623: void cx_array_swap( universe@623: void *arr, universe@623: size_t elem_size, universe@623: size_t idx1, universe@623: size_t idx2 universe@623: ) __attribute__((__nonnull__)); universe@623: universe@608: /** universe@606: * Allocates an array list for storing elements with \p item_size bytes each. universe@606: * universe@669: * If \p item_size is CX_STORE_POINTERS, the created list will be created as if universe@763: * cxListStorePointers() was called immediately after creation and the compare universe@763: * function will be automatically set to cx_cmp_ptr(), if none is given. universe@669: * universe@606: * @param allocator the allocator for allocating the list memory universe@670: * (if \c NULL the cxDefaultAllocator will be used) universe@606: * @param comparator the comparator for the elements universe@763: * (if \c NULL, and the list is not storing pointers, sort and find universe@763: * functions will not work) universe@606: * @param item_size the size of each element in bytes universe@606: * @param initial_capacity the initial number of elements the array can store universe@606: * @return the created list universe@606: */ universe@606: CxList *cxArrayListCreate( universe@606: CxAllocator const *allocator, universe@677: cx_compare_func comparator, universe@606: size_t item_size, universe@606: size_t initial_capacity universe@670: ); universe@606: universe@662: /** universe@662: * Allocates an array list for storing elements with \p item_size bytes each. universe@662: * universe@662: * The list will use the cxDefaultAllocator and \em NO compare function. universe@662: * If you want to call functions that need a compare function, you have to universe@662: * set it immediately after creation or use cxArrayListCreate(). universe@662: * universe@669: * If \p item_size is CX_STORE_POINTERS, the created list will be created as if universe@763: * cxListStorePointers() was called immediately after creation and the compare universe@763: * function will be automatically set to cx_cmp_ptr(). universe@669: * universe@662: * @param item_size the size of each element in bytes universe@662: * @param initial_capacity the initial number of elements the array can store universe@662: * @return the created list universe@662: */ universe@670: #define cxArrayListCreateSimple(item_size, initial_capacity) \ universe@670: cxArrayListCreate(NULL, NULL, item_size, initial_capacity) universe@606: universe@606: #ifdef __cplusplus universe@628: } // extern "C" universe@606: #endif universe@606: universe@628: #endif // UCX_ARRAY_LIST_H