list.h

Go to the documentation of this file.

#ifndef _LIST_H_
#define _LIST_H_

#include <stdint.h>
#include "project_settings.h"

#include "library.h"

#ifdef USE_MODULE_SUBSYS
#include "subsys.h"
#endif

typedef uint8_t(*list_sort_fn_t)(void*, void*);

typedef uint8_t(*list_identify_fn_t)(void*, void*);

typedef struct list_link_t {
    void* item_ptr; 
    struct list_link_t* next; 
    struct list_link_t* previous; 
} list_link_t;

typedef struct list_t {
    list_link_t* first; 
    list_link_t* last; 
    uint16_t length; 
    uint16_t array_length; 
    list_link_t* links; 
    uint16_t* item_array; 
    uint16_t item_size; 
    list_sort_fn_t sort_fn; 
    list_identify_fn_t identify_fn; 
    // the following overhead members are only needed
    // to make the list module faster

    list_link_t * working[2]; 
    list_link_t * unlinked[2]; 
    uint16_t unlinked_count; 
    //list_link_t * unused[2]; ///< unused Commented because feature not fully implemented
} list_t;

#define LIST_ALLOCATE(t, list_name,  max_elements)\
    t CAT2(list_name, _array)[max_elements];\
    list_link_t CAT2(list_name, _links)[max_elements];\
    list_t list_name

#define LIST_INIT(list_name, max_elements, item_size)\
    List_Init(&list_name, item_size, &CAT2(list_name, _array)[0], max_elements, &CAT2(list_name, _links)[0])


void List_Init(list_t* list, uint16_t item_size, void* item_array, uint16_t item_array_length, list_link_t* link_array);

void List_SetSortFunction(list_t* list, uint8_t(*sort_fn)(void* a, void* b));

void List_SetIdentifyFunction(list_t* list, uint8_t(*identify_fn)(void* identifier, void* item));

void* List_AddAndLink(list_t* list, void* item);

void* List_Add(list_t* list, void* item);

void* List_AddIndirect(list_t* list);

void List_Link(list_t* list);

void List_ResortFirst(list_t* list);

void List_ResortLast(list_t* list);

void List_LinkItem(list_t* list, void* item);

void* List_GetFirst(list_t* list);

void* List_GetLast(list_t* list);

void* List_GetNext(list_t* list, void* item);

void* List_GetItem(list_t* list, void* identifier);

void List_RemoveFirst(list_t* list);

void List_RemoveLast(list_t* list);

void List_Remove(list_t* list, void* item);

void List_RemoveAll(list_t* list);

void List_UnlinkItem(list_t* list, void* item);

void List_UnlinkFirst(list_t* list);

void List_UnlinkLast(list_t* list);

void List_RunFunction(list_t* list, void(*function)(void *) );


#endif //_LIST_H_