arr: Rename Free -> Deinit.

While this function frees the underlying array, and resets the entries,
the a, n, and cap variables themselves are not freed (not that this
necessarily makes sense).

Using arr alone this distinction is not that important, but a user of
arr might want to define a _free function that actually frees the entire
container, including the meta data.

The naming is also more consistent;  deinit() is the complement to
init().

Author: lorinder

src/csnip/arr.h

@@ -161,10 +161,10 @@
  *
  *	This function deletes the memory associated with an array.  The
  *	result is an array of size 0 with no allocated memory
- *	associated, i.e., it is like a freshly allocated array of
+ *	associated, i.e., it is like a freshly initialized array of
  *	capacity 0.
  */
-#define csnip_arr_Free(a, n, cap) \
+#define csnip_arr_Deinit(a, n, cap) \
 	do { \
 		csnip_mem_Free(a); \
 		(n) = 0; \
@@ -202,7 +202,7 @@
 				size_t i, val_type v); \
 	scope void prefix ## delete_at(csnip_pp_prepend_##gen_args \
 				size_t i); \
-	scope void prefix ## free(csnip_pp_list_##gen_args);
+	scope void prefix ## deinit(csnip_pp_list_##gen_args);
 
 /**	Define dynamic array managment functions.
  *
@@ -261,9 +261,9 @@
 	{ \
 		csnip_arr_DeleteAt(a, n, cap, i, err); \
 	} \
-	scope void prefix ## free(csnip_pp_list_##gen_args) \
+	scope void prefix ## deinit(csnip_pp_list_##gen_args) \
 	{ \
-		csnip_arr_Free(a, n, cap); \
+		csnip_arr_Deinit(a, n, cap); \
 	}
 /** @} */
 
@@ -276,6 +276,6 @@
 #define arr_Pop			csnip_arr_Pop
 #define arr_InsertAt		csnip_arr_InsertAt
 #define arr_DeleteAt		csnip_arr_DeleteAt
-#define arr_Free		csnip_arr_Free
+#define arr_Deinit		csnip_arr_Deinit
 #define CSNIP_ARR_HAVE_SHORT_NAMES
 #endif /* CSNIP_SHORT_NAMES && !CSNIP_ARR_HAVE_SHORT_NAMES */

src/csnip/clopts.c

@@ -228,7 +228,7 @@ int csnip_clopts_process(csnip_clopts* opts,
 
 void csnip_clopts_clear(csnip_clopts* opts)
 {
-	arr_Free(opts->optinfo, opts->n_optinfo, opts->n_optinfo_cap);
+	arr_Deinit(opts->optinfo, opts->n_optinfo, opts->n_optinfo_cap);
 }
 
 int csnip_clopts_parser_uchar(const csnip_clopts* opts,

test/arr_test0.c

@@ -31,6 +31,6 @@ int main()
 	for(int i = 0; i < N; ++i) {
 		printf("[%d] %d\n", Ax.n - i - 1, Ax.el[Ax.n - i - 1]);
 	}
-	IntArray_free(&Ax);
+	IntArray_deinit(&Ax);
 	return 0;
 }

test/arr_test1.c

@@ -60,7 +60,7 @@ static bool test_reserve()
 	if (A.cap < 5)
 		return false;
 
-	IntArr_free(&A, &err);
+	IntArr_deinit(&A, &err);
 	return true;
 }
 
@@ -81,7 +81,7 @@ static bool test_push()
 			return false;
 	}
 
-	IntArr_free(&A, NULL);
+	IntArr_deinit(&A, NULL);
 	return true;
 }
 
@@ -108,7 +108,7 @@ static bool test_pop()
 		return false;
 	}
 
-	IntArr_free(&A, NULL);
+	IntArr_deinit(&A, NULL);
 	return true;
 }
 
@@ -145,7 +145,7 @@ static bool test_insert_at()
 		}
 	}
 
-	IntArr_free(&A, NULL);
+	IntArr_deinit(&A, NULL);
 	return true;
 }
 
@@ -175,20 +175,20 @@ static bool test_delete_at()
 		}
 	}
 
-	IntArr_free(&A, NULL);
+	IntArr_deinit(&A, NULL);
 	return true;
 }
 
-static bool test_free()
+static bool test_deinit()
 {
 	IntArr A;
 	IntArr_init(&A, NULL, 256);
 
-	IntArr_free(&A, NULL);
+	IntArr_deinit(&A, NULL);
 	if (A.cap != 0 || A.a != NULL)
 		return false;
 
-	IntArr_free(&A, NULL); // free a 2nd time is a no-op.
+	IntArr_deinit(&A, NULL); // deinit a 2nd time is a no-op.
 	return true;
 }
 
@@ -211,7 +211,7 @@ int main(int argc, char** argv)
 	TEST(pop);
 	TEST(insert_at);
 	TEST(delete_at);
-	TEST(free);
+	TEST(deinit);
 #undef TEST
 
 	printf("Overall result: %s\n", (success ? "pass" : "FAIL"));