rtxDList.h

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2018 Objective Systems, Inc.
 *
 * This software is furnished under a license and may be used and copied
 * only in accordance with the terms of such license and with the
 * inclusion of the above copyright notice. This software or any other
 * copies thereof may not be provided or otherwise made available to any
 * other person. No title to and ownership of the software is hereby
 * transferred.
 *
 * The information in this software is subject to change without notice
 * and should not be construed as a commitment by Objective Systems, Inc.
 *
 * PROPRIETARY NOTICE
 *
 * This software is an unpublished work subject to a confidentiality agreement
 * and is protected by copyright and trade secret law.  Unauthorized copying,
 * redistribution or other use of this work is prohibited.
 *
 * The above notice of copyright on this source code product does not indicate
 * any actual or intended publication of such source code.
 *
 *****************************************************************************/
#ifndef _RTXDLIST_H_
#define _RTXDLIST_H_

#include "rtxsrc/osSysTypes.h"
#include "rtxsrc/rtxExternDefs.h"
#include "rtxsrc/rtxCommonDefs.h"
typedef struct OSRTDListNode {
   void* data;            
   struct OSRTDListNode* next; 
   struct OSRTDListNode* prev; 
} OSRTDListNode;

typedef struct OSRTDList {
   OSSIZE count;               
   OSRTDListNode* head;        
   OSRTDListNode* tail;        
} OSRTDList;

struct OSCTXT;

typedef struct OSRTDListBuf {
   OSSIZE n;
   OSSIZE nMax;
   OSSIZE nAll;
   OSSIZE firstSegSz;
   OSSIZE   elemSize;
   OSRTDList tmplist;
   void** dataArray;
} OSRTDListBuf;

#ifndef DLISTBUF_SEG
#define DLISTBUF_SEG 16
#endif

typedef struct OSRTDListUTF8StrNode {
   OSRTDListNode node;
   OSUTF8CHAR    utf8chars[1];
} OSRTDListUTF8StrNode;

#ifdef __cplusplus
extern "C" {
#endif

/* Doubly-linked list functions */

EXTERNRT void rtxDListInit (OSRTDList* pList);

EXTERNRT OSRTDListNode* rtxDListAppend
(struct OSCTXT* pctxt, OSRTDList* pList, void* pData);

EXTERNRT OSRTDListNode* rtxDListAppendCharArray
(struct OSCTXT* pctxt, OSRTDList* pList, size_t length, char* pData);

EXTERNRT OSRTDListNode* rtxDListAppendNode
(OSRTDList* pList, OSRTDListNode* pListNode);

EXTERNRT OSRTDListNode* rtxDListInsert
(struct OSCTXT* pctxt, OSRTDList* pList, OSSIZE idx, void* pData);

EXTERNRT OSRTDListNode* rtxDListInsertNode
(OSRTDList* pList, OSSIZE idx, OSRTDListNode* pListNode);

EXTERNRT OSRTDListNode* rtxDListInsertBefore
(struct OSCTXT* pctxt, OSRTDList* pList, OSRTDListNode* node, void* pData);

EXTERNRT OSRTDListNode* rtxDListInsertAfter
(struct OSCTXT* pctxt, OSRTDList* pList, OSRTDListNode* node, void* pData);

EXTERNRT OSRTDListNode*
rtxDListFindByIndex (const OSRTDList* pList, OSSIZE idx);

EXTERNRT OSRTDListNode*
rtxDListFindByData (const OSRTDList* pList, void* data);

EXTERNRT int rtxDListFindIndexByData (const OSRTDList* pList, void* data);

EXTERNRT void rtxDListFreeNode
   (struct OSCTXT* pctxt, OSRTDList* pList, OSRTDListNode* node);

EXTERNRT void rtxDListRemove (OSRTDList* pList, OSRTDListNode* node);

EXTERNRT void rtxDListFreeNodes (struct OSCTXT* pctxt, OSRTDList* pList);

EXTERNRT void rtxDListFreeAll (struct OSCTXT* pctxt, OSRTDList* pList);

EXTERNRT int rtxDListToArray
(struct OSCTXT* pctxt, OSRTDList* pList, void** ppArray,
 OSSIZE* pElemCount, OSSIZE elemSize);

EXTERNRT int rtxDListAppendArray
(struct OSCTXT* pctxt, OSRTDList* pList, void* pArray,
 OSSIZE numElements, OSSIZE elemSize);

EXTERNRT int rtxDListAppendArrayCopy
(struct OSCTXT* pctxt, OSRTDList* pList, const void* pArray,
 OSSIZE numElements, OSSIZE elemSize);

EXTERNRT int rtxDListToUTF8Str
(struct OSCTXT* pctxt, OSRTDList* pList, OSUTF8CHAR** ppstr, char sep);



typedef int (*PEqualsFunc) (const void* a, const void* b,
                               const void* sortCtxt);

EXTERNRT OSRTDListNode* rtxDListInsertSorted
(struct OSCTXT* pctxt, OSRTDList* pList, void* pData, PEqualsFunc equalsFunc,
 void* sortCtxt);

EXTERNRT OSRTDListNode* rtxDListInsertNodeSorted
(OSRTDList* pList, OSRTDListNode* pListNode, PEqualsFunc equalsFunc,
 void* sortCtxt);

#if defined(_MSC_VER)
/*  this disables 'conditional expression is constant' warnings */
/*  caused by using do { ... } while(0) in defines. */
#pragma warning(disable: 4127)
#endif

/* This rounds node size up to a 64-bit boundary to fix alignment issues */
#define OSRTDLISTNODESIZE ((sizeof(OSRTDListNode)+7)&(~7))

#define rtxDListAllocNodeAndData(pctxt,type,ppnode,ppdata) do { \
*ppnode = (OSRTDListNode*) \
rtxMemAlloc (pctxt, sizeof(type)+OSRTDLISTNODESIZE); \
if (0 != *ppnode) { \
(*ppnode)->data = (void*)((char*)(*ppnode)+OSRTDLISTNODESIZE); \
*ppdata = (type*)((*ppnode)->data); \
} else { *ppdata = 0; } \
} while (0)

#define rtxDListAppendData(pctxt,pList,pData) do { \
   rtxDListAppend(pctxt,pList,pData); \
} while(0);

/* Use function rtxDListInit instead. This macro reportedly caused problems
 * in some cases. */
#define rtxDListFastInit(pList) do { \
if ((pList) != 0) { \
(pList)->head = (pList)->tail = (OSRTDListNode*) 0; \
(pList)->count = 0; } \
} while (0)

#define rtxDListFreeTailNode(pctxt,pList) \
rtxDListFreeNode(pctxt,pList,(pList)->tail)

#define rtxDListFreeHeadNode(pctxt,pList) \
rtxDListFreeNode(pctxt,pList,(pList)->head)

/* Doubly-linked list buffer functions */

EXTERNRT void rtxDListBufInit (OSRTDListBuf* pBuf,
   OSSIZE segSz, void** ppdata, OSSIZE elemSz);

EXTERNRT int rtxDListBufExpand (struct OSCTXT* pctxt, OSRTDListBuf* pBuf);

EXTERNRT int rtxDListBufToArray (struct OSCTXT* pctxt, OSRTDListBuf* pBuf);

#ifdef __cplusplus
}
#endif

#endif