qlists.h

#ifndef  QLISTS_H
    #define QLISTS_H
 
    #include "qtypes.h"
    #include <string.h>
 
    #ifdef __cplusplus
    extern "C" {
    #endif


    typedef struct _qList_Node_s { // skipcq: CXX-E2000
        struct _qList_Node_s *next, *prev;  /*< Pointers to adjacent nodes. */
        void *container;                    /*< Pointer to the container list*/
    }
    qList_Node_t;

 
    #define qNode_MinimalFields     void *next, *prev, *container

    typedef struct _qList_s { // skipcq: CXX-E2000
        qNode_MinimalFields;        /*< To allow "list of lists" aka "nested-lists"*/
        qList_Node_t *head, *tail;  /*< Pointers to the beginning of and the end of the list. */
        size_t size;                /*< Used to hold the current size of the list. */
    }
    qList_t;

    #define QLIST_INITIALIZER   { NULL, NULL, NULL, NULL, NULL, 0U }

    typedef enum {
        qList_WalkInit,                 
        qList_WalkThrough,              
        qList_WalkEnd,                  
    }
    qList_WalkStage_t;

    typedef struct _qList_ForEachHandle_s { // skipcq: CXX-E2000
        void *node;                     
        void *arg;                      
        qList_WalkStage_t stage;        
    }
    #ifdef DOXYGEN
    qList_ForEachHandle_t;
    #else
    _qList_ForEachHandle_t; // skipcq: CXX-E2000
    typedef _qList_ForEachHandle_t* qList_ForEachHandle_t;
    #endif

    typedef struct _qList_CompareHandle_s { // skipcq: CXX-E2000
        const void *n1;                 
        const void *n2;                 
    }
    #ifdef DOXYGEN
    qList_CompareHandle_t;
    #else
    _qList_CompareHandle_t; // skipcq: CXX-E2000
    typedef _qList_CompareHandle_t* qList_CompareHandle_t;
    #endif

    typedef qBool_t (*qList_NodeFcn_t)( qList_ForEachHandle_t h );

    typedef qINT32_t qList_Position_t;

    #define QLIST_AT_FRONT          ( (qList_Position_t)( -1 ) )

    #define QLIST_AT_BACK           ( (qList_Position_t)( 2147483647 ) )
 

    qBool_t qList_Initialize( qList_t * const l );

    qBool_t qList_Insert( qList_t * const l,
                          void * const node,
                          const qList_Position_t p );

    qBool_t qList_RemoveItself( void *const node );

    void* qList_Remove( qList_t * const l,
                        void * const node,
                        const qList_Position_t p );

    qBool_t qList_Move( qList_t *const dst,
                        qList_t *const src,
                        const qList_Position_t p );

    qBool_t qList_IsMember( const qList_t * const l,
                            const void * const node );

    void* qList_GetFront( const qList_t * const l );

    void* qList_GetBack( const qList_t * const l );

    qBool_t qList_IsEmpty( const qList_t * const l );

    size_t qList_Length( const qList_t * const l );
 

    typedef qBool_t (*qList_CompareFcn_t)( qList_CompareHandle_t h );

    qBool_t qList_Sort( qList_t * const l,
                        qList_CompareFcn_t f ) ;

    qList_Node_t* _qNode_Backward( const qList_Node_t *const n ); /*This function are not intended for the user usage*/ // skipcq: CXX-E2000
    qList_Node_t* _qNode_Forward( const qList_Node_t *const n ); /*This function are not intended for the user usage*/ // skipcq: CXX-E2000

    typedef qList_Node_t* (*qList_Direction_t)( const qList_Node_t *const node );

    #define QLIST_FORWARD   ( _qNode_Forward )

    #define QLIST_BACKWARD  ( _qNode_Backward )

    typedef struct _qList_Iterator_s { // skipcq: CXX-E2000
        qList_t *l;
        qList_Node_t *iter;
        void *current;
    }
    qList_Iterator_t;
 

    qBool_t qList_IteratorSet( qList_Iterator_t *i,
                               qList_t *const l,
                               void *nodeOffset,
                               const qList_Direction_t d );

    qBool_t qList_ForEach( const qList_t *const l,
                           const qList_NodeFcn_t f,
                           void *arg,
                           qList_Direction_t d,
                           void *nodeOffset );

    qBool_t qList_Swap( void *node1,
                        void *node2 );

    qList_Iterator_t qList_Begin( qList_t *const xList );

    qList_Iterator_t qList_End( qList_t *const xList );

    qBool_t qListIterator_Until( const qList_Iterator_t * const i,
                                 const void * const node );

    void qListIterator_Forward( qList_Iterator_t *i );

    void qListIterator_Backward( qList_Iterator_t *i );

    void* qListIterator_Get( const qList_Iterator_t * const i );

    #ifdef __cplusplus
    }
    #endif
 
#endif