Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Code cleanup. #759

Merged
merged 11 commits into from
Sep 9, 2023
Merged

Code cleanup. #759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
385f9a6
Add rustfmt.toml to tests directory to format tests better for inspec…
schungx Sep 7, 2023
5be2e9e
Deprecate Module::get_custom_type.
schungx Sep 8, 2023
f7e89ac
Format deprecated API doc-comments.
schungx Sep 8, 2023
9ea14d5
Encapsulate CustomTypeInfo.
schungx Sep 8, 2023
66d16a0
Encapsulate VarDefInfo.
schungx Sep 8, 2023
da7ea1e
Implement Deserialize.
schungx Sep 8, 2023
b621640
Make CustomTypeInfo internals.
schungx Sep 8, 2023
7b9e3a6
Fine tune types.
schungx Sep 8, 2023
7147fa0
Shrink AST size.
schungx Sep 8, 2023
917a6ba
Remove unnecessary Deref/DerefMut.
schungx Sep 9, 2023
508012b
Ready 1.16.0
schungx Sep 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Deprecated API's
----------------

* `ParseErrorType::MalformedCallExpr` and `ParseErrorType::MalformedInExpr` are deprecated and will be removed in the next major version.
* `Module::get_custom_type` is deprecated in favor of `Module::get_custom_type_display_by_name` and other new methods.

New features
------------
Expand All @@ -43,14 +44,15 @@ New features
* Added `Engine::max_variables` and `Engine::set_max_variables` to limit the maximum number of variables allowed within a scope at any time. This is to guard against defining a huge number of variables containing large data just beyond individual data size limits. When `max_variables` is exceeded a new error, `ErrorTooManyVariables`, is returned.
* Added `zip` function for arrays.
* Added `on_print` and `on_debug` definitions for `TypeBuilder`.
* Doc-comments are now included in custom type definitions within plugin modules. They can be accessed via `Module::get_custom_type_comments`. These doc-comments for custom types are also exported in JSON via `Engine::gen_fn_metadata_to_json`.
* Doc-comments are now included in custom type definitions within plugin modules. They can be accessed via `Module::get_custom_type_raw`. These doc-comments for custom types are also exported in JSON via `Engine::gen_fn_metadata_to_json`.

Enhancements
------------

