Merge pull request #2 from Pulsar7/feature/add-func/append_dyn_arrays_inplace

Add function to append dynamic-arrays inplace

Author: Pulsar7

docs/README.md

@@ -4,12 +4,12 @@
 
 - [Description](#description)
 - [Usage](#usage)
-  - [Create new Dynamic-Array](#create-new-dynamic-array)
-  - [Clear Dynamic-Array](#clear-dynamic-array)
+  - [Initialize \& Clear Dynamic-Array](#initialize--clear-dynamic-array)
   - [Append elements to Dynamic-Array](#append-elements-to-dynamic-array)
   - [Get length of Dynamic-Array](#get-length-of-dynamic-array)
   - [Append elements of static-array to Dynamic-Array](#append-elements-of-static-array-to-dynamic-array)
   - [Get element of Dynamic-array by index](#get-element-of-dynamic-array-by-index)
+  - [Append two Dynamica-Arrays inplace](#append-two-dynamica-arrays-inplace)
 - [ToDo](#todo)
 
 ## Description
@@ -19,24 +19,17 @@
 
 ## Usage
 
-### Create new Dynamic-Array
+### Initialize & Clear Dynamic-Array
 
 ```C
+//
+// Initialize dynamic-array
 DynArray dynamic_array;
 if (init_dyn_array(&dynamic_array) != NO_ERROR) {
     return 1;
 }
-return 0;
-```
-
-### Clear Dynamic-Array
-
-```C
-DynArray dynamic_array;
-if (init_dyn_array(&dynamic_array) != NO_ERROR) {
-    return 1;
-}
-
+//
+// Clear dynamic-array
 if (clear_dyn_array(&dynamic_array) != NO_ERROR) {
     return 1;
 }
@@ -47,23 +40,28 @@ return 0;
 ### Append elements to Dynamic-Array
 
 ```C
+//
+// Initialize dynamic-array
 DynArray dynamic_array;
 if (init_dyn_array(&dynamic_array) != NO_ERROR) {
     return 1;
 }
-
+//
+// Append one element to dynamic-array
 int value_A = 1337;
 if (append_element_to_dyn_array(&dynamic_array, (void*)&value_A, sizeof(int)) != NO_ERROR) {
     printf("Couldn't append new element to dynamic-array\n");
 }
-
+//
+// Append 50 elements to dynamic-array
 for (int value = 0; value < 50; value++) {
     if (append_element_to_dyn_array(&dynamic_array, (void*)&value, sizeof(int)) != NO_ERROR) {
         printf("Couldn't append new element to dynamic-array\n");
         break;
     }
 }
-
+//
+// Clear dynamic-array
 if (clear_dyn_array(&dynamic_array) != NO_ERROR) {
     return 1;
 }
@@ -74,25 +72,30 @@ return 0;
 ### Get length of Dynamic-Array
 
 ```C
+//
+// Initialize dynamic-array
 DynArray dynamic_array;
 if (init_dyn_array(&dynamic_array) != NO_ERROR) {
     return 1;
 }
-
+//
+// Append 50 elements to dynamic-array
 for (int value = 0; value < 50; value++) {
     if (append_element_to_dyn_array(&dynamic_array, (void*)&value, sizeof(int)) != NO_ERROR) {
         printf("Couldn't append new element to dynamic-array\n");
         break;
     }
 }
-
+//
+// Get amount of elments in dynamic-array
 size_t array_len;
 if (get_len(&dynamic_array, &array_len) == true) {
     printf("length of dynamic-array=%d\n", array_len);
 } else {
     printf("Couldn't get length of dynamic-array\n");
 }
-
+//
+// Clear dynamic-array
 if (clear_dyn_array(&dynamic_array) != NO_ERROR) {
     return 1;
 }
@@ -103,22 +106,27 @@ return 0;
 ### Append elements of static-array to Dynamic-Array
 
 ```C
+//
+// Initialize dynamic-array
 DynArray dynamic_array;
 if (init_dyn_array(&dynamic_array) != NO_ERROR) {
     return 1;
 }
-
+//
+// Add static integer-array to dynamic-array
 int static_int_array[] = {1, 2, 3, 4, 5, 6, 7, 8, 9};
 if (append_static_array_elements_to_dyn_array(&dynamic_array, static_int_array, sizeof(int), (size_t)9) != NO_ERROR) {
     printf("Couldn't append int-elements of static-array to dynamic-array\n");
 }
-
+//
+// Add static char-array to dynamic-array
 char* static_char_array = "HeLlO WoRlD";
 size_t static_char_array_len = strlen(static_char_array);
 if (append_static_array_elements_to_dyn_array(&dynamic_array, static_char_array, sizeof(char), static_char_array_len) != NO_ERROR) {
     printf("Couldn't append static-string to dynamic-array\n");
 }
-
+//
+// Clear dynamic-array
 if (clear_dyn_array(&dynamic_array) != NO_ERROR) {
     return 1;
 }
@@ -129,27 +137,64 @@ return 0;
 ### Get element of Dynamic-array by index
 
 ```C
+//
+// Initialize dynamic-array
 DynArray dynamic_array;
 if (init_dyn_array(&dynamic_array) != NO_ERROR) {
     return 1;
 }
-
+//
+// Append string-element to dynamic-array
 char* static_char_array = "HeLlO WoRlD";
 size_t static_char_array_len = strlen(static_char_array);
 size_t data_size = sizeof(char)*((size_t)static_char_array_len);
 if (append_element_to_dyn_array(&dynamic_array, (void*)static_char_array, data_size) == NO_ERROR) {
+    //
+    // Get string-element from dynamic-array by its index
     printf("%s\n", (char*)get_element_by_index(&dynamic_array, 0));
 } else {
     printf("Couldn't append static-string to dynamic-array\n");
 }
-
+//
+// Clear dynamic-array
 if (clear_dyn_array(&dynamic_array) != NO_ERROR) {
     return 1;
 }
 
 return 0;
 ```
 
+### Append two Dynamica-Arrays inplace
+
+```C
+//
+// Initialize both dynamic-arrays
+DynArray dynamic_array_a, dynamic_array_b;
+if (init_dyn_array(&dynamic_array_a) == NO_ERROR || init_dyn_array(&dynamic_array_b) == NO_ERROR) {
+    //
+    // Failed to initialize one or both dynamic-arrays
+    return 1;
+}
+//
+// Add string as one element to dynamic-array-B (one node)
+char* static_char_array = "HeLlO WoRlD";
+size_t static_char_array_len = strlen(static_char_array);
+if (append_element_to_dyn_array(&dynamic_array_b, (void*)static_char_array, sizeof(char)*((size_t)static_char_array_len)) == NO_ERROR) {
+    //
+    // Append string-element from dynamic-array-B to dynamic-array-A
+    if (append_dyn_arrays_inplace(&dynamic_array_a, &dynamic_array_b)) {
+        printf("%s\n", (char*)get_element_by_index(&dynamic_array_a, 0));
+    }
+}
+//
+// Clear dynamic-arrays
+if (clear_dyn_array(&dynamic_array_a) != NO_ERROR || clear_dyn_array(&dynamic_array_b) != NO_ERROR) {
+    return 1;
+}
+
+return 0;
+```
+
 ## ToDo
 
 - [ ] Instead of iterating through whole dynamic-array at `get_len`, use `size_t length`-Value of `DynArray`-struct

includes/dynamic_array.h

@@ -31,15 +31,14 @@ typedef struct DynArray {
 /*
 Functions
 */
-//
-// Initialize new dynamic array
 Error_Code init_dyn_array(DynArray* dynamic_array);
 Error_Code append_element_to_dyn_array(DynArray* dynamic_array, void* data, const size_t data_size);
 void* get_last(const DynArray* dynamic_array);
 void* get_first(const DynArray* dynamic_array);
 bool get_len(const DynArray* dynamic_array, size_t* len);
 Error_Code append_static_array_elements_to_dyn_array(DynArray* dynamic_array, void* static_array, const size_t static_array_elem_size, const size_t static_array_len);
 void* get_element_by_index(const DynArray* dynamic_array, const size_t index);
+bool append_dyn_arrays_inplace(DynArray* a, const DynArray* b);
 Error_Code clear_dyn_array(DynArray* dynamic_array);
 
 #endif // DYNAMIC_ARRAY_LIB_DYNAMIC_ARRAY_H

src/dynamic_array.c

@@ -30,6 +30,8 @@ Error_Code check_dyn_array(const DynArray* dynamic_array) {
 
 /*
 Initialize a new dynamic-array.
+
+Set `dynamic_array->length` to 0.
 */
 Error_Code init_dyn_array(DynArray* dynamic_array) {
     if (dynamic_array == NULL) {
@@ -65,6 +67,9 @@ DynArrayNode* create_new_dyn_array_node(void* data, const size_t data_size) {
     new_node->next_ptr = NULL;
     new_node->prev_ptr = NULL;
     //
+    // Set data_size-value
+    new_node->data_size = data_size;
+    //
     // Allocate actual data in node
     new_node->data = calloc(1, data_size);
     if (new_node->data == NULL) {
@@ -87,6 +92,8 @@ Helper function
 Add first element to dynamic-array.
 This function assumes, that the given dynamic-array has already been checked with `check_dyn_array` and that the given
 `data-ptr` and `data_size` are also valid.
+
+Set `dynamic_array->length` to 1.
 */
 Error_Code add_first_element_to_dyn_array(DynArray* dynamic_array, void* data, const size_t data_size) {
     DynArrayNode* first_node = create_new_dyn_array_node(data, data_size);
@@ -108,6 +115,8 @@ Error_Code add_first_element_to_dyn_array(DynArray* dynamic_array, void* data, c
 
 /*
 Append element to dynamic-array.
+
+Increases `dynamic_array->length` by 1.
 */
 Error_Code append_element_to_dyn_array(DynArray* dynamic_array, void* data, const size_t data_size) {
     if (check_dyn_array(dynamic_array) != NO_ERROR) {
@@ -326,6 +335,45 @@ void* get_element_by_index(const DynArray* dynamic_array, const size_t index) {
     return current_ptr->data;
 }
 
+/*
+Append elements of dynamic-array `b` to dynamic-array `a`.
+Uses `append_element_to_dyn_array` under the hood.
+*/
+bool append_dyn_arrays_inplace(DynArray* a, const DynArray* b) {
+    DynArray* dyn_array_a = a;
+    const DynArray* dyn_array_b = b;
+    //
+    // Check both dynamic-arrays
+    if (check_dyn_array(dyn_array_a) != NO_ERROR || check_dyn_array(dyn_array_b) != NO_ERROR) {
+        //
+        // One or both of the given dynamic-arrays are invalid
+        // INVALID_ARRAY_ERROR
+        return false;
+    }
+    if (dyn_array_b->length == 0) {
+        //
+        // Dynamic-array `b` is empty, nothing to append
+        // NO_ERROR
+        return true;
+    }
+    //
+    // Iterate through dynamic-array `b`
+    Error_Code append_elem_error_code = NO_ERROR;
+    DynArrayNode* current_b_ptr = dyn_array_b->head_ptr;
+    while (current_b_ptr != NULL) {
+        append_elem_error_code = append_element_to_dyn_array(dyn_array_a, current_b_ptr->data, current_b_ptr->data_size);
+        if (append_elem_error_code != NO_ERROR) {
+            //
+            // Appending element went wrong
+            return false;
+        }
+        current_b_ptr = current_b_ptr->next_ptr;
+    }
+    //
+    // NO_ERROR
+    return true;
+}
+
 /*
 Delete all elements on an dynamic-array.
 */