linkedlist.h

Go to the documentation of this file.

// Copyright (c) 2019 Intel Corporation.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
 
#ifndef _EII_MSGENV_LINKEDLIST_H
#define _EII_MSGENV_LINKEDLIST_H
 
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
 
typedef enum {
    LL_SUCCESS       = 0,
    LL_ERR_APPEND    = 1,
    LL_ERR_NOT_FOUND = 2,
} linkedlist_ret_t;
 
// Forward declaration of node_t
typedef struct _node_t node_t;
 
typedef struct _node_t {
    // Pointer to next node
    node_t* next;
 
    // Value at the current node
    void* value;
 
    // Function to free the value
    void (*free)(void*);
} node_t;
 
typedef struct {
    // Root element of the linked list
    node_t* root;
    int len;
} linkedlist_t;
 
#define LINKEDLIST_FOREACH(LL, VALUE_TYPE, CODE) { \
    node_t* curr = LL->root; \
    while(curr != NULL) { \
        VALUE_TYPE* value = (VALUE_TYPE*) curr->value; \
        CODE \
        curr = curr->next; \
    } \
}
 
linkedlist_t* linkedlist_new();
 
node_t* linkedlist_node_new(void* value, void (*free_fn)(void*));
 
linkedlist_ret_t linkedlist_add(linkedlist_t* ll, node_t* node);
 
node_t* linkedlist_get_at(linkedlist_t* ll, int idx);
 
linkedlist_ret_t linkedlist_remove_at(linkedlist_t* ll, int idx);
 
void linkedlist_destroy(linkedlist_t* ll);
 
#ifdef __cplusplus
}
#endif // __cplusplus
 
#endif // _EII_MSGENV_LINKEDLIST_H