array_list.h

#ifndef ARRAY_LIST_H
#define ARRAY_LIST_H

/**
 * @file  array_list.h
 * @brief Generic Array List
 */

#ifndef ARRAY_LIST_INITIAL_CAPACITY
#define ARRAY_LIST_INITIAL_CAPACITY_EXPONENT 5 ///< default array list init capacity (2^5 = 32)
#endif

/**
 * @brief Array list chunk structure
 */
struct array_list {
    struct array_list *next; ///< Pointer to the next chunk
    int arc;                 ///< Length of the chunks array
    void *arv[];             ///< The chunks array
};

/**
 * @brief Array list iterator structure
 */
struct array_list_iterator {
    struct array_list *current_chunk; ///< Pointer to the current chunk
    int current;                      ///< Index of current element in chunk
};

/**
 * @brief Insert value into array list.
 *
 * If *al is NULL, allocate new array list and expand it to the right size.
 * The size of the array list grows while beeing used in
 * 2^n (1, 1, 2, 4, 8, ...).
 *
 * \param al Pointer to the pointer of the array list struct
 * \param idx Index of the array, at which the element is inserted
 * \param elem Pointer to payload/value
 *
 * \return Nothing
 */
void array_list_set(struct array_list **al, int idx, void *elem);

/**
 * @brief Get value from array list.
 *
 * \param al Pointer to the pointer of the array list struct
 * \param idx Index of the array, at which the element is inserted
 *
 * \return Pointer to the payload/value
 */
void *array_list_get(struct array_list *const *al, int idx);

/**
 * @brief Initialize a new array list iterator.
 *
 * \param al Pointer to the pointer of the array list struct
 *
 * \return Pointer to the initialized array list iterator
 */
struct array_list_iterator *array_list_iterator_init(struct array_list *const *al);

/**
 * @brief Get the next array list element from iterator.
 *
 * \param it Pointer to the array list iterator struct
 *
 * \return Pointer to the element
 */
void *array_list_iterator_next(struct array_list_iterator *const *it);

/**
 * @brief Frees an array list.
 *
 * \param al Pointer to the pointer of the array list struct
 * \param elem_free Pointer to a function that frees the payload element
 *
 * \return Nothing
 */
void array_list_free(struct array_list **al, void (*elem_free)(void *));

#endif