1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
//! Trait to build a custom type for use with [`Engine`].
use crate::func::SendSync;
use crate::module::FuncMetadata;
use crate::packages::string_basic::{FUNC_TO_DEBUG, FUNC_TO_STRING};
use crate::types::dynamic::Variant;
use crate::{Engine, FuncRegistration, Identifier, RhaiNativeFunc, StaticVec};
use std::marker::PhantomData;
#[cfg(feature = "no_std")]
use std::prelude::v1::*;
#[cfg(any(not(feature = "no_index"), not(feature = "no_object")))]
use crate::func::register::Mut;
/// Trait to build the API of a custom type for use with an [`Engine`]
/// (i.e. register the type and its getters, setters, methods, etc.).
///
/// # Example
///
/// ```
/// # #[cfg(not(feature = "no_object"))]
/// # {
/// use rhai::{CustomType, TypeBuilder, Engine};
///
/// #[derive(Debug, Clone, Eq, PartialEq)]
/// struct TestStruct {
/// field: i64
/// }
///
/// impl TestStruct {
/// fn new() -> Self {
/// Self { field: 1 }
/// }
/// fn update(&mut self, offset: i64) {
/// self.field += offset;
/// }
/// fn get_value(&mut self) -> i64 {
/// self.field
/// }
/// fn set_value(&mut self, value: i64) {
/// self.field = value;
/// }
/// }
///
/// impl CustomType for TestStruct {
/// fn build(mut builder: TypeBuilder<Self>) {
/// builder
/// // Register pretty-print name of the type
/// .with_name("TestStruct")
/// // Register display functions
/// .on_print(|v| format!("TestStruct({})", v.field))
/// .on_debug(|v| format!("{v:?}"))
/// // Register a constructor function
/// .with_fn("new_ts", Self::new)
/// // Register the 'update' method
/// .with_fn("update", Self::update)
/// // Register the 'value' property
/// .with_get_set("value", Self::get_value, Self::set_value);
/// }
/// }
///
/// # fn main() -> Result<(), Box<rhai::EvalAltResult>> {
/// let mut engine = Engine::new();
///
/// // Register API for the custom type.
/// engine.build_type::<TestStruct>();
///
/// assert_eq!(
/// engine.eval::<TestStruct>("let x = new_ts(); x.update(41); print(x); x")?,
/// TestStruct { field: 42 }
/// );
/// # Ok(())
/// # }
/// # }
/// ```
pub trait CustomType: Variant + Clone {
/// Builds the custom type for use with the [`Engine`].
///
/// Methods, property getters/setters, indexers etc. should be registered in this function.
fn build(builder: TypeBuilder<Self>);
}
impl Engine {
/// Build the API of a custom type for use with the [`Engine`].
///
/// The custom type must implement [`CustomType`].
#[inline]
pub fn build_type<T: CustomType>(&mut self) -> &mut Self {
T::build(TypeBuilder::new(self));
self
}
}
/// Builder to build the API of a custom type for use with an [`Engine`].
///
/// The type is automatically registered when this builder is dropped.
///
/// ## Pretty-Print Name
///
/// By default the type is registered with [`Engine::register_type`] (i.e. without a pretty-print name).
///
/// To define a pretty-print name, call [`with_name`][`TypeBuilder::with_name`],
/// to use [`Engine::register_type_with_name`] instead.
pub struct TypeBuilder<'a, T: Variant + Clone> {
engine: &'a mut Engine,
/// Keep the latest registered function(s) in cache to add additional metadata.
hashes: StaticVec<u64>,
_marker: PhantomData<T>,
}
impl<'a, T: Variant + Clone> TypeBuilder<'a, T> {
/// Create a [`TypeBuilder`] linked to a particular [`Engine`] instance.
#[inline(always)]
fn new(engine: &'a mut Engine) -> Self {
Self {
engine,
hashes: StaticVec::new_const(),
_marker: PhantomData,
}
}
}
impl<T: Variant + Clone> TypeBuilder<'_, T> {
/// Set a pretty-print name for the `type_of` function.
#[inline(always)]
pub fn with_name(&mut self, name: &str) -> &mut Self {
self.engine.register_type_with_name::<T>(name);
self
}
/// Set a comments for the type.
/// `TypeBuilder::with_name` must be called before this function, otherwise
/// the comments will not be registered.
///
/// Available with the metadata feature only.
#[cfg(feature = "metadata")]
#[inline(always)]
pub fn with_comments(&mut self, comments: &[&str]) -> &mut Self {
let namespace = self.engine.global_namespace_mut();
if let Some(name) = namespace
.get_custom_type_raw::<T>()
.map(|ty| ty.display_name.clone())
{
namespace.set_custom_type_with_comments::<T>(name.as_str(), comments);
}
self
}
/// Pretty-print this custom type.
#[inline(always)]
pub fn on_print(
&mut self,
on_print: impl Fn(&mut T) -> String + SendSync + 'static,
) -> &mut Self {
let FuncMetadata { hash, .. } =
FuncRegistration::new(FUNC_TO_STRING).register_into_engine(self.engine, on_print);
self.hashes.clear();
self.hashes.push(*hash);
self
}
/// Debug-print this custom type.
#[inline(always)]
pub fn on_debug(
&mut self,
on_debug: impl Fn(&mut T) -> String + SendSync + 'static,
) -> &mut Self {
let FuncMetadata { hash, .. } =
FuncRegistration::new(FUNC_TO_DEBUG).register_into_engine(self.engine, on_debug);
self.hashes.clear();
self.hashes.push(*hash);
self
}
/// Register a custom method.
#[inline(always)]
pub fn with_fn<A: 'static, const N: usize, const X: bool, R: Variant + Clone, const F: bool>(
&mut self,
name: impl AsRef<str> + Into<Identifier>,
method: impl RhaiNativeFunc<A, N, X, R, F> + SendSync + 'static,
) -> &mut Self {
let FuncMetadata { hash, .. } =
FuncRegistration::new(name).register_into_engine(self.engine, method);
self.hashes.clear();
self.hashes.push(*hash);
self
}
/// _(metadata)_ Add comments to the last registered function.
/// Available under the `metadata` feature only.
#[cfg(feature = "metadata")]
#[inline(always)]
pub fn and_comments(&mut self, comments: &[&str]) -> &mut Self {
let module = self.engine.global_namespace_mut();
for &hash in &self.hashes {
if let Some(f) = module.get_fn_metadata_mut(hash) {
f.comments = comments.into_iter().map(|&s| s.into()).collect();
}
}
self
}
}
impl<T> TypeBuilder<'_, T>
where
T: Variant + Clone + IntoIterator,
<T as IntoIterator>::Item: Variant + Clone,
{
/// Register a type iterator.
/// This is an advanced API.
#[inline(always)]
pub fn is_iterable(&mut self) -> &mut Self {
self.engine.register_iterator::<T>();
self
}
}
#[cfg(not(feature = "no_object"))]
impl<T: Variant + Clone> TypeBuilder<'_, T> {
/// Register a getter function.
///
/// The function signature must start with `&mut self` and not `&self`.
///
/// Not available under `no_object`.
#[inline(always)]
pub fn with_get<const X: bool, R: Variant + Clone, const F: bool>(
&mut self,
name: impl AsRef<str>,
get_fn: impl RhaiNativeFunc<(Mut<T>,), 1, X, R, F> + SendSync + 'static,
) -> &mut Self {
let FuncMetadata { hash, .. } =
FuncRegistration::new_getter(name).register_into_engine(self.engine, get_fn);
self.hashes.clear();
self.hashes.push(*hash);
self
}
/// Register a setter function.
///
/// Not available under `no_object`.
#[inline(always)]
pub fn with_set<const X: bool, R: Variant + Clone, const F: bool>(
&mut self,
name: impl AsRef<str>,
set_fn: impl RhaiNativeFunc<(Mut<T>, R), 2, X, (), F> + SendSync + 'static,
) -> &mut Self {
let FuncMetadata { hash, .. } =
FuncRegistration::new_setter(name).register_into_engine(self.engine, set_fn);
self.hashes.clear();
self.hashes.push(*hash);
self
}
/// Short-hand for registering both getter and setter functions.
///
/// All function signatures must start with `&mut self` and not `&self`.
///
/// Not available under `no_object`.
#[inline(always)]
pub fn with_get_set<
const X1: bool,
const X2: bool,
R: Variant + Clone,
const F1: bool,
const F2: bool,
>(
&mut self,
name: impl AsRef<str>,
get_fn: impl RhaiNativeFunc<(Mut<T>,), 1, X1, R, F1> + SendSync + 'static,
set_fn: impl RhaiNativeFunc<(Mut<T>, R), 2, X2, (), F2> + SendSync + 'static,
) -> &mut Self {
let hash_1 = FuncRegistration::new_getter(&name)
.register_into_engine(self.engine, get_fn)
.hash;
let hash_2 = FuncRegistration::new_setter(&name)
.register_into_engine(self.engine, set_fn)
.hash;
self.hashes.clear();
self.hashes.push(hash_1);
self.hashes.push(hash_2);
self
}
}
#[cfg(any(not(feature = "no_index"), not(feature = "no_object")))]
impl<T: Variant + Clone> TypeBuilder<'_, T> {
/// Register an index getter.
///
/// The function signature must start with `&mut self` and not `&self`.
///
/// Not available under both `no_index` and `no_object`.
#[inline(always)]
pub fn with_indexer_get<
IDX: Variant + Clone,
const X: bool,
R: Variant + Clone,
const F: bool,
>(
&mut self,
get_fn: impl RhaiNativeFunc<(Mut<T>, IDX), 2, X, R, F> + SendSync + 'static,
) -> &mut Self {
let FuncMetadata { hash, .. } =
FuncRegistration::new_index_getter().register_into_engine(self.engine, get_fn);
self.hashes.clear();
self.hashes.push(*hash);
self
}
/// Register an index setter.
///
/// Not available under both `no_index` and `no_object`.
#[inline(always)]
pub fn with_indexer_set<
IDX: Variant + Clone,
const X: bool,
R: Variant + Clone,
const F: bool,
>(
&mut self,
set_fn: impl RhaiNativeFunc<(Mut<T>, IDX, R), 3, X, (), F> + SendSync + 'static,
) -> &mut Self {
let FuncMetadata { hash, .. } =
FuncRegistration::new_index_setter().register_into_engine(self.engine, set_fn);
self.hashes.clear();
self.hashes.push(*hash);
self
}
/// Short-hand for registering both index getter and setter functions.
///
/// Not available under both `no_index` and `no_object`.
#[inline(always)]
pub fn with_indexer_get_set<
IDX: Variant + Clone,
const X1: bool,
const X2: bool,
R: Variant + Clone,
const F1: bool,
const F2: bool,
>(
&mut self,
get_fn: impl RhaiNativeFunc<(Mut<T>, IDX), 2, X1, R, F1> + SendSync + 'static,
set_fn: impl RhaiNativeFunc<(Mut<T>, IDX, R), 3, X2, (), F2> + SendSync + 'static,
) -> &mut Self {
let hash_1 = FuncRegistration::new_index_getter()
.register_into_engine(self.engine, get_fn)
.hash;
let hash_2 = FuncRegistration::new_index_setter()
.register_into_engine(self.engine, set_fn)
.hash;
self.hashes.clear();
self.hashes.push(hash_1);
self.hashes.push(hash_2);
self
}
}