linked_list.h

Go to the documentation of this file.

#ifndef LINKEDLIST_H
#define LINKEDLIST_H

#include "string.h"


//#define LL_IS_ARRAY_BACKED 1  //this defines if the linked list is back by an array of constant size or dynamically allocated

#ifndef LL_IS_ARRAY_BACKED
#include <core/mpx_supt.h>  //if the list is dynamically allocated, then we need the allocation functions from the core.
#endif

//maximum number of nodes if the list is array backed.
#define MAX_NUM_OF_LL_NODES 256

typedef struct s_ll linkedList_t;

typedef struct s_ll_node node_t;

struct s_ll_node
{
    void *data;
    node_t *next;
    node_t *prev;
#ifdef LL_IS_ARRAY_BACKED
    linkedList_t *parentList;
    unsigned char inUse;
#endif
};

struct s_ll
{
    node_t head;
    node_t tail;
    int (*searchCompFunc)(void*, void*); 
    int (*insertCompFunc)(void*, void*); 
    int (*freeNodeFunc)(node_t *nodeToFree); 
    void (*printNodeFunc)(void*);       
    size_t length;
#ifdef LL_IS_ARRAY_BACKED
    unsigned int numNodesInUse;
    node_t backingArray[MAX_NUM_OF_LL_NODES];
#endif
};

#define VARIABLE_LL_LENGTH(LIST_LENGTH) { \
    typedef struct s_ll_##LIST_LENGTH##_t linkedList_##LIST_LENGTH##_t \
    struct s_ll_##LIST_LENGTH##_t \
    { \
        node_t head; \
        node_t tail; \
        int (*searchCompFunc)(void*, void*); \
        int (*comparisonFunc)(void*, void*); \
        int (*freeNodeFunc)(node_t *nodeToFree); \
        void (*printList)(void*); \
        size_t length; \
        unsigned int numNodesInUse; \
        node_t backingArray[LIST_LENGTH]; \
    }; \
}


void initLinkedList(linkedList_t *list);


node_t * insertAfterNode(node_t *preceedingNode, node_t *  newNode);

node_t * insertBeforeNode(node_t *  nodeToFollow, node_t *newNode);

node_t * insertNode(linkedList_t *list, node_t * newNode);


node_t *makeNewNode(linkedList_t *list, void *data);

node_t *  moveNodeToNewList(node_t *nodeToMove, linkedList_t *newList);


void setFreeFunction(linkedList_t *list, int (*newFreeFunc)(node_t *));

void setInsertComparisonFunction(linkedList_t* list, int (*newCompFunc)(void*, void*));

void setPrintFunction(linkedList_t *list, void (*newPrintFunc)(void*));

void setSearchComparisonFunction(linkedList_t *list, int (*newSearchFunc)(void*, void*));



node_t * removeNode(node_t *nodeToRemove);

node_t *searchList(linkedList_t *listToSearch, void *data);



void printList(linkedList_t *list);

void listTest();

#endif // LINKEDLIST_H