le_singlyLinkedList.h

Go to the documentation of this file.

#ifndef LEGATO_SINGLY_LINKED_LIST_INCLUDE_GUARD
#define LEGATO_SINGLY_LINKED_LIST_INCLUDE_GUARD


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_sls_Link
{
    struct le_sls_Link* nextPtr;       
}
le_sls_Link_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct
{
    le_sls_Link_t* tailLinkPtr;        
}
le_sls_List_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef bool (*le_sls_LessThanFunc_t)(le_sls_Link_t* a, le_sls_Link_t* b);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SLS_LIST_DECL_INIT {NULL}

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SLS_LIST_INIT (le_sls_List_t)LE_SLS_LIST_DECL_INIT


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SLS_LINK_INIT (le_sls_Link_t){NULL}


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sls_Stack
(
    le_sls_List_t* listPtr,            
    le_sls_Link_t* newLinkPtr          
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sls_Queue
(
    le_sls_List_t* listPtr,            
    le_sls_Link_t* newLinkPtr          
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sls_AddAfter
(
    le_sls_List_t* listPtr,            
    le_sls_Link_t* currentLinkPtr,     
    le_sls_Link_t* newLinkPtr          
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sls_Link_t* le_sls_RemoveAfter
(
    le_sls_List_t* listPtr,            
    le_sls_Link_t* currentLinkPtr      
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sls_Link_t* le_sls_Pop
(
    le_sls_List_t* listPtr             
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sls_Link_t* le_sls_Peek
(
    const le_sls_List_t* listPtr            
);


//------------------------------------------------------------------------------------------------------------
//------------------------------------------------------------------------------------------------------------
le_sls_Link_t* le_sls_PeekTail
(
    const le_sls_List_t* listPtr            
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sls_Link_t* le_sls_PeekNext
(
    const le_sls_List_t* listPtr,           
    const le_sls_Link_t* currentLinkPtr     
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_DECLARE_INLINE bool le_sls_IsEmpty
(
    const le_sls_List_t* listPtr            
)
//--------------------------------------------------------------------------------------------------
{
    return (le_sls_Peek(listPtr) == NULL);
}


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sls_Sort
(
    le_sls_List_t* listPtr,                 
    le_sls_LessThanFunc_t comparatorPtr     
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_sls_IsInList
(
    const le_sls_List_t* listPtr,    
    const le_sls_Link_t* linkPtr     
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_DECLARE_INLINE bool le_sls_IsHead
(
    const le_sls_List_t* listPtr,    
    const le_sls_Link_t* linkPtr     
)
{
    return (le_sls_Peek(listPtr) == linkPtr);
}


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_DECLARE_INLINE bool le_sls_IsTail
(
    const le_sls_List_t* listPtr,    
    const le_sls_Link_t* linkPtr     
)
{
    return (le_sls_PeekTail(listPtr) == linkPtr);
}


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
size_t le_sls_NumLinks
(
    const le_sls_List_t* listPtr       
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_sls_IsListCorrupted
(
    const le_sls_List_t* listPtr    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SLS_FOREACH(listPtr, iteratorPtr, type, member)              \
    for ((iteratorPtr) = CONTAINER_OF(le_sls_Peek(listPtr), type, member); \
         &((iteratorPtr)->member);                                      \
         (iteratorPtr) = CONTAINER_OF(le_sls_PeekNext((listPtr),&((iteratorPtr)->member)), \
                                      type, member))



#endif  // LEGATO_SINGLY_LINKED_LIST_INCLUDE_GUARD