//! Main module defining the script evaluation `Engine`. use crate::any::{Dynamic, Union}; use crate::calc_fn_hash; use crate::error::ParseErrorType; use crate::module::ModuleRef; use crate::optimize::OptimizationLevel; use crate::packages::{ CorePackage, Package, PackageLibrary, PackageStore, PackagesCollection, StandardPackage, }; use crate::parser::{Expr, FnDef, ReturnType, Stmt, AST}; use crate::result::EvalAltResult; use crate::scope::{EntryType as ScopeEntryType, Scope}; use crate::token::Position; use crate::utils::{StaticVec, EMPTY_TYPE_ID}; #[cfg(not(feature = "no_module"))] use crate::module::{resolvers, Module, ModuleResolver}; use crate::stdlib::{ any::TypeId, boxed::Box, collections::HashMap, format, iter::{empty, once, repeat}, mem, num::NonZeroUsize, ops::{Deref, DerefMut}, rc::Rc, string::{String, ToString}, sync::Arc, vec::Vec, }; /// An dynamic array of `Dynamic` values. /// /// Not available under the `no_index` feature. #[cfg(not(feature = "no_index"))] pub type Array = Vec; /// An dynamic hash map of `Dynamic` values with `String` keys. /// /// Not available under the `no_object` feature. #[cfg(not(feature = "no_object"))] pub type Map = HashMap; pub type FnCallArgs<'a> = [&'a mut Dynamic]; #[cfg(feature = "sync")] pub type FnAny = dyn Fn(&mut FnCallArgs, Position) -> Result> + Send + Sync; #[cfg(not(feature = "sync"))] pub type FnAny = dyn Fn(&mut FnCallArgs, Position) -> Result>; #[cfg(feature = "sync")] pub type IteratorFn = dyn Fn(Dynamic) -> Box> + Send + Sync; #[cfg(not(feature = "sync"))] pub type IteratorFn = dyn Fn(Dynamic) -> Box>; #[cfg(debug_assertions)] pub const MAX_CALL_STACK_DEPTH: usize = 28; #[cfg(not(debug_assertions))] pub const MAX_CALL_STACK_DEPTH: usize = 256; pub const KEYWORD_PRINT: &str = "print"; pub const KEYWORD_DEBUG: &str = "debug"; pub const KEYWORD_TYPE_OF: &str = "type_of"; pub const KEYWORD_EVAL: &str = "eval"; pub const FUNC_TO_STRING: &str = "to_string"; pub const FUNC_GETTER: &str = "get$"; pub const FUNC_SETTER: &str = "set$"; pub const FUNC_INDEXER: &str = "$index$"; /// A type that encapsulates a mutation target for an expression with side effects. enum Target<'a> { /// The target is a mutable reference to a `Dynamic` value somewhere. Ref(&'a mut Dynamic), /// The target is a temporary `Dynamic` value (i.e. the mutation can cause no side effects). Value(Box), /// The target is a character inside a String. /// This is necessary because directly pointing to a char inside a String is impossible. StringChar(Box<(&'a mut Dynamic, usize, Dynamic)>), } impl Target<'_> { /// Get the value of the `Target` as a `Dynamic`. pub fn clone_into_dynamic(self) -> Dynamic { match self { Target::Ref(r) => r.clone(), Target::Value(v) => *v, Target::StringChar(s) => s.2, } } /// Update the value of the `Target`. pub fn set_value(&mut self, new_val: Dynamic, pos: Position) -> Result<(), Box> { match self { Target::Ref(r) => **r = new_val, Target::Value(_) => { return Err(Box::new(EvalAltResult::ErrorAssignmentToUnknownLHS(pos))) } Target::StringChar(x) => match x.0 { Dynamic(Union::Str(s)) => { // Replace the character at the specified index position let new_ch = new_val .as_char() .map_err(|_| EvalAltResult::ErrorCharMismatch(pos))?; let mut chars: Vec = s.chars().collect(); let ch = chars[x.1]; // See if changed - if so, update the String if ch != new_ch { chars[x.1] = new_ch; s.clear(); chars.iter().for_each(|&ch| s.push(ch)); } } _ => unreachable!(), }, } Ok(()) } } impl<'a> From<&'a mut Dynamic> for Target<'a> { fn from(value: &'a mut Dynamic) -> Self { Self::Ref(value) } } impl> From for Target<'_> { fn from(value: T) -> Self { Self::Value(Box::new(value.into())) } } /// A type that holds all the current states of the Engine. #[derive(Debug, Clone, Copy)] pub struct State<'a> { /// Global script-defined functions. pub fn_lib: &'a FunctionsLib, /// Normally, access to variables are parsed with a relative offset into the scope to avoid a lookup. /// In some situation, e.g. after running an `eval` statement, subsequent offsets may become mis-aligned. /// When that happens, this flag is turned on to force a scope lookup by name. pub always_search: bool, } impl<'a> State<'a> { /// Create a new `State`. pub fn new(fn_lib: &'a FunctionsLib) -> Self { Self { always_search: false, fn_lib, } } /// Does a certain script-defined function exist in the `State`? pub fn has_function(&self, name: &str, params: usize) -> bool { self.fn_lib.contains_key(&calc_fn_hash( empty(), name, repeat(EMPTY_TYPE_ID()).take(params), )) } /// Get a script-defined function definition from the `State`. pub fn get_function(&self, name: &str, params: usize) -> Option<&FnDef> { self.fn_lib .get(&calc_fn_hash( empty(), name, repeat(EMPTY_TYPE_ID()).take(params), )) .map(|f| f.as_ref()) } } /// An external native Rust function. #[cfg(not(feature = "sync"))] pub type NativeFunction = Rc>; /// An external native Rust function. #[cfg(feature = "sync")] pub type NativeFunction = Arc>; /// A sharable script-defined function. #[cfg(feature = "sync")] pub type ScriptedFunction = Arc; /// A sharable script-defined function. #[cfg(not(feature = "sync"))] pub type ScriptedFunction = Rc; /// A type that holds a library (`HashMap`) of script-defined functions. /// /// Since script-defined functions have `Dynamic` parameters, functions with the same name /// and number of parameters are considered equivalent. /// /// The key of the `HashMap` is a `u64` hash calculated by the function `calc_fn_hash` /// with dummy parameter types `EMPTY_TYPE_ID()` repeated the correct number of times. #[derive(Debug, Clone, Default)] pub struct FunctionsLib(HashMap); impl FunctionsLib { /// Create a new `FunctionsLib` from a collection of `FnDef`. pub fn from_vec(vec: Vec) -> Self { FunctionsLib( vec.into_iter() .map(|f| { let hash = calc_fn_hash( empty(), &f.name, repeat(EMPTY_TYPE_ID()).take(f.params.len()), ); #[cfg(feature = "sync")] { (hash, Arc::new(f)) } #[cfg(not(feature = "sync"))] { (hash, Rc::new(f)) } }) .collect(), ) } /// Does a certain function exist in the `FunctionsLib`? /// /// The `u64` hash is calculated by the function `crate::calc_fn_hash`. pub fn has_function(&self, hash: u64) -> bool { self.contains_key(&hash) } /// Get a function definition from the `FunctionsLib`. /// /// The `u64` hash is calculated by the function `crate::calc_fn_hash`. pub fn get_function(&self, hash: u64) -> Option<&FnDef> { self.get(&hash).map(|fn_def| fn_def.as_ref()) } /// Get a function definition from the `FunctionsLib`. pub fn get_function_by_signature(&self, name: &str, params: usize) -> Option<&FnDef> { let hash = calc_fn_hash(empty(), name, repeat(EMPTY_TYPE_ID()).take(params)); self.get_function(hash) } /// Merge another `FunctionsLib` into this `FunctionsLib`. pub fn merge(&self, other: &Self) -> Self { if self.is_empty() { other.clone() } else if other.is_empty() { self.clone() } else { let mut functions = self.clone(); functions.extend(other.iter().map(|(hash, fn_def)| (*hash, fn_def.clone()))); functions } } } impl From> for FunctionsLib { fn from(values: Vec<(u64, ScriptedFunction)>) -> Self { FunctionsLib(values.into_iter().collect()) } } impl Deref for FunctionsLib { #[cfg(feature = "sync")] type Target = HashMap>; #[cfg(not(feature = "sync"))] type Target = HashMap>; fn deref(&self) -> &Self::Target { &self.0 } } impl DerefMut for FunctionsLib { #[cfg(feature = "sync")] fn deref_mut(&mut self) -> &mut HashMap> { &mut self.0 } #[cfg(not(feature = "sync"))] fn deref_mut(&mut self) -> &mut HashMap> { &mut self.0 } } /// Rhai main scripting engine. /// /// ``` /// # fn main() -> Result<(), Box> { /// use rhai::Engine; /// /// let engine = Engine::new(); /// /// let result = engine.eval::("40 + 2")?; /// /// println!("Answer: {}", result); // prints 42 /// # Ok(()) /// # } /// ``` /// /// Currently, `Engine` is neither `Send` nor `Sync`. Turn on the `sync` feature to make it `Send + Sync`. pub struct Engine { /// A collection of all library packages loaded into the engine. pub(crate) packages: PackagesCollection, /// A collection of all library packages loaded into the engine. pub(crate) base_package: PackageStore, /// A module resolution service. #[cfg(not(feature = "no_module"))] pub(crate) module_resolver: Option>, /// A hashmap mapping type names to pretty-print names. pub(crate) type_names: HashMap, /// Closure for implementing the `print` command. #[cfg(feature = "sync")] pub(crate) print: Box, /// Closure for implementing the `print` command. #[cfg(not(feature = "sync"))] pub(crate) print: Box, /// Closure for implementing the `debug` command. #[cfg(feature = "sync")] pub(crate) debug: Box, /// Closure for implementing the `debug` command. #[cfg(not(feature = "sync"))] pub(crate) debug: Box, /// Optimize the AST after compilation. pub(crate) optimization_level: OptimizationLevel, /// Maximum levels of call-stack to prevent infinite recursion. /// /// Defaults to 28 for debug builds and 256 for non-debug builds. pub(crate) max_call_stack_depth: usize, } impl Default for Engine { fn default() -> Self { // Create the new scripting Engine let mut engine = Self { packages: Default::default(), base_package: Default::default(), #[cfg(not(feature = "no_module"))] #[cfg(not(feature = "no_std"))] module_resolver: Some(Box::new(resolvers::FileModuleResolver::new())), #[cfg(not(feature = "no_module"))] #[cfg(feature = "no_std")] module_resolver: None, type_names: Default::default(), // default print/debug implementations print: Box::new(default_print), debug: Box::new(default_print), // optimization level #[cfg(feature = "no_optimize")] optimization_level: OptimizationLevel::None, #[cfg(not(feature = "no_optimize"))] #[cfg(not(feature = "optimize_full"))] optimization_level: OptimizationLevel::Simple, #[cfg(not(feature = "no_optimize"))] #[cfg(feature = "optimize_full")] optimization_level: OptimizationLevel::Full, max_call_stack_depth: MAX_CALL_STACK_DEPTH, }; #[cfg(feature = "no_stdlib")] engine.load_package(CorePackage::new().get()); #[cfg(not(feature = "no_stdlib"))] engine.load_package(StandardPackage::new().get()); engine } } /// Make getter function pub fn make_getter(id: &str) -> String { format!("{}{}", FUNC_GETTER, id) } /// Extract the property name from a getter function name. fn extract_prop_from_getter(fn_name: &str) -> Option<&str> { #[cfg(not(feature = "no_object"))] { if fn_name.starts_with(FUNC_GETTER) { Some(&fn_name[FUNC_GETTER.len()..]) } else { None } } #[cfg(feature = "no_object")] { None } } /// Make setter function pub fn make_setter(id: &str) -> String { format!("{}{}", FUNC_SETTER, id) } /// Extract the property name from a setter function name. fn extract_prop_from_setter(fn_name: &str) -> Option<&str> { #[cfg(not(feature = "no_object"))] { if fn_name.starts_with(FUNC_SETTER) { Some(&fn_name[FUNC_SETTER.len()..]) } else { None } } #[cfg(feature = "no_object")] { None } } /// Print/debug to stdout fn default_print(s: &str) { #[cfg(not(feature = "no_std"))] println!("{}", s); } /// Search for a variable within the scope fn search_scope<'a>( scope: &'a mut Scope, name: &str, modules: &Option>, index: Option, pos: Position, ) -> Result<(&'a mut Dynamic, ScopeEntryType), Box> { #[cfg(not(feature = "no_module"))] { if let Some(modules) = modules { let (id, root_pos) = modules.get(0); let module = if let Some(index) = index { scope .get_mut(scope.len() - index.get()) .0 .downcast_mut::() .unwrap() } else { scope.find_module(id).ok_or_else(|| { Box::new(EvalAltResult::ErrorModuleNotFound( id.to_string(), *root_pos, )) })? }; return Ok(( module.get_qualified_var_mut(name, modules.key(), pos)?, // Module variables are constant ScopeEntryType::Constant, )); } } let index = if let Some(index) = index { scope.len() - index.get() } else { scope .get_index(name) .ok_or_else(|| Box::new(EvalAltResult::ErrorVariableNotFound(name.into(), pos)))? .0 }; Ok(scope.get_mut(index)) } impl Engine { /// Create a new `Engine` pub fn new() -> Self { Default::default() } /// Create a new `Engine` with _no_ built-in functions. /// Use the `load_package` method to load packages of functions. pub fn new_raw() -> Self { Self { packages: Default::default(), base_package: Default::default(), #[cfg(not(feature = "no_module"))] module_resolver: None, type_names: Default::default(), print: Box::new(|_| {}), debug: Box::new(|_| {}), #[cfg(feature = "no_optimize")] optimization_level: OptimizationLevel::None, #[cfg(not(feature = "no_optimize"))] #[cfg(not(feature = "optimize_full"))] optimization_level: OptimizationLevel::Simple, #[cfg(not(feature = "no_optimize"))] #[cfg(feature = "optimize_full")] optimization_level: OptimizationLevel::Full, max_call_stack_depth: MAX_CALL_STACK_DEPTH, } } /// Load a new package into the `Engine`. /// /// When searching for functions, packages loaded later are preferred. /// In other words, loaded packages are searched in reverse order. pub fn load_package(&mut self, package: PackageLibrary) { // Push the package to the top - packages are searched in reverse order self.packages.push(package); } /// Load a new package into the `Engine`. /// /// When searching for functions, packages loaded later are preferred. /// In other words, loaded packages are searched in reverse order. pub fn load_packages(&mut self, package: PackageLibrary) { // Push the package to the top - packages are searched in reverse order self.packages.push(package); } /// Control whether and how the `Engine` will optimize an AST after compilation. /// /// Not available under the `no_optimize` feature. #[cfg(not(feature = "no_optimize"))] pub fn set_optimization_level(&mut self, optimization_level: OptimizationLevel) { self.optimization_level = optimization_level } /// Set the maximum levels of function calls allowed for a script in order to avoid /// infinite recursion and stack overflows. pub fn set_max_call_levels(&mut self, levels: usize) { self.max_call_stack_depth = levels } /// Set the module resolution service used by the `Engine`. /// /// Not available under the `no_module` feature. #[cfg(not(feature = "no_module"))] pub fn set_module_resolver(&mut self, resolver: Option) { self.module_resolver = resolver.map(|f| Box::new(f) as Box); } /// Universal method for calling functions either registered with the `Engine` or written in Rhai. /// /// ## WARNING /// /// Function call arguments may be _consumed_ when the function requires them to be passed by value. /// All function arguments not in the first position are always passed by value and thus consumed. /// **DO NOT** reuse the argument values unless for the first `&mut` argument - all others are silently replaced by `()`! pub(crate) fn call_fn_raw( &self, scope: Option<&mut Scope>, state: &State, fn_name: &str, args: &mut FnCallArgs, def_val: Option<&Dynamic>, pos: Position, level: usize, ) -> Result> { // Check for stack overflow if level > self.max_call_stack_depth { return Err(Box::new(EvalAltResult::ErrorStackOverflow(pos))); } // First search in script-defined functions (can override built-in) if let Some(fn_def) = state.get_function(fn_name, args.len()) { return self.call_script_fn(scope, state, fn_def, args, pos, level); } // Search built-in's and external functions let fn_spec = calc_fn_hash(empty(), fn_name, args.iter().map(|a| a.type_id())); if let Some(func) = self .base_package .get_function(fn_spec) .or_else(|| self.packages.get_function(fn_spec)) { // Run external function let result = func(args, pos)?; // See if the function match print/debug (which requires special processing) return Ok(match fn_name { KEYWORD_PRINT => (self.print)(result.as_str().map_err(|type_name| { Box::new(EvalAltResult::ErrorMismatchOutputType( type_name.into(), pos, )) })?) .into(), KEYWORD_DEBUG => (self.debug)(result.as_str().map_err(|type_name| { Box::new(EvalAltResult::ErrorMismatchOutputType( type_name.into(), pos, )) })?) .into(), _ => result, }); } // Return default value (if any) if let Some(val) = def_val { return Ok(val.clone()); } // Getter function not found? if let Some(prop) = extract_prop_from_getter(fn_name) { return Err(Box::new(EvalAltResult::ErrorDotExpr( format!("- property '{}' unknown or write-only", prop), pos, ))); } // Setter function not found? if let Some(prop) = extract_prop_from_setter(fn_name) { return Err(Box::new(EvalAltResult::ErrorDotExpr( format!("- property '{}' unknown or read-only", prop), pos, ))); } let types_list: Vec<_> = args .iter() .map(|name| self.map_type_name(name.type_name())) .collect(); // Getter function not found? if fn_name == FUNC_INDEXER { return Err(Box::new(EvalAltResult::ErrorFunctionNotFound( format!("[]({})", types_list.join(", ")), pos, ))); } // Raise error Err(Box::new(EvalAltResult::ErrorFunctionNotFound( format!("{} ({})", fn_name, types_list.join(", ")), pos, ))) } /// Call a script-defined function. /// /// ## WARNING /// /// Function call arguments may be _consumed_ when the function requires them to be passed by value. /// All function arguments not in the first position are always passed by value and thus consumed. /// **DO NOT** reuse the argument values unless for the first `&mut` argument - all others are silently replaced by `()`! pub(crate) fn call_script_fn( &self, scope: Option<&mut Scope>, state: &State, fn_def: &FnDef, args: &mut FnCallArgs, pos: Position, level: usize, ) -> Result> { match scope { // Extern scope passed in which is not empty Some(scope) if scope.len() > 0 => { let scope_len = scope.len(); let mut state = State::new(state.fn_lib); // Put arguments into scope as variables - variable name is copied scope.extend( fn_def .params .iter() .zip( // Actually consume the arguments instead of cloning them args.into_iter().map(|v| mem::take(*v)), ) .map(|(name, value)| (name.clone(), ScopeEntryType::Normal, value)), ); // Evaluate the function at one higher level of call depth let result = self .eval_stmt(scope, &mut state, &fn_def.body, level + 1) .or_else(|err| match *err { // Convert return statement to return value EvalAltResult::Return(x, _) => Ok(x), _ => Err(EvalAltResult::set_position(err, pos)), }); scope.rewind(scope_len); return result; } // No new scope - create internal scope _ => { let mut scope = Scope::new(); let mut state = State::new(state.fn_lib); // Put arguments into scope as variables scope.extend( fn_def .params .iter() .zip( // Actually consume the arguments instead of cloning them args.into_iter().map(|v| mem::take(*v)), ) .map(|(name, value)| (name, ScopeEntryType::Normal, value)), ); // Evaluate the function at one higher level of call depth return self .eval_stmt(&mut scope, &mut state, &fn_def.body, level + 1) .or_else(|err| match *err { // Convert return statement to return value EvalAltResult::Return(x, _) => Ok(x), _ => Err(EvalAltResult::set_position(err, pos)), }); } } } // Has a system function an override? fn has_override(&self, state: &State, name: &str) -> bool { let hash = calc_fn_hash(empty(), name, once(TypeId::of::())); // First check registered functions self.base_package.contains_function(hash) // Then check packages || self.packages.contains_function(hash) // Then check script-defined functions || state.has_function(name, 1) } // Perform an actual function call, taking care of special functions /// /// ## WARNING /// /// Function call arguments may be _consumed_ when the function requires them to be passed by value. /// All function arguments not in the first position are always passed by value and thus consumed. /// **DO NOT** reuse the argument values unless for the first `&mut` argument - all others are silently replaced by `()`! fn exec_fn_call( &self, state: &State, fn_name: &str, args: &mut FnCallArgs, def_val: Option<&Dynamic>, pos: Position, level: usize, ) -> Result> { match fn_name { // type_of KEYWORD_TYPE_OF if args.len() == 1 && !self.has_override(state, KEYWORD_TYPE_OF) => { Ok(self.map_type_name(args[0].type_name()).to_string().into()) } // eval - reaching this point it must be a method-style call KEYWORD_EVAL if args.len() == 1 && !self.has_override(state, KEYWORD_EVAL) => { Err(Box::new(EvalAltResult::ErrorRuntime( "'eval' should not be called in method style. Try eval(...);".into(), pos, ))) } // Normal method call _ => self.call_fn_raw(None, state, fn_name, args, def_val, pos, level), } } /// Evaluate a text string as a script - used primarily for 'eval'. fn eval_script_expr( &self, scope: &mut Scope, state: &State, script: &Dynamic, pos: Position, ) -> Result> { let script = script .as_str() .map_err(|type_name| EvalAltResult::ErrorMismatchOutputType(type_name.into(), pos))?; // Compile the script text // No optimizations because we only run it once let mut ast = self.compile_with_scope_and_optimization_level( &Scope::new(), script, OptimizationLevel::None, )?; // If new functions are defined within the eval string, it is an error if ast.fn_lib().len() > 0 { return Err(Box::new(EvalAltResult::ErrorParsing( ParseErrorType::WrongFnDefinition.into_err(pos), ))); } let statements = mem::take(ast.statements_mut()); let ast = AST::new(statements, state.fn_lib.clone()); // Evaluate the AST self.eval_ast_with_scope_raw(scope, &ast) .map_err(|err| EvalAltResult::set_position(err, pos)) } /// Chain-evaluate a dot/index chain. fn eval_dot_index_chain_helper( &self, state: &State, mut target: Target, rhs: &Expr, idx_values: &mut StaticVec, is_index: bool, op_pos: Position, level: usize, mut new_val: Option, ) -> Result<(Dynamic, bool), Box> { // Get a reference to the mutation target Dynamic let obj = match target { Target::Ref(r) => r, Target::Value(ref mut r) => r.as_mut(), Target::StringChar(ref mut x) => &mut x.2, }; // Pop the last index value let mut idx_val = idx_values.pop(); if is_index { match rhs { // xxx[idx].dot_rhs... Expr::Dot(idx, idx_rhs, pos) | // xxx[idx][dot_rhs]... Expr::Index(idx, idx_rhs, pos) => { let is_index = matches!(rhs, Expr::Index(_,_,_)); let indexed_val = self.get_indexed_mut(state, obj, idx_val, idx.position(), op_pos, false)?; self.eval_dot_index_chain_helper( state, indexed_val, idx_rhs.as_ref(), idx_values, is_index, *pos, level, new_val ) } // xxx[rhs] = new_val _ if new_val.is_some() => { let mut indexed_val = self.get_indexed_mut(state, obj, idx_val, rhs.position(), op_pos, true)?; indexed_val.set_value(new_val.unwrap(), rhs.position())?; Ok((Default::default(), true)) } // xxx[rhs] _ => self .get_indexed_mut(state, obj, idx_val, rhs.position(), op_pos, false) .map(|v| (v.clone_into_dynamic(), false)) } } else { match rhs { // xxx.fn_name(arg_expr_list) Expr::FnCall(fn_name, None,_, def_val, pos) => { let mut args: Vec<_> = once(obj) .chain(idx_val.downcast_mut::>().unwrap().iter_mut()) .collect(); let def_val = def_val.as_deref(); // A function call is assumed to have side effects, so the value is changed // TODO - Remove assumption of side effects by checking whether the first parameter is &mut self.exec_fn_call(state, fn_name, &mut args, def_val, *pos, 0).map(|v| (v, true)) } // xxx.module::fn_name(...) - syntax error Expr::FnCall(_,_,_,_,_) => unreachable!(), // {xxx:map}.id = ??? #[cfg(not(feature = "no_object"))] Expr::Property(id, pos) if obj.is::() && new_val.is_some() => { let mut indexed_val = self.get_indexed_mut(state, obj, id.to_string().into(), *pos, op_pos, true)?; indexed_val.set_value(new_val.unwrap(), rhs.position())?; Ok((Default::default(), true)) } // {xxx:map}.id #[cfg(not(feature = "no_object"))] Expr::Property(id, pos) if obj.is::() => { let indexed_val = self.get_indexed_mut(state, obj, id.to_string().into(), *pos, op_pos, false)?; Ok((indexed_val.clone_into_dynamic(), false)) } // xxx.id = ??? a Expr::Property(id, pos) if new_val.is_some() => { let fn_name = make_setter(id); let mut args = [obj, new_val.as_mut().unwrap()]; self.exec_fn_call(state, &fn_name, &mut args, None, *pos, 0).map(|v| (v, true)) } // xxx.id Expr::Property(id, pos) => { let fn_name = make_getter(id); let mut args = [obj]; self.exec_fn_call(state, &fn_name, &mut args, None, *pos, 0).map(|v| (v, false)) } #[cfg(not(feature = "no_object"))] // {xxx:map}.idx_lhs[idx_expr] Expr::Index(dot_lhs, dot_rhs, pos) | // {xxx:map}.dot_lhs.rhs Expr::Dot(dot_lhs, dot_rhs, pos) if obj.is::() => { let is_index = matches!(rhs, Expr::Index(_,_,_)); let indexed_val = if let Expr::Property(id, pos) = dot_lhs.as_ref() { self.get_indexed_mut(state, obj, id.to_string().into(), *pos, op_pos, false)? } else { // Syntax error return Err(Box::new(EvalAltResult::ErrorDotExpr( "".to_string(), rhs.position(), ))); }; self.eval_dot_index_chain_helper( state, indexed_val, dot_rhs, idx_values, is_index, *pos, level, new_val ) } // xxx.idx_lhs[idx_expr] Expr::Index(dot_lhs, dot_rhs, pos) | // xxx.dot_lhs.rhs Expr::Dot(dot_lhs, dot_rhs, pos) => { let is_index = matches!(rhs, Expr::Index(_,_,_)); let mut args = [obj, &mut Default::default()]; let indexed_val = &mut (if let Expr::Property(id, pos) = dot_lhs.as_ref() { let fn_name = make_getter(id); self.exec_fn_call(state, &fn_name, &mut args[..1], None, *pos, 0)? } else { // Syntax error return Err(Box::new(EvalAltResult::ErrorDotExpr( "".to_string(), rhs.position(), ))); }); let (result, may_be_changed) = self.eval_dot_index_chain_helper( state, indexed_val.into(), dot_rhs, idx_values, is_index, *pos, level, new_val )?; // Feed the value back via a setter just in case it has been updated if may_be_changed { if let Expr::Property(id, pos) = dot_lhs.as_ref() { let fn_name = make_setter(id); // Re-use args because the first &mut parameter will not be consumed args[1] = indexed_val; self.exec_fn_call(state, &fn_name, &mut args, None, *pos, 0).or_else(|err| match *err { // If there is no setter, no need to feed it back because the property is read-only EvalAltResult::ErrorDotExpr(_,_) => Ok(Default::default()), err => Err(Box::new(err)) })?; } } Ok((result, may_be_changed)) } // Syntax error _ => Err(Box::new(EvalAltResult::ErrorDotExpr( "".to_string(), rhs.position(), ))), } } } /// Evaluate a dot/index chain. fn eval_dot_index_chain( &self, scope: &mut Scope, state: &mut State, dot_lhs: &Expr, dot_rhs: &Expr, is_index: bool, op_pos: Position, level: usize, new_val: Option, ) -> Result> { let idx_values = &mut StaticVec::new(); self.eval_indexed_chain(scope, state, dot_rhs, idx_values, 0, level)?; match dot_lhs { // id.??? or id[???] Expr::Variable(id, modules, index, pos) => { let index = if state.always_search { None } else { *index }; let (target, typ) = search_scope(scope, id, modules, index, *pos)?; // Constants cannot be modified match typ { ScopeEntryType::Module => unreachable!(), ScopeEntryType::Constant if new_val.is_some() => { return Err(Box::new(EvalAltResult::ErrorAssignmentToConstant( id.to_string(), *pos, ))); } ScopeEntryType::Constant | ScopeEntryType::Normal => (), } let this_ptr = target.into(); self.eval_dot_index_chain_helper( state, this_ptr, dot_rhs, idx_values, is_index, op_pos, level, new_val, ) .map(|(v, _)| v) } // {expr}.??? = ??? or {expr}[???] = ??? expr if new_val.is_some() => { return Err(Box::new(EvalAltResult::ErrorAssignmentToUnknownLHS( expr.position(), ))); } // {expr}.??? or {expr}[???] expr => { let val = self.eval_expr(scope, state, expr, level)?; let this_ptr = val.into(); self.eval_dot_index_chain_helper( state, this_ptr, dot_rhs, idx_values, is_index, op_pos, level, new_val, ) .map(|(v, _)| v) } } } /// Evaluate a chain of indexes and store the results in a list. /// The first few results are stored in the array `list` which is of fixed length. /// Any spill-overs are stored in `more`, which is dynamic. /// The fixed length array is used to avoid an allocation in the overwhelming cases of just a few levels of indexing. /// The total number of values is returned. fn eval_indexed_chain( &self, scope: &mut Scope, state: &mut State, expr: &Expr, idx_values: &mut StaticVec, size: usize, level: usize, ) -> Result<(), Box> { match expr { Expr::FnCall(_, None, arg_exprs, _, _) => { let mut arg_values = StaticVec::::new(); for arg_expr in arg_exprs.iter() { arg_values.push(self.eval_expr(scope, state, arg_expr, level)?); } idx_values.push(Dynamic::from(arg_values)); } Expr::FnCall(_, _, _, _, _) => unreachable!(), Expr::Property(_, _) => idx_values.push(()), // Store a placeholder - no need to copy the property name Expr::Index(lhs, rhs, _) | Expr::Dot(lhs, rhs, _) => { // Evaluate in left-to-right order let lhs_val = match lhs.as_ref() { Expr::Property(_, _) => Default::default(), // Store a placeholder in case of a property _ => self.eval_expr(scope, state, lhs, level)?, }; // Push in reverse order self.eval_indexed_chain(scope, state, rhs, idx_values, size, level)?; idx_values.push(lhs_val); } _ => idx_values.push(self.eval_expr(scope, state, expr, level)?), } Ok(()) } /// Get the value at the indexed position of a base type fn get_indexed_mut<'a>( &self, state: &State, val: &'a mut Dynamic, mut idx: Dynamic, idx_pos: Position, op_pos: Position, create: bool, ) -> Result, Box> { let type_name = self.map_type_name(val.type_name()); match val { #[cfg(not(feature = "no_index"))] Dynamic(Union::Array(arr)) => { // val_array[idx] let index = idx .as_int() .map_err(|_| EvalAltResult::ErrorNumericIndexExpr(idx_pos))?; let arr_len = arr.len(); if index >= 0 { arr.get_mut(index as usize) .map(Target::from) .ok_or_else(|| { Box::new(EvalAltResult::ErrorArrayBounds(arr_len, index, idx_pos)) }) } else { Err(Box::new(EvalAltResult::ErrorArrayBounds( arr_len, index, idx_pos, ))) } } #[cfg(not(feature = "no_object"))] Dynamic(Union::Map(map)) => { // val_map[idx] let index = idx .take_string() .map_err(|_| EvalAltResult::ErrorStringIndexExpr(idx_pos))?; Ok(if create { map.entry(index).or_insert(Default::default()).into() } else { map.get_mut(&index) .map(Target::from) .unwrap_or_else(|| Target::from(())) }) } #[cfg(not(feature = "no_index"))] Dynamic(Union::Str(s)) => { // val_string[idx] let index = idx .as_int() .map_err(|_| EvalAltResult::ErrorNumericIndexExpr(idx_pos))?; if index >= 0 { let ch = s.chars().nth(index as usize).ok_or_else(|| { Box::new(EvalAltResult::ErrorStringBounds( s.chars().count(), index, idx_pos, )) })?; Ok(Target::StringChar(Box::new(( val, index as usize, ch.into(), )))) } else { Err(Box::new(EvalAltResult::ErrorStringBounds( s.chars().count(), index, idx_pos, ))) } } _ => { let args = &mut [val, &mut idx]; self.exec_fn_call(state, FUNC_INDEXER, args, None, op_pos, 0) .map(|v| v.into()) .map_err(|_| { Box::new(EvalAltResult::ErrorIndexingType( // Error - cannot be indexed type_name.to_string(), op_pos, )) }) } } } // Evaluate an 'in' expression fn eval_in_expr( &self, scope: &mut Scope, state: &mut State, lhs: &Expr, rhs: &Expr, level: usize, ) -> Result> { let lhs_value = self.eval_expr(scope, state, lhs, level)?; let rhs_value = self.eval_expr(scope, state, rhs, level)?; match rhs_value { #[cfg(not(feature = "no_index"))] Dynamic(Union::Array(rhs_value)) => { let def_value = false.into(); // Call the `==` operator to compare each value for value in rhs_value.iter() { // WARNING - Always clone the values here because they'll be consumed by the function call. // Do not pass the `&mut` straight through because the `==` implementation // very likely takes parameters passed by value! let args = &mut [&mut lhs_value.clone(), &mut value.clone()]; let def_value = Some(&def_value); let pos = rhs.position(); if self .call_fn_raw(None, state, "==", args, def_value, pos, level)? .as_bool() .unwrap_or(false) { return Ok(true.into()); } } Ok(false.into()) } #[cfg(not(feature = "no_object"))] Dynamic(Union::Map(rhs_value)) => match lhs_value { // Only allows String or char Dynamic(Union::Str(s)) => Ok(rhs_value.contains_key(s.as_ref()).into()), Dynamic(Union::Char(c)) => Ok(rhs_value.contains_key(&c.to_string()).into()), _ => Err(Box::new(EvalAltResult::ErrorInExpr(lhs.position()))), }, Dynamic(Union::Str(rhs_value)) => match lhs_value { // Only allows String or char Dynamic(Union::Str(s)) => Ok(rhs_value.contains(s.as_ref()).into()), Dynamic(Union::Char(c)) => Ok(rhs_value.contains(c).into()), _ => Err(Box::new(EvalAltResult::ErrorInExpr(lhs.position()))), }, _ => Err(Box::new(EvalAltResult::ErrorInExpr(rhs.position()))), } } /// Evaluate an expression fn eval_expr( &self, scope: &mut Scope, state: &mut State, expr: &Expr, level: usize, ) -> Result> { match expr { Expr::IntegerConstant(i, _) => Ok((*i).into()), #[cfg(not(feature = "no_float"))] Expr::FloatConstant(f, _) => Ok((*f).into()), Expr::StringConstant(s, _) => Ok(s.to_string().into()), Expr::CharConstant(c, _) => Ok((*c).into()), Expr::Variable(id, modules, index, pos) => { let index = if state.always_search { None } else { *index }; let (val, _) = search_scope(scope, id, modules, index, *pos)?; Ok(val.clone()) } Expr::Property(_, _) => unreachable!(), // Statement block Expr::Stmt(stmt, _) => self.eval_stmt(scope, state, stmt, level), // lhs = rhs Expr::Assignment(lhs, rhs, op_pos) => { let rhs_val = self.eval_expr(scope, state, rhs, level)?; match lhs.as_ref() { // name = rhs Expr::Variable(id, modules, index, pos) => { let index = if state.always_search { None } else { *index }; let (value_ptr, typ) = search_scope(scope, id, modules, index, *pos)?; match typ { ScopeEntryType::Constant => Err(Box::new( EvalAltResult::ErrorAssignmentToConstant(id.to_string(), *pos), )), ScopeEntryType::Normal => { *value_ptr = rhs_val; Ok(Default::default()) } // End variable cannot be a module ScopeEntryType::Module => unreachable!(), } } // idx_lhs[idx_expr] = rhs #[cfg(not(feature = "no_index"))] Expr::Index(idx_lhs, idx_expr, op_pos) => { let new_val = Some(rhs_val); self.eval_dot_index_chain( scope, state, idx_lhs, idx_expr, true, *op_pos, level, new_val, ) } // dot_lhs.dot_rhs = rhs #[cfg(not(feature = "no_object"))] Expr::Dot(dot_lhs, dot_rhs, _) => { let new_val = Some(rhs_val); self.eval_dot_index_chain( scope, state, dot_lhs, dot_rhs, false, *op_pos, level, new_val, ) } // Error assignment to constant expr if expr.is_constant() => { Err(Box::new(EvalAltResult::ErrorAssignmentToConstant( expr.get_constant_str(), lhs.position(), ))) } // Syntax error _ => Err(Box::new(EvalAltResult::ErrorAssignmentToUnknownLHS( lhs.position(), ))), } } // lhs[idx_expr] #[cfg(not(feature = "no_index"))] Expr::Index(lhs, idx_expr, op_pos) => { self.eval_dot_index_chain(scope, state, lhs, idx_expr, true, *op_pos, level, None) } // lhs.dot_rhs #[cfg(not(feature = "no_object"))] Expr::Dot(lhs, dot_rhs, op_pos) => { self.eval_dot_index_chain(scope, state, lhs, dot_rhs, false, *op_pos, level, None) } #[cfg(not(feature = "no_index"))] Expr::Array(contents, _) => Ok(Dynamic(Union::Array(Box::new( contents .iter() .map(|item| self.eval_expr(scope, state, item, level)) .collect::, _>>()?, )))), #[cfg(not(feature = "no_object"))] Expr::Map(contents, _) => Ok(Dynamic(Union::Map(Box::new( contents .iter() .map(|(key, expr, _)| { self.eval_expr(scope, state, expr, level) .map(|val| (key.clone(), val)) }) .collect::, _>>()?, )))), // Normal function call Expr::FnCall(fn_name, None, arg_exprs, def_val, pos) => { let mut arg_values = arg_exprs .iter() .map(|expr| self.eval_expr(scope, state, expr, level)) .collect::, _>>()?; let mut args: Vec<_> = arg_values.iter_mut().collect(); if fn_name.as_ref() == KEYWORD_EVAL && args.len() == 1 && !self.has_override(state, KEYWORD_EVAL) { // eval - only in function call style let prev_len = scope.len(); // Evaluate the text string as a script let result = self.eval_script_expr(scope, state, args[0], arg_exprs[0].position()); if scope.len() != prev_len { // IMPORTANT! If the eval defines new variables in the current scope, // all variable offsets from this point on will be mis-aligned. state.always_search = true; } result } else { // Normal function call - except for eval (handled above) let def_value = def_val.as_deref(); self.exec_fn_call(state, fn_name, &mut args, def_value, *pos, level) } } // Module-qualified function call #[cfg(not(feature = "no_module"))] Expr::FnCall(fn_name, Some(modules), arg_exprs, def_val, pos) => { let modules = modules.as_ref(); let mut arg_values = arg_exprs .iter() .map(|expr| self.eval_expr(scope, state, expr, level)) .collect::, _>>()?; let mut args: Vec<_> = arg_values.iter_mut().collect(); let (id, root_pos) = modules.get(0); // First module let module = scope.find_module(id).ok_or_else(|| { Box::new(EvalAltResult::ErrorModuleNotFound(id.into(), *root_pos)) })?; // First search in script-defined functions (can override built-in) if let Some(fn_def) = module.get_qualified_scripted_fn(modules.key()) { self.call_script_fn(None, state, fn_def, &mut args, *pos, level) } else { // Then search in Rust functions let hash1 = modules.key(); let hash2 = calc_fn_hash(empty(), "", args.iter().map(|a| a.type_id())); match module.get_qualified_fn(fn_name, hash1 ^ hash2, *pos) { Ok(func) => func(&mut args, *pos), Err(_) if def_val.is_some() => Ok(def_val.as_deref().unwrap().clone()), Err(err) => Err(err), } } } Expr::In(lhs, rhs, _) => { self.eval_in_expr(scope, state, lhs.as_ref(), rhs.as_ref(), level) } Expr::And(lhs, rhs, _) => Ok((self .eval_expr(scope, state, lhs.as_ref(), level)? .as_bool() .map_err(|_| { EvalAltResult::ErrorBooleanArgMismatch("AND".into(), lhs.position()) })? && // Short-circuit using && self .eval_expr(scope, state, rhs.as_ref(), level)? .as_bool() .map_err(|_| { EvalAltResult::ErrorBooleanArgMismatch("AND".into(), rhs.position()) })?) .into()), Expr::Or(lhs, rhs, _) => Ok((self .eval_expr(scope, state, lhs.as_ref(), level)? .as_bool() .map_err(|_| { EvalAltResult::ErrorBooleanArgMismatch("OR".into(), lhs.position()) })? || // Short-circuit using || self .eval_expr(scope, state, rhs.as_ref(), level)? .as_bool() .map_err(|_| { EvalAltResult::ErrorBooleanArgMismatch("OR".into(), rhs.position()) })?) .into()), Expr::True(_) => Ok(true.into()), Expr::False(_) => Ok(false.into()), Expr::Unit(_) => Ok(().into()), _ => unreachable!(), } } /// Evaluate a statement pub(crate) fn eval_stmt( &self, scope: &mut Scope, state: &mut State, stmt: &Stmt, level: usize, ) -> Result> { match stmt { // No-op Stmt::Noop(_) => Ok(Default::default()), // Expression as statement Stmt::Expr(expr) => { let result = self.eval_expr(scope, state, expr, level)?; Ok(if let Expr::Assignment(_, _, _) = *expr.as_ref() { // If it is an assignment, erase the result at the root Default::default() } else { result }) } // Block scope Stmt::Block(block, _) => { let prev_len = scope.len(); let result = block.iter().try_fold(Default::default(), |_, stmt| { self.eval_stmt(scope, state, stmt, level) }); scope.rewind(prev_len); // The impact of an eval statement goes away at the end of a block // because any new variables introduced will go out of scope state.always_search = false; result } // If-else statement Stmt::IfThenElse(guard, if_body, else_body) => self .eval_expr(scope, state, guard, level)? .as_bool() .map_err(|_| Box::new(EvalAltResult::ErrorLogicGuard(guard.position()))) .and_then(|guard_val| { if guard_val { self.eval_stmt(scope, state, if_body, level) } else if let Some(stmt) = else_body { self.eval_stmt(scope, state, stmt.as_ref(), level) } else { Ok(Default::default()) } }), // While loop Stmt::While(guard, body) => loop { match self.eval_expr(scope, state, guard, level)?.as_bool() { Ok(true) => match self.eval_stmt(scope, state, body, level) { Ok(_) => (), Err(err) => match *err { EvalAltResult::ErrorLoopBreak(false, _) => (), EvalAltResult::ErrorLoopBreak(true, _) => return Ok(Default::default()), _ => return Err(err), }, }, Ok(false) => return Ok(Default::default()), Err(_) => { return Err(Box::new(EvalAltResult::ErrorLogicGuard(guard.position()))) } } }, // Loop statement Stmt::Loop(body) => loop { match self.eval_stmt(scope, state, body, level) { Ok(_) => (), Err(err) => match *err { EvalAltResult::ErrorLoopBreak(false, _) => (), EvalAltResult::ErrorLoopBreak(true, _) => return Ok(Default::default()), _ => return Err(err), }, } }, // For loop Stmt::For(name, expr, body) => { let arr = self.eval_expr(scope, state, expr, level)?; let tid = arr.type_id(); if let Some(iter_fn) = self .base_package .get_iterator(tid) .or_else(|| self.packages.get_iterator(tid)) { // Add the loop variable let var_name = name.as_ref().clone(); scope.push(var_name, ()); let index = scope.len() - 1; for a in iter_fn(arr) { *scope.get_mut(index).0 = a; match self.eval_stmt(scope, state, body, level) { Ok(_) => (), Err(err) => match *err { EvalAltResult::ErrorLoopBreak(false, _) => (), EvalAltResult::ErrorLoopBreak(true, _) => break, _ => return Err(err), }, } } scope.rewind(scope.len() - 1); Ok(Default::default()) } else { Err(Box::new(EvalAltResult::ErrorFor(expr.position()))) } } // Continue statement Stmt::Continue(pos) => Err(Box::new(EvalAltResult::ErrorLoopBreak(false, *pos))), // Break statement Stmt::Break(pos) => Err(Box::new(EvalAltResult::ErrorLoopBreak(true, *pos))), // Empty return Stmt::ReturnWithVal(None, ReturnType::Return, pos) => { Err(Box::new(EvalAltResult::Return(Default::default(), *pos))) } // Return value Stmt::ReturnWithVal(Some(a), ReturnType::Return, pos) => Err(Box::new( EvalAltResult::Return(self.eval_expr(scope, state, a, level)?, *pos), )), // Empty throw Stmt::ReturnWithVal(None, ReturnType::Exception, pos) => { Err(Box::new(EvalAltResult::ErrorRuntime("".into(), *pos))) } // Throw value Stmt::ReturnWithVal(Some(a), ReturnType::Exception, pos) => { let val = self.eval_expr(scope, state, a, level)?; Err(Box::new(EvalAltResult::ErrorRuntime( val.take_string().unwrap_or_else(|_| "".to_string()), *pos, ))) } // Let statement Stmt::Let(name, Some(expr), _) => { let val = self.eval_expr(scope, state, expr, level)?; // TODO - avoid copying variable name in inner block? let var_name = name.as_ref().clone(); scope.push_dynamic_value(var_name, ScopeEntryType::Normal, val, false); Ok(Default::default()) } Stmt::Let(name, None, _) => { // TODO - avoid copying variable name in inner block? let var_name = name.as_ref().clone(); scope.push(var_name, ()); Ok(Default::default()) } // Const statement Stmt::Const(name, expr, _) if expr.is_constant() => { let val = self.eval_expr(scope, state, expr, level)?; // TODO - avoid copying variable name in inner block? let var_name = name.as_ref().clone(); scope.push_dynamic_value(var_name, ScopeEntryType::Constant, val, true); Ok(Default::default()) } // Const expression not constant Stmt::Const(_, _, _) => unreachable!(), // Import statement Stmt::Import(expr, name, _) => { #[cfg(feature = "no_module")] unreachable!(); #[cfg(not(feature = "no_module"))] { if let Some(path) = self .eval_expr(scope, state, expr, level)? .try_cast::() { if let Some(resolver) = self.module_resolver.as_ref() { let module = resolver.resolve(self, &path, expr.position())?; // TODO - avoid copying module name in inner block? let mod_name = name.as_ref().clone(); scope.push_module(mod_name, module); Ok(Default::default()) } else { Err(Box::new(EvalAltResult::ErrorModuleNotFound( path, expr.position(), ))) } } else { Err(Box::new(EvalAltResult::ErrorImportExpr(expr.position()))) } } } } } /// Map a type_name into a pretty-print name pub(crate) fn map_type_name<'a>(&'a self, name: &'a str) -> &'a str { self.type_names .get(name) .map(String::as_str) .unwrap_or(name) } }