le_doublyLinkedList.h

Go to the documentation of this file.

#ifndef LEGATO_DOUBLY_LINKED_LIST_INCLUDE_GUARD
#define LEGATO_DOUBLY_LINKED_LIST_INCLUDE_GUARD


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_dls_Link
{
    struct le_dls_Link* nextPtr;       
    struct le_dls_Link* prevPtr;       
}
le_dls_Link_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct
{
    le_dls_Link_t* headLinkPtr;        
}
le_dls_List_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef bool (*le_dls_LessThanFunc_t)(le_dls_Link_t* a, le_dls_Link_t* b);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_DLS_LIST_DECL_INIT {NULL}

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_DLS_LIST_INIT (le_dls_List_t)LE_DLS_LIST_DECL_INIT


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_DLS_LINK_INIT (le_dls_Link_t){NULL, NULL}


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_dls_Stack
(
    le_dls_List_t* listPtr,            
    le_dls_Link_t* newLinkPtr          
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_dls_Queue
(
    le_dls_List_t* listPtr,            
    le_dls_Link_t* newLinkPtr          
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_dls_AddAfter
(
    le_dls_List_t* listPtr,            
    le_dls_Link_t* currentLinkPtr,     
    le_dls_Link_t* newLinkPtr          
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_dls_AddBefore
(
    le_dls_List_t* listPtr,            
    le_dls_Link_t* currentLinkPtr,     
    le_dls_Link_t* newLinkPtr          
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_dls_Link_t* le_dls_Pop
(
    le_dls_List_t* listPtr             
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_dls_Link_t* le_dls_PopTail
(
    le_dls_List_t* listPtr             
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_dls_Remove
(
    le_dls_List_t* listPtr,             
    le_dls_Link_t* linkToRemovePtr      
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_dls_Link_t* le_dls_Peek
(
    const le_dls_List_t* listPtr            
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_dls_Link_t* le_dls_PeekTail
(
    const le_dls_List_t* listPtr            
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_DECLARE_INLINE bool le_dls_IsEmpty
(
    const le_dls_List_t* listPtr            
)
//--------------------------------------------------------------------------------------------------
{
    return (le_dls_Peek(listPtr) == NULL);
}


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_dls_Link_t* le_dls_PeekNext
(
    const le_dls_List_t* listPtr,           
    const le_dls_Link_t* currentLinkPtr     
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_dls_Link_t* le_dls_PeekPrev
(
    const le_dls_List_t* listPtr,          
    const le_dls_Link_t* currentLinkPtr    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_dls_Swap
(
    le_dls_List_t* listPtr,         
    le_dls_Link_t* linkPtr,         
    le_dls_Link_t* otherLinkPtr     
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_dls_Sort
(
    le_dls_List_t* listPtr,                 
    le_dls_LessThanFunc_t comparatorPtr     
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_dls_IsInList
(
    const le_dls_List_t* listPtr,    
    const le_dls_Link_t* linkPtr     
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_DECLARE_INLINE bool le_dls_IsHead
(
    const le_dls_List_t* listPtr,    
    const le_dls_Link_t* linkPtr     
)
{
    return (le_dls_Peek(listPtr) == linkPtr);
}


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_DECLARE_INLINE bool le_dls_IsTail
(
    const le_dls_List_t* listPtr,    
    const le_dls_Link_t* linkPtr     
)
{
    return (le_dls_PeekTail(listPtr) == linkPtr);
}


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
size_t le_dls_NumLinks
(
    const le_dls_List_t* listPtr       
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_dls_IsListCorrupted
(
    const le_dls_List_t* listPtr    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_DLS_FOREACH(listPtr, iteratorPtr, type, member)              \
    for ((iteratorPtr) = CONTAINER_OF(le_dls_Peek(listPtr), type, member); \
         &((iteratorPtr)->member);                                      \
         (iteratorPtr) = CONTAINER_OF(le_dls_PeekNext((listPtr),&((iteratorPtr)->member)), \
                                      type, member))


#endif  // LEGATO_DOUBLY_LINKED_LIST_INCLUDE_GUARD