linkedlist.h

/*
 * \file common/linkedlist.h
 *
 * Linked list implementation for internal use
 *
 * This file defines a linked list implementation that operates on the FreeRTOS
 * heap, and is able to generically store function pointers and data
 *
 * \copyright Copyright (c) 2017-2024, Purdue University ACM SIGBots.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
 
#pragma once
 
typedef void (*generic_fn_t)(void);
 
typedef struct ll_node_s {
    union {
        generic_fn_t func; // Note: a list should not contain both data/funcs
        void* data;
    } payload;
    struct ll_node_s* next;
} ll_node_s_t;
 
typedef struct {
    ll_node_s_t* head;
} linked_list_s_t;

ll_node_s_t* linked_list_init_func_node(generic_fn_t func);

ll_node_s_t* linked_list_init_data_node(void* data);

linked_list_s_t* linked_list_init();

void linked_list_prepend_func(linked_list_s_t* list, generic_fn_t func);

void linked_list_prepend_data(linked_list_s_t* list, void* data);

void linked_list_append_func(linked_list_s_t* list, generic_fn_t func);

void linked_list_remove_func(linked_list_s_t* list, generic_fn_t func);

void linked_list_append_data(linked_list_s_t* list, void* data);

void linked_list_remove_data(linked_list_s_t* list, void* data);
 
typedef void (*linked_list_foreach_fn_t)(ll_node_s_t*, void*);

void linked_list_foreach(linked_list_s_t* list, linked_list_foreach_fn_t, void* extra_data);

void linked_list_free(linked_list_s_t* list);