/* * Copyright (c) 2017 Cisco and/or its affiliates. * 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. */ /** */ #include #include #include #include #include #include #include #include PARCListInterface *PARCArrayListAsPARCList = &(PARCListInterface) { .Add = (bool (*)(void *, void *))parcArrayList_Add, .AddAtIndex = (void (*)(void *, int index, void *))parcArrayList_InsertAtIndex, .AddCollection = (bool (*)(void *, PARCCollection *))NULL, .AddCollectionAtIndex = (bool (*)(void *, int index, PARCCollection *))NULL, .Clear = (void (*)(void *))parcArrayList_Clear, .Contains = (bool (*)(const void *, const PARCObject *))NULL, .ContainsCollection = (bool (*)(const void *, const PARCCollection *))NULL, .Copy = (void * (*)(const PARCList *))parcArrayList_Copy, .Destroy = (void (*)(void **))parcArrayList_Destroy, .Equals = (bool (*)(const void *, const void *))parcArrayList_Equals, .GetAtIndex = (void * (*)(const void *, size_t))parcArrayList_Get, .HashCode = (PARCHashCode (*)(const void *))NULL, .IndexOf = (size_t (*)(const void *, const PARCObject *element))NULL, .IsEmpty = (bool (*)(const void *))parcArrayList_IsEmpty, .LastIndexOf = (size_t (*)(void *, const PARCObject *element))NULL, .Remove = (bool (*)(void *, const PARCObject *))NULL, .RemoveAtIndex = (void * (*)(PARCList *, size_t))parcArrayList_RemoveAtIndex, .RemoveCollection = (bool (*)(void *, const PARCCollection *))NULL, .RetainCollection = (bool (*)(void *, const PARCCollection *))NULL, .SetAtIndex = (void * (*)(void *, size_t index, void *))parcArrayList_Set, .Size = (size_t (*)(const void *))parcArrayList_Size, .SubList = (PARCList * (*)(const void *, size_t, size_t))NULL, .ToArray = (void** (*)(const void *))NULL, }; struct parc_array_list { void **array; size_t numberOfElements; size_t limit; bool (*equalsElement)(void *x, void *y); void (*destroyElement)(void **elementAddress); }; static size_t _remaining(const PARCArrayList *array) { return array->limit - array->numberOfElements; } static PARCArrayList * _ensureCapacity(PARCArrayList *array, size_t newCapacity) { void *newArray = parcMemory_Reallocate(array->array, newCapacity * sizeof(void *)); if (newArray == NULL) { return NULL; } array->array = newArray; array->limit = newCapacity; return array; } static PARCArrayList * _ensureRemaining(PARCArrayList *array, size_t remnant) { assertNotNull(array, "Parameter must be a non-null PARCArrayList pointer."); if (_remaining(array) < remnant) { size_t newCapacity = parcArrayList_Size(array) + remnant; return _ensureCapacity(array, newCapacity); } return array; } bool parcArrayList_IsValid(const PARCArrayList *instance) { bool result = false; if (instance != NULL) { if (instance->numberOfElements == 0 ? true : instance->array != NULL) { result = true; } } return result; } void parcArrayList_AssertValid(const PARCArrayList *instance) { trapIllegalValueIf(instance == NULL, "Parameter must be a non-null PARC_ArrayList pointer."); assertTrue(instance->numberOfElements == 0 ? true : instance->array != NULL, "PARC_ArrayList size is inconsistent."); } static PARCArrayList * _parcArrayList_Init(PARCArrayList *arrayList, size_t nElements, size_t limit, void **array, bool (*equalsElement)(void *x, void *y), void (*destroyElement)(void **elementAddress)) { if (arrayList != NULL) { arrayList->array = array; arrayList->numberOfElements = nElements; arrayList->limit = limit; arrayList->equalsElement = equalsElement; arrayList->destroyElement = destroyElement; } return arrayList; } PARCArrayList * parcArrayList_Create(void (*destroyElement)(void **element)) { PARCArrayList *result = parcMemory_AllocateAndClear(sizeof(PARCArrayList)); assertNotNull(result, "Memory allocation of PARCArrayList failed"); return _parcArrayList_Init(result, 0, 0, NULL, NULL, destroyElement); } PARCArrayList * parcArrayList_Create_Capacity(bool (*equalsElement)(void *x, void *y), void (*destroyElement)(void **element), size_t size) { PARCArrayList *result = parcMemory_AllocateAndClear(sizeof(PARCArrayList)); assertNotNull(result, "Memory allocation of PARCArrayList failed"); _parcArrayList_Init(result, 0, 0, NULL, equalsElement, destroyElement); if (result != NULL) { _ensureRemaining(result, size); } return result; } bool parcArrayList_Add(PARCArrayList *array, const void *pointer) { parcArrayList_OptionalAssertValid(array); if (_ensureRemaining(array, 1) == NULL) { trapOutOfMemory("Cannot increase space for PARCArrayList."); } array->array[array->numberOfElements++] = (void *) pointer; return true; } PARCArrayList * parcArrayList_AddAll(PARCArrayList *array, void *argv[], size_t argc) { for (size_t i = 0; i < argc; i++) { parcArrayList_Add(array, argv[i]); } return array; } bool parcArrayList_IsEmpty(const PARCArrayList *list) { parcArrayList_OptionalAssertValid(list); return list->numberOfElements == 0; } bool parcArrayList_Equals(const PARCArrayList *a, const PARCArrayList *b) { bool result = true; if (a != b) { if (a == NULL || b == NULL) { result = false; } else if (a->numberOfElements != b->numberOfElements) { result = false; } else { for (size_t i = 0; i < a->numberOfElements; i++) { if (a->equalsElement != NULL) { if (!a->equalsElement(a->array[i], b->array[i])) { result = false; break; } } else { if (a->array[i] != b->array[i]) { result = false; break; } } } } } return result; } void * parcArrayList_RemoveAtIndex(PARCArrayList *array, size_t index) { trapOutOfBoundsIf(index >= array->numberOfElements, "Index must be within the range [0, %zu)", array->numberOfElements); void *element = array->array[index]; // Adjust the list to elide the element. for (size_t i = index; i < array->numberOfElements - 1; i++) { array->array[i] = array->array[i + 1]; } array->numberOfElements--; return element; } void parcArrayList_Set(const PARCArrayList *array, size_t index, void *pointer) { trapOutOfBoundsIf(index >= array->numberOfElements, "Index must be within the range [0, %zu)", array->numberOfElements); array->array[index] = pointer; } void * parcArrayList_Get(const PARCArrayList *array, size_t index) { trapOutOfBoundsIf(index >= array->numberOfElements, "Index must be within the range [0, %zu)", array->numberOfElements); return array->array[index]; } void * parcArrayList_Peek(const PARCArrayList *list) { return parcArrayList_Get(list, parcArrayList_Size(list) - 1); } size_t parcArrayList_Size(const PARCArrayList *pointerArray) { return pointerArray->numberOfElements; } void parcArrayList_Destroy(PARCArrayList **arrayPtr) { assertNotNull(arrayPtr, "Parameter must be a non-null pointer to a PARC_ArrayList pointer."); PARCArrayList *array = *arrayPtr; parcArrayList_OptionalAssertValid(array); assertTrue(array->numberOfElements == 0 ? true : array->array != NULL, "PARC_ArrayList is inconsistent."); if (array->destroyElement != NULL) { for (size_t i = 0; i < array->numberOfElements; i++) { if (array->array[i] != NULL) { array->destroyElement(&array->array[i]); } } } if (array->array != NULL) { parcMemory_Deallocate((void **) &(array->array)); } parcMemory_Deallocate((void **) &array); *arrayPtr = 0; } PARCArrayList * parcArrayList_Copy(const PARCArrayList *original) { parcArrayList_OptionalAssertValid(original); PARCArrayList *result = parcArrayList_Create(original->destroyElement); if (result != NULL) { for (size_t i = 0; i < original->numberOfElements; i++) { parcArrayList_Add(result, original->array[i]); } } return result; } void parcArrayList_StdlibFreeFunction(void **elementPtr) { if (elementPtr != NULL) { free(*elementPtr); *elementPtr = 0; } } void parcArrayList_PARCMemoryFreeFunction(void **elementPtr) { if (elementPtr != NULL) { parcMemory_Deallocate((void **) elementPtr); *elementPtr = 0; } } PARCArrayList * parcArrayList_RemoveAndDestroyAtIndex(PARCArrayList *array, size_t index) { parcArrayList_OptionalAssertValid(array); assertTrue(index < array->numberOfElements, "Index must be ( 0 <= index < %zd). Actual=%zd", array->numberOfElements, index); if (index < array->numberOfElements) { // Destroy the element at the given index. if (array->destroyElement != NULL) { array->destroyElement(&array->array[index]); } // Adjust the list to elide the element. for (size_t i = index; i < array->numberOfElements - 1; i++) { array->array[i] = array->array[i + 1]; } array->numberOfElements--; } return array; } PARCArrayList * parcArrayList_InsertAtIndex(PARCArrayList *array, size_t index, const void *pointer) { parcArrayList_OptionalAssertValid(array); size_t length = parcArrayList_Size(array); assertTrue(index <= array->numberOfElements, "You can't insert beyond the end of the list"); // Create space and grow the array if needed _ensureRemaining(array, length + 1); for (size_t i = index; i < length; i++) { array->array[i + 1] = array->array[i]; } array->numberOfElements++; array->array[index] = (void *) pointer; return array; } void * parcArrayList_Pop(PARCArrayList *array) { return parcArrayList_RemoveAtIndex(array, parcArrayList_Size(array) - 1); } void parcArrayList_Clear(PARCArrayList *array) { while (!parcArrayList_IsEmpty(array)) { parcArrayList_RemoveAndDestroyAtIndex(array, parcArrayList_Size(array) - 1); } }