1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
//! This crate contains procedural macros to make creating Rhai plugin-modules much easier. //! //! # Export an Entire Rust Module to a Rhai `Module` //! //! ``` //! use rhai::{EvalAltResult, FLOAT}; //! use rhai::plugin::*; //! use rhai::module_resolvers::*; //! //! #[export_module] //! mod advanced_math { //! pub const MYSTIC_NUMBER: FLOAT = 42.0; //! //! pub fn euclidean_distance(x1: FLOAT, y1: FLOAT, x2: FLOAT, y2: FLOAT) -> FLOAT { //! ((y2 - y1).abs().powf(2.0) + (x2 -x1).abs().powf(2.0)).sqrt() //! } //! } //! //! # fn main() -> Result<(), Box<EvalAltResult>> { //! let mut engine = Engine::new(); //! let m = exported_module!(advanced_math); //! let mut r = StaticModuleResolver::new(); //! r.insert("Math::Advanced", m); //! engine.set_module_resolver(Some(r)); //! //! assert_eq!(engine.eval::<FLOAT>( //! r#" //! import "Math::Advanced" as math; //! math::euclidean_distance(0.0, 1.0, 0.0, math::MYSTIC_NUMBER) //! "#)?, 41.0); //! # Ok(()) //! # } //! ``` //! //! # Register a Rust Function with a Rhai `Module` //! //! ``` //! use rhai::{EvalAltResult, FLOAT, Module, RegisterFn}; //! use rhai::plugin::*; //! use rhai::module_resolvers::*; //! //! #[export_fn] //! fn distance_function(x1: FLOAT, y1: FLOAT, x2: FLOAT, y2: FLOAT) -> FLOAT { //! ((y2 - y1).abs().powf(2.0) + (x2 -x1).abs().powf(2.0)).sqrt() //! } //! //! # fn main() -> Result<(), Box<EvalAltResult>> { //! let mut engine = Engine::new(); //! engine.register_fn("get_mystic_number", || 42.0 as FLOAT); //! let mut m = Module::new(); //! set_exported_fn!(m, "euclidean_distance", distance_function); //! let mut r = StaticModuleResolver::new(); //! r.insert("Math::Advanced", m); //! engine.set_module_resolver(Some(r)); //! //! assert_eq!(engine.eval::<FLOAT>( //! r#" //! import "Math::Advanced" as math; //! math::euclidean_distance(0.0, 1.0, 0.0, get_mystic_number()) //! "#)?, 41.0); //! # Ok(()) //! # } //! ``` //! //! # Register a Plugin Function with an `Engine` //! //! ``` //! use rhai::{EvalAltResult, FLOAT, Module, RegisterFn}; //! use rhai::plugin::*; //! use rhai::module_resolvers::*; //! //! #[export_fn] //! pub fn distance_function(x1: FLOAT, y1: FLOAT, x2: FLOAT, y2: FLOAT) -> FLOAT { //! ((y2 - y1).abs().powf(2.0) + (x2 -x1).abs().powf(2.0)).sqrt() //! } //! //! # fn main() -> Result<(), Box<EvalAltResult>> { //! let mut engine = Engine::new(); //! engine.register_fn("get_mystic_number", || { 42 as FLOAT }); //! register_exported_fn!(engine, "euclidean_distance", distance_function); //! //! assert_eq!(engine.eval::<FLOAT>( //! "euclidean_distance(0.0, 1.0, 0.0, get_mystic_number())" //! )?, 41.0); //! # Ok(()) //! # } //! ``` //! use quote::quote; use syn::parse_macro_input; mod attrs; mod function; mod module; mod register; mod rhai_module; #[cfg(test)] mod test; /// Attribute, when put on a Rust function, turns it into a _plugin function_. /// /// # Usage /// /// ``` /// # use rhai::{Engine, EvalAltResult}; /// use rhai::plugin::*; /// /// #[export_fn] /// fn my_plugin_function(x: i64) -> i64 { /// x * 2 /// } /// /// # fn main() -> Result<(), Box<EvalAltResult>> { /// let mut engine = Engine::new(); /// /// register_exported_fn!(engine, "func", my_plugin_function); /// /// assert_eq!(engine.eval::<i64>("func(21)")?, 42); /// # Ok(()) /// # } /// ``` #[proc_macro_attribute] pub fn export_fn( args: proc_macro::TokenStream, input: proc_macro::TokenStream, ) -> proc_macro::TokenStream { let mut output = proc_macro2::TokenStream::from(input.clone()); let parsed_params = match crate::attrs::outer_item_attributes(args.into(), "export_fn") { Ok(args) => args, Err(err) => return proc_macro::TokenStream::from(err.to_compile_error()), }; let mut function_def = parse_macro_input!(input as function::ExportedFn); if let Err(e) = function_def.set_params(parsed_params) { return e.to_compile_error().into(); } output.extend(function_def.generate()); proc_macro::TokenStream::from(output) } /// Attribute, when put on a Rust module, turns it into a _plugin module_. /// /// # Usage /// /// ``` /// # use rhai::{Engine, Module, EvalAltResult}; /// use rhai::plugin::*; /// /// #[export_module] /// mod my_plugin_module { /// pub fn foo(x: i64) -> i64 { x * 2 } /// pub fn bar() -> i64 { 21 } /// } /// /// # fn main() -> Result<(), Box<EvalAltResult>> { /// let mut engine = Engine::new(); /// /// let module = exported_module!(my_plugin_module); /// /// engine.load_package(module); /// /// assert_eq!(engine.eval::<i64>("foo(bar())")?, 42); /// # Ok(()) /// # } /// ``` #[proc_macro_attribute] pub fn export_module( args: proc_macro::TokenStream, input: proc_macro::TokenStream, ) -> proc_macro::TokenStream { let parsed_params = match crate::attrs::outer_item_attributes(args.into(), "export_module") { Ok(args) => args, Err(err) => return proc_macro::TokenStream::from(err.to_compile_error()), }; let mut module_def = parse_macro_input!(input as module::Module); if let Err(e) = module_def.set_params(parsed_params) { return e.to_compile_error().into(); } let tokens = module_def.generate(); proc_macro::TokenStream::from(tokens) } /// Macro to generate a Rhai `Module` from a _plugin module_ defined via `#[export_module]`. /// /// # Usage /// /// ``` /// # use rhai::{Engine, Module, EvalAltResult}; /// use rhai::plugin::*; /// /// #[export_module] /// mod my_plugin_module { /// pub fn foo(x: i64) -> i64 { x * 2 } /// pub fn bar() -> i64 { 21 } /// } /// /// # fn main() -> Result<(), Box<EvalAltResult>> { /// let mut engine = Engine::new(); /// /// let module = exported_module!(my_plugin_module); /// /// engine.load_package(module); /// /// assert_eq!(engine.eval::<i64>("foo(bar())")?, 42); /// # Ok(()) /// # } /// ``` #[proc_macro] pub fn exported_module(module_path: proc_macro::TokenStream) -> proc_macro::TokenStream { let module_path = parse_macro_input!(module_path as syn::Path); let tokens = quote::quote! { #module_path::rhai_module_generate() }; proc_macro::TokenStream::from(tokens) } /// Macro to combine a _plugin module_ into an existing module. /// /// Functions and variables in the plugin module overrides any existing similarly-named /// functions and variables in the target module. /// /// This call is intended to be used within the `def_package!` macro to define a custom /// package based on a plugin module. /// /// All sub-modules, if any, in the plugin module are _flattened_ and their functions/variables /// registered at the top level because packages require so. /// /// The text string name in the second parameter can be anything and is reserved for future use; /// it is recommended to be an ID string that uniquely identifies the plugin module. /// /// # Usage /// /// ``` /// # use rhai::{Engine, Module, EvalAltResult}; /// use rhai::plugin::*; /// /// #[export_module] /// mod my_plugin_module { /// pub fn foo(x: i64) -> i64 { x * 2 } /// pub fn bar() -> i64 { 21 } /// } /// /// # fn main() -> Result<(), Box<EvalAltResult>> { /// let mut engine = Engine::new(); /// /// let mut module = Module::new(); /// combine_with_exported_module!(&mut module, "my_plugin_module_ID", my_plugin_module); /// /// engine.load_package(module); /// /// assert_eq!(engine.eval::<i64>("foo(bar())")?, 42); /// # Ok(()) /// # } /// ``` #[proc_macro] pub fn combine_with_exported_module(args: proc_macro::TokenStream) -> proc_macro::TokenStream { let (module_expr, _export_name, module_path) = match crate::register::parse_register_macro(args) { Ok(triple) => triple, Err(e) => return e.to_compile_error().into(), }; let tokens = quote! { #module_path::rhai_generate_into_module(#module_expr, true); }; proc_macro::TokenStream::from(tokens) } /// Macro to register a _plugin function_ (defined via `#[export_fn]`) into an `Engine`. /// /// # Usage /// /// ``` /// # use rhai::{Engine, EvalAltResult}; /// use rhai::plugin::*; /// /// #[export_fn] /// fn my_plugin_function(x: i64) -> i64 { /// x * 2 /// } /// /// # fn main() -> Result<(), Box<EvalAltResult>> { /// let mut engine = Engine::new(); /// /// register_exported_fn!(engine, "func", my_plugin_function); /// /// assert_eq!(engine.eval::<i64>("func(21)")?, 42); /// # Ok(()) /// # } /// ``` #[proc_macro] pub fn register_exported_fn(args: proc_macro::TokenStream) -> proc_macro::TokenStream { let (engine_expr, export_name, rust_modpath) = match crate::register::parse_register_macro(args) { Ok(triple) => triple, Err(e) => return e.to_compile_error().into(), }; let gen_mod_path = crate::register::generated_module_path(&rust_modpath); let tokens = quote! { #engine_expr.register_result_fn(&(#export_name), #gen_mod_path::dynamic_result_fn); }; proc_macro::TokenStream::from(tokens) } /// Macro to register a _plugin function_ into a Rhai `Module`. /// /// # Usage /// /// ``` /// # use rhai::{Engine, EvalAltResult}; /// use rhai::plugin::*; /// /// #[export_fn] /// fn my_plugin_function(x: i64) -> i64 { /// x * 2 /// } /// /// # fn main() -> Result<(), Box<EvalAltResult>> { /// let mut engine = Engine::new(); /// /// let mut module = Module::new(); /// set_exported_fn!(module, "func", my_plugin_function); /// /// engine.load_package(module); /// /// assert_eq!(engine.eval::<i64>("func(21)")?, 42); /// # Ok(()) /// # } /// ``` #[proc_macro] pub fn set_exported_fn(args: proc_macro::TokenStream) -> proc_macro::TokenStream { let (module_expr, export_name, rust_modpath) = match crate::register::parse_register_macro(args) { Ok(triple) => triple, Err(e) => return e.to_compile_error().into(), }; let gen_mod_path = crate::register::generated_module_path(&rust_modpath); let tokens = quote! { #module_expr.set_fn(#export_name, FnAccess::Public, #gen_mod_path::token_input_types().as_ref(), #gen_mod_path::token_callable()); }; proc_macro::TokenStream::from(tokens) }