bsl_list.h

/*
 * This file is part of the openHiTLS project.
 *
 * openHiTLS is licensed under the Mulan PSL v2.
 * You can use this software according to the terms and conditions of the Mulan PSL v2.
 * You may obtain a copy of Mulan PSL v2 at:
 *
 *     http://license.coscl.org.cn/MulanPSL2
 *
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
 * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PSL v2 for more details.
 */

 
#ifndef BSL_LIST_H
#define BSL_LIST_H
 
#include <stdint.h>
#include "bsl_errno.h"
#include "bsl_sal.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* for handling ASN.1 SET OF type */

typedef struct BslListNode {
    struct BslListNode *prev; 
    struct BslListNode *next; 
    void *data;               
} BslListNode;

typedef struct BslList {
    BslListNode *first;     
    BslListNode *last;      
    BslListNode *curr;      
    int32_t count;          
    int32_t dataSize;       
} BslList;

typedef enum {
    BSL_LIST_POS_BEFORE, 
    BSL_LIST_POS_AFTER,  
    BSL_LIST_POS_BEGIN,  
    BSL_LIST_POS_END     
} BslListPosition;

typedef int32_t (*BSL_LIST_PFUNC_CMP)(const void *, const void *);

typedef void (*BSL_LIST_PFUNC_FREE)(void *);

typedef void *(*BSL_LIST_PFUNC_DUP)(const void *);
 
/*
  The following macros return the specified element of the list.  They do
  not change the current list pointer.
 */
/* returns the current element */
#define BSL_LIST_CURR_ELMT(pList) ((pList) ? ((pList)->curr ? ((pList)->curr->data) : NULL) : NULL)
 
/* returns the next element */
#define BSL_LIST_NEXT_ELMT(pList) \
    ((pList) ? ((pList)->curr ? ((pList)->curr->next ? ((pList)->curr->next->data) : NULL) : NULL) : NULL)
 
/* returns the previous element */
#define BSL_LIST_PREV_ELMT(pList) \
    ((pList) ? ((pList)->curr ? ((pList)->curr->prev ? ((pList)->curr->prev->data) : NULL) : NULL) : NULL)
 
/* returns the last element */
#define BSL_LIST_LAST_ELMT(pList) ((pList) ? ((pList)->last ? ((pList)->last->data) : NULL) : NULL)
 
/* returns the first element */
#define BSL_LIST_FIRST_ELMT(pList) ((pList) ? ((pList)->first ? ((pList)->first->data) : NULL) : NULL)
 
/* checks if the list is NULL */
#define BSL_LIST_EMPTY(pList) (((pList) != NULL) ? ((pList)->count == 0) : 0)
 
/* returns the number of nodes in the list */
#define BSL_LIST_COUNT(pList) ((pList) ? ((pList)->count) : 0)
 
/* checks if current node is the end */
#define BSL_LIST_IS_END(pList) ((pList) ? (NULL == (pList)->curr) : 0)
 
/* checks if current node is the first one */
#define BSL_LIST_IS_START(pList) ((pList) ? ((pList)->first == (pList)->curr) : 0)
 
/* Get the next element */
#define BSL_LIST_GET_NEXT(pList) ((pList) ? (BSL_LIST_Next(pList) ? BSL_LIST_CURR_ELMT(pList) : NULL) : NULL)
 
/* Get the previous element */
#define BSL_LIST_GET_PREV(pList) ((pList) ? (BSL_LIST_Prev(pList) ? BSL_LIST_CURR_ELMT(pList) : NULL) : NULL)
 
/* Get the first element */
#define BSL_LIST_GET_FIRST(pList) ((pList) ? (BSL_LIST_First(pList) ? BSL_LIST_CURR_ELMT(pList) : NULL) : NULL)
 
/* Get the last element */
#define BSL_LIST_GET_LAST(pList) ((pList) ? (BSL_LIST_Last(pList) ? BSL_LIST_CURR_ELMT(pList) : NULL) : NULL)

#define BSL_LIST_FREE(pList, pFreeFunc)        \
    do {                                       \
        BSL_LIST_DeleteAll((pList), pFreeFunc); \
        if (NULL != (pList)) {             \
            BSL_SAL_Free(pList);                  \
            (pList) = NULL;                       \
        }                                      \
    } while (0)
 
 
#define SEC_INT_ERROR (-2)

int32_t BSL_LIST_SetMaxElements(int32_t iMaxElements);

int32_t BSL_LIST_GetMaxElements(void);

int32_t BSL_LIST_AddElement(BslList *pList, void *pData, BslListPosition enPosition);

void BSL_LIST_DeleteAll(BslList *pList, BSL_LIST_PFUNC_FREE pfFreeFunc);

void BSL_LIST_DeleteCurrent(BslList *pList, BSL_LIST_PFUNC_FREE pfFreeFunc);

void BSL_LIST_DetachCurrent(BslList *pList);

void *BSL_LIST_Search(BslList *pList, const void *pSearchFor, BSL_LIST_PFUNC_CMP pSearcher, int32_t *pstErr);

void *BSL_LIST_GetIndexNode(uint32_t ulIndex, BslList *pList);

BslList *BSL_LIST_Copy(BslList *pSrcList, BSL_LIST_PFUNC_DUP pFuncCpy, BSL_LIST_PFUNC_FREE pfFreeFunc);

BslList *BSL_LIST_Sort(BslList *pList, BSL_LIST_PFUNC_CMP pfCmp);

BslList *BSL_LIST_New(int32_t dataSize);

void *BSL_LIST_Curr(const BslList *pstList);

void *BSL_LIST_First(BslList *pstList);

void *BSL_LIST_Last(BslList *pstList);

void *BSL_LIST_Next(BslList *pstList);

void *BSL_LIST_Prev(BslList *pstList);

int32_t BSL_LIST_GetElmtIndex(const void *elmt, BslList *pstList);

BslList *BSL_LIST_Concat(BslList *pDestList, const BslList *pSrcList);

void BSL_LIST_FreeWithoutData(BslList *pstList);

void BSL_LIST_RevList(BslList *pstList);

int32_t BSL_LIST_SetMaxQsortCount(uint32_t uiQsortSize);

uint32_t BSL_LIST_GetMaxQsortCount(void);

void BSL_LIST_DeleteAllAfterSort(BslList *pList);

BslListNode *BSL_LIST_FirstNode(const BslList *list);

void *BSL_LIST_GetData(const BslListNode *pstNode);

BslListNode *BSL_LIST_GetNextNode(const BslList *pstList, const BslListNode *pstListNode);

BslListNode *BSL_LIST_GetPrevNode(const BslListNode *pstListNode);

void BSL_LIST_DeleteNode(BslList *pstList, const BslListNode *pstListNode, BSL_LIST_PFUNC_FREE pfFreeFunc);

void BSL_LIST_DetachNode(BslList *pstList, BslListNode **pstListNode);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif // BSL_LIST_H