Add single-ptr variants data structures' free fns
All checks were successful
Run Unit Tests / build-and-run-unit-tests (push) Successful in 6s

This commit is contained in:
Stephen Seo 2024-09-13 12:51:09 +09:00
parent 6b862ab022
commit ed85ded967
6 changed files with 55 additions and 22 deletions

View file

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

View file

@ -32,6 +32,11 @@ typedef struct SDArchiverHashMap {
} SDArchiverHashMap; } SDArchiverHashMap;
SDArchiverHashMap *simple_archiver_hash_map_init(void); 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); void simple_archiver_hash_map_free(SDArchiverHashMap **hash_map);
/// Returns zero on success. /// Returns zero on success.

View file

@ -41,9 +41,9 @@ SDArchiverLinkedList *simple_archiver_list_init(void) {
return list; return list;
} }
void simple_archiver_list_free(SDArchiverLinkedList **list) { void simple_archiver_list_free_single_ptr(SDArchiverLinkedList *list) {
if (list && *list) { if (list) {
SDArchiverLLNode *node = (*list)->head; SDArchiverLLNode *node = list->head;
SDArchiverLLNode *prev; SDArchiverLLNode *prev;
while (node) { while (node) {
prev = 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; *list = NULL;
} }
} }

View file

@ -35,6 +35,11 @@ typedef struct SDArchiverLinkedList {
} SDArchiverLinkedList; } SDArchiverLinkedList;
SDArchiverLinkedList *simple_archiver_list_init(void); 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); void simple_archiver_list_free(SDArchiverLinkedList **list);
/// Returns 0 on success. Puts data at the end of the list /// Returns 0 on success. Puts data at the end of the list

View file

@ -77,23 +77,29 @@ SDArchiverPHeap *simple_archiver_priority_heap_init_less_fn(
return priority_heap; return priority_heap;
} }
void simple_archiver_priority_heap_free(SDArchiverPHeap **priority_heap) { void simple_archiver_priority_heap_free_single_ptr(
if (priority_heap && *priority_heap) { SDArchiverPHeap *priority_heap) {
for (size_t idx = 1; idx < (*priority_heap)->size + 1; ++idx) { if (priority_heap) {
if ((*priority_heap)->nodes[idx].is_valid != 0) { for (size_t idx = 1; idx < priority_heap->size + 1; ++idx) {
if ((*priority_heap)->nodes[idx].data_cleanup_fn) { if (priority_heap->nodes[idx].is_valid != 0) {
(*priority_heap) if (priority_heap->nodes[idx].data_cleanup_fn) {
->nodes[idx] priority_heap->nodes[idx].data_cleanup_fn(
.data_cleanup_fn((*priority_heap)->nodes[idx].data); priority_heap->nodes[idx].data);
} else { } 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->nodes);
free(*priority_heap); 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; *priority_heap = NULL;
} }
} }

View file

@ -43,6 +43,12 @@ 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(void);
SDArchiverPHeap *simple_archiver_priority_heap_init_less_fn( SDArchiverPHeap *simple_archiver_priority_heap_init_less_fn(
int (*less_fn)(long long, long long)); 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); void simple_archiver_priority_heap_free(SDArchiverPHeap **priority_heap);
/// If data_cleanup_fn is NULL, then "free()" is used on data when freed. /// If data_cleanup_fn is NULL, then "free()" is used on data when freed.