wasmer_runtime_core_fl/
macros.rs

1/// Helper macro to create a new `Func` object using the provided function pointer.
2///
3/// # Usage
4///
5/// Function pointers or closures are supported. Closures can capture
6/// their environment (with `move`). The first parameter is likely to
7/// be of kind `vm::Ctx`, though it can be optional.
8///
9/// ```
10/// # use wasmer_runtime_core::{imports, func};
11/// # use wasmer_runtime_core::vm;
12///
13/// // A function that has access to `vm::Ctx`.
14/// fn func_with_vmctx(_: &mut vm::Ctx, n: i32) -> i32 {
15///     n
16/// }
17///
18/// // A function that cannot access `vm::Ctx`.
19/// fn func(n: i32) -> i32 {
20///     n
21/// }
22///
23/// let i = 7;
24///
25/// let import_object = imports! {
26///     "env" => {
27///         "foo" => func!(func_with_vmctx),
28///         "bar" => func!(func),
29///         // A closure with a captured environment, and an access to `vm::Ctx`.
30///         "baz" => func!(move |_: &mut vm::Ctx, n: i32| -> i32 {
31///             n + i
32///         }),
33///         // A closure without a captured environment, and no access to `vm::Ctx`.
34///         "qux" => func!(|n: i32| -> i32 {
35///             n
36///         }),
37///     },
38/// };
39/// ```
40#[macro_export]
41macro_rules! func {
42    ($func:expr) => {{
43        $crate::Func::new($func)
44    }};
45}
46
47/// Generate an [`ImportObject`] safely.
48///
49/// [`ImportObject`]: struct.ImportObject.html
50///
51/// # Note
52/// The `import` macro currently only supports
53/// importing functions.
54///
55///
56/// # Usage
57/// ```
58/// # use wasmer_runtime_core::{imports, func};
59/// # use wasmer_runtime_core::vm::Ctx;
60/// let import_object = imports! {
61///     "env" => {
62///         "foo" => func!(foo),
63///     },
64/// };
65///
66/// let imports_with_state = imports! {
67///     || (0 as _, |_a| {}),
68///     "env" => {
69///         "foo" => func!(foo),
70///     },
71/// };
72///
73/// fn foo(_: &mut Ctx, n: i32) -> i32 {
74///     n
75/// }
76/// ```
77#[macro_export]
78macro_rules! imports {
79    ( $( $ns_name:expr => $ns:tt ),* $(,)? ) => {{
80        use $crate::{
81            import::{ImportObject, Namespace},
82        };
83
84        let mut import_object = ImportObject::new();
85
86        $({
87            let ns = $crate::__imports_internal!($ns);
88
89            import_object.register($ns_name, ns);
90        })*
91
92        import_object
93    }};
94    ($state_gen:expr, $( $ns_name:expr => $ns:tt ),* $(,)? ) => {{
95        use $crate::{
96            import::{ImportObject, Namespace},
97        };
98
99        let mut import_object = ImportObject::new_with_data($state_gen);
100
101        $({
102            let ns = $crate::__imports_internal!($ns);
103
104            import_object.register($ns_name, ns);
105        })*
106
107        import_object
108    }};
109}
110
111#[macro_export]
112#[doc(hidden)]
113macro_rules! __imports_internal {
114    ( { $( $imp_name:expr => $import_item:expr ),* $(,)? } ) => {{
115        let mut ns = Namespace::new();
116        $(
117            ns.insert($imp_name, $import_item);
118        )*
119        ns
120    }};
121    ($ns:ident) => {
122        $ns
123    };
124}
125
126#[macro_export]
127#[doc(hidden)]
128macro_rules! namespace {
129    ( $( $imp_name:expr => $import_item:expr ),* $(,)? ) => {{
130        let mut ns = $crate::import::Namespace::new();
131        $(
132            ns.insert($imp_name, $import_item);
133        )*
134        ns
135    }};
136}
137
138#[cfg(test)]
139mod test {
140    fn func(arg: i32) -> i32 {
141        arg + 1
142    }
143
144    #[test]
145    fn imports_macro_allows_trailing_comma_and_none() {
146        let _ = imports! {
147            "env" => {
148                "func" => func!(func),
149            },
150        };
151        let _ = imports! {
152            "env" => {
153                "func" => func!(func),
154            }
155        };
156        let _ = imports! {
157            "env" => {
158                "func" => func!(func),
159            },
160            "abc" => {
161                "def" => func!(func),
162            }
163        };
164        let _ = imports! {
165            "env" => {
166                "func" => func!(func)
167            },
168        };
169        let _ = imports! {
170            "env" => {
171                "func" => func!(func)
172            }
173        };
174        let _ = imports! {
175            "env" => {
176                "func1" => func!(func),
177                "func2" => func!(func)
178            }
179        };
180        let _ = imports! {
181            "env" => {
182                "func1" => func!(func),
183                "func2" => func!(func),
184            }
185        };
186    }
187
188    #[test]
189    fn imports_macro_allows_trailing_comma_and_none_with_state() {
190        use std::{ffi, ptr};
191
192        fn dtor(_arg: *mut ffi::c_void) {}
193        fn state_creator() -> (*mut ffi::c_void, fn(*mut ffi::c_void)) {
194            (ptr::null_mut() as *mut ffi::c_void, dtor)
195        }
196        let _ = imports! {
197            state_creator,
198            "env" => {
199                "func1" => func!(func),
200                "func2" => func!(func),
201            }
202        };
203        let _ = imports! {
204            state_creator,
205            "env" => {
206                "func1" => func!(func),
207                "func2" => func!(func)
208            },
209        };
210        let _ = imports! {
211            state_creator,
212            "env" => {
213                "func1" => func!(func),
214                "func2" => func!(func),
215            },
216        };
217    }
218}
wasmer_runtime_core_fl/macros.rs

wasmer_runtime_core_fl/
macros.rs
