Deprecated 'ARENA_SUPPRESS_MALLOC_WARN'

ccgargantua · Jan 6, 2024 · 3f3ac5f · 3f3ac5f
1 parent 1252afa
commit 3f3ac5f
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -22,14 +22,13 @@ For one file in one translation unit, you need to define some macros before incl
 ```c
 #define ARENA_IMPLEMENTATION
 
-// You will get a warning if you don't specify:
-// either both of these...
-#define ARENA_MALLOC <stdlib_malloc_like_allocator> // defaults to stdlib malloc
-#define ARENA_FREE <stdlib_free_like_deallocator>   // defaults to stdlib free
-// ... or just this
-#define ARENA_SUPPRESS_MALLOC_WARN // Alternatively use compiler flag -DARENA_SUPPRESS_MALLOC_WARN
+// All of these are optional
+#define ARENA_MALLOC <stdlib_malloc_like_allocator>
+#define ARENA_FREE <stdlib_free_like_deallocator>
+#define ARENA_MEMCPY <stdlib_memcpy_like_copier>
 
-#include "arena.h"
+// for debug functionality, you can also do:
+#define ARENA_DEBUG
 ```
 
 After doing this in **one** file in **one** translation unit, for **any other file** you can include normally with a lone `#include "arena.h"`.

diff --git a/arena.h b/arena.h
@@ -5,16 +5,15 @@ example.
 QUICK USAGE:
   One file in one translation unit must have the
   following before including "arena.h", replacing
-  the macro values appropriately when needed.
+  the macro values appropriately when desired.
 
 ```
 #define ARENA_IMPLEMENTATION
 
-// Either both of these...
+// All of these are optional
 #define ARENA_MALLOC <stdlib_malloc_like_allocator>
 #define ARENA_FREE <stdlib_free_like_deallocator>
-// ... or just this
-#define ARENA_SUPPRESS_MALLOC_WARN // alternatively using compiler flag -D with same name
+#define ARENA_MEMCPY <stdlib_memcpy_like_copier>
 
 // for debug functionality, you can also do:
 #define ARENA_DEBUG
@@ -183,20 +182,20 @@ Arena_Allocation* arena_get_allocation_struct(Arena *arena, void *ptr);
 #ifdef ARENA_IMPLEMENTATION
 
 
-#if !defined(ARENA_MALLOC) || !defined(ARENA_FREE) || !defined(ARENA_MEMCPY)
-
-    #ifndef ARENA_SUPPRESS_MALLOC_WARN
-        #warning "Using <stdlib.h> malloc and free, because a replacement for one or both was not specified before including 'arena.h'."
-    #endif /* !ARENA_SUPPRESS_MALLOC_WARN */
-
+#ifndef ARENA_MALLOC
     #include <stdlib.h>
     #define ARENA_MALLOC malloc
+#endif
+
+#ifndef ARENA_FREE
+    #include <stdlib.h>
     #define ARENA_FREE free
+#endif
 
+#ifndef ARENA_MEMCPY
     #include <string.h>
     #define ARENA_MEMCPY memcpy
-
-#endif /* !defined ARENA_MALLOC, ARENA_FREE */
+#endif
 
 
 Arena* arena_create(size_t size)

diff --git a/code_examples/example.c b/code_examples/example.c
@@ -2,7 +2,6 @@
 #include <string.h> // memcpy
 
 #define ARENA_IMPLEMENTATION
-#define ARENA_SUPPRESS_MALLOC_WARN
 #include "../arena.h"
 
 int main(void)

diff --git a/code_examples/example_aligned.c b/code_examples/example_aligned.c
@@ -1,7 +1,6 @@
 #include <stdio.h>  // printf
 
 #define ARENA_IMPLEMENTATION
-#define ARENA_SUPPRESS_MALLOC_WARN
 #include "../arena.h"
 
 int main(void)

diff --git a/code_examples/example_debug.c b/code_examples/example_debug.c
@@ -3,7 +3,6 @@
 
 #define ARENA_DEBUG
 #define ARENA_IMPLEMENTATION
-#define ARENA_SUPPRESS_MALLOC_WARN
 #include "../arena.h"
 
 int main(void)