dynarray.h

/**
 * @mainpage
 * @author Grant S Ralls
 *
 * @ref dynarray.h
 */

/**
 * @file dynarray.h
 *
 * This header file defines the publically available functions
 */
#ifndef DYNARRAY
#define DYNARRAY
#include <stdlib.h>

/**
 * @brief Saves stats about the array for memory handling
 */
typedef struct {
    /// The size of a single entry in bytes
    size_t item_size;
    /// The number of available "slots" in the array
    size_t capacity;
    /// The number of currently filled "slots" in the array
    size_t length;
} array_info;

/**
 * @brief Creates a dynamic array
 * @param capacity The initial number of available slots for the array
 * @param item_size The size, in bytes, of the item that will be stored in this array
 * @return A pointer to the array
 */
void* dynarray_construct(size_t capacity, size_t item_size);
/**
 * @brief Retrieves the array information of a given array.
 * @param Array a pointer to a dynamic array
 * @return A pointer to a @ref array_info "array_info block"
 */
array_info* dynarray_array_info(void* array);
/**
 * @brief Inserts an item in a specific slot, overwriting any existing item
 * @param array A pointer to the array
 * @param item The item to be inserted
 * @param pos The, zero-indexed, position to place the item
 */
void dynarray_insert_at(void* array, void* item, int pos);
/**
 * @brief Gets the length of the array
 * @param array A pointer to the array
 * @return The length of the array
 */
size_t dynarray_length(void* array);
/**
 * @brief Pushes to the back of the array length
 * @param array A pointer to the array
 * @param item A pointer to the item to insert
 */
void dynarray_push_back(void* array, void* item);
/**
* @brief Removes an item from the back of the array
* @param array A pointer to the array
*/
void dynarray_pop_back(void* array);
#endif