Add is_def_fn with 3 parameters.

This commit is contained in:
Stephen Chung 2023-03-30 16:43:15 +08:00
parent 2a98d38a7e
commit 34c7dabe44
4 changed files with 77 additions and 12 deletions

View File

@ -15,6 +15,7 @@ New features
------------ ------------
* It is now possible to require a specific _type_ to the `this` pointer for a particular script-defined function so that it is called only when the `this` pointer contains the specified type. * It is now possible to require a specific _type_ to the `this` pointer for a particular script-defined function so that it is called only when the `this` pointer contains the specified type.
* `is_def_fn` is extended to support checking for typed methods, with syntax `is_def_fn(this_type, fn_name, arity)`
Version 1.13.0 Version 1.13.0

View File

@ -112,6 +112,21 @@ fn curry(fn_ptr: FnPtr, ...args: ?) -> FnPtr;
/// ``` /// ```
fn is_def_fn(fn_name: String, num_params: int) -> bool; fn is_def_fn(fn_name: String, num_params: int) -> bool;
/// Return `true` if a script-defined function exists with a specified name and
/// number of parameters, bound to a specified type for `this`.
///
/// # Example
///
/// ```rhai
/// // A method that requires `this` to be `MyType`
/// fn MyType.foo(x) { }
///
/// print(is_def_fn("MyType", "foo", 1)); // prints true
/// print(is_def_fn("foo", 1)); // prints false
/// print(is_def_fn("MyType", "foo", 2)); // prints false
/// ```
fn is_def_fn(this_type: String, fn_name: String, num_params: int) -> bool;
/// Return `true` if a variable matching a specified name is defined. /// Return `true` if a variable matching a specified name is defined.
/// ///
/// # Example /// # Example

View File

