rhai/src/engine.rs

1663 lines
59 KiB
Rust
Raw Normal View History

2020-03-08 12:54:02 +01:00
//! Main module defining the script evaluation `Engine`.
2016-02-29 22:43:45 +01:00
2020-04-12 17:00:06 +02:00
use crate::any::{Dynamic, Union};
use crate::error::ParseErrorType;
2020-04-10 06:16:39 +02:00
use crate::optimize::OptimizationLevel;
use crate::parser::{Expr, FnDef, ReturnType, Stmt, INT};
2020-03-04 15:00:01 +01:00
use crate::result::EvalAltResult;
2020-03-25 04:27:18 +01:00
use crate::scope::{EntryRef as ScopeSource, EntryType as ScopeEntryType, Scope};
use crate::token::Position;
2020-03-17 19:26:11 +01:00
use crate::stdlib::{
2020-04-12 17:00:06 +02:00
any::TypeId,
2020-03-10 03:07:44 +01:00
borrow::Cow,
2020-03-17 19:26:11 +01:00
boxed::Box,
cmp::Ordering,
2020-03-10 03:07:44 +01:00
collections::HashMap,
2020-03-17 19:26:11 +01:00
format,
2020-03-10 03:07:44 +01:00
iter::once,
ops::{Deref, DerefMut},
rc::Rc,
2020-03-17 19:26:11 +01:00
string::{String, ToString},
2020-03-10 03:07:44 +01:00
sync::Arc,
2020-03-17 19:26:11 +01:00
vec,
vec::Vec,
2020-03-10 03:07:44 +01:00
};
2020-03-04 15:00:01 +01:00
/// An dynamic array of `Dynamic` values.
2020-04-03 13:42:01 +02:00
///
/// Not available under the `no_index` feature.
pub type Array = Vec<Dynamic>;
2020-03-04 15:00:01 +01:00
2020-04-03 13:42:01 +02:00
/// An dynamic hash map of `Dynamic` values with `String` keys.
///
/// Not available under the `no_object` feature.
2020-03-29 17:53:35 +02:00
pub type Map = HashMap<String, Dynamic>;
2020-04-12 17:00:06 +02:00
pub type FnCallArgs<'a> = [&'a mut Dynamic];
2016-02-29 22:43:45 +01:00
2020-04-03 11:17:00 +02:00
#[cfg(feature = "sync")]
pub type FnAny = dyn Fn(&mut FnCallArgs, Position) -> Result<Dynamic, EvalAltResult> + Send + Sync;
#[cfg(not(feature = "sync"))]
2020-03-26 03:56:28 +01:00
pub type FnAny = dyn Fn(&mut FnCallArgs, Position) -> Result<Dynamic, EvalAltResult>;
2020-03-08 12:54:02 +01:00
2020-04-03 11:17:00 +02:00
#[cfg(feature = "sync")]
type IteratorFn = dyn Fn(&Dynamic) -> Box<dyn Iterator<Item = Dynamic>> + Send + Sync;
#[cfg(not(feature = "sync"))]
2020-03-08 12:54:02 +01:00
type IteratorFn = dyn Fn(&Dynamic) -> Box<dyn Iterator<Item = Dynamic>>;
2020-04-07 17:13:47 +02:00
#[cfg(debug_assertions)]
2020-04-09 12:45:49 +02:00
pub const MAX_CALL_STACK_DEPTH: usize = 32;
2020-04-07 17:13:47 +02:00
#[cfg(not(debug_assertions))]
pub const MAX_CALL_STACK_DEPTH: usize = 256;
2020-04-01 03:51:33 +02:00
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$";
2020-03-03 10:28:38 +01:00
2020-03-11 16:43:04 +01:00
#[derive(Debug, Eq, PartialEq, Hash, Clone, Copy)]
2020-03-06 16:49:52 +01:00
enum IndexSourceType {
2020-03-30 16:19:37 +02:00
Expression,
String,
2020-03-05 13:28:03 +01:00
Array,
2020-03-29 17:53:35 +02:00
Map,
2020-03-30 16:19:37 +02:00
}
#[derive(Debug, Eq, PartialEq, Hash, Clone)]
enum IndexValue {
Num(usize),
Str(String),
}
impl IndexValue {
fn from_num(idx: INT) -> Self {
Self::Num(idx as usize)
}
fn from_str(name: String) -> Self {
Self::Str(name)
}
fn as_num(self) -> usize {
match self {
Self::Num(n) => n,
_ => panic!("index value is numeric"),
}
}
fn as_str(self) -> String {
match self {
Self::Str(s) => s,
_ => panic!("index value is string"),
}
}
}
#[derive(Debug)]
enum Target<'a> {
Scope(ScopeSource<'a>),
2020-04-12 17:00:06 +02:00
Value(&'a mut Dynamic),
2020-03-30 16:19:37 +02:00
}
impl<'a> Target<'a> {
2020-04-12 17:00:06 +02:00
fn from(value: &'a mut Dynamic) -> Self {
2020-03-30 16:19:37 +02:00
Self::Value(value)
}
fn from_src(src: ScopeSource<'a>) -> Self {
Self::Scope(src)
}
2020-04-12 17:00:06 +02:00
fn get_mut(self, scope: &'a mut Scope) -> &'a mut Dynamic {
2020-03-30 16:19:37 +02:00
match self {
Self::Value(t) => t,
2020-04-12 17:00:06 +02:00
Self::Scope(src) => scope.get_mut(src),
2020-03-30 16:19:37 +02:00
}
}
2020-03-05 13:28:03 +01:00
}
2020-03-12 06:02:13 +01:00
#[derive(Debug, Eq, PartialEq, Hash, Clone)]
2020-03-04 15:00:01 +01:00
pub struct FnSpec<'a> {
pub name: Cow<'a, str>,
2020-03-30 16:19:37 +02:00
pub args: Vec<TypeId>,
}
/// A type that holds a library of script-defined functions.
///
/// Since script-defined functions have `Dynamic` parameters, functions with the same name
/// and number of parameters are considered equivalent.
///
/// Since the key is a combination of the function name (a String) plus the number of parameters,
/// we cannot use a `HashMap` because we don't want to clone the function name string just
/// to search for it.
///
/// So instead this is implemented as a sorted list and binary searched.
#[derive(Debug, Clone)]
pub struct FunctionsLib(
#[cfg(feature = "sync")] Vec<Arc<FnDef>>,
#[cfg(not(feature = "sync"))] Vec<Rc<FnDef>>,
);
impl FnDef {
/// Function to order two FnDef records, for binary search.
pub fn compare(&self, name: &str, params_len: usize) -> Ordering {
// First order by name
match self.name.as_str().cmp(name) {
// Then by number of parameters
Ordering::Equal => self.params.len().cmp(&params_len),
order => order,
}
}
}
impl FunctionsLib {
/// Create a new `FunctionsLib`.
pub fn new() -> Self {
FunctionsLib(Vec::new())
}
/// Create a new `FunctionsLib` from a collection of `FnDef`.
pub fn from_vec(vec: Vec<FnDef>) -> Self {
#[cfg(feature = "sync")]
{
FunctionsLib(vec.into_iter().map(Arc::new).collect())
}
#[cfg(not(feature = "sync"))]
{
FunctionsLib(vec.into_iter().map(Rc::new).collect())
}
}
/// Does a certain function exist in the `FunctionsLib`?
pub fn has_function(&self, name: &str, params: usize) -> bool {
self.0.binary_search_by(|f| f.compare(name, params)).is_ok()
}
/// Get a function definition from the `FunctionsLib`.
pub fn get_function(&self, name: &str, params: usize) -> Option<&FnDef> {
2020-04-11 12:09:03 +02:00
self.0
.binary_search_by(|f| f.compare(name, params))
.ok()
.map(|n| self.0[n].as_ref())
}
/// 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();
other.iter().cloned().for_each(|fn_def| {
if let Some((n, _)) = functions
.iter()
.enumerate()
.find(|(_, f)| f.name == fn_def.name && f.params.len() == fn_def.params.len())
{
functions[n] = fn_def;
} else {
functions.push(fn_def);
}
});
functions
}
}
}
impl Deref for FunctionsLib {
#[cfg(feature = "sync")]
type Target = Vec<Arc<FnDef>>;
#[cfg(not(feature = "sync"))]
type Target = Vec<Rc<FnDef>>;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl DerefMut for FunctionsLib {
#[cfg(feature = "sync")]
fn deref_mut(&mut self) -> &mut Vec<Arc<FnDef>> {
&mut self.0
}
#[cfg(not(feature = "sync"))]
fn deref_mut(&mut self) -> &mut Vec<Rc<FnDef>> {
&mut self.0
}
}
2020-03-04 15:00:01 +01:00
/// Rhai main scripting engine.
2017-10-30 16:08:44 +01:00
///
2020-03-19 06:52:10 +01:00
/// ```
2020-03-09 14:57:07 +01:00
/// # fn main() -> Result<(), rhai::EvalAltResult> {
2017-10-30 16:08:44 +01:00
/// use rhai::Engine;
///
/// let engine = Engine::new();
2017-10-30 16:08:44 +01:00
///
2020-03-09 14:57:07 +01:00
/// let result = engine.eval::<i64>("40 + 2")?;
///
/// println!("Answer: {}", result); // prints 42
/// # Ok(())
/// # }
2017-10-30 16:08:44 +01:00
/// ```
2020-04-03 13:42:01 +02:00
///
/// Currently, `Engine` is neither `Send` nor `Sync`. Turn on the `sync` feature to make it `Send + Sync`.
2020-03-07 03:15:42 +01:00
pub struct Engine<'e> {
2020-03-27 07:34:01 +01:00
/// A hashmap containing all compiled functions known to the engine.
pub(crate) functions: Option<HashMap<FnSpec<'e>, Box<FnAny>>>,
2020-03-27 07:34:01 +01:00
/// A hashmap containing all iterators known to the engine.
pub(crate) type_iterators: Option<HashMap<TypeId, Box<IteratorFn>>>,
2020-03-27 07:34:01 +01:00
/// A hashmap mapping type names to pretty-print names.
pub(crate) type_names: Option<HashMap<String, String>>,
2020-03-30 16:19:37 +02:00
/// Closure for implementing the `print` command.
2020-04-03 11:17:00 +02:00
#[cfg(feature = "sync")]
pub(crate) on_print: Option<Box<dyn Fn(&str) + Send + Sync + 'e>>,
/// Closure for implementing the `print` command.
2020-04-03 11:17:00 +02:00
#[cfg(not(feature = "sync"))]
pub(crate) on_print: Option<Box<dyn Fn(&str) + 'e>>,
2020-04-03 11:17:00 +02:00
2020-03-30 16:19:37 +02:00
/// Closure for implementing the `debug` command.
2020-04-03 11:17:00 +02:00
#[cfg(feature = "sync")]
pub(crate) on_debug: Option<Box<dyn Fn(&str) + Send + Sync + 'e>>,
/// Closure for implementing the `debug` command.
2020-04-03 11:17:00 +02:00
#[cfg(not(feature = "sync"))]
pub(crate) on_debug: Option<Box<dyn Fn(&str) + 'e>>,
2020-03-27 07:34:01 +01:00
/// Optimize the AST after compilation.
pub(crate) optimization_level: OptimizationLevel,
/// Maximum levels of call-stack to prevent infinite recursion.
2020-04-07 17:13:47 +02:00
///
2020-04-09 12:45:49 +02:00
/// Defaults to 32 for debug builds and 256 for non-debug builds.
2020-03-27 07:34:01 +01:00
pub(crate) max_call_stack_depth: usize,
2017-12-20 12:16:14 +01:00
}
2020-03-25 04:27:18 +01:00
impl Default for Engine<'_> {
fn default() -> Self {
2020-03-09 14:57:07 +01:00
// Create the new scripting Engine
let mut engine = Engine {
functions: None,
type_iterators: None,
type_names: None,
// default print/debug implementations
on_print: Some(Box::new(default_print)),
on_debug: Some(Box::new(default_print)),
2020-03-16 05:40:42 +01:00
// optimization level
2020-04-10 06:16:39 +02:00
#[cfg(feature = "no_optimize")]
optimization_level: OptimizationLevel::None,
2020-03-16 05:40:42 +01:00
#[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,
2020-03-27 07:34:01 +01:00
max_call_stack_depth: MAX_CALL_STACK_DEPTH,
2020-03-09 14:57:07 +01:00
};
engine.register_core_lib();
#[cfg(not(feature = "no_stdlib"))]
engine.register_stdlib();
2020-03-09 14:57:07 +01:00
engine
}
2020-03-25 04:27:18 +01:00
}
2020-03-30 10:10:50 +02:00
/// 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> {
2020-04-10 06:16:39 +02:00
#[cfg(not(feature = "no_object"))]
{
if fn_name.starts_with(FUNC_GETTER) {
Some(&fn_name[FUNC_GETTER.len()..])
} else {
None
}
}
#[cfg(feature = "no_object")]
{
2020-03-30 10:10:50 +02:00
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> {
2020-04-10 06:16:39 +02:00
#[cfg(not(feature = "no_object"))]
{
if fn_name.starts_with(FUNC_SETTER) {
Some(&fn_name[FUNC_SETTER.len()..])
} else {
None
}
}
#[cfg(feature = "no_object")]
{
2020-03-30 10:10:50 +02:00
None
}
}
2020-03-25 04:27:18 +01:00
impl Engine<'_> {
/// Create a new `Engine`
pub fn new() -> Self {
Default::default()
}
2020-03-09 14:57:07 +01:00
/// Create a new `Engine` with minimal configurations without the standard library etc.
pub fn new_raw() -> Self {
let mut engine = Engine {
functions: None,
type_iterators: None,
type_names: None,
on_print: None,
on_debug: None,
2020-04-10 06:16:39 +02:00
#[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,
};
engine.register_core_lib();
engine
}
/// Control whether and how the `Engine` will optimize an AST after compilation
2020-04-03 13:42:01 +02:00
///
/// 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
}
2020-03-27 07:34:01 +01:00
/// 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
}
2020-04-01 03:51:33 +02:00
/// Universal method for calling functions either registered with the `Engine` or written in Rhai
2020-03-04 15:00:01 +01:00
pub(crate) fn call_fn_raw(
&self,
scope: Option<&mut Scope>,
fn_lib: Option<&FunctionsLib>,
2020-03-04 15:00:01 +01:00
fn_name: &str,
2020-03-26 03:56:28 +01:00
args: &mut FnCallArgs,
2020-03-08 12:54:02 +01:00
def_val: Option<&Dynamic>,
pos: Position,
2020-03-27 07:34:01 +01:00
level: usize,
) -> Result<Dynamic, EvalAltResult> {
2020-04-07 17:13:47 +02:00
// Check for stack overflow
if level > self.max_call_stack_depth {
return Err(EvalAltResult::ErrorStackOverflow(pos));
}
2020-04-10 06:16:39 +02:00
#[cfg(feature = "no_function")]
const fn_lib: Option<&FunctionsLib> = None;
2020-03-11 16:43:04 +01:00
// First search in script-defined functions (can override built-in)
2020-04-11 12:09:03 +02:00
if let Some(fn_def) = fn_lib.and_then(|lib| lib.get_function(fn_name, args.len())) {
match scope {
// Extern scope passed in which is not empty
Some(scope) if scope.len() > 0 => {
let scope_len = scope.len();
scope.extend(
// Put arguments into scope as variables - variable name is copied
// TODO - avoid copying variable name
fn_def
.params
.iter()
2020-04-12 17:00:06 +02:00
.zip(args.into_iter().map(|v| v.clone()))
2020-04-11 12:09:03 +02:00
.map(|(name, value)| (name.clone(), ScopeEntryType::Normal, value)),
);
// Evaluate the function at one higher level of call depth
let result = self
.eval_stmt(scope, fn_lib, &fn_def.body, level + 1)
.or_else(|err| match err {
// Convert return statement to return value
EvalAltResult::Return(x, _) => Ok(x),
err => Err(err.set_position(pos)),
});
scope.rewind(scope_len);
return result;
}
// No new scope - create internal scope
_ => {
let mut scope = Scope::new();
scope.extend(
// Put arguments into scope as variables
fn_def
.params
.iter()
2020-04-12 17:00:06 +02:00
.zip(args.into_iter().map(|v| v.clone()))
2020-04-11 12:09:03 +02:00
.map(|(name, value)| (name, ScopeEntryType::Normal, value)),
);
// Evaluate the function at one higher level of call depth
return self
.eval_stmt(&mut scope, fn_lib, &fn_def.body, level + 1)
.or_else(|err| match err {
// Convert return statement to return value
EvalAltResult::Return(x, _) => Ok(x),
err => Err(err.set_position(pos)),
});
}
}
2020-03-11 16:43:04 +01:00
}
let spec = FnSpec {
2020-03-04 15:00:01 +01:00
name: fn_name.into(),
2020-04-12 17:00:06 +02:00
args: args.iter().map(|a| a.type_id()).collect(),
2020-03-04 15:00:01 +01:00
};
2020-03-19 12:53:42 +01:00
// Argument must be a string
2020-04-12 17:00:06 +02:00
fn cast_to_string(r: &Dynamic, pos: Position) -> Result<&str, EvalAltResult> {
r.as_str()
.map_err(|type_name| EvalAltResult::ErrorMismatchOutputType(type_name.into(), pos))
2020-03-19 12:53:42 +01:00
}
// Search built-in's and external functions
2020-04-11 12:09:03 +02:00
if let Some(func) = self.functions.as_ref().and_then(|f| f.get(&spec)) {
// Run external function
let result = func(args, pos)?;
// See if the function match print/debug (which requires special processing)
return match fn_name {
2020-04-12 17:00:06 +02:00
KEYWORD_PRINT if self.on_print.is_some() => {
self.on_print.as_ref().unwrap()(cast_to_string(&result, pos)?);
Ok(Dynamic::from_unit())
}
KEYWORD_DEBUG if self.on_debug.is_some() => {
self.on_debug.as_ref().unwrap()(cast_to_string(&result, pos)?);
Ok(Dynamic::from_unit())
}
KEYWORD_PRINT | KEYWORD_DEBUG => Ok(Dynamic::from_unit()),
2020-04-11 12:09:03 +02:00
_ => Ok(result),
};
2020-03-11 16:43:04 +01:00
}
2020-03-30 10:10:50 +02:00
if let Some(prop) = extract_prop_from_getter(fn_name) {
2020-04-10 06:16:39 +02:00
// Map property access
2020-04-12 17:00:06 +02:00
if let Ok(map) = args[0].as_map() {
return Ok(map
.get(prop)
.cloned()
.unwrap_or_else(|| Dynamic::from_unit()));
2020-03-29 17:53:35 +02:00
}
2020-03-08 12:54:02 +01:00
// Getter function not found
2020-03-11 16:43:04 +01:00
return Err(EvalAltResult::ErrorDotExpr(
2020-03-30 10:10:50 +02:00
format!("- property '{}' unknown or write-only", prop),
2020-03-07 13:55:03 +01:00
pos,
2020-03-11 16:43:04 +01:00
));
}
2020-03-30 10:10:50 +02:00
if let Some(prop) = extract_prop_from_setter(fn_name) {
2020-04-12 17:00:06 +02:00
let value = args[1].clone();
2020-03-29 17:53:35 +02:00
2020-04-10 06:16:39 +02:00
// Map property update
2020-04-12 17:00:06 +02:00
if let Dynamic(Union::Map(map)) = args[0] {
2020-04-10 06:16:39 +02:00
map.insert(prop.to_string(), value);
2020-04-12 17:00:06 +02:00
return Ok(Dynamic::from_unit());
2020-03-29 17:53:35 +02:00
}
2020-03-08 12:54:02 +01:00
// Setter function not found
2020-03-11 16:43:04 +01:00
return Err(EvalAltResult::ErrorDotExpr(
2020-03-30 10:10:50 +02:00
format!("- property '{}' unknown or read-only", prop),
pos,
2020-03-11 16:43:04 +01:00
));
}
2020-03-11 16:43:04 +01:00
if let Some(val) = def_val {
// Return default value
return Ok(val.clone());
}
2020-03-11 16:43:04 +01:00
// Raise error
2020-03-26 03:56:28 +01:00
let types_list: Vec<_> = args
2020-03-11 16:43:04 +01:00
.iter()
2020-04-13 04:27:08 +02:00
.map(|x| x.type_name())
2020-03-11 16:43:04 +01:00
.map(|name| self.map_type_name(name))
2020-03-26 03:56:28 +01:00
.collect();
2020-03-11 16:43:04 +01:00
Err(EvalAltResult::ErrorFunctionNotFound(
format!("{} ({})", fn_name, types_list.join(", ")),
2020-03-11 16:43:04 +01:00
pos,
))
2017-12-20 12:16:14 +01:00
}
/// Chain-evaluate a dot setter.
2017-12-20 12:16:14 +01:00
fn get_dot_val_helper(
&self,
2017-12-20 12:16:14 +01:00
scope: &mut Scope,
fn_lib: Option<&FunctionsLib>,
2020-03-30 16:19:37 +02:00
target: Target,
2017-12-20 12:16:14 +01:00
dot_rhs: &Expr,
2020-03-27 07:34:01 +01:00
level: usize,
) -> Result<Dynamic, EvalAltResult> {
match dot_rhs {
// xxx.fn_name(arg_expr_list)
Expr::FunctionCall(fn_name, arg_expr_list, def_val, pos) => {
let mut values = arg_expr_list
2019-09-18 12:21:07 +02:00
.iter()
.map(|arg_expr| self.eval_expr(scope, fn_lib, arg_expr, level))
2017-12-20 12:16:14 +01:00
.collect::<Result<Vec<_>, _>>()?;
2020-03-01 17:11:00 +01:00
2020-03-30 16:19:37 +02:00
let this_ptr = target.get_mut(scope);
2020-04-12 17:00:06 +02:00
let mut args: Vec<_> = once(this_ptr).chain(values.iter_mut()).collect();
2017-12-20 12:16:14 +01:00
let def_val = def_val.as_ref();
self.call_fn_raw(None, fn_lib, fn_name, &mut args, def_val, *pos, 0)
}
2020-03-01 17:11:00 +01:00
// xxx.id
2020-03-13 11:12:41 +01:00
Expr::Property(id, pos) => {
let mut args = [target.get_mut(scope)];
self.call_fn_raw(None, fn_lib, &make_getter(id), &mut args, None, *pos, 0)
}
2020-03-01 17:11:00 +01:00
// xxx.idx_lhs[idx_expr]
Expr::Index(idx_lhs, idx_expr, op_pos) => {
2020-04-01 03:51:33 +02:00
let value = match idx_lhs.as_ref() {
// xxx.id[idx_expr]
2020-03-13 11:12:41 +01:00
Expr::Property(id, pos) => {
let mut args = [target.get_mut(scope)];
self.call_fn_raw(None, fn_lib, &make_getter(id), &mut args, None, *pos, 0)?
2020-03-05 13:28:03 +01:00
}
// xxx.???[???][idx_expr]
2020-03-29 17:53:35 +02:00
Expr::Index(_, _, _) => {
self.get_dot_val_helper(scope, fn_lib, target, idx_lhs, level)?
2020-03-29 17:53:35 +02:00
}
// Syntax error
_ => {
return Err(EvalAltResult::ErrorDotExpr(
"".to_string(),
dot_rhs.position(),
))
}
2020-03-05 13:28:03 +01:00
};
self.get_indexed_value(scope, fn_lib, &value, idx_expr, *op_pos, level)
2020-04-01 03:51:33 +02:00
.map(|(val, _, _)| val)
}
2020-03-01 17:11:00 +01:00
// xxx.dot_lhs.rhs
Expr::Dot(dot_lhs, rhs, _) => match dot_lhs.as_ref() {
// xxx.id.rhs
2020-03-13 11:12:41 +01:00
Expr::Property(id, pos) => {
let mut args = [target.get_mut(scope)];
self.call_fn_raw(None, fn_lib, &make_getter(id), &mut args, None, *pos, 0)
2020-04-01 03:51:33 +02:00
.and_then(|mut val| {
2020-04-12 17:00:06 +02:00
let target = Target::from(&mut val);
self.get_dot_val_helper(scope, fn_lib, target, rhs, level)
})
2020-03-01 06:30:22 +01:00
}
// xxx.idx_lhs[idx_expr].rhs
Expr::Index(idx_lhs, idx_expr, op_pos) => {
2020-03-29 17:53:35 +02:00
let val = match idx_lhs.as_ref() {
// xxx.id[idx_expr].rhs
2020-03-13 11:12:41 +01:00
Expr::Property(id, pos) => {
let fn_name = make_getter(id);
let mut args = [target.get_mut(scope)];
self.call_fn_raw(None, fn_lib, &fn_name, &mut args, None, *pos, 0)?
2020-03-05 13:28:03 +01:00
}
// xxx.???[???][idx_expr].rhs
2020-03-29 17:53:35 +02:00
Expr::Index(_, _, _) => {
self.get_dot_val_helper(scope, fn_lib, target, idx_lhs, level)?
2020-03-29 17:53:35 +02:00
}
// Syntax error
_ => {
return Err(EvalAltResult::ErrorDotExpr(
"".to_string(),
dot_rhs.position(),
))
}
2020-03-05 13:28:03 +01:00
};
self.get_indexed_value(scope, fn_lib, &val, idx_expr, *op_pos, level)
2020-04-01 03:51:33 +02:00
.and_then(|(mut val, _, _)| {
2020-04-12 17:00:06 +02:00
let target = Target::from(&mut val);
self.get_dot_val_helper(scope, fn_lib, target, rhs, level)
})
}
// Syntax error
_ => Err(EvalAltResult::ErrorDotExpr(
"".to_string(),
dot_lhs.position(),
)),
2017-12-20 12:16:14 +01:00
},
// Syntax error
_ => Err(EvalAltResult::ErrorDotExpr(
"".to_string(),
dot_rhs.position(),
)),
}
}
/// Evaluate a dot chain getter
fn get_dot_val(
&self,
scope: &mut Scope,
fn_lib: Option<&FunctionsLib>,
dot_lhs: &Expr,
dot_rhs: &Expr,
2020-03-27 07:34:01 +01:00
level: usize,
) -> Result<Dynamic, EvalAltResult> {
match dot_lhs {
// id.???
2020-03-13 11:12:41 +01:00
Expr::Variable(id, pos) => {
2020-03-29 17:53:35 +02:00
let (entry, _) = Self::search_scope(scope, id, *pos)?;
2020-03-25 04:27:18 +01:00
// Avoid referencing scope which is used below as mut
let entry = ScopeSource { name: id, ..entry };
// This is a variable property access (potential function call).
// Use a direct index into `scope` to directly mutate the variable value.
self.get_dot_val_helper(scope, fn_lib, Target::from_src(entry), dot_rhs, level)
}
// idx_lhs[idx_expr].???
Expr::Index(idx_lhs, idx_expr, op_pos) => {
2020-04-10 06:16:39 +02:00
let (idx_src_type, src, index, mut val) =
self.eval_index_expr(scope, fn_lib, idx_lhs, idx_expr, *op_pos, level)?;
2020-04-12 17:00:06 +02:00
let target = Target::from(&mut val);
let value = self.get_dot_val_helper(scope, fn_lib, target, dot_rhs, level);
2020-03-08 12:54:02 +01:00
// In case the expression mutated `target`, we need to update it back into the scope because it is cloned.
2020-04-11 10:06:57 +02:00
match src.map(|s| s.typ) {
None => (),
Some(ScopeEntryType::Constant) => {
return Err(EvalAltResult::ErrorAssignmentToConstant(
src.unwrap().name.to_string(),
idx_lhs.position(),
));
}
Some(ScopeEntryType::Normal) => {
Self::update_indexed_var_in_scope(
idx_src_type,
scope,
src.unwrap(),
index,
(val, dot_rhs.position()),
)?;
}
}
2020-04-01 03:51:33 +02:00
value
}
// {expr}.???
expr => {
let mut val = self.eval_expr(scope, fn_lib, expr, level)?;
2020-04-12 17:00:06 +02:00
self.get_dot_val_helper(scope, fn_lib, Target::from(&mut val), dot_rhs, level)
}
}
}
/// Search for a variable within the scope, returning its value and index inside the Scope
2020-03-29 17:53:35 +02:00
fn search_scope<'a>(
scope: &'a Scope,
2017-12-20 17:37:12 +01:00
id: &str,
begin: Position,
2020-03-29 17:53:35 +02:00
) -> Result<(ScopeSource<'a>, Dynamic), EvalAltResult> {
2017-12-20 17:37:12 +01:00
scope
2020-03-03 08:20:20 +01:00
.get(id)
.ok_or_else(|| EvalAltResult::ErrorVariableNotFound(id.into(), begin))
2017-12-20 17:37:12 +01:00
}
2020-03-29 17:53:35 +02:00
/// Get the value at the indexed position of a base type
fn get_indexed_value(
&self,
scope: &mut Scope,
fn_lib: Option<&FunctionsLib>,
2020-03-29 17:53:35 +02:00
val: &Dynamic,
idx_expr: &Expr,
2020-03-29 17:53:35 +02:00
op_pos: Position,
2020-03-27 07:34:01 +01:00
level: usize,
2020-03-30 16:19:37 +02:00
) -> Result<(Dynamic, IndexSourceType, IndexValue), EvalAltResult> {
2020-03-29 17:53:35 +02:00
let idx_pos = idx_expr.position();
2020-04-01 03:51:33 +02:00
// val_array[idx]
2020-04-12 17:00:06 +02:00
if let Ok(arr) = val.as_array() {
2020-04-10 06:16:39 +02:00
let index = self
.eval_expr(scope, fn_lib, idx_expr, level)?
2020-04-12 17:00:06 +02:00
.as_int()
2020-03-29 17:53:35 +02:00
.map_err(|_| EvalAltResult::ErrorNumericIndexExpr(idx_expr.position()))?;
2020-04-10 06:16:39 +02:00
return if index >= 0 {
arr.get(index as usize)
2020-04-12 17:00:06 +02:00
.map(|v| {
(
v.clone(),
IndexSourceType::Array,
IndexValue::from_num(index),
)
})
2020-04-10 06:16:39 +02:00
.ok_or_else(|| EvalAltResult::ErrorArrayBounds(arr.len(), index, idx_pos))
2020-03-04 15:00:01 +01:00
} else {
2020-04-10 06:16:39 +02:00
Err(EvalAltResult::ErrorArrayBounds(arr.len(), index, idx_pos))
2020-03-29 17:53:35 +02:00
};
}
2020-04-10 06:16:39 +02:00
// val_map[idx]
2020-04-12 17:00:06 +02:00
if let Ok(map) = val.as_map() {
2020-04-10 06:16:39 +02:00
let index = self
.eval_expr(scope, fn_lib, idx_expr, level)?
2020-04-12 17:00:06 +02:00
.take_string()
2020-04-10 06:16:39 +02:00
.map_err(|_| EvalAltResult::ErrorStringIndexExpr(idx_expr.position()))?;
return Ok((
map.get(&index)
.cloned()
2020-04-12 17:00:06 +02:00
.unwrap_or_else(|| Dynamic::from_unit()),
2020-04-10 06:16:39 +02:00
IndexSourceType::Map,
IndexValue::from_str(index),
));
2020-03-29 17:53:35 +02:00
}
2020-04-01 03:51:33 +02:00
// val_string[idx]
2020-04-12 17:00:06 +02:00
if let Ok(s) = val.as_str() {
2020-04-10 06:16:39 +02:00
let index = self
.eval_expr(scope, fn_lib, idx_expr, level)?
2020-04-12 17:00:06 +02:00
.as_int()
2020-03-29 17:53:35 +02:00
.map_err(|_| EvalAltResult::ErrorNumericIndexExpr(idx_expr.position()))?;
2020-04-10 06:16:39 +02:00
return if index >= 0 {
2020-03-04 15:00:01 +01:00
s.chars()
2020-04-10 06:16:39 +02:00
.nth(index as usize)
2020-03-29 17:53:35 +02:00
.map(|ch| {
(
2020-04-12 17:00:06 +02:00
Dynamic::from_char(ch),
2020-03-29 17:53:35 +02:00
IndexSourceType::String,
2020-04-10 06:16:39 +02:00
IndexValue::from_num(index),
2020-03-29 17:53:35 +02:00
)
})
.ok_or_else(|| {
2020-04-10 06:16:39 +02:00
EvalAltResult::ErrorStringBounds(s.chars().count(), index, idx_pos)
})
2020-03-04 15:00:01 +01:00
} else {
Err(EvalAltResult::ErrorStringBounds(
s.chars().count(),
2020-04-10 06:16:39 +02:00
index,
idx_pos,
2020-03-04 15:00:01 +01:00
))
2020-03-29 17:53:35 +02:00
};
2020-03-04 15:00:01 +01:00
}
2020-03-29 17:53:35 +02:00
// Error - cannot be indexed
2020-04-01 03:51:33 +02:00
Err(EvalAltResult::ErrorIndexingType(
2020-03-29 17:53:35 +02:00
self.map_type_name(val.type_name()).to_string(),
op_pos,
2020-04-01 03:51:33 +02:00
))
2020-03-04 15:00:01 +01:00
}
/// Evaluate an index expression
2020-03-07 03:15:42 +01:00
fn eval_index_expr<'a>(
&self,
2017-12-20 21:09:53 +01:00
scope: &mut Scope,
fn_lib: Option<&FunctionsLib>,
2020-03-07 03:15:42 +01:00
lhs: &'a Expr,
2020-03-05 13:28:03 +01:00
idx_expr: &Expr,
op_pos: Position,
2020-03-27 07:34:01 +01:00
level: usize,
2020-03-29 17:53:35 +02:00
) -> Result<
(
IndexSourceType,
Option<ScopeSource<'a>>,
2020-03-30 16:19:37 +02:00
IndexValue,
2020-03-29 17:53:35 +02:00
Dynamic,
),
EvalAltResult,
> {
2020-03-05 13:28:03 +01:00
match lhs {
2020-03-06 03:50:20 +01:00
// id[idx_expr]
2020-03-29 17:53:35 +02:00
Expr::Variable(id, _) => {
let (
ScopeSource {
typ: src_type,
index: src_idx,
..
},
val,
) = Self::search_scope(scope, &id, lhs.position())?;
2020-04-10 06:16:39 +02:00
let (val, idx_src_type, index) =
self.get_indexed_value(scope, fn_lib, &val, idx_expr, op_pos, level)?;
2020-03-29 17:53:35 +02:00
Ok((
idx_src_type,
Some(ScopeSource {
name: &id,
2020-03-29 17:53:35 +02:00
typ: src_type,
index: src_idx,
}),
2020-04-10 06:16:39 +02:00
index,
val,
2020-03-29 17:53:35 +02:00
))
}
2020-03-05 13:28:03 +01:00
2020-03-06 03:50:20 +01:00
// (expr)[idx_expr]
expr => {
let val = self.eval_expr(scope, fn_lib, expr, level)?;
self.get_indexed_value(scope, fn_lib, &val, idx_expr, op_pos, level)
2020-04-10 06:16:39 +02:00
.map(|(val, _, index)| (IndexSourceType::Expression, None, index, val))
}
2020-03-05 13:28:03 +01:00
}
2020-03-01 06:30:22 +01:00
}
/// Replace a character at an index position in a mutable string
2020-03-01 06:30:22 +01:00
fn str_replace_char(s: &mut String, idx: usize, new_ch: char) {
2020-03-06 16:49:52 +01:00
let mut chars: Vec<char> = s.chars().collect();
let ch = *chars.get(idx).expect("string index out of bounds");
2020-03-01 06:30:22 +01:00
// See if changed - if so, update the String
2020-03-06 16:49:52 +01:00
if ch != new_ch {
chars[idx] = new_ch;
s.clear();
chars.iter().for_each(|&ch| s.push(ch));
2020-03-01 06:30:22 +01:00
}
2017-12-20 17:37:12 +01:00
}
/// Update the value at an index position in a variable inside the scope
fn update_indexed_var_in_scope(
2020-03-29 17:53:35 +02:00
idx_src_type: IndexSourceType,
scope: &mut Scope,
src: ScopeSource,
2020-03-30 16:19:37 +02:00
idx: IndexValue,
new_val: (Dynamic, Position),
) -> Result<Dynamic, EvalAltResult> {
2020-03-29 17:53:35 +02:00
match idx_src_type {
2020-03-06 16:49:52 +01:00
// array_id[idx] = val
IndexSourceType::Array => {
2020-03-25 04:27:18 +01:00
let arr = scope.get_mut_by_type::<Array>(src);
2020-03-30 16:19:37 +02:00
arr[idx.as_num()] = new_val.0;
2020-04-12 17:00:06 +02:00
Ok(Dynamic::from_unit())
2020-03-29 17:53:35 +02:00
}
// map_id[idx] = val
IndexSourceType::Map => {
let arr = scope.get_mut_by_type::<Map>(src);
2020-03-30 16:19:37 +02:00
arr.insert(idx.as_str(), new_val.0);
2020-04-12 17:00:06 +02:00
Ok(Dynamic::from_unit())
}
2020-03-06 16:49:52 +01:00
// string_id[idx] = val
IndexSourceType::String => {
2020-03-25 04:27:18 +01:00
let s = scope.get_mut_by_type::<String>(src);
let pos = new_val.1;
// Value must be a character
let ch = new_val
.0
2020-04-12 17:00:06 +02:00
.as_char()
.map_err(|_| EvalAltResult::ErrorCharMismatch(pos))?;
2020-03-30 16:19:37 +02:00
Self::str_replace_char(s, idx.as_num(), ch);
2020-04-12 17:00:06 +02:00
Ok(Dynamic::from_unit())
}
IndexSourceType::Expression => panic!("expression cannot be indexed for update"),
}
}
/// Update the value at an index position
fn update_indexed_value(
2020-03-08 12:54:02 +01:00
mut target: Dynamic,
2020-03-30 16:19:37 +02:00
idx: IndexValue,
new_val: Dynamic,
pos: Position,
) -> Result<Dynamic, EvalAltResult> {
2020-04-12 17:00:06 +02:00
match target {
Dynamic(Union::Array(ref mut arr)) => {
arr[idx.as_num()] = new_val;
}
Dynamic(Union::Map(ref mut map)) => {
map.insert(idx.as_str(), new_val);
}
Dynamic(Union::Str(ref mut s)) => {
// Value must be a character
let ch = new_val
.as_char()
.map_err(|_| EvalAltResult::ErrorCharMismatch(pos))?;
2020-03-29 17:53:35 +02:00
2020-04-12 17:00:06 +02:00
Self::str_replace_char(s, idx.as_num(), ch);
}
// All other variable types should be an error
_ => panic!("array, map or string source type expected for indexing"),
}
2020-04-12 17:00:06 +02:00
Ok(target)
}
/// Chain-evaluate a dot setter
2017-12-20 12:16:14 +01:00
fn set_dot_val_helper(
&self,
scope: &mut Scope,
fn_lib: Option<&FunctionsLib>,
2020-04-12 17:00:06 +02:00
this_ptr: &mut Dynamic,
2017-12-20 12:16:14 +01:00
dot_rhs: &Expr,
new_val: (&mut Dynamic, Position),
2020-03-27 07:34:01 +01:00
level: usize,
) -> Result<Dynamic, EvalAltResult> {
match dot_rhs {
// xxx.id
2020-03-13 11:12:41 +01:00
Expr::Property(id, pos) => {
2020-04-12 17:00:06 +02:00
let mut args = [this_ptr, new_val.0];
self.call_fn_raw(None, fn_lib, &make_setter(id), &mut args, None, *pos, 0)
}
2020-03-01 17:11:00 +01:00
// xxx.lhs[idx_expr]
// TODO - Allow chaining of indexing!
Expr::Index(lhs, idx_expr, op_pos) => match lhs.as_ref() {
// xxx.id[idx_expr]
Expr::Property(id, pos) => {
let fn_name = make_getter(id);
self.call_fn_raw(None, fn_lib, &fn_name, &mut [this_ptr], None, *pos, 0)
.and_then(|val| {
2020-04-10 06:16:39 +02:00
let (_, _, index) = self
.get_indexed_value(scope, fn_lib, &val, idx_expr, *op_pos, level)?;
2020-04-10 06:16:39 +02:00
Self::update_indexed_value(val, index, new_val.0.clone(), new_val.1)
})
.and_then(|mut val| {
let fn_name = make_setter(id);
2020-04-12 17:00:06 +02:00
let mut args = [this_ptr, &mut val];
self.call_fn_raw(None, fn_lib, &fn_name, &mut args, None, *pos, 0)
})
}
// All others - syntax error for setters chain
_ => Err(EvalAltResult::ErrorDotExpr(
"for assignment".to_string(),
*op_pos,
)),
},
// xxx.lhs.{...}
Expr::Dot(lhs, rhs, _) => match lhs.as_ref() {
// xxx.id.rhs
2020-03-13 11:12:41 +01:00
Expr::Property(id, pos) => {
let fn_name = make_getter(id);
self.call_fn_raw(None, fn_lib, &fn_name, &mut [this_ptr], None, *pos, 0)
2020-04-01 03:51:33 +02:00
.and_then(|mut val| {
2020-04-12 17:00:06 +02:00
self.set_dot_val_helper(scope, fn_lib, &mut val, rhs, new_val, level)
2020-04-01 03:51:33 +02:00
.map(|_| val) // Discard Ok return value
2017-12-20 21:09:53 +01:00
})
2020-04-01 03:51:33 +02:00
.and_then(|mut val| {
let fn_name = make_setter(id);
2020-04-12 17:00:06 +02:00
let mut args = [this_ptr, &mut val];
self.call_fn_raw(None, fn_lib, &fn_name, &mut args, None, *pos, 0)
2017-12-20 12:16:14 +01:00
})
}
// xxx.lhs[idx_expr].rhs
// TODO - Allow chaining of indexing!
Expr::Index(lhs, idx_expr, op_pos) => match lhs.as_ref() {
// xxx.id[idx_expr].rhs
2020-03-13 11:12:41 +01:00
Expr::Property(id, pos) => {
let fn_name = make_getter(id);
self.call_fn_raw(None, fn_lib, &fn_name, &mut [this_ptr], None, *pos, 0)
.and_then(|v| {
2020-04-10 06:16:39 +02:00
let (mut value, _, index) = self.get_indexed_value(
scope, fn_lib, &v, idx_expr, *op_pos, level,
)?;
let val_pos = new_val.1;
2020-04-12 17:00:06 +02:00
let this_ptr = &mut value;
self.set_dot_val_helper(
scope, fn_lib, this_ptr, rhs, new_val, level,
)?;
2020-03-08 12:54:02 +01:00
// In case the expression mutated `target`, we need to update it back into the scope because it is cloned.
2020-04-10 06:16:39 +02:00
Self::update_indexed_value(v, index, value, val_pos)
})
.and_then(|mut v| {
let fn_name = make_setter(id);
2020-04-12 17:00:06 +02:00
let mut args = [this_ptr, &mut v];
self.call_fn_raw(None, fn_lib, &fn_name, &mut args, None, *pos, 0)
})
}
// All others - syntax error for setters chain
_ => Err(EvalAltResult::ErrorDotExpr(
"for assignment".to_string(),
*op_pos,
)),
},
// All others - syntax error for setters chain
_ => Err(EvalAltResult::ErrorDotExpr(
"for assignment".to_string(),
lhs.position(),
)),
2017-12-20 12:16:14 +01:00
},
// Syntax error
_ => Err(EvalAltResult::ErrorDotExpr(
"for assignment".to_string(),
dot_rhs.position(),
)),
}
}
// Evaluate a dot chain setter
2017-12-20 12:16:14 +01:00
fn set_dot_val(
&self,
2017-12-20 12:16:14 +01:00
scope: &mut Scope,
fn_lib: Option<&FunctionsLib>,
2017-12-20 12:16:14 +01:00
dot_lhs: &Expr,
dot_rhs: &Expr,
new_val: (&mut Dynamic, Position),
2020-03-13 11:12:41 +01:00
op_pos: Position,
2020-03-27 07:34:01 +01:00
level: usize,
) -> Result<Dynamic, EvalAltResult> {
match dot_lhs {
// id.???
2020-03-13 11:12:41 +01:00
Expr::Variable(id, pos) => {
2020-04-11 10:06:57 +02:00
let (src, mut target) = Self::search_scope(scope, id, *pos)?;
2020-03-13 11:12:41 +01:00
2020-04-11 10:06:57 +02:00
match src.typ {
2020-03-25 04:27:18 +01:00
ScopeEntryType::Constant => Err(EvalAltResult::ErrorAssignmentToConstant(
2020-03-24 09:57:35 +01:00
id.to_string(),
op_pos,
)),
_ => {
2020-03-25 04:27:18 +01:00
// Avoid referencing scope which is used below as mut
2020-04-11 10:06:57 +02:00
let entry = ScopeSource { name: id, ..src };
2020-04-12 17:00:06 +02:00
let this_ptr = &mut target;
let value = self
.set_dot_val_helper(scope, fn_lib, this_ptr, dot_rhs, new_val, level);
2020-03-24 09:57:35 +01:00
// In case the expression mutated `target`, we need to update it back into the scope because it is cloned.
2020-03-25 04:27:18 +01:00
*scope.get_mut(entry) = target;
2020-04-01 03:51:33 +02:00
value
2020-03-24 09:57:35 +01:00
}
}
}
2020-03-01 17:11:00 +01:00
// lhs[idx_expr].???
// TODO - Allow chaining of indexing!
Expr::Index(lhs, idx_expr, op_pos) => {
2020-04-10 06:16:39 +02:00
let (idx_src_type, src, index, mut target) =
self.eval_index_expr(scope, fn_lib, lhs, idx_expr, *op_pos, level)?;
let val_pos = new_val.1;
2020-04-12 17:00:06 +02:00
let this_ptr = &mut target;
let value =
self.set_dot_val_helper(scope, fn_lib, this_ptr, dot_rhs, new_val, level);
2020-03-05 13:28:03 +01:00
2020-03-08 12:54:02 +01:00
// In case the expression mutated `target`, we need to update it back into the scope because it is cloned.
2020-04-11 10:06:57 +02:00
match src.map(|x| x.typ) {
None => (),
Some(ScopeEntryType::Constant) => {
return Err(EvalAltResult::ErrorAssignmentToConstant(
src.unwrap().name.to_string(),
lhs.position(),
));
}
Some(ScopeEntryType::Normal) => {
Self::update_indexed_var_in_scope(
idx_src_type,
scope,
src.unwrap(),
index,
(target, val_pos),
)?;
}
2020-03-01 06:30:22 +01:00
}
2020-04-01 03:51:33 +02:00
value
}
// Syntax error
_ => Err(EvalAltResult::ErrorDotExpr(
"for assignment".to_string(),
dot_lhs.position(),
)),
}
}
2020-04-06 11:47:34 +02:00
// Evaluate an 'in' expression
fn eval_in_expr(
&self,
2020-04-06 11:47:34 +02:00
scope: &mut Scope,
fn_lib: Option<&FunctionsLib>,
2020-04-06 11:47:34 +02:00
lhs: &Expr,
rhs: &Expr,
level: usize,
) -> Result<Dynamic, EvalAltResult> {
let mut lhs_value = self.eval_expr(scope, fn_lib, lhs, level)?;
let rhs_value = self.eval_expr(scope, fn_lib, rhs, level)?;
2020-04-06 11:47:34 +02:00
2020-04-12 17:00:06 +02:00
match rhs_value {
Dynamic(Union::Array(mut rhs_value)) => {
let def_value = Dynamic::from_bool(false);
let mut result = false;
// Call the '==' operator to compare each value
for value in rhs_value.iter_mut() {
let args = &mut [&mut lhs_value, value];
let def_value = Some(&def_value);
if self
.call_fn_raw(None, fn_lib, "==", args, def_value, rhs.position(), level)?
.as_bool()
.unwrap_or(false)
{
result = true;
break;
}
2020-04-06 11:47:34 +02:00
}
2020-04-12 17:00:06 +02:00
Ok(Dynamic::from_bool(result))
2020-04-10 06:16:39 +02:00
}
2020-04-12 17:00:06 +02:00
Dynamic(Union::Map(rhs_value)) => {
// Only allows String or char
match lhs_value {
Dynamic(Union::Str(s)) => Ok(Dynamic::from_bool(rhs_value.contains_key(&s))),
Dynamic(Union::Char(c)) => {
Ok(Dynamic::from_bool(rhs_value.contains_key(&c.to_string())))
}
_ => Err(EvalAltResult::ErrorInExpr(lhs.position())),
}
2020-04-10 06:16:39 +02:00
}
2020-04-12 17:00:06 +02:00
Dynamic(Union::Str(rhs_value)) => {
// Only allows String or char
match lhs_value {
Dynamic(Union::Str(s)) => Ok(Dynamic::from_bool(rhs_value.contains(&s))),
Dynamic(Union::Char(c)) => Ok(Dynamic::from_bool(rhs_value.contains(c))),
_ => Err(EvalAltResult::ErrorInExpr(lhs.position())),
}
}
_ => Err(EvalAltResult::ErrorInExpr(rhs.position())),
2020-04-06 11:47:34 +02:00
}
}
/// Evaluate an expression
2020-03-27 07:34:01 +01:00
fn eval_expr(
&self,
2020-03-27 07:34:01 +01:00
scope: &mut Scope,
fn_lib: Option<&FunctionsLib>,
2020-03-27 07:34:01 +01:00
expr: &Expr,
level: usize,
) -> Result<Dynamic, EvalAltResult> {
match expr {
2020-04-12 17:00:06 +02:00
Expr::IntegerConstant(i, _) => Ok(Dynamic::from_int(*i)),
#[cfg(not(feature = "no_float"))]
Expr::FloatConstant(f, _) => Ok(Dynamic::from_float(*f)),
Expr::StringConstant(s, _) => Ok(Dynamic::from_string(s.to_string())),
Expr::CharConstant(c, _) => Ok(Dynamic::from_char(*c)),
2020-03-29 17:53:35 +02:00
Expr::Variable(id, pos) => Self::search_scope(scope, id, *pos).map(|(_, val)| val),
2020-03-13 11:12:41 +01:00
Expr::Property(_, _) => panic!("unexpected property."),
2020-03-07 03:39:00 +01:00
// Statement block
Expr::Stmt(stmt, _) => self.eval_stmt(scope, fn_lib, stmt, level),
2020-03-07 03:39:00 +01:00
// lhs = rhs
2020-03-13 11:12:41 +01:00
Expr::Assignment(lhs, rhs, op_pos) => {
let mut rhs_val = self.eval_expr(scope, fn_lib, rhs, level)?;
2016-03-26 18:46:28 +01:00
2020-03-05 13:28:03 +01:00
match lhs.as_ref() {
// name = rhs
2020-04-11 10:06:57 +02:00
Expr::Variable(name, pos) => match scope.get(name) {
None => {
return Err(EvalAltResult::ErrorVariableNotFound(
2020-04-12 17:00:06 +02:00
name.to_string(),
2020-04-11 10:06:57 +02:00
*pos,
))
}
Some((
entry
@
ScopeSource {
typ: ScopeEntryType::Normal,
..
},
_,
)) => {
2020-03-25 04:27:18 +01:00
// Avoid referencing scope which is used below as mut
let entry = ScopeSource { name, ..entry };
*scope.get_mut(entry) = rhs_val.clone();
2020-03-14 04:51:45 +01:00
Ok(rhs_val)
2020-03-03 09:24:03 +01:00
}
2020-04-05 11:44:48 +02:00
2020-04-11 10:06:57 +02:00
Some((
ScopeSource {
typ: ScopeEntryType::Constant,
..
},
_,
)) => Err(EvalAltResult::ErrorAssignmentToConstant(
name.to_string(),
*op_pos,
)),
2020-03-13 11:12:41 +01:00
},
2020-03-05 13:28:03 +01:00
// idx_lhs[idx_expr] = rhs
#[cfg(not(feature = "no_index"))]
Expr::Index(idx_lhs, idx_expr, op_pos) => {
2020-04-10 06:16:39 +02:00
let (idx_src_type, src, index, _) =
self.eval_index_expr(scope, fn_lib, idx_lhs, idx_expr, *op_pos, level)?;
2020-03-05 13:28:03 +01:00
2020-04-11 10:06:57 +02:00
match src.map(|x| x.typ) {
None => Err(EvalAltResult::ErrorAssignmentToUnknownLHS(
2020-03-06 16:49:52 +01:00
idx_lhs.position(),
2020-04-11 10:06:57 +02:00
)),
Some(ScopeEntryType::Constant) => {
Err(EvalAltResult::ErrorAssignmentToConstant(
src.unwrap().name.to_string(),
idx_lhs.position(),
))
}
Some(ScopeEntryType::Normal) => Ok(Self::update_indexed_var_in_scope(
idx_src_type,
scope,
src.unwrap(),
index,
(rhs_val, rhs.position()),
)?),
2020-03-01 06:30:22 +01:00
}
2016-03-26 18:46:28 +01:00
}
2020-03-02 05:08:03 +01:00
// dot_lhs.dot_rhs = rhs
#[cfg(not(feature = "no_object"))]
Expr::Dot(dot_lhs, dot_rhs, _) => {
let new_val = (&mut rhs_val, rhs.position());
self.set_dot_val(scope, fn_lib, dot_lhs, dot_rhs, new_val, *op_pos, level)
}
2020-03-02 05:08:03 +01:00
2020-03-13 11:12:41 +01:00
// Error assignment to constant
expr if expr.is_constant() => Err(EvalAltResult::ErrorAssignmentToConstant(
expr.get_constant_str(),
2020-03-13 11:12:41 +01:00
lhs.position(),
)),
// Syntax error
2020-03-05 13:28:03 +01:00
_ => Err(EvalAltResult::ErrorAssignmentToUnknownLHS(lhs.position())),
2016-02-29 22:43:45 +01:00
}
}
2020-03-01 17:11:00 +01:00
2020-04-10 06:16:39 +02:00
// lhs[idx_expr]
#[cfg(not(feature = "no_index"))]
Expr::Index(lhs, idx_expr, op_pos) => self
.eval_index_expr(scope, fn_lib, lhs, idx_expr, *op_pos, level)
.map(|(_, _, _, x)| x),
#[cfg(not(feature = "no_object"))]
Expr::Dot(lhs, rhs, _) => self.get_dot_val(scope, fn_lib, lhs, rhs, level),
2020-03-01 17:11:00 +01:00
#[cfg(not(feature = "no_index"))]
Expr::Array(contents, _) => {
2020-03-29 17:53:35 +02:00
let mut arr = Array::new();
2016-03-26 18:46:28 +01:00
2020-03-27 07:34:01 +01:00
contents.into_iter().try_for_each(|item| {
self.eval_expr(scope, fn_lib, item, level)
.map(|val| arr.push(val))
2020-03-27 07:34:01 +01:00
})?;
2016-03-26 18:46:28 +01:00
2020-04-12 17:00:06 +02:00
Ok(Dynamic(Union::Array(arr)))
2016-03-26 18:46:28 +01:00
}
2020-03-01 17:11:00 +01:00
2020-03-29 17:53:35 +02:00
#[cfg(not(feature = "no_object"))]
Expr::Map(contents, _) => {
let mut map = Map::new();
contents.into_iter().try_for_each(|item| {
self.eval_expr(scope, fn_lib, &item.1, level).map(|val| {
2020-03-29 17:53:35 +02:00
map.insert(item.0.clone(), val);
})
})?;
2020-04-12 17:00:06 +02:00
Ok(Dynamic(Union::Map(Box::new(map))))
2020-03-29 17:53:35 +02:00
}
Expr::FunctionCall(fn_name, args_expr_list, def_val, pos) => {
// Has a system function an override?
fn has_override(
engine: &Engine,
fn_lib: Option<&FunctionsLib>,
name: &str,
) -> bool {
engine.functions.as_ref().map_or(false, |lib| {
lib.contains_key(&FnSpec {
name: name.into(),
args: vec![TypeId::of::<String>()],
})
}) || fn_lib.map_or(false, |lib| lib.has_function(name, 1))
}
2020-03-11 04:39:15 +01:00
2020-04-06 06:29:01 +02:00
match fn_name.as_ref() {
// type_of
KEYWORD_TYPE_OF
if args_expr_list.len() == 1
&& !has_override(self, fn_lib, KEYWORD_TYPE_OF) =>
{
2020-04-10 06:16:39 +02:00
let result = self.eval_expr(scope, fn_lib, &args_expr_list[0], level)?;
2020-04-12 17:00:06 +02:00
Ok(Dynamic::from_string(
self.map_type_name(result.type_name()).to_string(),
))
}
// eval
KEYWORD_EVAL
if args_expr_list.len() == 1
&& !has_override(self, fn_lib, KEYWORD_EVAL) =>
{
let pos = args_expr_list[0].position();
2020-04-10 06:16:39 +02:00
let result = self.eval_expr(scope, fn_lib, &args_expr_list[0], level)?;
// Get the script text by evaluating the expression
2020-04-12 17:00:06 +02:00
let script = result.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,
)
.map_err(EvalAltResult::ErrorParsing)?;
// If new functions are defined within the eval string, it is an error
2020-04-10 06:16:39 +02:00
if ast.1.len() > 0 {
return Err(EvalAltResult::ErrorParsing(
ParseErrorType::WrongFnDefinition.into_err(pos),
));
}
if let Some(lib) = fn_lib {
#[cfg(feature = "sync")]
{
ast.1 = Arc::new(lib.clone());
}
#[cfg(not(feature = "sync"))]
{
ast.1 = Rc::new(lib.clone());
}
}
// Evaluate the AST
self.eval_ast_with_scope_raw(scope, &ast)
.map_err(|err| err.set_position(pos))
}
// Normal function call
_ => {
let mut arg_values = args_expr_list
.iter()
.map(|expr| self.eval_expr(scope, fn_lib, expr, level))
2020-03-26 03:56:28 +01:00
.collect::<Result<Vec<_>, _>>()?;
2020-04-12 17:00:06 +02:00
let mut args: Vec<_> = arg_values.iter_mut().collect();
let def_val = def_val.as_ref();
self.call_fn_raw(None, fn_lib, fn_name, &mut args, def_val, *pos, level)
}
}
2020-03-04 15:00:01 +01:00
}
2020-03-01 17:11:00 +01:00
Expr::In(lhs, rhs, _) => {
self.eval_in_expr(scope, fn_lib, lhs.as_ref(), rhs.as_ref(), level)
}
2020-04-06 11:47:34 +02:00
2020-04-12 17:00:06 +02:00
Expr::And(lhs, rhs, _) => Ok(Dynamic::from_bool(
self
.eval_expr(scope, fn_lib,lhs.as_ref(), level)?
2020-04-12 17:00:06 +02:00
.as_bool()
.map_err(|_| {
EvalAltResult::ErrorBooleanArgMismatch("AND".into(), lhs.position())
})?
&& // Short-circuit using &&
self
.eval_expr(scope, fn_lib,rhs.as_ref(), level)?
2020-04-12 17:00:06 +02:00
.as_bool()
.map_err(|_| {
EvalAltResult::ErrorBooleanArgMismatch("AND".into(), rhs.position())
})?,
2020-03-02 05:08:03 +01:00
)),
2020-04-12 17:00:06 +02:00
Expr::Or(lhs, rhs, _) => Ok(Dynamic::from_bool(
self
.eval_expr(scope,fn_lib, lhs.as_ref(), level)?
2020-04-12 17:00:06 +02:00
.as_bool()
.map_err(|_| {
EvalAltResult::ErrorBooleanArgMismatch("OR".into(), lhs.position())
})?
|| // Short-circuit using ||
self
.eval_expr(scope,fn_lib, rhs.as_ref(), level)?
2020-04-12 17:00:06 +02:00
.as_bool()
.map_err(|_| {
EvalAltResult::ErrorBooleanArgMismatch("OR".into(), rhs.position())
})?,
2020-03-02 05:08:03 +01:00
)),
2020-04-12 17:00:06 +02:00
Expr::True(_) => Ok(Dynamic::from_bool(true)),
Expr::False(_) => Ok(Dynamic::from_bool(false)),
Expr::Unit(_) => Ok(Dynamic::from_unit()),
2020-04-10 06:16:39 +02:00
2020-04-10 11:14:07 +02:00
_ => panic!("should not appear: {:?}", expr),
2016-02-29 22:43:45 +01:00
}
}
/// Evaluate a statement
pub(crate) fn eval_stmt(
&self,
scope: &mut Scope,
fn_lib: Option<&FunctionsLib>,
stmt: &Stmt,
2020-03-27 07:34:01 +01:00
level: usize,
) -> Result<Dynamic, EvalAltResult> {
match stmt {
2020-03-09 14:57:07 +01:00
// No-op
2020-04-12 17:00:06 +02:00
Stmt::Noop(_) => Ok(Dynamic::from_unit()),
2020-03-09 14:57:07 +01:00
2020-03-06 16:49:52 +01:00
// Expression as statement
2020-03-14 04:51:45 +01:00
Stmt::Expr(expr) => {
let result = self.eval_expr(scope, fn_lib, expr, level)?;
2020-03-14 04:51:45 +01:00
2020-03-14 16:41:15 +01:00
Ok(if !matches!(expr.as_ref(), Expr::Assignment(_, _, _)) {
result
} else {
2020-03-14 04:51:45 +01:00
// If it is an assignment, erase the result at the root
2020-04-12 17:00:06 +02:00
Dynamic::from_unit()
2020-03-14 04:51:45 +01:00
})
}
2020-03-01 17:11:00 +01:00
2020-03-06 16:49:52 +01:00
// Block scope
2020-03-09 14:57:07 +01:00
Stmt::Block(block, _) => {
let prev_len = scope.len();
2016-02-29 22:43:45 +01:00
2020-04-12 17:00:06 +02:00
let result = block.iter().try_fold(Dynamic::from_unit(), |_, stmt| {
self.eval_stmt(scope, fn_lib, stmt, level)
2020-03-27 07:34:01 +01:00
});
2016-02-29 22:43:45 +01:00
2020-03-06 16:49:52 +01:00
scope.rewind(prev_len);
2016-02-29 22:43:45 +01:00
2020-03-16 16:51:32 +01:00
result
2016-02-29 22:43:45 +01:00
}
2020-03-01 17:11:00 +01:00
2020-03-06 16:49:52 +01:00
// If-else statement
2020-03-22 03:18:16 +01:00
Stmt::IfThenElse(guard, if_body, else_body) => self
.eval_expr(scope, fn_lib, guard, level)?
2020-04-12 17:00:06 +02:00
.as_bool()
.map_err(|_| EvalAltResult::ErrorLogicGuard(guard.position()))
2020-03-01 06:30:22 +01:00
.and_then(|guard_val| {
if guard_val {
self.eval_stmt(scope, fn_lib, if_body, level)
} else if let Some(stmt) = else_body {
self.eval_stmt(scope, fn_lib, stmt.as_ref(), level)
2020-03-01 06:30:22 +01:00
} else {
2020-04-12 17:00:06 +02:00
Ok(Dynamic::from_unit())
2016-03-03 14:20:55 +01:00
}
2020-03-01 06:30:22 +01:00
}),
2020-03-01 17:11:00 +01:00
2020-03-06 16:49:52 +01:00
// While loop
Stmt::While(guard, body) => loop {
2020-04-12 17:00:06 +02:00
match self.eval_expr(scope, fn_lib, guard, level)?.as_bool() {
Ok(guard_val) if guard_val => {
match self.eval_stmt(scope, fn_lib, body, level) {
Ok(_) | Err(EvalAltResult::ErrorLoopBreak(false, _)) => (),
Err(EvalAltResult::ErrorLoopBreak(true, _)) => {
2020-04-12 17:00:06 +02:00
return Ok(Dynamic::from_unit())
}
Err(x) => return Err(x),
}
}
2020-04-12 17:00:06 +02:00
Ok(_) => return Ok(Dynamic::from_unit()),
Err(_) => return Err(EvalAltResult::ErrorLogicGuard(guard.position())),
2016-02-29 22:43:45 +01:00
}
2017-12-20 12:16:14 +01:00
},
2020-03-01 17:11:00 +01:00
2020-03-06 16:49:52 +01:00
// Loop statement
Stmt::Loop(body) => loop {
match self.eval_stmt(scope, fn_lib, body, level) {
2020-04-01 10:22:18 +02:00
Ok(_) | Err(EvalAltResult::ErrorLoopBreak(false, _)) => (),
2020-04-12 17:00:06 +02:00
Err(EvalAltResult::ErrorLoopBreak(true, _)) => return Ok(Dynamic::from_unit()),
2017-12-21 12:28:59 +01:00
Err(x) => return Err(x),
2017-10-30 16:08:44 +01:00
}
2017-12-20 12:16:14 +01:00
},
2020-03-01 17:11:00 +01:00
2020-03-06 16:49:52 +01:00
// For loop
Stmt::For(name, expr, body) => {
let arr = self.eval_expr(scope, fn_lib, expr, level)?;
2020-04-12 17:00:06 +02:00
let tid = arr.type_id();
2020-03-01 17:11:00 +01:00
2020-04-11 12:09:03 +02:00
if let Some(iter_fn) = self.type_iterators.as_ref().and_then(|t| t.get(&tid)) {
// Add the loop variable - variable name is copied
// TODO - avoid copying variable name
scope.push(name.clone(), ());
2020-03-25 04:27:18 +01:00
2020-04-11 12:09:03 +02:00
let entry = ScopeSource {
name,
index: scope.len() - 1,
typ: ScopeEntryType::Normal,
};
2020-03-01 17:11:00 +01:00
2020-04-11 12:09:03 +02:00
for a in iter_fn(&arr) {
*scope.get_mut(entry) = a;
2020-03-01 17:11:00 +01:00
2020-04-11 12:09:03 +02:00
match self.eval_stmt(scope, fn_lib, body, level) {
Ok(_) | Err(EvalAltResult::ErrorLoopBreak(false, _)) => (),
Err(EvalAltResult::ErrorLoopBreak(true, _)) => break,
Err(x) => return Err(x),
}
}
2020-04-11 12:09:03 +02:00
scope.rewind(scope.len() - 1);
2020-04-12 17:00:06 +02:00
Ok(Dynamic::from_unit())
} else {
2020-03-24 09:57:35 +01:00
Err(EvalAltResult::ErrorFor(expr.position()))
}
}
2020-03-01 17:11:00 +01:00
2020-04-01 10:22:18 +02:00
// Continue statement
Stmt::Continue(pos) => Err(EvalAltResult::ErrorLoopBreak(false, *pos)),
2020-03-06 16:49:52 +01:00
// Break statement
2020-04-01 10:22:18 +02:00
Stmt::Break(pos) => Err(EvalAltResult::ErrorLoopBreak(true, *pos)),
2020-03-01 17:11:00 +01:00
2020-03-03 11:15:20 +01:00
// Empty return
2020-03-11 16:43:04 +01:00
Stmt::ReturnWithVal(None, ReturnType::Return, pos) => {
2020-04-12 17:00:06 +02:00
Err(EvalAltResult::Return(Dynamic::from_unit(), *pos))
2020-03-03 11:15:20 +01:00
}
// Return value
2020-03-27 07:34:01 +01:00
Stmt::ReturnWithVal(Some(a), ReturnType::Return, pos) => Err(EvalAltResult::Return(
self.eval_expr(scope, fn_lib, a, level)?,
2020-03-27 07:34:01 +01:00
*pos,
)),
2020-03-03 11:15:20 +01:00
// Empty throw
2020-03-11 16:43:04 +01:00
Stmt::ReturnWithVal(None, ReturnType::Exception, pos) => {
2020-03-03 11:15:20 +01:00
Err(EvalAltResult::ErrorRuntime("".into(), *pos))
}
2020-03-01 17:11:00 +01:00
2020-03-03 11:15:20 +01:00
// Throw value
2020-03-11 16:43:04 +01:00
Stmt::ReturnWithVal(Some(a), ReturnType::Exception, pos) => {
let val = self.eval_expr(scope, fn_lib, a, level)?;
2020-03-03 11:15:20 +01:00
Err(EvalAltResult::ErrorRuntime(
2020-04-12 17:00:06 +02:00
val.take_string().unwrap_or_else(|_| "".to_string()),
2020-03-03 11:15:20 +01:00
*pos,
))
}
2020-03-01 17:11:00 +01:00
2020-03-06 16:49:52 +01:00
// Let statement
2020-03-11 16:43:04 +01:00
Stmt::Let(name, Some(expr), _) => {
let val = self.eval_expr(scope, fn_lib, expr, level)?;
2020-04-05 11:44:48 +02:00
// TODO - avoid copying variable name in inner block?
2020-03-25 04:27:18 +01:00
scope.push_dynamic_value(name.clone(), ScopeEntryType::Normal, val, false);
2020-04-12 17:00:06 +02:00
Ok(Dynamic::from_unit())
2020-03-11 16:43:04 +01:00
}
Stmt::Let(name, None, _) => {
2020-04-05 11:44:48 +02:00
// TODO - avoid copying variable name in inner block?
2020-03-11 16:43:04 +01:00
scope.push(name.clone(), ());
2020-04-12 17:00:06 +02:00
Ok(Dynamic::from_unit())
2016-02-29 22:43:45 +01:00
}
2020-03-13 11:12:41 +01:00
// Const statement
Stmt::Const(name, expr, _) if expr.is_constant() => {
let val = self.eval_expr(scope, fn_lib, expr, level)?;
2020-04-05 11:44:48 +02:00
// TODO - avoid copying variable name in inner block?
2020-03-25 04:27:18 +01:00
scope.push_dynamic_value(name.clone(), ScopeEntryType::Constant, val, true);
2020-04-12 17:00:06 +02:00
Ok(Dynamic::from_unit())
2020-03-13 11:12:41 +01:00
}
Stmt::Const(_, _, _) => panic!("constant expression not constant!"),
2016-02-29 22:43:45 +01:00
}
}
/// Map a type_name into a pretty-print name
2020-03-03 09:24:03 +01:00
pub(crate) fn map_type_name<'a>(&'a self, name: &'a str) -> &'a str {
2020-04-11 12:09:03 +02:00
self.type_names
.as_ref()
.and_then(|list| list.get(name).map(String::as_str))
.unwrap_or(name)
2020-03-02 16:16:19 +01:00
}
2016-03-01 15:40:48 +01:00
}
2020-03-04 16:44:32 +01:00
/// Print/debug to stdout
fn default_print(s: &str) {
2020-04-10 06:16:39 +02:00
#[cfg(not(feature = "no_std"))]
2020-03-04 16:44:32 +01:00
println!("{}", s);
}