ub_llist.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Texas Instruments Incorporated
 * Copyright (c) 2023 Excelfore Corporation (https://excelfore.com)
 *
 * All rights reserved not granted herein.
 * Limited License.
 *
 * Texas Instruments Incorporated grants a world-wide, royalty-free,
 * non-exclusive license under copyrights and patents it now or hereafter
 * owns or controls to make, have made, use, import, offer to sell and sell ("Utilize")
 * this software subject to the terms herein. With respect to the foregoing patent
 * license, such license is granted solely to the extent that any such patent is necessary
 * to Utilize the software alone. The patent license shall not apply to any combinations which
 * include this software, other than combinations with devices manufactured by or for TI ("TI Devices").
 * No hardware patent is licensed hereunder.
 *
 * Redistributions must preserve existing copyright notices and reproduce this license (including the
 * above copyright notice and the disclaimer and (if applicable) source code license limitations below)
 * in the documentation and/or other materials provided with the distribution
 *
 * Redistribution and use in binary form, without modification, are permitted provided that the following
 * conditions are met:
 *
 * * No reverse engineering, decompilation, or disassembly of this software is permitted with respect to any
 * software provided in binary form.
 * * any redistribution and use are licensed by TI for use only with TI Devices.
 * * Nothing shall obligate TI to provide you with source code for the software licensed and provided to you in object code.
 *
 * If software source code is provided to you, modification and redistribution of the source code are permitted
 * provided that the following conditions are met:
 *
 * * any redistribution and use of the source code, including any resulting derivative works, are licensed by
 * TI for use only with TI Devices.
 * * any redistribution and use of any object code compiled from the source code and any resulting derivative
 * works, are licensed by TI for use only with TI Devices.
 *
 * Neither the name of Texas Instruments Incorporated nor the names of its suppliers may be used to endorse or
 * promote products derived from this software without specific prior written permission.
 *
 * DISCLAIMER.
 *
 * THIS SOFTWARE IS PROVIDED BY TI AND TI"S LICENSORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL TI AND TI"S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef LUB_LIST_UTILS_H_
#define LUB_LIST_UTILS_H_
 
#include <stdint.h>
#include <stdlib.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct ub_list_node {
    struct ub_list_node *prev;     
    struct ub_list_node *next;     
    void *data;            
};
 
#define UB_LIST_NODE_INIT {NULL, NULL, NULL}
 
struct ub_list {
    struct ub_list_node *head;    
    struct ub_list_node *tail;    
    uint32_t count;
};
 
#define UB_LIST_INIT {NULL, NULL, 0}
 
void ub_list_init(struct ub_list *ub_list);
 
typedef void (ub_list_node_clear_h)(struct ub_list_node *node, void *arg);
 
void ub_list_clear(struct ub_list *ub_list, ub_list_node_clear_h node_clear,
           void *arg);
 
void ub_list_append(struct ub_list *ub_list, struct ub_list_node *node);
 
void ub_list_prepend(struct ub_list *ub_list, struct ub_list_node *node);
 
void ub_list_insert_before(struct ub_list *ub_list, struct ub_list_node *refnode,
               struct ub_list_node *node);
 
void ub_list_insert_after(struct ub_list *ub_list, struct ub_list_node *refnode,
              struct ub_list_node *node);
 
void ub_list_unlink(struct ub_list *ub_list, struct ub_list_node *node);
 
typedef bool (ub_list_sort_h)(struct ub_list_node *node1,
                  struct ub_list_node *node2, void *arg);
 
void ub_list_sort(struct ub_list *ub_list, ub_list_sort_h *sh, void *arg);
 
typedef bool (ub_list_apply_h)(struct ub_list_node *node, void *arg);
 
struct ub_list_node *ub_list_apply(const struct ub_list *ub_list, bool fwd,
                   ub_list_apply_h *ah, void *arg);
 
struct ub_list_node *ub_list_head(const struct ub_list *ub_list);
 
struct ub_list_node *ub_list_tail(const struct ub_list *ub_list);
 
uint32_t ub_list_count(const struct ub_list *ub_list);
 
static inline void *ub_list_nodedata(const struct ub_list_node *node){
    return node ? node->data : NULL;
}
 
static inline bool ub_list_isempty(const struct ub_list *ub_list){
    return (ub_list!=NULL) ? (ub_list->head == NULL) : true;
}
 
#define UB_LIST_FOREACH_ITER(ub_list, node) \
    (node) = ub_list_head((ub_list)); (node); (node) = (node)->next
 
#ifdef __cplusplus
}
#endif
 
#endif