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

Packit 1fb8d4
/**
Packit 1fb8d4
 * WinPR: Windows Portable Runtime
Packit 1fb8d4
 * System.Collections.ArrayList
Packit 1fb8d4
 *
Packit 1fb8d4
 * Copyright 2012 Marc-Andre Moreau <marcandre.moreau@gmail.com>
Packit 1fb8d4
 *
Packit 1fb8d4
 * Licensed under the Apache License, Version 2.0 (the "License");
Packit 1fb8d4
 * you may not use this file except in compliance with the License.
Packit 1fb8d4
 * You may obtain a copy of the License at
Packit 1fb8d4
 *
Packit 1fb8d4
 *     http://www.apache.org/licenses/LICENSE-2.0
Packit 1fb8d4
 *
Packit 1fb8d4
 * Unless required by applicable law or agreed to in writing, software
Packit 1fb8d4
 * distributed under the License is distributed on an "AS IS" BASIS,
Packit 1fb8d4
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Packit 1fb8d4
 * See the License for the specific language governing permissions and
Packit 1fb8d4
 * limitations under the License.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
#ifdef HAVE_CONFIG_H
Packit 1fb8d4
#include "config.h"
Packit 1fb8d4
#endif
Packit 1fb8d4
Packit 1fb8d4
#include <winpr/crt.h>
Packit 1fb8d4
Packit 1fb8d4
#include <winpr/collections.h>
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * C equivalent of the C# ArrayList Class:
Packit 1fb8d4
 * http://msdn.microsoft.com/en-us/library/system.collections.arraylist.aspx
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Properties
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Gets or sets the number of elements that the ArrayList can contain.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
int ArrayList_Capacity(wArrayList* arrayList)
Packit 1fb8d4
{
Packit 1fb8d4
	return arrayList->capacity;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Gets the number of elements actually contained in the ArrayList.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
int ArrayList_Count(wArrayList* arrayList)
Packit 1fb8d4
{
Packit 1fb8d4
	return arrayList->size;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Gets the internal list of items contained in the ArrayList.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
int ArrayList_Items(wArrayList* arrayList, ULONG_PTR** ppItems)
Packit 1fb8d4
{
Packit Service 5a9772
	*ppItems = (ULONG_PTR*)arrayList->array;
Packit 1fb8d4
	return arrayList->size;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Gets a value indicating whether the ArrayList has a fixed size.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
BOOL ArrayList_IsFixedSized(wArrayList* arrayList)
Packit 1fb8d4
{
Packit 1fb8d4
	return FALSE;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Gets a value indicating whether the ArrayList is read-only.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
BOOL ArrayList_IsReadOnly(wArrayList* arrayList)
Packit 1fb8d4
{
Packit 1fb8d4
	return FALSE;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Gets a value indicating whether access to the ArrayList is synchronized (thread safe).
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
BOOL ArrayList_IsSynchronized(wArrayList* arrayList)
Packit 1fb8d4
{
Packit 1fb8d4
	return arrayList->synchronized;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Lock access to the ArrayList
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
void ArrayList_Lock(wArrayList* arrayList)
Packit 1fb8d4
{
Packit 1fb8d4
	EnterCriticalSection(&arrayList->lock);
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Unlock access to the ArrayList
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
void ArrayList_Unlock(wArrayList* arrayList)
Packit 1fb8d4
{
Packit 1fb8d4
	LeaveCriticalSection(&arrayList->lock);
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Gets the element at the specified index.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
void* ArrayList_GetItem(wArrayList* arrayList, int index)
Packit 1fb8d4
{
Packit 1fb8d4
	void* obj = NULL;
Packit 1fb8d4
Packit 1fb8d4
	if ((index >= 0) && (index < arrayList->size))
Packit 1fb8d4
	{
Packit 1fb8d4
		obj = arrayList->array[index];
Packit 1fb8d4
	}
Packit 1fb8d4
Packit 1fb8d4
	return obj;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Sets the element at the specified index.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
void ArrayList_SetItem(wArrayList* arrayList, int index, void* obj)
Packit 1fb8d4
{
Packit 1fb8d4
	if ((index >= 0) && (index < arrayList->size))
Packit 1fb8d4
	{
Packit 1fb8d4
		arrayList->array[index] = obj;
Packit 1fb8d4
	}
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Methods
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Shift a section of the list.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit Service 5a9772
static BOOL ArrayList_Shift(wArrayList* arrayList, int index, int count)
Packit 1fb8d4
{
Packit 1fb8d4
	if (count > 0)
Packit 1fb8d4
	{
Packit 1fb8d4
		if (arrayList->size + count > arrayList->capacity)
Packit 1fb8d4
		{
Packit 1fb8d4
			void** newArray;
Packit 1fb8d4
			int newCapacity = arrayList->capacity * arrayList->growthFactor;
Packit 1fb8d4
			newArray = (void**)realloc(arrayList->array, sizeof(void*) * newCapacity);
Packit 1fb8d4
Packit 1fb8d4
			if (!newArray)
Packit 1fb8d4
				return FALSE;
Packit 1fb8d4
Packit 1fb8d4
			arrayList->array = newArray;
Packit 1fb8d4
			arrayList->capacity = newCapacity;
Packit 1fb8d4
		}
Packit 1fb8d4
Packit 1fb8d4
		MoveMemory(&arrayList->array[index + count], &arrayList->array[index],
Packit 1fb8d4
		           (arrayList->size - index) * sizeof(void*));
Packit 1fb8d4
		arrayList->size += count;
Packit 1fb8d4
	}
Packit 1fb8d4
	else if (count < 0)
Packit 1fb8d4
	{
Packit 1fb8d4
		int chunk = arrayList->size - index + count;
Packit 1fb8d4
Packit 1fb8d4
		if (chunk > 0)
Packit Service 5a9772
			MoveMemory(&arrayList->array[index], &arrayList->array[index - count],
Packit Service 5a9772
			           chunk * sizeof(void*));
Packit 1fb8d4
Packit 1fb8d4
		arrayList->size += count;
Packit 1fb8d4
	}
Packit 1fb8d4
Packit 1fb8d4
	return TRUE;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Removes all elements from the ArrayList.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
void ArrayList_Clear(wArrayList* arrayList)
Packit 1fb8d4
{
Packit 1fb8d4
	int index;
Packit 1fb8d4
Packit 1fb8d4
	if (arrayList->synchronized)
Packit 1fb8d4
		EnterCriticalSection(&arrayList->lock);
Packit 1fb8d4
Packit 1fb8d4
	for (index = 0; index < arrayList->size; index++)
Packit 1fb8d4
	{
Packit 1fb8d4
		if (arrayList->object.fnObjectFree)
Packit 1fb8d4
			arrayList->object.fnObjectFree(arrayList->array[index]);
Packit 1fb8d4
Packit 1fb8d4
		arrayList->array[index] = NULL;
Packit 1fb8d4
	}
Packit 1fb8d4
Packit 1fb8d4
	arrayList->size = 0;
Packit 1fb8d4
Packit 1fb8d4
	if (arrayList->synchronized)
Packit 1fb8d4
		LeaveCriticalSection(&arrayList->lock);
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Determines whether an element is in the ArrayList.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
BOOL ArrayList_Contains(wArrayList* arrayList, void* obj)
Packit 1fb8d4
{
Packit 1fb8d4
	int index;
Packit 1fb8d4
	BOOL rc = FALSE;
Packit 1fb8d4
Packit 1fb8d4
	if (arrayList->synchronized)
Packit 1fb8d4
		EnterCriticalSection(&arrayList->lock);
Packit 1fb8d4
Packit 1fb8d4
	for (index = 0; index < arrayList->size; index++)
Packit 1fb8d4
	{
Packit 1fb8d4
		rc = arrayList->object.fnObjectEquals(arrayList->array[index], obj);
Packit 1fb8d4
Packit 1fb8d4
		if (rc)
Packit 1fb8d4
			break;
Packit 1fb8d4
	}
Packit 1fb8d4
Packit 1fb8d4
	if (arrayList->synchronized)
Packit 1fb8d4
		LeaveCriticalSection(&arrayList->lock);
Packit 1fb8d4
Packit 1fb8d4
	return rc;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Adds an object to the end of the ArrayList.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
int ArrayList_Add(wArrayList* arrayList, void* obj)
Packit 1fb8d4
{
Packit 1fb8d4
	int index = -1;
Packit 1fb8d4
Packit 1fb8d4
	if (arrayList->synchronized)
Packit 1fb8d4
		EnterCriticalSection(&arrayList->lock);
Packit 1fb8d4
Packit 1fb8d4
	if (arrayList->size + 1 > arrayList->capacity)
Packit 1fb8d4
	{
Packit 1fb8d4
		void** newArray;
Packit 1fb8d4
		int newCapacity = arrayList->capacity * arrayList->growthFactor;
Packit 1fb8d4
		newArray = (void**)realloc(arrayList->array, sizeof(void*) * newCapacity);
Packit 1fb8d4
Packit 1fb8d4
		if (!newArray)
Packit 1fb8d4
			goto out;
Packit 1fb8d4
Packit 1fb8d4
		arrayList->array = newArray;
Packit 1fb8d4
		arrayList->capacity = newCapacity;
Packit 1fb8d4
	}
Packit 1fb8d4
Packit 1fb8d4
	arrayList->array[arrayList->size++] = obj;
Packit 1fb8d4
	index = arrayList->size;
Packit 1fb8d4
out:
Packit 1fb8d4
Packit 1fb8d4
	if (arrayList->synchronized)
Packit 1fb8d4
		LeaveCriticalSection(&arrayList->lock);
Packit 1fb8d4
Packit 1fb8d4
	return index;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/*
Packit 1fb8d4
 * Inserts an element into the ArrayList at the specified index.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
BOOL ArrayList_Insert(wArrayList* arrayList, int index, void* obj)
Packit 1fb8d4
{
Packit 1fb8d4
	BOOL ret = TRUE;
Packit 1fb8d4
Packit 1fb8d4
	if (arrayList->synchronized)
Packit 1fb8d4
		EnterCriticalSection(&arrayList->lock);
Packit 1fb8d4
Packit 1fb8d4
	if ((index >= 0) && (index < arrayList->size))
Packit 1fb8d4
	{
Packit 1fb8d4
		if (!ArrayList_Shift(arrayList, index, 1))
Packit 1fb8d4
		{
Packit 1fb8d4
			ret = FALSE;
Packit 1fb8d4
		}
Packit 1fb8d4
		else
Packit 1fb8d4
		{
Packit 1fb8d4
			arrayList->array[index] = obj;
Packit 1fb8d4
		}
Packit 1fb8d4
	}
Packit 1fb8d4
Packit 1fb8d4
	if (arrayList->synchronized)
Packit 1fb8d4
		LeaveCriticalSection(&arrayList->lock);
Packit 1fb8d4
Packit 1fb8d4
	return ret;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Removes the first occurrence of a specific object from the ArrayList.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
BOOL ArrayList_Remove(wArrayList* arrayList, void* obj)
Packit 1fb8d4
{
Packit 1fb8d4
	int index;
Packit 1fb8d4
	BOOL found = FALSE;
Packit 1fb8d4
	BOOL ret = TRUE;
Packit 1fb8d4
Packit 1fb8d4
	if (arrayList->synchronized)
Packit 1fb8d4
		EnterCriticalSection(&arrayList->lock);
Packit 1fb8d4
Packit 1fb8d4
	for (index = 0; index < arrayList->size; index++)
Packit 1fb8d4
	{
Packit 1fb8d4
		if (arrayList->object.fnObjectEquals(arrayList->array[index], obj))
Packit 1fb8d4
		{
Packit 1fb8d4
			found = TRUE;
Packit 1fb8d4
			break;
Packit 1fb8d4
		}
Packit 1fb8d4
	}
Packit 1fb8d4
Packit 1fb8d4
	if (found)
Packit 1fb8d4
	{
Packit 1fb8d4
		if (arrayList->object.fnObjectFree)
Packit 1fb8d4
			arrayList->object.fnObjectFree(arrayList->array[index]);
Packit 1fb8d4
Packit 1fb8d4
		ret = ArrayList_Shift(arrayList, index, -1);
Packit 1fb8d4
	}
Packit 1fb8d4
Packit 1fb8d4
	if (arrayList->synchronized)
Packit 1fb8d4
		LeaveCriticalSection(&arrayList->lock);
Packit 1fb8d4
Packit 1fb8d4
	return ret;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Removes the element at the specified index of the ArrayList.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
BOOL ArrayList_RemoveAt(wArrayList* arrayList, int index)
Packit 1fb8d4
{
Packit 1fb8d4
	BOOL ret = TRUE;
Packit 1fb8d4
Packit 1fb8d4
	if (arrayList->synchronized)
Packit 1fb8d4
		EnterCriticalSection(&arrayList->lock);
Packit 1fb8d4
Packit 1fb8d4
	if ((index >= 0) && (index < arrayList->size))
Packit 1fb8d4
	{
Packit 1fb8d4
		if (arrayList->object.fnObjectFree)
Packit 1fb8d4
			arrayList->object.fnObjectFree(arrayList->array[index]);
Packit 1fb8d4
Packit 1fb8d4
		ret = ArrayList_Shift(arrayList, index, -1);
Packit 1fb8d4
	}
Packit 1fb8d4
Packit 1fb8d4
	if (arrayList->synchronized)
Packit 1fb8d4
		LeaveCriticalSection(&arrayList->lock);
Packit 1fb8d4
Packit 1fb8d4
	return ret;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit Service 5a9772
 * Searches for the specified Object and returns the zero-based index of the first occurrence within
Packit Service 5a9772
 * the entire ArrayList.
Packit 1fb8d4
 *
Packit Service 5a9772
 * Searches for the specified Object and returns the zero-based index of the last occurrence within
Packit Service 5a9772
 * the range of elements in the ArrayList that extends from the first element to the specified
Packit Service 5a9772
 * index.
Packit 1fb8d4
 *
Packit Service 5a9772
 * Searches for the specified Object and returns the zero-based index of the last occurrence within
Packit Service 5a9772
 * the range of elements in the ArrayList that contains the specified number of elements and ends at
Packit Service 5a9772
 * the specified index.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
int ArrayList_IndexOf(wArrayList* arrayList, void* obj, int startIndex, int count)
Packit 1fb8d4
{
Packit 1fb8d4
	int index;
Packit 1fb8d4
	BOOL found = FALSE;
Packit 1fb8d4
Packit 1fb8d4
	if (arrayList->synchronized)
Packit 1fb8d4
		EnterCriticalSection(&arrayList->lock);
Packit 1fb8d4
Packit 1fb8d4
	if (startIndex < 0)
Packit 1fb8d4
		startIndex = 0;
Packit 1fb8d4
Packit 1fb8d4
	if (count < 0)
Packit 1fb8d4
		count = arrayList->size;
Packit 1fb8d4
Packit 1fb8d4
	for (index = startIndex; index < startIndex + count; index++)
Packit 1fb8d4
	{
Packit 1fb8d4
		if (arrayList->object.fnObjectEquals(arrayList->array[index], obj))
Packit 1fb8d4
		{
Packit 1fb8d4
			found = TRUE;
Packit 1fb8d4
			break;
Packit 1fb8d4
		}
Packit 1fb8d4
	}
Packit 1fb8d4
Packit 1fb8d4
	if (!found)
Packit 1fb8d4
		index = -1;
Packit 1fb8d4
Packit 1fb8d4
	if (arrayList->synchronized)
Packit 1fb8d4
		LeaveCriticalSection(&arrayList->lock);
Packit 1fb8d4
Packit 1fb8d4
	return index;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit Service 5a9772
 * Searches for the specified Object and returns the zero-based index of the last occurrence within
Packit Service 5a9772
 * the entire ArrayList.
Packit 1fb8d4
 *
Packit Service 5a9772
 * Searches for the specified Object and returns the zero-based index of the last occurrence within
Packit Service 5a9772
 * the range of elements in the ArrayList that extends from the first element to the specified
Packit Service 5a9772
 * index.
Packit 1fb8d4
 *
Packit Service 5a9772
 * Searches for the specified Object and returns the zero-based index of the last occurrence within
Packit Service 5a9772
 * the range of elements in the ArrayList that contains the specified number of elements and ends at
Packit Service 5a9772
 * the specified index.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
int ArrayList_LastIndexOf(wArrayList* arrayList, void* obj, int startIndex, int count)
Packit 1fb8d4
{
Packit 1fb8d4
	int index;
Packit 1fb8d4
	BOOL found = FALSE;
Packit 1fb8d4
Packit 1fb8d4
	if (arrayList->synchronized)
Packit 1fb8d4
		EnterCriticalSection(&arrayList->lock);
Packit 1fb8d4
Packit 1fb8d4
	if (startIndex < 0)
Packit 1fb8d4
		startIndex = 0;
Packit 1fb8d4
Packit 1fb8d4
	if (count < 0)
Packit 1fb8d4
		count = arrayList->size;
Packit 1fb8d4
Packit 1fb8d4
	for (index = startIndex + count - 1; index >= startIndex; index--)
Packit 1fb8d4
	{
Packit 1fb8d4
		if (arrayList->object.fnObjectEquals(arrayList->array[index], obj))
Packit 1fb8d4
		{
Packit 1fb8d4
			found = TRUE;
Packit 1fb8d4
			break;
Packit 1fb8d4
		}
Packit 1fb8d4
	}
Packit 1fb8d4
Packit 1fb8d4
	if (!found)
Packit 1fb8d4
		index = -1;
Packit 1fb8d4
Packit 1fb8d4
	if (arrayList->synchronized)
Packit 1fb8d4
		LeaveCriticalSection(&arrayList->lock);
Packit 1fb8d4
Packit 1fb8d4
	return index;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
static BOOL ArrayList_DefaultCompare(const void* objA, const void* objB)
Packit 1fb8d4
{
Packit 1fb8d4
	return objA == objB ? TRUE : FALSE;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
/**
Packit 1fb8d4
 * Construction, Destruction
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
wArrayList* ArrayList_New(BOOL synchronized)
Packit 1fb8d4
{
Packit 1fb8d4
	wArrayList* arrayList = NULL;
Packit 1fb8d4
	arrayList = (wArrayList*)calloc(1, sizeof(wArrayList));
Packit 1fb8d4
Packit 1fb8d4
	if (!arrayList)
Packit 1fb8d4
		return NULL;
Packit 1fb8d4
Packit 1fb8d4
	arrayList->synchronized = synchronized;
Packit 1fb8d4
	arrayList->capacity = 32;
Packit 1fb8d4
	arrayList->growthFactor = 2;
Packit 1fb8d4
	arrayList->object.fnObjectEquals = ArrayList_DefaultCompare;
Packit 1fb8d4
	arrayList->array = (void**)calloc(arrayList->capacity, sizeof(void*));
Packit 1fb8d4
Packit 1fb8d4
	if (!arrayList->array)
Packit 1fb8d4
		goto out_free;
Packit 1fb8d4
Packit 1fb8d4
	InitializeCriticalSectionAndSpinCount(&arrayList->lock, 4000);
Packit 1fb8d4
	return arrayList;
Packit 1fb8d4
out_free:
Packit 1fb8d4
	free(arrayList);
Packit 1fb8d4
	return NULL;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
void ArrayList_Free(wArrayList* arrayList)
Packit 1fb8d4
{
Packit 1fb8d4
	if (!arrayList)
Packit 1fb8d4
		return;
Packit 1fb8d4
Packit 1fb8d4
	ArrayList_Clear(arrayList);
Packit 1fb8d4
	DeleteCriticalSection(&arrayList->lock);
Packit 1fb8d4
	free(arrayList->array);
Packit 1fb8d4
	free(arrayList);
Packit 1fb8d4
}