102 lines
2.8 KiB
Rust
102 lines
2.8 KiB
Rust
//! Helper module which defines [`FuncArgs`] to make function calling easier.
|
|
|
|
#![allow(non_snake_case)]
|
|
|
|
use crate::types::dynamic::Variant;
|
|
use crate::Dynamic;
|
|
#[cfg(feature = "no_std")]
|
|
use std::prelude::v1::*;
|
|
|
|
/// Trait that parses arguments to a function call.
|
|
///
|
|
/// Any data type can implement this trait in order to pass arguments to
|
|
/// [`Engine::call_fn`][crate::Engine::call_fn].
|
|
pub trait FuncArgs {
|
|
/// Parse function call arguments into a container.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```
|
|
/// use rhai::{Engine, Dynamic, FuncArgs, Scope};
|
|
///
|
|
/// // A struct containing function arguments
|
|
/// struct Options {
|
|
/// pub foo: bool,
|
|
/// pub bar: String,
|
|
/// pub baz: i64,
|
|
/// }
|
|
///
|
|
/// impl FuncArgs for Options {
|
|
/// fn parse<ARGS: Extend<Dynamic>>(self, args: &mut ARGS) {
|
|
/// args.extend(Some(self.foo.into()));
|
|
/// args.extend(Some(self.bar.into()));
|
|
/// args.extend(Some(self.baz.into()));
|
|
/// }
|
|
/// }
|
|
///
|
|
/// # fn main() -> Result<(), Box<rhai::EvalAltResult>> {
|
|
/// # #[cfg(not(feature = "no_function"))]
|
|
/// # {
|
|
/// let options = Options { foo: false, bar: "world".to_string(), baz: 42 };
|
|
///
|
|
/// let engine = Engine::new();
|
|
/// let mut scope = Scope::new();
|
|
///
|
|
/// let ast = engine.compile(
|
|
/// "
|
|
/// fn hello(x, y, z) {
|
|
/// if x { `hello ${y}` } else { y + z }
|
|
/// }
|
|
/// ")?;
|
|
///
|
|
/// let result: String = engine.call_fn(&mut scope, &ast, "hello", options)?;
|
|
///
|
|
/// assert_eq!(result, "world42");
|
|
/// # }
|
|
/// # Ok(())
|
|
/// # }
|
|
/// ```
|
|
fn parse<ARGS: Extend<Dynamic>>(self, args: &mut ARGS);
|
|
}
|
|
|
|
impl<T: Variant + Clone> FuncArgs for Vec<T> {
|
|
#[inline]
|
|
fn parse<ARGS: Extend<Dynamic>>(self, args: &mut ARGS) {
|
|
args.extend(self.into_iter().map(Dynamic::from));
|
|
}
|
|
}
|
|
|
|
impl<T: Variant + Clone, const N: usize> FuncArgs for [T; N] {
|
|
#[inline]
|
|
fn parse<ARGS: Extend<Dynamic>>(self, args: &mut ARGS) {
|
|
args.extend(IntoIterator::into_iter(self).map(Dynamic::from));
|
|
}
|
|
}
|
|
|
|
/// Macro to implement [`FuncArgs`] for tuples of standard types (each can be converted into a [`Dynamic`]).
|
|
macro_rules! impl_args {
|
|
($($p:ident),*) => {
|
|
impl<$($p: Variant + Clone),*> FuncArgs for ($($p,)*)
|
|
{
|
|
#[inline]
|
|
#[allow(unused_variables)]
|
|
fn parse<ARGS: Extend<Dynamic>>(self, args: &mut ARGS) {
|
|
let ($($p,)*) = self;
|
|
$(args.extend(Some(Dynamic::from($p)));)*
|
|
}
|
|
}
|
|
|
|
impl_args!(@pop $($p),*);
|
|
};
|
|
(@pop) => {
|
|
};
|
|
(@pop $head:ident) => {
|
|
impl_args!();
|
|
};
|
|
(@pop $head:ident $(, $tail:ident)+) => {
|
|
impl_args!($($tail),*);
|
|
};
|
|
}
|
|
|
|
impl_args!(A, B, C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V);
|