Add a macro to make initialization easier

Author: JalonWong

README.md

@@ -31,12 +31,7 @@ static HEAP: Heap = Heap::empty();
 #[entry]
 fn main() -> ! {
     // Initialize the allocator BEFORE you use it
-    {
-        use core::mem::MaybeUninit;
-        const HEAP_SIZE: usize = 1024;
-        static mut HEAP_MEM: [MaybeUninit<u8>; HEAP_SIZE] = [MaybeUninit::uninit(); HEAP_SIZE];
-        unsafe { HEAP.init(&raw mut HEAP_MEM as usize, HEAP_SIZE) }
-    }
+    embedded_alloc::init!(HEAP, 1024);
 
     // now the allocator is ready types like Box, Vec can be used.
 

examples/global_alloc.rs

@@ -17,12 +17,7 @@ static HEAP: Heap = Heap::empty();
 #[entry]
 fn main() -> ! {
     // Initialize the allocator BEFORE you use it
-    {
-        use core::mem::MaybeUninit;
-        const HEAP_SIZE: usize = 1024;
-        static mut HEAP_MEM: [MaybeUninit<u8>; HEAP_SIZE] = [MaybeUninit::uninit(); HEAP_SIZE];
-        unsafe { HEAP.init(&raw mut HEAP_MEM as usize, HEAP_SIZE) }
-    }
+    embedded_alloc::init!(HEAP, 1024);
 
     let mut xs = Vec::new();
     xs.push(1);

examples/llff_integration_test.rs

@@ -63,11 +63,7 @@ fn test_allocator_api() {
 
 #[entry]
 fn main() -> ! {
-    {
-        const HEAP_SIZE: usize = 1024;
-        static mut HEAP_MEM: [MaybeUninit<u8>; HEAP_SIZE] = [MaybeUninit::uninit(); HEAP_SIZE];
-        unsafe { HEAP.init(&raw mut HEAP_MEM as usize, HEAP_SIZE) }
-    }
+    embedded_alloc::init!(HEAP, 1024);
 
     #[allow(clippy::type_complexity)]
     let tests: &[(fn() -> (), &'static str)] = &[

examples/tlsf_integration_test.rs

@@ -81,10 +81,7 @@ fn test_allocator_api() {
 
 #[entry]
 fn main() -> ! {
-    {
-        static mut HEAP_MEM: [MaybeUninit<u8>; HEAP_SIZE] = [MaybeUninit::uninit(); HEAP_SIZE];
-        unsafe { HEAP.init(&raw mut HEAP_MEM as usize, HEAP_SIZE) }
-    }
+    embedded_alloc::init!(HEAP, HEAP_SIZE);
 
     #[allow(clippy::type_complexity)]
     let tests: &[(fn() -> (), &'static str)] = &[

src/lib.rs

@@ -12,3 +12,16 @@ mod tlsf;
 pub use llff::Heap as LlffHeap;
 #[cfg(feature = "tlsf")]
 pub use tlsf::Heap as TlsfHeap;
+
+/// Init a heap with a static memory region.
+#[macro_export]
+macro_rules! init {
+    ($heap:ident, $size:expr) => {
+        static mut HEAP_MEM: [core::mem::MaybeUninit<u8>; $size] =
+            [core::mem::MaybeUninit::uninit(); $size];
+        #[allow(static_mut_refs)]
+        unsafe {
+            $heap.init(&raw mut HEAP_MEM as usize, $size)
+        }
+    };
+}