@ -1,6 +1,9 @@
//! Implement function-calling mechanism for [`Engine`]. //! Implement function-calling mechanism for [`Engine`].
use super::{get_builtin_binary_op_fn, get_builtin_op_assignment_fn, CallableFunction}; use super::{
calc_typed_method_hash, get_builtin_binary_op_fn, get_builtin_op_assignment_fn,
CallableFunction,
};
use crate::api::default_limits::MAX_DYNAMIC_PARAMETERS; use crate::api::default_limits::MAX_DYNAMIC_PARAMETERS;
use crate::ast::{Expr, FnCallExpr, FnCallHashes}; use crate::ast::{Expr, FnCallExpr, FnCallHashes};
use crate::engine::{ use crate::engine::{
@ -1099,7 +1102,7 @@ impl Engine {
FnCallHashes::from_hash(calc_fn_hash(None, name, args_len)) FnCallHashes::from_hash(calc_fn_hash(None, name, args_len))
}; };
} }
// Handle Fn() // Handle Fn(fn_name)
KEYWORD_FN_PTR if total_args == 1 => { KEYWORD_FN_PTR if total_args == 1 => {
let arg = first_arg.unwrap(); let arg = first_arg.unwrap();
let (arg_value, arg_pos) = let (arg_value, arg_pos) =
@ -1114,7 +1117,7 @@ impl Engine {
.map_err(|err| err.fill_position(arg_pos)); .map_err(|err| err.fill_position(arg_pos));
} }
// Handle curry() // Handle curry(x, ...)
KEYWORD_FN_PTR_CURRY if total_args > 1 => { KEYWORD_FN_PTR_CURRY if total_args > 1 => {
let first = first_arg.unwrap(); let first = first_arg.unwrap();
let (arg_value, arg_pos) = let (arg_value, arg_pos) =
@ -1137,7 +1140,7 @@ impl Engine {
return Ok(fn_ptr.into()); return Ok(fn_ptr.into());
} }
// Handle is_shared() // Handle is_shared(var)
#[cfg(not(feature = "no_closure"))] #[cfg(not(feature = "no_closure"))]
crate::engine::KEYWORD_IS_SHARED if total_args == 1 => { crate::engine::KEYWORD_IS_SHARED if total_args == 1 => {
let arg = first_arg.unwrap(); let arg = first_arg.unwrap();
@ -1146,7 +1149,7 @@ impl Engine {
return Ok(arg_value.is_shared().into()); return Ok(arg_value.is_shared().into());
} }
// Handle is_def_fn() // Handle is_def_fn(fn_name, arity)
#[cfg(not(feature = "no_function"))] #[cfg(not(feature = "no_function"))]
crate::engine::KEYWORD_IS_DEF_FN if total_args == 2 => { crate::engine::KEYWORD_IS_DEF_FN if total_args == 2 => {
let first = first_arg.unwrap(); let first = first_arg.unwrap();
@ -1164,17 +1167,54 @@ impl Engine {
.as_int() .as_int()
.map_err(|typ| self.make_type_mismatch_err::<crate::INT>(typ, arg_pos))?; .map_err(|typ| self.make_type_mismatch_err::<crate::INT>(typ, arg_pos))?;
return Ok(if (0..=crate::MAX_USIZE_INT).contains(&num_params) { return Ok(if num_params >= 0 {
#[allow(clippy::cast_sign_loss, clippy::cast_possible_truncation)] #[allow(clippy::cast_sign_loss, clippy::cast_possible_truncation)]
let hash_script = calc_fn_hash(None, &fn_name, num_params as usize); let hash_script = calc_fn_hash(None, &fn_name, num_params as usize);
self.has_script_fn(global, caches, hash_script) self.has_script_fn(global, caches, hash_script).into()
} else { } else {
false Dynamic::FALSE
} });
.into());
} }
// Handle is_def_var() // Handle is_def_fn(this_type, fn_name, arity)
#[cfg(not(feature = "no_function"))]
#[cfg(not(feature = "no_object"))]
crate::engine::KEYWORD_IS_DEF_FN if total_args == 3 => {
let first = first_arg.unwrap();
let (arg_value, arg_pos) =
self.get_arg_value(global, caches, scope, this_ptr.as_deref_mut(), first)?;
let this_type = arg_value
.into_immutable_string()
.map_err(|typ| self.make_type_mismatch_err::<ImmutableString>(typ, arg_pos))?;
let (arg_value, arg_pos) =
self.get_arg_value(global, caches, scope, this_ptr.as_deref_mut(), &a_expr[0])?;
let fn_name = arg_value
.into_immutable_string()
.map_err(|typ| self.make_type_mismatch_err::<ImmutableString>(typ, arg_pos))?;
let (arg_value, arg_pos) =
self.get_arg_value(global, caches, scope, this_ptr, &a_expr[1])?;
let num_params = arg_value
.as_int()
.map_err(|typ| self.make_type_mismatch_err::<crate::INT>(typ, arg_pos))?;
return Ok(if num_params >= 0 {
#[allow(clippy::cast_sign_loss, clippy::cast_possible_truncation)]
let hash_script = calc_typed_method_hash(
calc_fn_hash(None, &fn_name, num_params as usize),
&this_type,
);
self.has_script_fn(global, caches, hash_script).into()
} else {
Dynamic::FALSE
});
}
// Handle is_def_var(fn_name)
KEYWORD_IS_DEF_VAR if total_args == 1 => { KEYWORD_IS_DEF_VAR if total_args == 1 => {
let arg = first_arg.unwrap(); let arg = first_arg.unwrap();
let (arg_value, arg_pos) = let (arg_value, arg_pos) =
@ -1185,7 +1225,7 @@ impl Engine {
return Ok(scope.contains(&var_name).into()); return Ok(scope.contains(&var_name).into());
} }
// Handle eval() // Handle eval(script)
KEYWORD_EVAL if total_args == 1 => { KEYWORD_EVAL if total_args == 1 => {
// eval - only in function call style // eval - only in function call style
let orig_scope_len = scope.len(); let orig_scope_len = scope.len();

View File

@ -108,6 +108,15 @@ fn test_method_call_typed() -> Result<(), Box<EvalAltResult>> {
TestStruct { x: 1002 } TestStruct { x: 1002 }
); );
assert!(engine.eval::<bool>(
r#"
fn "Test-Struct#ABC".foo(x) {
this.update(x);
}
is_def_fn("Test-Struct#ABC", "foo", 1)
"#
)?);
assert!(matches!( assert!(matches!(
*engine *engine
.run( .run(