FreeRDP/winpr/libwinpr/utils/collections/ArrayList.c

598 lines
12 KiB
C
Raw Normal View History

/**
* WinPR: Windows Portable Runtime
* System.Collections.ArrayList
*
* Copyright 2012 Marc-Andre Moreau <marcandre.moreau@gmail.com>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
2022-02-16 12:08:00 +03:00
#include <winpr/config.h>
#include <stdarg.h>
2012-12-06 02:24:01 +04:00
#include <winpr/crt.h>
2021-06-14 10:42:22 +03:00
#include <winpr/assert.h>
#include <winpr/collections.h>
#if defined(_WIN32) && (_MSC_VER < 1800) && !defined(__MINGW32__)
#define va_copy(dest, src) (dest = src)
#endif
struct s_wArrayList
{
size_t capacity;
size_t growthFactor;
BOOL synchronized;
size_t size;
void** array;
CRITICAL_SECTION lock;
wObject object;
};
/**
* C equivalent of the C# ArrayList Class:
* http://msdn.microsoft.com/en-us/library/system.collections.arraylist.aspx
*/
/**
* Properties
*/
/**
* Gets or sets the number of elements that the ArrayList can contain.
*/
size_t ArrayList_Capacity(wArrayList* arrayList)
{
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
2012-12-06 02:24:01 +04:00
return arrayList->capacity;
}
/**
* Gets the number of elements actually contained in the ArrayList.
*/
size_t ArrayList_Count(wArrayList* arrayList)
{
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
2012-12-06 02:24:01 +04:00
return arrayList->size;
}
/**
* Gets the internal list of items contained in the ArrayList.
*/
size_t ArrayList_Items(wArrayList* arrayList, ULONG_PTR** ppItems)
{
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
2019-11-06 17:24:51 +03:00
*ppItems = (ULONG_PTR*)arrayList->array;
return arrayList->size;
}
/**
* Gets a value indicating whether the ArrayList has a fixed size.
*/
BOOL ArrayList_IsFixedSized(wArrayList* arrayList)
{
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
return FALSE;
}
/**
* Gets a value indicating whether the ArrayList is read-only.
*/
BOOL ArrayList_IsReadOnly(wArrayList* arrayList)
{
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
return FALSE;
}
/**
* Gets a value indicating whether access to the ArrayList is synchronized (thread safe).
*/
BOOL ArrayList_IsSynchronized(wArrayList* arrayList)
{
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
2012-12-06 02:24:01 +04:00
return arrayList->synchronized;
}
2012-12-08 04:40:44 +04:00
/**
* Lock access to the ArrayList
*/
2021-06-17 10:21:20 +03:00
static void ArrayList_Lock_Conditional(wArrayList* arrayList)
{
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
if (arrayList->synchronized)
EnterCriticalSection(&arrayList->lock);
}
void ArrayList_Lock(wArrayList* arrayList)
2012-12-08 04:40:44 +04:00
{
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
EnterCriticalSection(&arrayList->lock);
2012-12-08 04:40:44 +04:00
}
/**
* Unlock access to the ArrayList
*/
2021-06-17 10:21:20 +03:00
static void ArrayList_Unlock_Conditional(wArrayList* arrayList)
{
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
if (arrayList->synchronized)
LeaveCriticalSection(&arrayList->lock);
}
void ArrayList_Unlock(wArrayList* arrayList)
2012-12-08 04:40:44 +04:00
{
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
LeaveCriticalSection(&arrayList->lock);
2012-12-08 04:40:44 +04:00
}
/**
2012-12-06 02:24:01 +04:00
* Gets the element at the specified index.
*/
void* ArrayList_GetItem(wArrayList* arrayList, size_t index)
{
void* obj = NULL;
2012-12-06 02:24:01 +04:00
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
2020-11-10 10:14:56 +03:00
if (index < arrayList->size)
2012-12-06 02:24:01 +04:00
{
obj = arrayList->array[index];
}
return obj;
}
/**
* Sets the element at the specified index.
*/
void ArrayList_SetItem(wArrayList* arrayList, size_t index, const void* obj)
2012-12-06 02:24:01 +04:00
{
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
2020-11-10 10:14:56 +03:00
if (index < arrayList->size)
2012-12-06 02:24:01 +04:00
{
if (arrayList->object.fnObjectNew)
arrayList->array[index] = arrayList->object.fnObjectNew(obj);
else
2022-04-27 22:02:18 +03:00
{
union
{
const void* cpv;
void* pv;
} cnv;
cnv.cpv = obj;
arrayList->array[index] = cnv.pv;
}
2012-12-06 02:24:01 +04:00
}
}
/**
* Methods
*/
static BOOL ArrayList_EnsureCapacity(wArrayList* arrayList, size_t count)
{
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
WINPR_ASSERT(count > 0);
if (arrayList->size + count > arrayList->capacity)
{
void** newArray;
size_t newCapacity = arrayList->capacity * arrayList->growthFactor;
if (newCapacity < arrayList->size + count)
newCapacity = arrayList->size + count;
newArray = (void**)realloc(arrayList->array, sizeof(void*) * newCapacity);
if (!newArray)
return FALSE;
arrayList->array = newArray;
arrayList->capacity = newCapacity;
}
return TRUE;
}
2012-12-06 02:24:01 +04:00
/**
* Shift a section of the list.
*/
2021-06-14 10:42:22 +03:00
static BOOL ArrayList_Shift(wArrayList* arrayList, size_t index, SSIZE_T count)
2012-12-06 02:24:01 +04:00
{
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
2012-12-06 02:24:01 +04:00
if (count > 0)
{
if (!ArrayList_EnsureCapacity(arrayList, count))
return FALSE;
2012-12-06 02:24:01 +04:00
MoveMemory(&arrayList->array[index + count], &arrayList->array[index],
(arrayList->size - index) * sizeof(void*));
2012-12-06 02:24:01 +04:00
arrayList->size += count;
}
else if (count < 0)
{
INT64 chunk = arrayList->size - index + count;
if (chunk > 0)
2019-11-06 17:24:51 +03:00
MoveMemory(&arrayList->array[index], &arrayList->array[index - count],
chunk * sizeof(void*));
2012-12-06 02:24:01 +04:00
arrayList->size += count;
}
2014-04-09 23:53:42 +04:00
return TRUE;
2012-12-06 02:24:01 +04:00
}
/**
* Removes all elements from the ArrayList.
*/
void ArrayList_Clear(wArrayList* arrayList)
{
size_t index;
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
ArrayList_Lock_Conditional(arrayList);
for (index = 0; index < arrayList->size; index++)
{
if (arrayList->object.fnObjectFree)
arrayList->object.fnObjectFree(arrayList->array[index]);
arrayList->array[index] = NULL;
}
arrayList->size = 0;
ArrayList_Unlock_Conditional(arrayList);
}
/**
* Determines whether an element is in the ArrayList.
*/
BOOL ArrayList_Contains(wArrayList* arrayList, const void* obj)
{
size_t index;
BOOL rc = FALSE;
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
ArrayList_Lock_Conditional(arrayList);
for (index = 0; index < arrayList->size; index++)
{
rc = arrayList->object.fnObjectEquals(arrayList->array[index], obj);
if (rc)
break;
}
ArrayList_Unlock_Conditional(arrayList);
return rc;
}
#if defined(WITH_WINPR_DEPRECATED)
int ArrayList_Add(wArrayList* arrayList, const void* obj)
{
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
if (!ArrayList_Append(arrayList, obj))
return -1;
2021-06-17 12:25:58 +03:00
return (int)ArrayList_Count(arrayList) - 1;
}
#endif
/**
* Adds an object to the end of the ArrayList.
*/
BOOL ArrayList_Append(wArrayList* arrayList, const void* obj)
{
size_t index;
BOOL rc = FALSE;
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
ArrayList_Lock_Conditional(arrayList);
2014-04-09 23:53:42 +04:00
if (!ArrayList_EnsureCapacity(arrayList, 1))
goto out;
index = arrayList->size++;
ArrayList_SetItem(arrayList, index, obj);
rc = TRUE;
2014-04-09 23:53:42 +04:00
out:
ArrayList_Unlock_Conditional(arrayList);
2012-12-06 02:24:01 +04:00
return rc;
}
/*
* Inserts an element into the ArrayList at the specified index.
*/
BOOL ArrayList_Insert(wArrayList* arrayList, size_t index, const void* obj)
{
2014-04-09 23:53:42 +04:00
BOOL ret = TRUE;
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
ArrayList_Lock_Conditional(arrayList);
2020-11-10 10:14:56 +03:00
if (index < arrayList->size)
2012-12-06 02:24:01 +04:00
{
2014-04-09 23:53:42 +04:00
if (!ArrayList_Shift(arrayList, index, 1))
{
ret = FALSE;
}
else
{
ArrayList_SetItem(arrayList, index, obj);
2014-04-09 23:53:42 +04:00
}
}
2012-12-06 02:24:01 +04:00
ArrayList_Unlock_Conditional(arrayList);
2014-04-09 23:53:42 +04:00
return ret;
}
/**
* Removes the first occurrence of a specific object from the ArrayList.
*/
BOOL ArrayList_Remove(wArrayList* arrayList, const void* obj)
{
size_t index;
2012-12-06 02:24:01 +04:00
BOOL found = FALSE;
2014-04-09 23:53:42 +04:00
BOOL ret = TRUE;
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
ArrayList_Lock_Conditional(arrayList);
2012-12-06 02:24:01 +04:00
for (index = 0; index < arrayList->size; index++)
{
if (arrayList->object.fnObjectEquals(arrayList->array[index], obj))
2012-12-06 02:24:01 +04:00
{
found = TRUE;
break;
}
}
2012-12-06 02:24:01 +04:00
if (found)
{
if (arrayList->object.fnObjectFree)
arrayList->object.fnObjectFree(arrayList->array[index]);
2014-04-09 23:53:42 +04:00
ret = ArrayList_Shift(arrayList, index, -1);
}
2012-12-06 02:24:01 +04:00
ArrayList_Unlock_Conditional(arrayList);
2014-04-09 23:53:42 +04:00
return ret;
}
/**
* Removes the element at the specified index of the ArrayList.
*/
BOOL ArrayList_RemoveAt(wArrayList* arrayList, size_t index)
{
2014-04-09 23:53:42 +04:00
BOOL ret = TRUE;
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
ArrayList_Lock_Conditional(arrayList);
2020-11-10 10:14:56 +03:00
if (index < arrayList->size)
2012-12-06 02:24:01 +04:00
{
if (arrayList->object.fnObjectFree)
arrayList->object.fnObjectFree(arrayList->array[index]);
2014-04-09 23:53:42 +04:00
ret = ArrayList_Shift(arrayList, index, -1);
}
2012-12-06 02:24:01 +04:00
ArrayList_Unlock_Conditional(arrayList);
2014-04-09 23:53:42 +04:00
return ret;
}
/**
2019-11-06 17:24:51 +03:00
* Searches for the specified Object and returns the zero-based index of the first occurrence within
* the entire ArrayList.
*
2019-11-06 17:24:51 +03:00
* Searches for the specified Object and returns the zero-based index of the last occurrence within
* the range of elements in the ArrayList that extends from the first element to the specified
* index.
*
2019-11-06 17:24:51 +03:00
* Searches for the specified Object and returns the zero-based index of the last occurrence within
* the range of elements in the ArrayList that contains the specified number of elements and ends at
* the specified index.
*/
SSIZE_T ArrayList_IndexOf(wArrayList* arrayList, const void* obj, SSIZE_T startIndex, SSIZE_T count)
{
SSIZE_T index, sindex, cindex;
2012-12-06 02:24:01 +04:00
BOOL found = FALSE;
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
ArrayList_Lock_Conditional(arrayList);
2012-12-06 02:24:01 +04:00
sindex = (size_t)startIndex;
2012-12-06 02:24:01 +04:00
if (startIndex < 0)
sindex = 0;
2012-12-06 02:24:01 +04:00
cindex = (size_t)count;
2012-12-06 02:24:01 +04:00
if (count < 0)
cindex = arrayList->size;
for (index = sindex; index < sindex + cindex; index++)
2012-12-06 02:24:01 +04:00
{
if (arrayList->object.fnObjectEquals(arrayList->array[index], obj))
2012-12-06 02:24:01 +04:00
{
found = TRUE;
break;
}
}
2012-12-06 02:24:01 +04:00
if (!found)
index = -1;
ArrayList_Unlock_Conditional(arrayList);
2012-12-06 02:24:01 +04:00
return index;
}
/**
2019-11-06 17:24:51 +03:00
* Searches for the specified Object and returns the zero-based index of the last occurrence within
* the entire ArrayList.
*
2019-11-06 17:24:51 +03:00
* Searches for the specified Object and returns the zero-based index of the last occurrence within
* the range of elements in the ArrayList that extends from the first element to the specified
* index.
*
2019-11-06 17:24:51 +03:00
* Searches for the specified Object and returns the zero-based index of the last occurrence within
* the range of elements in the ArrayList that contains the specified number of elements and ends at
* the specified index.
*/
SSIZE_T ArrayList_LastIndexOf(wArrayList* arrayList, const void* obj, SSIZE_T startIndex,
SSIZE_T count)
{
SSIZE_T index, sindex, cindex;
2012-12-06 02:24:01 +04:00
BOOL found = FALSE;
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
ArrayList_Lock_Conditional(arrayList);
2012-12-06 02:24:01 +04:00
sindex = (size_t)startIndex;
2012-12-06 02:24:01 +04:00
if (startIndex < 0)
sindex = 0;
2012-12-06 02:24:01 +04:00
cindex = (size_t)count;
2012-12-06 02:24:01 +04:00
if (count < 0)
cindex = arrayList->size;
2012-12-06 02:24:01 +04:00
for (index = sindex + cindex; index > sindex; index--)
2012-12-06 02:24:01 +04:00
{
if (arrayList->object.fnObjectEquals(arrayList->array[index - 1], obj))
2012-12-06 02:24:01 +04:00
{
found = TRUE;
break;
}
}
2012-12-06 02:24:01 +04:00
if (!found)
index = -1;
ArrayList_Unlock_Conditional(arrayList);
2012-12-06 02:24:01 +04:00
return index;
}
static BOOL ArrayList_DefaultCompare(const void* objA, const void* objB)
{
return objA == objB ? TRUE : FALSE;
}
wObject* ArrayList_Object(wArrayList* arrayList)
{
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
return &arrayList->object;
}
BOOL ArrayList_ForEach(wArrayList* arrayList, ArrayList_ForEachFkt fkt, ...)
{
BOOL rc;
va_list ap;
va_start(ap, fkt);
rc = ArrayList_ForEachAP(arrayList, fkt, ap);
va_end(ap);
return rc;
}
BOOL ArrayList_ForEachAP(wArrayList* arrayList, ArrayList_ForEachFkt fkt, va_list ap)
{
size_t index, count;
BOOL rc = FALSE;
va_list cap;
2021-06-14 10:42:22 +03:00
WINPR_ASSERT(arrayList);
WINPR_ASSERT(fkt);
ArrayList_Lock_Conditional(arrayList);
count = ArrayList_Count(arrayList);
for (index = 0; index < count; index++)
{
BOOL rs;
void* obj = ArrayList_GetItem(arrayList, index);
va_copy(cap, ap);
rs = fkt(obj, index, cap);
va_end(cap);
if (!rs)
goto fail;
}
rc = TRUE;
fail:
ArrayList_Unlock_Conditional(arrayList);
return rc;
}
/**
* Construction, Destruction
*/
wArrayList* ArrayList_New(BOOL synchronized)
{
wObject* obj;
wArrayList* arrayList = NULL;
arrayList = (wArrayList*)calloc(1, sizeof(wArrayList));
2014-04-09 17:26:43 +04:00
if (!arrayList)
return NULL;
2014-04-09 17:26:43 +04:00
arrayList->synchronized = synchronized;
arrayList->growthFactor = 2;
obj = ArrayList_Object(arrayList);
if (!obj)
goto fail;
obj->fnObjectEquals = ArrayList_DefaultCompare;
if (!ArrayList_EnsureCapacity(arrayList, 32))
goto fail;
2014-04-09 17:26:43 +04:00
InitializeCriticalSectionAndSpinCount(&arrayList->lock, 4000);
return arrayList;
fail:
ArrayList_Free(arrayList);
2014-04-09 17:26:43 +04:00
return NULL;
}
void ArrayList_Free(wArrayList* arrayList)
{
if (!arrayList)
return;
ArrayList_Clear(arrayList);
DeleteCriticalSection(&arrayList->lock);
free(arrayList->array);
free(arrayList);
}