Linked_list.h

Go to the documentation of this file.

/******************************************************************************
* Title                 :   Linked list header file  
* Filename              :   Linked_list.h
* Author                :   Maximiliano Valencia
* Origin Date           :   09/02/2019
* Version               :   1.0.0
* Compiler              :   gcc
* Target                :   STM32
* Notes                 :   None
******************************************************************************/
#ifndef LINKED_LIST_H
#define LINKED_LIST_H

/******************************************************************************
* Includes
******************************************************************************/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <pthread.h>

/******************************************************************************
* Preprocessor Constants
******************************************************************************/


/******************************************************************************
* Configuration Constants
******************************************************************************/


/******************************************************************************
* Macros
******************************************************************************/


/******************************************************************************
* Typedefs
******************************************************************************/
typedef struct list_t list_t;
typedef struct node_t node_t;

struct list_t
{
    uint8_t numElements;    
    size_t dataSize;        
    node_t* head;           
    node_t* tail;           
    pthread_mutex_t lock;   
};

struct node_t
{
    void* data;     
    node_t* next;   
};

/******************************************************************************
* Variables
******************************************************************************/


/******************************************************************************
* Function Prototypes
******************************************************************************/
void list_init(list_t* list, size_t dataSize);
void list_free(list_t* list);
void list_destroy(list_t* list);
void list_push(list_t* list, const void* data);
void list_push_front(list_t* list, const void* data);
uint8_t list_pop(list_t* list, void* data);
uint8_t list_pop_front(list_t* list, void* data);
uint8_t list_get_by_index(list_t* list, uint8_t index, void* data);
void list_print(list_t* list, void (*printFn)(const void* data));
void list_for_each(list_t* list, void (*eachFn)(const void* data, void* arg), void* arg);
uint8_t list_size(list_t* list);

#endif /* LINKED_LIST_H */