Add combine_with_exported_module.

This commit is contained in:
Stephen Chung 2020-09-13 22:12:11 +08:00 committed by J Henry Waugh
parent c63f30a6a2
commit 7ceb624ec1
5 changed files with 10 additions and 17 deletions

View File

@ -161,7 +161,7 @@ pub fn combine_with_exported_module(args: proc_macro::TokenStream) -> proc_macro
Err(e) => return e.to_compile_error().into(), Err(e) => return e.to_compile_error().into(),
}; };
let tokens = quote! { let tokens = quote! {
#module_path::rhai_generate_into_module(#module_expr, true); #module_path::rhai_generate_into_module(#module_expr);
}; };
proc_macro::TokenStream::from(tokens) proc_macro::TokenStream::from(tokens)
} }

View File

@ -17,7 +17,7 @@ pub(crate) fn generate_body(
let mut set_fn_stmts: Vec<syn::Stmt> = Vec::new(); let mut set_fn_stmts: Vec<syn::Stmt> = Vec::new();
let mut set_const_stmts: Vec<syn::Stmt> = Vec::new(); let mut set_const_stmts: Vec<syn::Stmt> = Vec::new();
let mut add_mod_blocks: Vec<syn::ExprBlock> = Vec::new(); let mut add_mod_blocks: Vec<syn::ExprBlock> = Vec::new();
let mut set_flattened_mod_blocks: Vec<syn::ExprBlock> = Vec::new(); let mut set_mod_blocks: Vec<syn::ExprBlock> = Vec::new();
let str_type_path = syn::parse2::<syn::Path>(quote! { str }).unwrap(); let str_type_path = syn::parse2::<syn::Path>(quote! { str }).unwrap();
for (const_name, const_type, const_expr) in consts { for (const_name, const_type, const_expr) in consts {
@ -55,10 +55,10 @@ pub(crate) fn generate_body(
}) })
.unwrap(), .unwrap(),
); );
set_flattened_mod_blocks.push( set_mod_blocks.push(
syn::parse2::<syn::ExprBlock>(quote! { syn::parse2::<syn::ExprBlock>(quote! {
#(#cfg_attrs)* { #(#cfg_attrs)* {
self::#module_name::rhai_generate_into_module(m, flatten); self::#module_name::rhai_generate_into_module(m);
} }
}) })
.unwrap(), .unwrap(),
@ -155,6 +155,11 @@ pub(crate) fn generate_body(
#(#add_mod_blocks)* #(#add_mod_blocks)*
} }
} }
pub fn rhai_generate_into_module(m: &mut Module) {
#(#set_fn_stmts)*
#(#set_const_stmts)*
#(#set_mod_blocks)*
}
} }
}) })
.unwrap(); .unwrap();

View File

@ -66,9 +66,6 @@ In fact, this exactly is how Rhai's built-in packages, such as `BasicMathPackage
`rhai::plugins::combine_with_exported_module!` adds all functions and constants from the `rhai::plugins::combine_with_exported_module!` adds all functions and constants from the
[plugins][plugin module] definition into the package itself. [plugins][plugin module] definition into the package itself.
All sub-modules are _flattened_ (i.e. all functions and constants defined within sub-modules are registered
at the top level) and so there will not be any sub-modules added to the package.
```rust ```rust
// Import necessary types and traits. // Import necessary types and traits.
use rhai::{ use rhai::{
@ -107,17 +104,8 @@ def_package!(rhai:MyPackage:"My own personal super package", module, {
// Merge all registered functions and constants from the plugin module into the custom package. // Merge all registered functions and constants from the plugin module into the custom package.
// //
// Functions in the sub-module 'my_sub_module' are flattened and registered at the top level
// instead of in a sub-module.
//
// The text string name in the middle parameter can be anything and is reserved for future use; // The text string name in the middle parameter can be anything and is reserved for future use;
// it is recommended to be an ID string that uniquely identifies the module. // it is recommended to be an ID string that uniquely identifies the module.
//
// This call ends up registering three functions at the top level of the package:
// 1) greet
// 2) get_num
// 3) get_sub_num (flattened from sub-module 'my_sub_module')
//
combine_with_exported_module!(module, "my-functions", my_module)); combine_with_exported_module!(module, "my-functions", my_module));
}); });
``` ```

View File

@ -11,7 +11,7 @@ mod test {
pub mod special_array_package { pub mod special_array_package {
use rhai::{Array, INT}; use rhai::{Array, INT};
pub const MYSTIC_NUMBER: INT = 42; pub const MYSTIC_NUMBER: INT = 42 as INT;
#[cfg(not(feature = "no_object"))] #[cfg(not(feature = "no_object"))]
pub mod feature { pub mod feature {

0
xxx.rs Normal file
View File