Merge pull request 'f5-doubly-linked-list' (#20) from f5-doubly-linked-list into main

Reviewed-on: #20

Include/Fledasty/Core/DoublyLinkedList.h

@@ -0,0 +1,57 @@
+/*
+ * 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.
+ * 
+ * -----------------------------------------------------------------------------
+ * File: DoublyLinkedList.c
+ * Description:
+ *  This file contains the functions for modifying the Doubly Linked List. It 
+ *  includes functions to append, Insert before, Insert after, Insert at index, 
+ *  Get, Remove element, Remove at index, Check if has element and Check if is empty.
+ * 
+ * Author: Mineplay
+ * -----------------------------------------------------------------------------
+ */
+#ifndef FLEDASTY_DOUBLY_LINKED_LIST
+#define FLEDASTY_DOUBLY_LINKED_LIST
+
+#include <stddef.h>
+#include <stdbool.h>
+
+#include "../Utils/Error.h"
+
+typedef struct FledastyDoublyLinkedListNode {
+    void *value;
+    struct FledastyDoublyLinkedListNode *previous, *next;
+} FledastyDoublyLinkedListNode;
+
+typedef struct {
+    size_t size, element_byte_size;
+    FledastyDoublyLinkedListNode *start, *end;
+} FledastyDoublyLinkedList;
+
+FledastyError fledasty_doubly_linked_list_initialize(FledastyDoublyLinkedList *new_doubly_linked_list, void *values, const size_t values_size, const size_t element_byte_size);
+FledastyError fledasty_doubly_list_destroy(FledastyDoublyLinkedList *current_doubly_linked_list);
+
+FledastyError fledasty_doubly_linked_list_append(FledastyDoublyLinkedList *current_doubly_linked_list, void *value);
+
+FledastyError fledasty_doubly_linked_list_insert_at_index(FledastyDoublyLinkedList *current_doubly_linked_list, const size_t index, void *value);
+FledastyError fledasty_doubly_linked_list_insert_before_value(FledastyDoublyLinkedList *current_doubly_linked_list, void *before_value, void *value);
+FledastyError fledasty_doubly_linked_list_insert_after_value(FledastyDoublyLinkedList *current_doubly_linked_list, void *after_value, void *value);
+
+FledastyError fledasty_doubly_linked_list_remove_at_index(FledastyDoublyLinkedList *current_doubly_linked_list, const size_t index);
+FledastyError fledasty_doubly_linked_list_remove_value(FledastyDoublyLinkedList *current_doubly_linked_list, void *value);
+
+bool fledasty_doubly_linked_list_has_value(const FledastyDoublyLinkedList *current_doubly_linked_list, void *value);
+static inline bool fledasty_doubly_linked_list_is_empty(const FledastyDoublyLinkedList *current_doubly_linked_list) { return current_doubly_linked_list->size == 0; }
+
+#endif

Include/Fledasty/Core/LinkedList.h

@@ -12,7 +12,7 @@
  * limitations under the License.
  * 
  * -----------------------------------------------------------------------------
- * File: LinkedList.c
+ * File: LinkedList.h
  * Description:
  *  This file contains the functions for modifying the Linked List. It includes 
  *  functions to append, Insert before, Insert after, Insert at index, 

Src/Core/DoublyLinkedList.c

@@ -0,0 +1,338 @@
+/*
+ * 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.
+ * 
+ * -----------------------------------------------------------------------------
+ * File: DoublyLinkedList.c
+ * Description:
+ *  This file contains the functions for modifying the Doubly Linked List. It 
+ *  includes functions to append, Insert before, Insert after, Insert at index, 
+ *  Get, Remove element, Remove at index, Check if has element and Check if is empty.
+ * 
+ * Author: Mineplay
+ * -----------------------------------------------------------------------------
+ */
+#include "../../Include/Fledasty/Core/DoublyLinkedList.h"
+#include "Fledasty/Utils/Error.h"
+
+#include <Hallocy/Core/Allocator.h>
+#include <Hallocy/Core/Memory.h>
+#include <Hallocy/Utils/Error.h>
+
+FledastyError fledasty_doubly_linked_list_initialize(FledastyDoublyLinkedList *new_doubly_linked_list, void *values, const size_t values_size, const size_t element_byte_size) {
+    if (new_doubly_linked_list == NULL) {
+        return FLEDASTY_ERROR_FAILED_ALLOCATION;
+    }
+
+    new_doubly_linked_list->element_byte_size = element_byte_size;
+    if (values == NULL || values_size == 0) {
+        new_doubly_linked_list->size = 0;
+        new_doubly_linked_list->start = NULL;
+        new_doubly_linked_list->end = NULL;
+    } else {
+        new_doubly_linked_list->size = values_size;
+
+        new_doubly_linked_list->start = (FledastyDoublyLinkedListNode*)hallocy_malloc(sizeof(FledastyDoublyLinkedListNode));
+        new_doubly_linked_list->start->value = hallocy_malloc(new_doubly_linked_list->element_byte_size);
+        hallocy_copy_memory(new_doubly_linked_list->start->value, values, new_doubly_linked_list->element_byte_size);
+
+        new_doubly_linked_list->start->previous = NULL;
+        new_doubly_linked_list->start->next = NULL;
+
+        FledastyDoublyLinkedListNode *last_node = new_doubly_linked_list->start;
+        for (size_t index = new_doubly_linked_list->element_byte_size; index < new_doubly_linked_list->size * new_doubly_linked_list->element_byte_size; index += new_doubly_linked_list->element_byte_size) {
+            FledastyDoublyLinkedListNode *new_node = (FledastyDoublyLinkedListNode*)hallocy_malloc(sizeof(FledastyDoublyLinkedListNode));
+            new_node->value = hallocy_malloc(new_doubly_linked_list->element_byte_size);
+            hallocy_copy_memory(new_node->value, (unsigned char*)values + index, new_doubly_linked_list->element_byte_size);
+            
+            new_node->previous = last_node;
+            new_node->next = NULL;
+
+            last_node->next = new_node;
+            last_node = new_node;
+        }
+        
+        new_doubly_linked_list->end = last_node;
+    }
+
+    return FLEDASTY_ERROR_NONE;
+}
+
+FledastyError fledasty_doubly_list_destroy(FledastyDoublyLinkedList *current_doubly_linked_list) {
+    if (current_doubly_linked_list == NULL) {
+        return FLEDASTY_ERROR_INVALID_POINTER;
+    }
+
+    FledastyDoublyLinkedListNode *current_node = current_doubly_linked_list->start;
+    while (current_node->next != NULL) {
+        current_node = current_node->next;
+
+        HallocyError result = hallocy_free(current_node->previous->value);
+        if (result == HALLOCY_ERROR_NONE) {
+            return FLEDASTY_ERROR_FAILED_ALLOCATION;
+        }
+
+        result = hallocy_free(current_node->previous);
+        if (result == HALLOCY_ERROR_NONE) {
+            return FLEDASTY_ERROR_FAILED_ALLOCATION;
+        }
+    }
+
+    if (current_node != NULL) {
+        hallocy_free(current_node->value);
+        hallocy_free(current_node);
+    }
+
+    return FLEDASTY_ERROR_NONE;
+}
+
+FledastyError fledasty_doubly_linked_list_append(FledastyDoublyLinkedList *current_doubly_linked_list, void *value) {
+    if (current_doubly_linked_list == NULL || value == NULL) {
+        return FLEDASTY_ERROR_INVALID_POINTER;
+    }
+
+    FledastyDoublyLinkedListNode *new_node = (FledastyDoublyLinkedListNode*)hallocy_malloc(sizeof(FledastyDoublyLinkedListNode));
+    
+    new_node->value = hallocy_malloc(current_doubly_linked_list->element_byte_size);
+    hallocy_copy_memory(new_node->value, value, current_doubly_linked_list->element_byte_size);
+    
+    new_node->previous = current_doubly_linked_list->end;
+    new_node->next = NULL;
+    
+    current_doubly_linked_list->end->next = new_node;
+    current_doubly_linked_list->end = new_node;
+    current_doubly_linked_list->size += 1;
+
+    return FLEDASTY_ERROR_NONE;
+}
+
+FledastyError fledasty_doubly_linked_list_insert_at_index(FledastyDoublyLinkedList *current_doubly_linked_list, const size_t index, void *value) {
+    if (current_doubly_linked_list == NULL || value == NULL) {
+        return FLEDASTY_ERROR_INVALID_POINTER;
+    }
+
+    if (index > current_doubly_linked_list->size) {
+        return FLEDASTY_ERROR_INDEX_OUT_OF_RANGE;
+    }
+
+    FledastyDoublyLinkedListNode *new_node = (FledastyDoublyLinkedListNode*)hallocy_malloc(sizeof(FledastyDoublyLinkedListNode));
+    
+    new_node->value = hallocy_malloc(current_doubly_linked_list->element_byte_size);
+    hallocy_copy_memory(new_node->value, value, current_doubly_linked_list->element_byte_size);
+
+    if (index == 0) {
+        new_node->previous = NULL;
+        new_node->next = current_doubly_linked_list->start;
+
+        current_doubly_linked_list->start->previous = new_node;
+        current_doubly_linked_list->start = new_node;
+    } else if (index == current_doubly_linked_list->size) {
+        new_node->previous = current_doubly_linked_list->end;
+        new_node->next = NULL;
+        
+        current_doubly_linked_list->end->next = new_node;
+        current_doubly_linked_list->end = new_node;
+    } else {
+        FledastyDoublyLinkedListNode *current_node = NULL;
+        if (index < current_doubly_linked_list->size / 2) {
+            current_node = current_doubly_linked_list->start;
+            for (size_t node = 0; node < index - 1; node += 1) {
+                current_node = current_node->next;
+            }
+        } else {
+            current_node = current_doubly_linked_list->end;
+            for (size_t node = current_doubly_linked_list->size - 1; node > index - 1; node -= 1) {
+                current_node = current_node->previous;
+            }
+        }
+    
+        new_node->previous = current_node;
+        new_node->next = current_node->next;
+
+        current_node->next->previous = new_node;
+        current_node->next = new_node;
+    }
+
+    current_doubly_linked_list->size += 1;
+    return FLEDASTY_ERROR_NONE;
+}
+
+FledastyError fledasty_doubly_linked_list_insert_before_value(FledastyDoublyLinkedList *current_doubly_linked_list, void *before_value, void *value) {
+    if (current_doubly_linked_list == NULL || before_value == NULL || value == NULL) {
+        return FLEDASTY_ERROR_INVALID_POINTER;
+    }
+
+    FledastyDoublyLinkedListNode *current_node = current_doubly_linked_list->start;
+    while (current_node != NULL && !hallocy_compare_memory(current_node->value, before_value, current_doubly_linked_list->element_byte_size)) {
+        current_node = current_node->next;
+    }
+
+    if (current_node == NULL) {
+        return FLEDASTY_ERROR_VALUE_NOT_FOUND;
+    }
+
+    FledastyDoublyLinkedListNode *new_node = (FledastyDoublyLinkedListNode*)hallocy_malloc(sizeof(FledastyDoublyLinkedListNode));
+    
+    new_node->value = hallocy_malloc(current_doubly_linked_list->element_byte_size);
+    hallocy_copy_memory(new_node->value, value, current_doubly_linked_list->element_byte_size);
+
+    if (current_node->previous == NULL) {
+        new_node->previous = NULL;
+        new_node->next = current_doubly_linked_list->start;
+
+        current_doubly_linked_list->start->previous = new_node;
+        current_doubly_linked_list->start = new_node;
+    } else {
+        new_node->previous = current_node->previous;
+        new_node->next = current_node;
+
+        current_node->previous->next = new_node;
+        current_node->previous = new_node;
+    }
+
+    current_doubly_linked_list->size += 1;
+    return FLEDASTY_ERROR_NONE;
+}
+
+FledastyError fledasty_doubly_linked_list_insert_after_value(FledastyDoublyLinkedList *current_doubly_linked_list, void *after_value, void *value) {
+    if (current_doubly_linked_list == NULL || after_value == NULL || value == NULL) {
+        return FLEDASTY_ERROR_INVALID_POINTER;
+    }
+
+    FledastyDoublyLinkedListNode *current_node = current_doubly_linked_list->start;
+    while (current_node != NULL && !hallocy_compare_memory(current_node->value, after_value, current_doubly_linked_list->element_byte_size)) {
+        current_node = current_node->next;
+    }
+
+    if (current_node == NULL) {
+        return FLEDASTY_ERROR_VALUE_NOT_FOUND;
+    }
+
+    FledastyDoublyLinkedListNode *new_node = (FledastyDoublyLinkedListNode*)hallocy_malloc(sizeof(FledastyDoublyLinkedListNode));
+    
+    new_node->value = hallocy_malloc(current_doubly_linked_list->element_byte_size);
+    hallocy_copy_memory(new_node->value, value, current_doubly_linked_list->element_byte_size);
+
+    if (current_node == current_doubly_linked_list->end) {
+        new_node->next = NULL;
+        new_node->previous = current_doubly_linked_list->end;
+
+        current_doubly_linked_list->end->next = new_node;
+        current_doubly_linked_list->end = new_node;
+    } else {
+        new_node->previous = current_node;
+        new_node->next = current_node->next;
+    
+        current_node->next->previous = new_node;
+        current_node->next = new_node;
+    }
+
+    current_doubly_linked_list->size += 1;
+    return FLEDASTY_ERROR_NONE;
+}
+
+FledastyError fledasty_doubly_linked_list_remove_at_index(FledastyDoublyLinkedList *current_doubly_linked_list, const size_t index) {
+    if (current_doubly_linked_list == NULL) {
+        return FLEDASTY_ERROR_INVALID_POINTER;
+    }
+
+    if (index >= current_doubly_linked_list->size) {
+        return FLEDASTY_ERROR_INDEX_OUT_OF_RANGE;
+    }
+
+    FledastyDoublyLinkedListNode *current_node = NULL;
+    if (index < current_doubly_linked_list->size / 2) {
+        current_node = current_doubly_linked_list->start;
+        for (size_t node = 0; node < index; node += 1) {
+            current_node = current_node->next;
+        }
+    } else {
+        current_node = current_doubly_linked_list->end;
+        for (size_t node = current_doubly_linked_list->size - 1; node > index; node -= 1) {
+            current_node = current_node->previous;
+        }
+    }
+
+    if (current_node->previous == NULL) {
+        current_doubly_linked_list->start = current_node->next;
+        current_doubly_linked_list->start->previous = NULL;
+        if (current_node->next == NULL) {
+            current_doubly_linked_list->end = current_node->previous;
+        }
+    } else {
+        current_node->previous->next = current_node->next;
+        if (current_node->next == NULL) {
+            current_doubly_linked_list->end = current_node->previous;
+        } else {
+            current_node->next->previous = current_node->previous;
+        }
+    }
+
+    hallocy_free(current_node->value);
+    hallocy_free(current_node);
+
+    current_doubly_linked_list->size -= 1;
+    return FLEDASTY_ERROR_NONE;
+}
+
+FledastyError fledasty_doubly_linked_list_remove_value(FledastyDoublyLinkedList *current_doubly_linked_list, void *value) {
+    if (current_doubly_linked_list == NULL || value == NULL) {
+        return FLEDASTY_ERROR_INVALID_POINTER;
+    }
+
+    FledastyDoublyLinkedListNode *current_node = current_doubly_linked_list->start;
+    while (current_node != NULL && !hallocy_compare_memory(current_node->value, value, current_doubly_linked_list->element_byte_size)) {
+        current_node = current_node->next;
+    }
+
+    if (current_node == NULL) {
+        return FLEDASTY_ERROR_VALUE_NOT_FOUND;
+    }
+
+    if (current_node->previous == NULL) {
+        current_doubly_linked_list->start = current_node->next;
+        current_doubly_linked_list->start->previous = NULL;
+        if (current_node->next == NULL) {
+            current_doubly_linked_list->end = current_node->previous;
+        }
+    } else {
+        current_node->previous->next = current_node->next;
+        if (current_node->next == NULL) {
+            current_doubly_linked_list->end = current_node->previous;
+        } else {
+            current_node->next->previous = current_node->previous;
+        }
+    }
+
+    hallocy_free(current_node->next);
+    hallocy_free(current_node);
+
+    current_doubly_linked_list->size -= 1;
+    return FLEDASTY_ERROR_NONE;
+}
+
+bool fledasty_doubly_linked_list_has_value(const FledastyDoublyLinkedList *current_doubly_linked_list, void *value) {
+    if (current_doubly_linked_list == NULL || value == NULL) {
+        return false;
+    }
+
+    FledastyDoublyLinkedListNode *current_node = current_doubly_linked_list->start;
+    while (current_node != NULL) {
+        if (hallocy_compare_memory(current_node->value, value, current_doubly_linked_list->element_byte_size)) {
+            return true;
+        }
+
+        current_node = current_node->next;
+    }
+
+    return false;
+}

Src/Core/LinkedList.c

@@ -123,6 +123,7 @@ FledastyError fledasty_linked_list_insert_at_index(FledastyLinkedList *current_l
         new_node->next = current_linked_list->start;
         current_linked_list->start = new_node;
     } else if (index == current_linked_list->size) {
+        new_node->next = NULL;
         current_linked_list->end->next = new_node;
         current_linked_list->end = new_node;
     } else {
@@ -267,7 +268,6 @@ FledastyError fledasty_linked_list_remove_value(FledastyLinkedList *current_link
     hallocy_free(current_node->next);
     hallocy_free(current_node);
 
-
     current_linked_list->size -= 1;
     return FLEDASTY_ERROR_NONE;
 }

Tests/Main.c

@@ -24,6 +24,7 @@
 #include <Fledasty/Core/Stack.h>
 #include <Fledasty/Core/DynamicArray.h>
 #include <Fledasty/Core/LinkedList.h>
+#include <Fledasty/Core/DoublyLinkedList.h>
 
 int main() {
     FledastyQueue test_queue;
@@ -137,6 +138,47 @@ int main() {
     }
 
     fledasty_linked_list_destroy(&test_linked_list);
+
+    FledastyDoublyLinkedList test_doubly_linked_list;
+    fledasty_doubly_linked_list_initialize(&test_doubly_linked_list, (int[]){11, 12, 13, 14, 15}, 5, sizeof(int));
+
+    for (int i = 0; i < 10; i += 1) {
+        fledasty_doubly_linked_list_append(&test_doubly_linked_list, &i);
+    }
+
+    insert_value = 35;
+    fledasty_doubly_linked_list_insert_at_index(&test_doubly_linked_list, test_doubly_linked_list.size - 1, &insert_value);
+    insert_value = 28;
+    insert_at_value = 35;
+    fledasty_doubly_linked_list_insert_before_value(&test_doubly_linked_list, &insert_at_value, &insert_value);
+    insert_value = 90;
+    fledasty_doubly_linked_list_insert_after_value(&test_doubly_linked_list, &insert_at_value, &insert_value);
+
+    fledasty_doubly_linked_list_remove_at_index(&test_doubly_linked_list, 2);
+    remove_value = 0;
+    fledasty_doubly_linked_list_remove_value(&test_doubly_linked_list, &remove_value);
+
+    FledastyDoublyLinkedListNode *test_doubly_linked_list_node = test_doubly_linked_list.start;
+    for (int i = 0; i < test_doubly_linked_list.size; i += 1) {
+        printf("Doubly linked list get: %d\n", *(int*)test_doubly_linked_list_node->value);
+        test_doubly_linked_list_node = test_doubly_linked_list_node->next;
+    }
+
+    test_doubly_linked_list_node = test_doubly_linked_list.end;
+    for (int i = 0; i < test_doubly_linked_list.size; i += 1) {
+        printf("Doubly linked list get backwards: %d\n", *(int*)test_doubly_linked_list_node->value);
+        test_doubly_linked_list_node = test_doubly_linked_list_node->previous;
+    }
+
+    if (fledasty_doubly_linked_list_has_value(&test_doubly_linked_list, &insert_value)) {
+        printf("Doubly linked list contains %d\n", insert_value);
+    }
+
+    if (fledasty_doubly_linked_list_is_empty(&test_doubly_linked_list)) {
+        printf("Doubly linked list is empty\n");
+    }
+
+    fledasty_doubly_list_destroy(&test_doubly_linked_list);
     printf("Done\n");
     return 0;
 }