rtxArrayList.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2022 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 _RTXARRAYLIST_H_
#define _RTXARRAYLIST_H_

#include "rtxsrc/rtxContext.h"

#define OSRT_ARRAYLIST_CAPACITY 10

typedef struct _OSRTArrayList {
   OSRTDList segments;
   OSSIZE    segmentSize;
   OSSIZE    size;
   OSSIZE    dataSize;
   OSBOOL    (*equalsFunc)(void*,void*,OSSIZE);
} OSRTArrayList;

typedef struct _OSRTArrayListIter {
   const OSRTArrayList* pArrayList;
   OSRTDListNode* pSegment;
   OSSIZE         index;
} OSRTArrayListIter;

/* Iteration is done as follows:
 * rtxArrayListInitIter (&iter, &arrayList, 0);
 * while (rtxArrayListHasNextItem (&iter)) {
 *    pdata = rtxArrayListNextItem (&iter);
 *    ...
 */
#ifdef __cplusplus
extern "C" {
#endif

EXTERNRT void rtxArrayListInit
(OSRTArrayList* pArrayList, OSSIZE capacity);

EXTERNRT OSRTArrayList* rtxNewArrayList (OSCTXT* pctxt, OSSIZE capacity);

EXTERNRT void rtxFreeArrayList (OSCTXT* pctxt, OSRTArrayList* pArrayList);

EXTERNRT int rtxArrayListAdd
(OSCTXT* pctxt, OSRTArrayList* pArrayList, void* pdata, OSSIZE* pindex);

EXTERNRT void rtxArrayListRemove
(OSCTXT* pctxt, OSRTArrayList* pArrayList, void* pdata);

EXTERNRT void rtxArrayListRemoveIndexed
(OSCTXT* pctxt, OSRTArrayList* pArrayList, OSSIZE idx);

EXTERNRT int rtxArrayListInsert
(OSCTXT* pctxt, OSRTArrayList* pArrayList, void* pdata, OSSIZE idx);

EXTERNRT int rtxArrayListReplace
(OSRTArrayList* pArrayList, void* pdata, OSSIZE idx);

EXTERNRT void* rtxArrayListGetIndexed
(const OSRTArrayList* pArrayList, OSSIZE idx);

EXTERNRT int rtxArrayListIndexOf (OSRTArrayList* pArrayList, void* pdata);

/* Iteration */

EXTERNRT int rtxArrayListInitIter (OSRTArrayListIter* piter,
   const OSRTArrayList* pArrayList, OSSIZE startIndex);

EXTERNRT OSBOOL rtxArrayListHasNextItem (OSRTArrayListIter* piter);

EXTERNRT void* rtxArrayListNextItem (OSRTArrayListIter* piter);

#ifdef __cplusplus
}
#endif

#endif