dlist.h

Go to the documentation of this file.

 
#ifndef ECU_DLIST_H_
#define ECU_DLIST_H_
 
/*------------------------------------------------------------*/
/*------------------------- INCLUDES -------------------------*/
/*------------------------------------------------------------*/
 
/* STDLib. */
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
/* ECU. */
#include "ecu/object_id.h"
#include "ecu/utils.h"
 
/*------------------------------------------------------------*/
/*---------------------- DEFINES AND MACROS ------------------*/
/*------------------------------------------------------------*/
 
#define ECU_DNODE_OBJ_UNUSED \
    ((void *)0)
 
#define ECU_DNODE_DESTROY_UNUSED \
    ((void (*)(struct ecu_dnode *, ecu_object_id_t))0)
 
#define ECU_DNODE_GET_ENTRY(ptr_, type_, member_) \
    ECU_CONTAINER_OF(ptr_, type_, member_)
 
#define ECU_DNODE_GET_CONST_ENTRY(ptr_, type_, member_) \
    ECU_CONST_CONTAINER_OF(ptr_, type_, member_)
 
#define ECU_DLIST_AT_FOR_EACH(var_, iter_, list_, start_)                      \
    for (struct ecu_dnode *var_ = ecu_dlist_iterator_at(iter_, list_, start_); \
         var_ != ecu_dlist_iterator_end(iter_);                                \
         var_ = ecu_dlist_iterator_next(iter_))
 
#define ECU_DLIST_CONST_AT_FOR_EACH(var_, citer_, list_, start_)                       \
    for (const struct ecu_dnode *var_ = ecu_dlist_iterator_cat(citer_, list_, start_); \
         var_ != ecu_dlist_iterator_cend(citer_);                                      \
         var_ = ecu_dlist_iterator_cnext(citer_))
 
#define ECU_DLIST_FOR_EACH(var_, iter_, list_)                            \
    for (struct ecu_dnode *var_ = ecu_dlist_iterator_begin(iter_, list_); \
         var_ != ecu_dlist_iterator_end(iter_);                           \
         var_ = ecu_dlist_iterator_next(iter_))
 
#define ECU_DLIST_CONST_FOR_EACH(var_, citer_, list_)                             \
    for (const struct ecu_dnode *var_ = ecu_dlist_iterator_cbegin(citer_, list_); \
         var_ != ecu_dlist_iterator_cend(citer_);                                 \
         var_ = ecu_dlist_iterator_cnext(citer_))
 
/*------------------------------------------------------------*/
/*-------------------------- DLIST ---------------------------*/
/*------------------------------------------------------------*/
 
struct ecu_dnode
{
    struct ecu_dnode *next;
 
    struct ecu_dnode *prev;
 
    void (*destroy)(struct ecu_dnode *me, ecu_object_id_t id);
 
    ecu_object_id_t id;
};
 
struct ecu_dlist
{
    struct ecu_dnode head;
};
 
/*------------------------------------------------------------*/
/*--------------------- DLIST ITERATORS ----------------------*/
/*------------------------------------------------------------*/
 
struct ecu_dlist_iterator
{
    struct ecu_dlist *list;
 
    struct ecu_dnode *current;
 
    struct ecu_dnode *next;
};
 
struct ecu_dlist_citerator
{
    const struct ecu_dlist *list;
 
    const struct ecu_dnode *current;
 
    const struct ecu_dnode *next;
};
 
/*------------------------------------------------------------*/
/*------------------ DNODE MEMBER FUNCTIONS ------------------*/
/*------------------------------------------------------------*/
 
