Site Map | Careers | Contact Us

• PRODUCTS
• SUPPORT
• RESOURCES

• PARTNERS
• CUSTOMERS
• ABOUT US

Home > Support > Documentation

rtxDList.h

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2007 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 {
   OSUINT32 count;              
   OSRTDListNode* head;         
   OSRTDListNode* tail;         
} OSRTDList;

struct OSCTXT;

typedef struct OSRTDListBuf {
   OSUINT32 n;
   OSUINT32 nMax;
   OSUINT32 nAll;
   OSUINT32 firstSegSz;
   size_t 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 */

EXTERNRTX void rtxDListInit (OSRTDList* pList);

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

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

EXTERNRTX OSRTDListNode* rtxDListInsert 
(struct OSCTXT* pctxt, OSRTDList* pList, OSUINT32 index, void* pData);

EXTERNRTX OSRTDListNode* rtxDListInsertNode 
(OSRTDList* pList, OSUINT32 index, OSRTDListNode* pListNode);

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

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

EXTERNRTX OSRTDListNode* 
rtxDListFindByIndex (const OSRTDList* pList, OSUINT32 index);

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

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

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

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

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

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

EXTERNRTX int rtxDListToArray 
(struct OSCTXT* pctxt, OSRTDList* pList, void** ppArray, 
 OSUINT32* pElemCount, size_t elemSize);

EXTERNRTX int rtxDListAppendArray 
(struct OSCTXT* pctxt, OSRTDList* pList, void* pArray, 
 OSUINT32 numElements, size_t elemSize);

EXTERNRTX int rtxDListAppendArrayCopy 
(struct OSCTXT* pctxt, OSRTDList* pList, const void* pArray, 
 OSUINT32 numElements, size_t elemSize);

EXTERNRTX int rtxDListToUTF8Str 
(struct OSCTXT* pctxt, OSRTDList* pList, OSUTF8CHAR** ppstr, char sep);
/* 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 { \
OSRTDListNode* _node = (OSRTDListNode*) \
(((char*)(pData)) - sizeof(OSRTDListNode)); \
_node->data = pData; \
rtxDListAppendNode (pList, _node); \
} while (0);

#define rtxDListFastInit(pList) do { \
if ((pList) != 0) { \
(pList)->head = (pList)->tail = (OSRTDListNode*) 0; \
(pList)->count = 0; } \
} while (0)

/* Doubly-linked list buffer functions */

EXTERNRTX void rtxDListBufInit (OSRTDListBuf* pBuf,
   OSUINT32 segSz, void** ppdata, size_t elemSz);

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

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

#ifdef __cplusplus
}
#endif

#endif

©Copyright 2001-2007. Objective Systems, Inc. All Rights Reserved.