Merge pull request #4 from Pulsar7/feature/add-insert-element-at-index-function

Feature/add insert element at index function

* add insert_element_at_index-function to 'dynamic_array'
* add improved 'dynamic_array' function-comments/documentation
* add 'deprecation'-warning to get_len-function

Author: Pulsar7

docs/README.md

@@ -11,7 +11,8 @@
   - [Get element of Dynamic-array by index](#get-element-of-dynamic-array-by-index)
   - [Append two Dynamic-Arrays inplace](#append-two-dynamic-arrays-inplace)
   - [Swap position of elements in Dynamic-Array](#swap-position-of-elements-in-dynamic-array)
-  - [Replace an Element by index](#replace-an-element-by-index)
+  - [Replace an element by index](#replace-an-element-by-index)
+  - [Insert an element at an index](#insert-an-element-at-an-index)
   - [Sort-Algorithms](#sort-algorithms)
     - [Bubble-Sort](#bubble-sort)
     - [Merge-Sort](#merge-sort)
@@ -94,7 +95,7 @@ for (int value = 0; value < 50; value++) {
 //
 // Get amount of elments in dynamic-array
 size_t array_len;
-if (get_len(&dynamic_array, &array_len) == true) {
+if (get_len(&dynamic_array, &array_len) == NO_ERROR) {
     printf("length of dynamic-array=%d\n", array_len);
 } else {
     printf("Couldn't get length of dynamic-array\n");
@@ -187,7 +188,7 @@ 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)) {
+    if (append_dyn_arrays_inplace(&dynamic_array_a, &dynamic_array_b) == NO_ERROR) {
         printf("%s\n", (char*)get_element_by_index(&dynamic_array_a, 0));
     }
 }
@@ -232,7 +233,7 @@ if (clear_dyn_array(&dynamic_array_a) != NO_ERROR) {
 return 0;
 ```
 
-### Replace an Element by index
+### Replace an element by index
 
 ```C
 //
@@ -259,6 +260,33 @@ if (clear_dyn_array(&dyn_a) != NO_ERROR) {
 return 0;
 ```
 
+### Insert an element at an index
+
+```C
+//
+// Initialize dynamic-array
+DynArray dyn_a;
+if (init_dyn_array(&dyn_a) != NO_ERROR) {
+    return 1;
+}
+//
+// Append static-integer-array to dynamic-array
+int int_array[] = {1, 2, 3, 4, 5, 6, 7, 8, 9};
+if (append_static_array_elements_to_dyn_array(&dyn_a, (void*)int_array, sizeof(int), (size_t)9) == NO_ERROR) {
+    //
+    // Insert additional element at index 0
+    int new_element = 1337;
+    insert_element_at_index(&dyn_a, (size_t)0, (void*)&new_element, sizeof(int));
+}
+//
+// Clear dynamic-array
+if (clear_dyn_array(&dyn_a) != NO_ERROR) {
+    return 1;
+}
+
+return 0;
+```
+
 
 ### Sort-Algorithms
 

includes/dynamic_array.h

@@ -2,7 +2,6 @@
 #define DYNAMIC_ARRAY_LIB_DYNAMIC_ARRAY_H
 
 #include <stddef.h>
-#include <stdbool.h>
 
 /*
 Define enums, structs
@@ -37,13 +36,14 @@ Error_Code init_dyn_array(DynArray* dynamic_array);
 Error_Code append_element_to_dyn_array(DynArray* dynamic_array, const 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 get_len(const DynArray* dynamic_array, size_t* len);
 Error_Code append_static_array_elements_to_dyn_array(DynArray* dynamic_array, const void* static_array, const size_t static_array_elem_size, const size_t static_array_len);
 DynArrayNode* get_element_ptr_by_index(const DynArray* dynamic_array, const size_t index);
 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 append_dyn_arrays_inplace(DynArray* a, const DynArray* b);
 Error_Code swap_elements_by_indices(DynArray* dynamic_array, const size_t index_a, const size_t index_b);
 Error_Code replace_element_by_index(DynArray* dynamic_array, const size_t index, const void* data, const size_t data_size);
+Error_Code insert_element_at_index(DynArray* dynamic_array, const size_t index, const void* data, const size_t data_size);
 Error_Code clear_dyn_array(DynArray* dynamic_array);
 
 #endif // DYNAMIC_ARRAY_LIB_DYNAMIC_ARRAY_H