vl_linked_list.h

Go to the documentation of this file.

 
#ifndef VL_LIST_H
#define VL_LIST_H
 
#include "vl_compare.h"
#include "vl_pool.h"
 
#define VL_LIST_ITER_INVALID VL_POOL_INVALID_IDX
 
#define VL_LIST_FOREACH(list, trackVar)                                                                                \
    for (vl_list_iter trackVar = (list)->head; (trackVar) != VL_LIST_ITER_INVALID;                                     \
         (trackVar) = vlListNext(list, trackVar))
 
#define VL_LIST_FOREACH_REVERSE(list, trackVar)                                                                        \
    for (vl_list_iter trackVar = (list)->tail; (trackVar) != VL_LIST_ITER_INVALID;                                     \
         (trackVar) = vlListPrev(list, trackVar))
 
typedef vl_pool_idx vl_list_iter;
 
typedef struct
{
    vl_pool nodePool;
    vl_uint16_t elementSize;
    vl_list_iter head;
    vl_list_iter tail;
    vl_dsidx_t length;
} vl_linked_list;
 
VL_API void vlListInit(vl_linked_list* list, vl_uint16_t elementSize);
 
#ifndef vlListFree
 
#define vlListFree(listPtr) vlPoolFree(&((listPtr)->nodePool))
 
#endif
 
VL_API vl_linked_list* vlListNew(vl_uint16_t elementSize);
 
VL_API void vlListDelete(vl_linked_list* list);
 
VL_API vl_list_iter vlListPushFront(vl_linked_list* list, const void* elem);
 
VL_API void vlListPopFront(vl_linked_list* list);
 
VL_API vl_list_iter vlListPushBack(vl_linked_list* list, const void* elem);
 
VL_API void vlListPopBack(vl_linked_list* list);
 
VL_API vl_list_iter vlListInsertAfter(vl_linked_list* list, vl_list_iter target, const void* elem);
 
VL_API vl_list_iter vlListInsertBefore(vl_linked_list* list, vl_list_iter target, const void* elem);
 
#ifndef vlListSize
#define vlListSize(listPtr) (vl_dsidx_t)((listPtr)->length)
#endif
 
#ifndef vlListReserve
#define vlListReserve(listPtr, n) vlFixedPoolReserve(&((listPtr)->nodePool))
#endif
 
#ifndef vlListClear
#define vlListClear(listPtr)                                                                                           \
    (((listPtr)->head = (listPtr)->tail = VL_LIST_ITER_INVALID));                                                      \
    vlFixedPoolClear(&((listPtr)->nodePool))
#endif
 
VL_API vl_linked_list* vlListClone(const vl_linked_list* src, vl_linked_list* dest);
 
VL_API int vlListCopy(vl_linked_list* src, vl_list_iter begin, vl_list_iter end, vl_linked_list* dest,
                      vl_list_iter after);
 
VL_API void vlListSort(vl_linked_list* src, vl_compare_function cmp);
 
VL_API vl_list_iter vlListFind(vl_linked_list* src, const void* element);
 
VL_API void vlListRemove(vl_linked_list* list, vl_list_iter iter);
 
VL_API vl_list_iter vlListNext(vl_linked_list* list, vl_list_iter iter);
 
VL_API vl_list_iter vlListPrev(vl_linked_list* list, vl_list_iter iter);
 
VL_API void* vlListSample(vl_linked_list* list, vl_list_iter iter);
 
#endif // VL_LIST_H