Add single-ptr variants data structures' free fns

priority-heap insert now takes a pointer to a priority-heap instead of a
double pointer.

src/data_structures/hash_map.c

@@ -159,16 +159,21 @@ SDArchiverHashMap *simple_archiver_hash_map_init(void) {
   return hash_map;
 }
 
-void simple_archiver_hash_map_free(SDArchiverHashMap **hash_map) {
-  if (hash_map && *hash_map) {
-    for (size_t idx = 0; idx < (*hash_map)->buckets_size; ++idx) {
-      SDArchiverLinkedList **linked_list = (*hash_map)->buckets + idx;
+void simple_archiver_hash_map_free_single_ptr(SDArchiverHashMap *hash_map) {
+  if (hash_map) {
+    for (size_t idx = 0; idx < hash_map->buckets_size; ++idx) {
+      SDArchiverLinkedList **linked_list = hash_map->buckets + idx;
       simple_archiver_list_free(linked_list);
     }
 
-    free((*hash_map)->buckets);
-    free(*hash_map);
+    free(hash_map->buckets);
+    free(hash_map);
+  }
+}
 
+void simple_archiver_hash_map_free(SDArchiverHashMap **hash_map) {
+  if (hash_map && *hash_map) {
+    simple_archiver_hash_map_free_single_ptr(*hash_map);
     *hash_map = NULL;
   }
 }

src/data_structures/hash_map.h

@@ -32,6 +32,11 @@ typedef struct SDArchiverHashMap {
 } SDArchiverHashMap;
 
 SDArchiverHashMap *simple_archiver_hash_map_init(void);
+
+/// It is recommended to use the double-pointer version of hash-map free as
+/// that will ensure the variable holding the pointer will end up pointing to
+/// NULL after free.
+void simple_archiver_hash_map_free_single_ptr(SDArchiverHashMap *hash_map);
 void simple_archiver_hash_map_free(SDArchiverHashMap **hash_map);
 
 /// Returns zero on success.

src/data_structures/linked_list.c

@@ -41,9 +41,9 @@ SDArchiverLinkedList *simple_archiver_list_init(void) {
   return list;
 }
 
-void simple_archiver_list_free(SDArchiverLinkedList **list) {
-  if (list && *list) {
-    SDArchiverLLNode *node = (*list)->head;
+void simple_archiver_list_free_single_ptr(SDArchiverLinkedList *list) {
+  if (list) {
+    SDArchiverLLNode *node = list->head;
     SDArchiverLLNode *prev;
     while (node) {
       prev = node;
@@ -58,7 +58,13 @@ void simple_archiver_list_free(SDArchiverLinkedList **list) {
       }
     }
 
-    free(*list);
+    free(list);
+  }
+}
+
+void simple_archiver_list_free(SDArchiverLinkedList **list) {
+  if (list && *list) {
+    simple_archiver_list_free_single_ptr(*list);
     *list = NULL;
   }
 }

src/data_structures/linked_list.h

@@ -35,6 +35,11 @@ typedef struct SDArchiverLinkedList {
 } SDArchiverLinkedList;
 
 SDArchiverLinkedList *simple_archiver_list_init(void);
+
+/// It is recommended to use the double-pointer version of list free as that
+/// will ensure the variable holding the pointer will end up pointing to NULL
+/// after free.
+void simple_archiver_list_free_single_ptr(SDArchiverLinkedList *list);
 void simple_archiver_list_free(SDArchiverLinkedList **list);
 
 /// Returns 0 on success. Puts data at the end of the list

src/data_structures/priority_heap.c

@@ -21,27 +21,27 @@
 #include <stdlib.h>
 
 void simple_archiver_priority_heap_internal_realloc(
-    SDArchiverPHeap **priority_heap) {
-  SDArchiverPHeap *new_priority_heap = malloc(sizeof(SDArchiverPHeap));
+    SDArchiverPHeap *priority_heap) {
+  SDArchiverPHeap new_priority_heap;
 
-  new_priority_heap->capacity = (*priority_heap)->capacity * 2;
-  new_priority_heap->size = 0;
-  new_priority_heap->less_fn = (*priority_heap)->less_fn;
+  new_priority_heap.capacity = priority_heap->capacity * 2;
+  new_priority_heap.size = 0;
+  new_priority_heap.less_fn = priority_heap->less_fn;
 
-  new_priority_heap->nodes =
-      calloc(new_priority_heap->capacity, sizeof(SDArchiverPHNode));
+  new_priority_heap.nodes =
+      calloc(new_priority_heap.capacity, sizeof(SDArchiverPHNode));
 
-  for (size_t idx = 1; idx < (*priority_heap)->size + 1; ++idx) {
-    if ((*priority_heap)->nodes[idx].is_valid != 0) {
+  for (size_t idx = 1; idx < priority_heap->size + 1; ++idx) {
+    if (priority_heap->nodes[idx].is_valid != 0) {
       simple_archiver_priority_heap_insert(
-          &new_priority_heap, (*priority_heap)->nodes[idx].priority,
-          (*priority_heap)->nodes[idx].data,
-          (*priority_heap)->nodes[idx].data_cleanup_fn);
-      (*priority_heap)->nodes[idx].is_valid = 0;
+          &new_priority_heap, priority_heap->nodes[idx].priority,
+          priority_heap->nodes[idx].data,
+          priority_heap->nodes[idx].data_cleanup_fn);
+      priority_heap->nodes[idx].is_valid = 0;
     }
   }
 
-  simple_archiver_priority_heap_free(priority_heap);
+  free(priority_heap->nodes);
 
   *priority_heap = new_priority_heap;
 }
@@ -77,54 +77,59 @@ SDArchiverPHeap *simple_archiver_priority_heap_init_less_fn(
   return priority_heap;
 }
 
-void simple_archiver_priority_heap_free(SDArchiverPHeap **priority_heap) {
-  if (priority_heap && *priority_heap) {
-    for (size_t idx = 1; idx < (*priority_heap)->size + 1; ++idx) {
-      if ((*priority_heap)->nodes[idx].is_valid != 0) {
-        if ((*priority_heap)->nodes[idx].data_cleanup_fn) {
-          (*priority_heap)
-              ->nodes[idx]
-              .data_cleanup_fn((*priority_heap)->nodes[idx].data);
+void simple_archiver_priority_heap_free_single_ptr(
+    SDArchiverPHeap *priority_heap) {
+  if (priority_heap) {
+    for (size_t idx = 1; idx < priority_heap->size + 1; ++idx) {
+      if (priority_heap->nodes[idx].is_valid != 0) {
+        if (priority_heap->nodes[idx].data_cleanup_fn) {
+          priority_heap->nodes[idx].data_cleanup_fn(
+              priority_heap->nodes[idx].data);
         } else {
-          free((*priority_heap)->nodes[idx].data);
+          free(priority_heap->nodes[idx].data);
         }
-        (*priority_heap)->nodes[idx].is_valid = 0;
+        priority_heap->nodes[idx].is_valid = 0;
       }
     }
 
-    free((*priority_heap)->nodes);
-    free(*priority_heap);
+    free(priority_heap->nodes);
+    free(priority_heap);
+  }
+}
+
+void simple_archiver_priority_heap_free(SDArchiverPHeap **priority_heap) {
+  if (priority_heap && *priority_heap) {
+    simple_archiver_priority_heap_free_single_ptr(*priority_heap);
     *priority_heap = NULL;
   }
 }
 
-void simple_archiver_priority_heap_insert(SDArchiverPHeap **priority_heap,
+void simple_archiver_priority_heap_insert(SDArchiverPHeap *priority_heap,
                                           long long priority, void *data,
                                           void (*data_cleanup_fn)(void *)) {
-  if (!priority_heap || !*priority_heap) {
+  if (!priority_heap) {
     return;
   }
 
-  if ((*priority_heap)->size + 1 >= (*priority_heap)->capacity) {
+  if (priority_heap->size + 1 >= priority_heap->capacity) {
     simple_archiver_priority_heap_internal_realloc(priority_heap);
   }
 
-  size_t hole = (*priority_heap)->size + 1;
+  size_t hole = priority_heap->size + 1;
 
   while (hole > 1 &&
-         (*priority_heap)
-                 ->less_fn(priority,
-                           (*priority_heap)->nodes[hole / 2].priority) != 0) {
-    (*priority_heap)->nodes[hole] = (*priority_heap)->nodes[hole / 2];
+         priority_heap->less_fn(priority,
+                                priority_heap->nodes[hole / 2].priority) != 0) {
+    priority_heap->nodes[hole] = priority_heap->nodes[hole / 2];
     hole /= 2;
   }
 
-  (*priority_heap)->nodes[hole].priority = priority;
-  (*priority_heap)->nodes[hole].data = data;
-  (*priority_heap)->nodes[hole].data_cleanup_fn = data_cleanup_fn;
-  (*priority_heap)->nodes[hole].is_valid = 1;
+  priority_heap->nodes[hole].priority = priority;
+  priority_heap->nodes[hole].data = data;
+  priority_heap->nodes[hole].data_cleanup_fn = data_cleanup_fn;
+  priority_heap->nodes[hole].is_valid = 1;
 
-  ++(*priority_heap)->size;
+  ++priority_heap->size;
 }
 
 void *simple_archiver_priority_heap_top(SDArchiverPHeap *priority_heap) {

src/data_structures/priority_heap.h

@@ -43,10 +43,16 @@ int simple_archiver_priority_heap_default_less(long long a, long long b);
 SDArchiverPHeap *simple_archiver_priority_heap_init(void);
 SDArchiverPHeap *simple_archiver_priority_heap_init_less_fn(
     int (*less_fn)(long long, long long));
+
+/// It is recommended to use the double-pointer version of priority-heap free
+/// as that will ensure the variable holding the pointer will end up pointing
+/// to NULL after free.
+void simple_archiver_priority_heap_free_single_ptr(
+    SDArchiverPHeap *priority_heap);
 void simple_archiver_priority_heap_free(SDArchiverPHeap **priority_heap);
 
 /// If data_cleanup_fn is NULL, then "free()" is used on data when freed.
-void simple_archiver_priority_heap_insert(SDArchiverPHeap **priority_heap,
+void simple_archiver_priority_heap_insert(SDArchiverPHeap *priority_heap,
                                           long long priority, void *data,
                                           void (*data_cleanup_fn)(void *));
 

src/data_structures/test.c

@@ -229,7 +229,7 @@ int main(void) {
     for (unsigned int idx = 0; idx < 3; ++idx) {
       unsigned int *data = malloc(sizeof(unsigned int));
       *data = idx;
-      simple_archiver_priority_heap_insert(&priority_heap, idx, data, NULL);
+      simple_archiver_priority_heap_insert(priority_heap, idx, data, NULL);
     }
     for (unsigned int idx = 0; idx < 3; ++idx) {
       unsigned int *data = simple_archiver_priority_heap_top(priority_heap);
@@ -251,7 +251,7 @@ int main(void) {
     for (unsigned int idx = 0; idx < max; ++idx) {
       unsigned int *data = malloc(sizeof(unsigned int));
       *data = idx;
-      simple_archiver_priority_heap_insert(&priority_heap, idx, data, NULL);
+      simple_archiver_priority_heap_insert(priority_heap, idx, data, NULL);
     }
 
     for (unsigned int idx = 0; idx < max; ++idx) {
@@ -266,7 +266,7 @@ int main(void) {
     for (unsigned int idx = max; idx-- > 0;) {
       unsigned int *data = malloc(sizeof(unsigned int));
       *data = idx;
-      simple_archiver_priority_heap_insert(&priority_heap, idx, data, NULL);
+      simple_archiver_priority_heap_insert(priority_heap, idx, data, NULL);
     }
 
     for (unsigned int idx = 0; idx < max; ++idx) {
@@ -296,7 +296,7 @@ int main(void) {
 
     // Insert the deterministically randomized array.
     for (unsigned int idx = 0; idx < max; ++idx) {
-      simple_archiver_priority_heap_insert(&priority_heap, array[idx],
+      simple_archiver_priority_heap_insert(priority_heap, array[idx],
                                            array + idx, no_free_fn);
     }
 
@@ -321,7 +321,7 @@ int main(void) {
     for (unsigned int idx = 0; idx < max; ++idx) {
       unsigned int *data = malloc(sizeof(unsigned int));
       *data = idx;
-      simple_archiver_priority_heap_insert(&priority_heap, idx, data, NULL);
+      simple_archiver_priority_heap_insert(priority_heap, idx, data, NULL);
     }
     simple_archiver_priority_heap_free(&priority_heap);
 
@@ -331,7 +331,7 @@ int main(void) {
     for (unsigned int idx = 0; idx < max; ++idx) {
       unsigned int *data = malloc(sizeof(unsigned int));
       *data = idx;
-      simple_archiver_priority_heap_insert(&priority_heap, idx, data, NULL);
+      simple_archiver_priority_heap_insert(priority_heap, idx, data, NULL);
     }
 
     for (unsigned int idx = max; idx-- > 0;) {
@@ -364,7 +364,7 @@ int main(void) {
 
     // Insert the deterministically randomized array.
     for (unsigned int idx = 0; idx < max; ++idx) {
-      simple_archiver_priority_heap_insert(&priority_heap, array[idx],
+      simple_archiver_priority_heap_insert(priority_heap, array[idx],
                                            array + idx, no_free_fn);
     }