* [`once_cell`](https://crates.io/crates/once_cell) is used in `std` environments instead of the home-brew `SusLock` which is removed.
* Originally, unit tests use the `?` operator liberally to simplify code. However, this causes the loss of proper line numbers when a test fails, making it difficult to identify the exact location of the failure. This is now fixed by changing to `unwrap()`.
* Many inlined collections are turned back into `Vec` because they are not transient and do not appear to improve performance. Using `Vec` seems to be yield better performance as it probably enables more compiler optimizations.
* General code clean-up to remove optimizations tricks that are not obviously beneficial in favor of clearer code.


Version 1.15.1
Expand Down
1 change: 0 additions & 1 deletion src/api/build_type.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,6 @@ impl Engine {
///
/// To define a pretty-print name, call [`with_name`][`TypeBuilder::with_name`],
/// to use [`Engine::register_type_with_name`] instead.
#[must_use]
pub struct TypeBuilder<'a, T: Variant + Clone> {
engine: &'a mut Engine,
name: Option<&'static str>,
Expand Down
6 changes: 5 additions & 1 deletion src/api/call_fn.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ use std::{any::type_name, mem};
/// Options for calling a script-defined function via [`Engine::call_fn_with_options`].
#[derive(Debug, Hash)]
#[non_exhaustive]
#[must_use]
pub struct CallFnOptions<'t> {
/// A value for binding to the `this` pointer (if any). Default [`None`].
pub this_ptr: Option<&'t mut Dynamic>,
Expand All @@ -36,6 +35,7 @@ impl Default for CallFnOptions<'_> {
impl<'a> CallFnOptions<'a> {
/// Create a default [`CallFnOptions`].
#[inline(always)]
#[must_use]
pub fn new() -> Self {
Self {
this_ptr: None,
Expand All @@ -46,24 +46,28 @@ impl<'a> CallFnOptions<'a> {
}
/// Bind to the `this` pointer.
#[inline(always)]
#[must_use]
pub fn bind_this_ptr(mut self, value: &'a mut Dynamic) -> Self {
self.this_ptr = Some(value);
self
}
/// Set the custom state of this evaluation run (if any).
#[inline(always)]
#[must_use]
pub fn with_tag(mut self, value: impl Variant + Clone) -> Self {
self.tag = Some(Dynamic::from(value));
self
}
/// Set whether to evaluate the [`AST`] to load necessary modules before calling the function.
#[inline(always)]
#[must_use]
pub const fn eval_ast(mut self, value: bool) -> Self {
self.eval_ast = value;
self
}
/// Set whether to rewind the [`Scope`] after the function call.
#[inline(always)]
#[must_use]
pub const fn rewind_scope(mut self, value: bool) -> Self {
self.rewind_scope = value;
self
Expand Down
97 changes: 70 additions & 27 deletions src/api/deprecated.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ impl Engine {
///
/// # Deprecated
///
/// This method is deprecated. Use [`run_file`][Engine::run_file] instead.
/// This method is deprecated.
/// Use [`run_file`][Engine::run_file] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.1.0", note = "use `run_file` instead")]
Expand All @@ -43,7 +44,8 @@ impl Engine {
///
/// # Deprecated
///
/// This method is deprecated. Use [`run_file_with_scope`][Engine::run_file_with_scope] instead.
/// This method is deprecated.
/// Use [`run_file_with_scope`][Engine::run_file_with_scope] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.1.0", note = "use `run_file_with_scope` instead")]
Expand All @@ -59,7 +61,8 @@ impl Engine {
///
/// # Deprecated
///
/// This method is deprecated. Use [`run`][Engine::run] instead.
/// This method is deprecated.
/// Use [`run`][Engine::run] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.1.0", note = "use `run` instead")]
Expand All @@ -73,7 +76,8 @@ impl Engine {
///
/// # Deprecated
///
/// This method is deprecated. Use [`run_with_scope`][Engine::run_with_scope] instead.
/// This method is deprecated.
/// Use [`run_with_scope`][Engine::run_with_scope] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.1.0", note = "use `run_with_scope` instead")]
Expand All @@ -87,7 +91,8 @@ impl Engine {
///
/// # Deprecated
///
/// This method is deprecated. Use [`run_ast`][Engine::run_ast] instead.
/// This method is deprecated.
/// Use [`run_ast`][Engine::run_ast] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.1.0", note = "use `run_ast` instead")]
Expand All @@ -101,7 +106,8 @@ impl Engine {
///
/// # Deprecated
///
/// This method is deprecated. Use [`run_ast_with_scope`][Engine::run_ast_with_scope] instead.
/// This method is deprecated.
/// Use [`run_ast_with_scope`][Engine::run_ast_with_scope] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.1.0", note = "use `run_ast_with_scope` instead")]
Expand All @@ -118,7 +124,8 @@ impl Engine {
///
/// # Deprecated
///
/// This method is deprecated. Use [`call_fn_with_options`][Engine::call_fn_with_options] instead.
/// This method is deprecated.
/// Use [`call_fn_with_options`][Engine::call_fn_with_options] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.1.0", note = "use `call_fn_with_options` instead")]
Expand All @@ -142,7 +149,8 @@ impl Engine {
///
/// # Deprecated
///
/// This method is deprecated. Use [`call_fn_with_options`][Engine::call_fn_with_options] instead.
/// This method is deprecated.
/// Use [`call_fn_with_options`][Engine::call_fn_with_options] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.12.0", note = "use `call_fn_with_options` instead")]
Expand Down Expand Up @@ -181,7 +189,8 @@ impl Engine {
///
/// # Deprecated
///
/// This method is deprecated. Use [`register_fn`][Engine::register_fn] instead.
/// This method is deprecated.
/// Use [`register_fn`][Engine::register_fn] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.9.1", note = "use `register_fn` instead")]
Expand All @@ -201,7 +210,8 @@ impl Engine {
///
/// # Deprecated
///
/// This method is deprecated. Use [`register_get`][Engine::register_get] instead.
/// This method is deprecated.
/// Use [`register_get`][Engine::register_get] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.9.1", note = "use `register_get` instead")]
Expand All @@ -220,7 +230,8 @@ impl Engine {
///
/// # Deprecated
///
/// This method is deprecated. Use [`register_set`][Engine::register_set] instead.
/// This method is deprecated.
/// Use [`register_set`][Engine::register_set] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.9.1", note = "use `register_set` instead")]
Expand All @@ -241,7 +252,8 @@ impl Engine {
///
/// # Deprecated
///
/// This method is deprecated. Use [`register_indexer_get`][Engine::register_indexer_get] instead.
/// This method is deprecated.
/// Use [`register_indexer_get`][Engine::register_indexer_get] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.9.1", note = "use `register_indexer_get` instead")]
Expand All @@ -264,7 +276,8 @@ impl Engine {
///
/// # Deprecated
///
/// This method is deprecated. Use [`register_indexer_set`][Engine::register_indexer_set] instead.
/// This method is deprecated.
/// Use [`register_indexer_set`][Engine::register_indexer_set] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.9.1", note = "use `register_indexer_set` instead")]
Expand Down Expand Up @@ -340,7 +353,8 @@ impl Dynamic {
///
/// # Deprecated
///
/// This method is deprecated. Use [`into_string`][Dynamic::into_string] instead.
/// This method is deprecated.
/// Use [`into_string`][Dynamic::into_string] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.1.0", note = "use `into_string` instead")]
Expand All @@ -354,7 +368,8 @@ impl Dynamic {
///
/// # Deprecated
///
/// This method is deprecated. Use [`into_immutable_string`][Dynamic::into_immutable_string] instead.
/// This method is deprecated.
/// Use [`into_immutable_string`][Dynamic::into_immutable_string] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.1.0", note = "use `into_immutable_string` instead")]
Expand Down Expand Up @@ -389,7 +404,8 @@ impl NativeCallContext<'_> {
///
/// # Deprecated
///
/// This method is deprecated. Use [`call_fn_raw`][NativeCallContext::call_fn_raw] instead.
/// This method is deprecated.
/// Use [`call_fn_raw`][NativeCallContext::call_fn_raw] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.2.0", note = "use `call_fn_raw` instead")]
Expand Down Expand Up @@ -418,7 +434,8 @@ impl FnPtr {
///
/// # Deprecated
///
/// This method is deprecated. Use [`curry().len()`][`FnPtr::curry`] instead.
/// This method is deprecated.
/// Use [`curry().len()`][`FnPtr::curry`] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.8.0", note = "use `curry().len()` instead")]
Expand All @@ -436,8 +453,8 @@ impl FnPtr {
///
/// # Deprecated
///
/// This method is deprecated. Use [`call_within_context`][FnPtr::call_within_context] or
/// [`call_raw`][FnPtr::call_raw] instead.
/// This method is deprecated.
/// Use [`call_within_context`][FnPtr::call_within_context] or [`call_raw`][FnPtr::call_raw] instead.
///
/// This method will be removed in the next major version.
#[deprecated(
Expand All @@ -461,7 +478,8 @@ impl crate::Expression<'_> {
///
/// # Deprecated
///
/// This method is deprecated. Use [`get_string_value`][crate::Expression::get_string_value] instead.
/// This method is deprecated.
/// Use [`get_string_value`][crate::Expression::get_string_value] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.4.0", note = "use `get_string_value` instead")]
Expand All @@ -481,7 +499,8 @@ impl Position {
///
/// # Deprecated
///
/// This function is deprecated. Use [`new`][Position::new] (which panics when `line` is zero) instead.
/// This function is deprecated.
/// Use [`new`][Position::new] (which panics when `line` is zero) instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.6.0", note = "use `new` instead")]
Expand All @@ -502,7 +521,8 @@ impl<'a, T: Variant + Clone> TypeBuilder<'a, T> {
///
/// # Deprecated
///
/// This method is deprecated. Use `with_fn` instead.
/// This method is deprecated.
/// Use [`with_fn`][`TypeBuilder::with_fn`] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.9.1", note = "use `with_fn` instead")]
Expand All @@ -528,7 +548,8 @@ impl<'a, T: Variant + Clone> TypeBuilder<'a, T> {
///
/// # Deprecated
///
/// This method is deprecated. Use `with_get` instead.
/// This method is deprecated.
/// Use [`with_get`][`TypeBuilder::with_get`] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.9.1", note = "use `with_get` instead")]
Expand All @@ -548,7 +569,8 @@ impl<'a, T: Variant + Clone> TypeBuilder<'a, T> {
///
/// # Deprecated
///
/// This method is deprecated. Use `with_set` instead.
/// This method is deprecated.
/// Use [`with_set`][`TypeBuilder::with_set`] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.9.1", note = "use `with_set` instead")]
Expand All @@ -570,7 +592,8 @@ impl<'a, T: Variant + Clone> TypeBuilder<'a, T> {
///
/// # Deprecated
///
/// This method is deprecated. Use `with_indexer_get` instead.
/// This method is deprecated.
/// Use [`with_indexer_get`][`TypeBuilder::with_indexer_get`] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.9.1", note = "use `with_indexer_get` instead")]
Expand All @@ -589,7 +612,8 @@ impl<'a, T: Variant + Clone> TypeBuilder<'a, T> {
///
/// # Deprecated
///
/// This method is deprecated. Use `with_indexer_set` instead.
/// This method is deprecated.
/// Use [`with_indexer_set`][`TypeBuilder::with_indexer_set`] instead.
///
/// This method will be removed in the next major version.
#[deprecated(since = "1.9.1", note = "use `with_indexer_set` instead")]
Expand All @@ -608,7 +632,8 @@ impl Module {
///
/// # Deprecated
///
/// This method is deprecated. Use `new` instead.
/// This method is deprecated.
/// Use [`new`][`Module::new`] instead.
///
/// This method will be removed in the next major version.
#[inline(always)]
Expand All @@ -617,6 +642,24 @@ impl Module {
pub const fn with_capacity(_capacity: usize) -> Self {
Self::new()
}

/// Get the display name of a registered custom type.
///
/// # Deprecated
///
/// This method is deprecated.
/// Use [`get_custom_type_display_by_name`][`Module::get_custom_type_display_by_name`] instead.
///
/// This method will be removed in the next major version.
#[inline(always)]
#[must_use]
#[deprecated(
since = "1.16.0",
note = "use `get_custom_type_display_by_name` instead"
)]
pub fn get_custom_type(&self, type_name: &str) -> Option<&str> {
self.get_custom_type_display_by_name(type_name)
}
}

#[cfg(not(feature = "no_index"))]
Expand Down
Loading
Loading