ctb_DNode.h

Go to the documentation of this file.

/**
 * @file
 */
#ifndef CTB_DNODE_H
#define CTB_DNODE_H
 
/**
 * @brief Doubly linked node type
 */
typedef struct ctb_DNode ctb_DNode_t;
 
/**
 * @brief Doubly linked node data structure
 */
struct ctb_DNode {
    ctb_DNode_t * next; /**< Pointer to the next node */
    ctb_DNode_t * prev; /**< Pointer to the previous node */
};
 
/**
 * @brief Initializes a doubly linked node
 *
 * @param self Pointer to a doubly linked node
 * @return Pointer to the initialized doubly linked node
 */
ctb_DNode_t * ctb_DNode_init(ctb_DNode_t * const self);
 
/**
 * @brief Returns the next node
 *
 * @param self Pointer to a doubly linked node
 * @return Pointer to the next node
 */
ctb_DNode_t * ctb_DNode_getNext(ctb_DNode_t * const self);
 
/**
 * @brief Returns the previous node
 *
 * @param self Pointer to a doubly linked node
 * @return Pointer to the previous node
 */
ctb_DNode_t * ctb_DNode_getPrev(ctb_DNode_t * const self);
 
#endif // CTB_DNODE_H