cl_list.h

Go to the documentation of this file.

#ifndef __CL_LIST_H
#define __CL_LIST_H
 
#include "allocator.h"
#include "cl_types.h"
#include "types.h"
 
#include <stdbool.h>
 
// FORWARD DECLARATIONS
typedef struct __List CL_List;
 
// MACROS
 
#define CL_LIST_FOREACH(__type, __name, __list, ...)                                                                   \
    for (u32 __i = 0; __i < CL_ListSize(__list); __i++)                                                                \
    {                                                                                                                  \
        __type __name;                                                                                                 \
        CL_ListGet(__list, __i, &(__name));                                                                            \
        __VA_ARGS__                                                                                                    \
    }
 
#define CL_LIST_FOREACH_PTR(__type, __name, __list, ...)                                                               \
    for (u32 __i = 0; __i < CL_ListSize(__list); __i++)                                                                \
    {                                                                                                                  \
        __type *const __name;                                                                                          \
        CL_ListGetPtr(__list, __i, (void **)&(__name));                                                                \
        __VA_ARGS__                                                                                                    \
    }
 
// FUNCTIONS
 
CL_List *CL_ListAlloc(MEM_Allocator *const alloc, u32 elem_sz);
 
void CL_ListFree(CL_List *const list);
 
CL_Error CL_ListPushBack(CL_List *const list, const void *const elem);
 
CL_Error CL_ListPushFront(CL_List *const list, const void *const elem);
 
void CL_ListPopBack(CL_List *const list, void *out_elem);
 
void CL_ListPopFront(CL_List *const list, void *out_elem);
 
CL_Error CL_ListGet(const CL_List *const list, u32 index, void *out_elem);
 
CL_Error CL_ListGetPtr(const CL_List *const list, u32 index, void **out_elem);
 
CL_Error CL_ListGetLast(const CL_List *const list, void *out_elem);
 
CL_Error CL_ListGetLastPtr(const CL_List *const list, void **out_elem);
 
CL_Error CL_ListInsertAt(CL_List *const list, u32 index, const void *const elem);
 
CL_Error CL_ListRemoveAt(CL_List *const list, u32 index, void *out_elem);
 
bool CL_ListSearch(const CL_List *const list, const void *const elem, CL_CompareFn compare_fn, u32 *out_index);
 
void CL_ListClear(CL_List *const list);
 
u32 CL_ListSize(const CL_List *const list);
 
bool CL_ListIsEmpty(const CL_List *const list);
 
#endif