#ifdef __cplusplus
extern "C" {
#endif
 
extern void ecu_dnode_ctor(struct ecu_dnode *me,
                           void (*destroy)(struct ecu_dnode *me, ecu_object_id_t id),
                           ecu_object_id_t id);
 
extern void ecu_dnode_destroy(struct ecu_dnode *me);
extern ecu_object_id_t ecu_dnode_id(const struct ecu_dnode *me);
 
extern bool ecu_dnode_in_list(const struct ecu_dnode *me);
 
extern void ecu_dnode_insert_after(struct ecu_dnode *pos, struct ecu_dnode *node);
 
extern void ecu_dnode_insert_before(struct ecu_dnode *pos, struct ecu_dnode *node);
 
extern struct ecu_dnode *ecu_dnode_next(struct ecu_dnode *me);
 
extern const struct ecu_dnode *ecu_dnode_cnext(const struct ecu_dnode *me);
 
extern struct ecu_dnode *ecu_dnode_prev(struct ecu_dnode *me);
 
extern const struct ecu_dnode *ecu_dnode_cprev(const struct ecu_dnode *me);
 
extern void ecu_dnode_remove(struct ecu_dnode *me);
 
extern bool ecu_dnode_valid(const struct ecu_dnode *me);
/*------------------------------------------------------------*/
/*------------------ DLIST MEMBER FUNCTIONS ------------------*/
/*------------------------------------------------------------*/
 
extern void ecu_dlist_ctor(struct ecu_dlist *me);
 
extern void ecu_dlist_destroy(struct ecu_dlist *me);
extern struct ecu_dnode *ecu_dlist_back(struct ecu_dlist *me);
 
extern const struct ecu_dnode *ecu_dlist_cback(const struct ecu_dlist *me);
 
extern void ecu_dlist_clear(struct ecu_dlist *me);
 
extern bool ecu_dlist_empty(const struct ecu_dlist *me);
 
extern struct ecu_dnode *ecu_dlist_front(struct ecu_dlist *me);
 
extern const struct ecu_dnode *ecu_dlist_cfront(const struct ecu_dlist *me);
 
extern void ecu_dlist_insert_before(struct ecu_dlist *me,
                                    struct ecu_dnode *node,
                                    bool (*condition)(const struct ecu_dnode *node, const struct ecu_dnode *position, void *data),
                                    void *data);
 
extern void ecu_dlist_push_back(struct ecu_dlist *me, struct ecu_dnode *node);
 
extern void ecu_dlist_push_front(struct ecu_dlist *me, struct ecu_dnode *node);
 
extern struct ecu_dnode *ecu_dlist_pop_back(struct ecu_dlist *me);
 
extern struct ecu_dnode *ecu_dlist_pop_front(struct ecu_dlist *me);
 
extern size_t ecu_dlist_size(const struct ecu_dlist *me);
 
extern void ecu_dlist_sort(struct ecu_dlist *me,
                           bool (*lhs_less_than_rhs)(const struct ecu_dnode *lhs, const struct ecu_dnode *rhs, void *data),
                           void *data);
 
extern void ecu_dlist_swap(struct ecu_dlist *me, struct ecu_dlist *other);
 
extern bool ecu_dlist_valid(const struct ecu_dlist *me);
/*------------------------------------------------------------*/
/*----------- NON-CONST ITERATOR MEMBER FUNCTIONS ------------*/
/*------------------------------------------------------------*/
 
extern struct ecu_dnode *ecu_dlist_iterator_at(struct ecu_dlist_iterator *me,
                                               struct ecu_dlist *list,
                                               struct ecu_dnode *start);
 
extern struct ecu_dnode *ecu_dlist_iterator_begin(struct ecu_dlist_iterator *me, struct ecu_dlist *list);
 
extern struct ecu_dnode *ecu_dlist_iterator_end(struct ecu_dlist_iterator *me);
 
extern struct ecu_dnode *ecu_dlist_iterator_next(struct ecu_dlist_iterator *me);
 
/*------------------------------------------------------------*/
/*------------- CONST ITERATOR MEMBER FUNCTIONS --------------*/
/*------------------------------------------------------------*/
 
extern const struct ecu_dnode *ecu_dlist_iterator_cat(struct ecu_dlist_citerator *me,
                                                      const struct ecu_dlist *list,
                                                      const struct ecu_dnode *start);
 
extern const struct ecu_dnode *ecu_dlist_iterator_cbegin(struct ecu_dlist_citerator *me,
                                                         const struct ecu_dlist *list);
 
extern const struct ecu_dnode *ecu_dlist_iterator_cend(struct ecu_dlist_citerator *me);
 
extern const struct ecu_dnode *ecu_dlist_iterator_cnext(struct ecu_dlist_citerator *me);
#ifdef __cplusplus
}
#endif
 
#endif /* ECU_DLIST_H_ */