kjuulh/rhai
1
0
Fork 0
Code Issues 1 Pull Requests 1 Packages Projects Releases Wiki Activity

Update URL links.

Browse Source
This commit is contained in:
Stephen Chung 2021-01-07 17:30:06 +08:00
parent 67a85a19ae
commit 96b1e7777b
14 changed files with 54 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Cargo.toml
View File

@ -10,8 +10,8 @@ version = "0.19.10"
edition = "2018" edition = "2018"
authors = ["Jonathan Turner", "Lukáš Hozda", "Stephen Chung", "jhwgh1968"] authors = ["Jonathan Turner", "Lukáš Hozda", "Stephen Chung", "jhwgh1968"]
description = "Embedded scripting for Rust" description = "Embedded scripting for Rust"
homepage = "https://schungx.github.io/rhai" homepage = "https://rhaiscript.github.io/book"
repository = "https://github.com/jonathandturner/rhai" repository = "https://github.com/rhaiscript/rhai"
readme = "README.md" readme = "README.md"
license = "MIT OR Apache-2.0" license = "MIT OR Apache-2.0"
include = [ include = [

50
README.md
View File

@ -1,16 +1,16 @@
Rhai - Embedded Scripting for Rust Rhai - Embedded Scripting for Rust
================================= =================================
![GitHub last commit](https://img.shields.io/github/last-commit/jonathandturner/rhai?logo=github) ![GitHub last commit](https://img.shields.io/github/last-commit/rhaiscript/rhai?logo=github)
[![Build Status](https://github.com/jonathandturner/rhai/workflows/Build/badge.svg)](https://github.com/jonathandturner/rhai/actions) [![Build Status](https://github.com/rhaiscript/rhai/workflows/Build/badge.svg)](https://github.com/rhaiscript/rhai/actions)
[![license](https://img.shields.io/crates/l/rhai)](https://github.com/license/jonathandturner/rhai) [![license](https://img.shields.io/crates/l/rhai)](https://github.com/license/rhaiscript/rhai)
[![crates.io](https://img.shields.io/crates/v/rhai?logo=rust)](https://crates.io/crates/rhai/) [![crates.io](https://img.shields.io/crates/v/rhai?logo=rust)](https://crates.io/crates/rhai/)
[![crates.io](https://img.shields.io/crates/d/rhai?logo=rust)](https://crates.io/crates/rhai/) [![crates.io](https://img.shields.io/crates/d/rhai?logo=rust)](https://crates.io/crates/rhai/)
[![API Docs](https://docs.rs/rhai/badge.svg?logo=docs.rs)](https://docs.rs/rhai/) [![API Docs](https://docs.rs/rhai/badge.svg?logo=docs.rs)](https://docs.rs/rhai/)
[![chat](https://img.shields.io/discord/767611025456889857.svg?logo=discord)](https://discord.gg/HquqbYFcZ9) [![chat](https://img.shields.io/discord/767611025456889857.svg?logo=discord)](https://discord.gg/HquqbYFcZ9)
[![Reddit](https://img.shields.io/reddit/subreddit-subscribers/Rhai?logo=reddit)](https://www.reddit.com/r/Rhai) [![Reddit](https://img.shields.io/reddit/subreddit-subscribers/Rhai?logo=reddit)](https://www.reddit.com/r/Rhai)
![Rhai logo](https://schungx.github.io/rhai/images/logo/rhai-banner-transparent-colour.svg) ![Rhai logo](https://rhaiscript.github.io/book/images/logo/rhai-banner-transparent-colour.svg)
Rhai is an embedded scripting language and evaluation engine for Rust that gives a safe and easy way Rhai is an embedded scripting language and evaluation engine for Rust that gives a safe and easy way
to add scripting to any application. to add scripting to any application.
@ -31,44 +31,44 @@ Standard features
* Easy-to-use language similar to JavaScript+Rust with dynamic typing. * Easy-to-use language similar to JavaScript+Rust with dynamic typing.
* Fairly low compile-time overhead. * Fairly low compile-time overhead.
* Fairly efficient evaluation (1 million iterations in 0.3 sec on a single core, 2.3 GHz Linux VM). * Fairly efficient evaluation (1 million iterations in 0.3 sec on a single core, 2.3 GHz Linux VM).
* Tight integration with native Rust [functions](https://schungx.github.io/rhai/rust/functions.html) and [types]([#custom-types-and-methods](https://schungx.github.io/rhai/rust/custom.html)), including [getters/setters](https://schungx.github.io/rhai/rust/getters-setters.html), [methods](https://schungx.github.io/rhai/rust/custom.html) and [indexers](https://schungx.github.io/rhai/rust/indexers.html). * Tight integration with native Rust [functions](https://rhaiscript.github.io/book/rust/functions.html) and [types]([#custom-types-and-methods](https://rhaiscript.github.io/book/rust/custom.html)), including [getters/setters](https://rhaiscript.github.io/book/rust/getters-setters.html), [methods](https://rhaiscript.github.io/book/rust/custom.html) and [indexers](https://rhaiscript.github.io/book/rust/indexers.html).
* Freely pass Rust variables/constants into a script via an external [`Scope`](https://schungx.github.io/rhai/rust/scope.html) - all clonable Rust types are supported; no need to implement any special trait. * Freely pass Rust variables/constants into a script via an external [`Scope`](https://rhaiscript.github.io/book/rust/scope.html) - all clonable Rust types are supported; no need to implement any special trait.
* Easily [call a script-defined function](https://schungx.github.io/rhai/engine/call-fn.html) from Rust. * Easily [call a script-defined function](https://rhaiscript.github.io/book/engine/call-fn.html) from Rust.
* Relatively little `unsafe` code (yes there are some for performance reasons). * Relatively little `unsafe` code (yes there are some for performance reasons).
* Few dependencies (currently only [`smallvec`](https://crates.io/crates/smallvec)). * Few dependencies (currently only [`smallvec`](https://crates.io/crates/smallvec)).
* Re-entrant scripting engine can be made `Send + Sync` (via the `sync` feature). * Re-entrant scripting engine can be made `Send + Sync` (via the `sync` feature).
* Scripts are [optimized](https://schungx.github.io/rhai/engine/optimize.html) (useful for template-based machine-generated scripts) for repeated evaluations. * Scripts are [optimized](https://rhaiscript.github.io/book/engine/optimize.html) (useful for template-based machine-generated scripts) for repeated evaluations.
* Easy custom API development via [plugins](https://schungx.github.io/rhai/plugins/index.html) system powered by procedural macros. * Easy custom API development via [plugins](https://rhaiscript.github.io/book/plugins/index.html) system powered by procedural macros.
* [Function overloading](https://schungx.github.io/rhai/language/overload.html) and [operator overloading](https://schungx.github.io/rhai/rust/operators.html). * [Function overloading](https://rhaiscript.github.io/book/language/overload.html) and [operator overloading](https://rhaiscript.github.io/book/rust/operators.html).
* Dynamic dispatch via [function pointers](https://schungx.github.io/rhai/language/fn-ptr.html) with additional support for [currying](https://schungx.github.io/rhai/language/fn-curry.html). * Dynamic dispatch via [function pointers](https://rhaiscript.github.io/book/language/fn-ptr.html) with additional support for [currying](https://rhaiscript.github.io/book/language/fn-curry.html).
* [Closures](https://schungx.github.io/rhai/language/fn-closure.html) (anonymous functions) that can capture shared values. * [Closures](https://rhaiscript.github.io/book/language/fn-closure.html) (anonymous functions) that can capture shared values.
* Some syntactic support for [object-oriented programming (OOP)](https://schungx.github.io/rhai/language/oop.html). * Some syntactic support for [object-oriented programming (OOP)](https://rhaiscript.github.io/book/language/oop.html).
* Organize code base with dynamically-loadable [modules](https://schungx.github.io/rhai/language/modules.html). * Organize code base with dynamically-loadable [modules](https://rhaiscript.github.io/book/language/modules.html).
* Serialization/deserialization support via [serde](https://crates.io/crates/serde) (requires the `serde` feature). * Serialization/deserialization support via [serde](https://crates.io/crates/serde) (requires the `serde` feature).
* Support for [minimal builds](https://schungx.github.io/rhai/start/builds/minimal.html) by excluding unneeded language [features](https://schungx.github.io/rhai/start/features.html). * Support for [minimal builds](https://rhaiscript.github.io/book/start/builds/minimal.html) by excluding unneeded language [features](https://rhaiscript.github.io/book/start/features.html).
Protected against attacks Protected against attacks
------------------------- -------------------------
* Sand-boxed - the scripting engine, if declared immutable, cannot mutate the containing environment unless [explicitly permitted](https://schungx.github.io/rhai/patterns/control.html). * Sand-boxed - the scripting engine, if declared immutable, cannot mutate the containing environment unless [explicitly permitted](https://rhaiscript.github.io/book/patterns/control.html).
* Rugged - protected against malicious attacks (such as [stack-overflow](https://schungx.github.io/rhai/safety/max-call-stack.html), [over-sized data](https://schungx.github.io/rhai/safety/max-string-size.html), and [runaway scripts](https://schungx.github.io/rhai/safety/max-operations.html) etc.) that may come from untrusted third-party user-land scripts. * Rugged - protected against malicious attacks (such as [stack-overflow](https://rhaiscript.github.io/book/safety/max-call-stack.html), [over-sized data](https://rhaiscript.github.io/book/safety/max-string-size.html), and [runaway scripts](https://rhaiscript.github.io/book/safety/max-operations.html) etc.) that may come from untrusted third-party user-land scripts.
* Track script evaluation [progress](https://schungx.github.io/rhai/safety/progress.html) and manually terminate a script run. * Track script evaluation [progress](https://rhaiscript.github.io/book/safety/progress.html) and manually terminate a script run.
For those who actually want their own language For those who actually want their own language
--------------------------------------------- ---------------------------------------------
* Use as a [DSL](https://schungx.github.io/rhai/engine/dsl.html). * Use as a [DSL](https://rhaiscript.github.io/book/engine/dsl.html).
* Restrict the language by surgically [disabling keywords and operators](https://schungx.github.io/rhai/engine/disable.html). * Restrict the language by surgically [disabling keywords and operators](https://rhaiscript.github.io/book/engine/disable.html).
* Define [custom operators](https://schungx.github.io/rhai/engine/custom-op.html). * Define [custom operators](https://rhaiscript.github.io/book/engine/custom-op.html).
* Extend the language with [custom syntax](https://schungx.github.io/rhai/engine/custom-syntax.html). * Extend the language with [custom syntax](https://rhaiscript.github.io/book/engine/custom-syntax.html).
Documentation Documentation
------------- -------------
See [The Rhai Book](https://schungx.github.io/rhai) for details on the Rhai scripting engine and language. See [The Rhai Book](https://rhaiscript.github.io/book) for details on the Rhai scripting engine and language.
To build _The Book_, first install [`mdbook`](https://github.com/rust-lang/mdBook) To build _The Book_, first install [`mdbook`](https://github.com/rust-lang/mdBook)
and [`mdbook-tera`](https://github.com/avitex/mdbook-tera) (for templating). and [`mdbook-tera`](https://github.com/avitex/mdbook-tera) (for templating).
@ -87,8 +87,8 @@ License
Licensed under either of the following, at your choice: Licensed under either of the following, at your choice:
* [Apache License, Version 2.0](https://github.com/jonathandturner/rhai/blob/master/LICENSE-APACHE.txt), or * [Apache License, Version 2.0](https://github.com/rhaiscript/rhai/blob/master/LICENSE-APACHE.txt), or
* [MIT license](https://github.com/jonathandturner/rhai/blob/master/LICENSE-MIT.txt) * [MIT license](https://github.com/rhaiscript/rhai/blob/master/LICENSE-MIT.txt)
Unless explicitly stated otherwise, any contribution intentionally submitted Unless explicitly stated otherwise, any contribution intentionally submitted
for inclusion in this crate, as defined in the Apache-2.0 license, shall for inclusion in this crate, as defined in the Apache-2.0 license, shall

4
RELEASES.md
View File

@ -480,7 +480,7 @@ Version 0.16.0
The major new feature in this version is OOP - well, poor man's OOP, that is. The major new feature in this version is OOP - well, poor man's OOP, that is.
The `README` is officially transferred to [The Rhai Book](https://schungx.github.io/rhai). The `README` is officially transferred to [The Rhai Book](https://rhaiscript.github.io/book).
An online [Playground](https://alvinhochun.github.io/rhai-demo/) is available. An online [Playground](https://alvinhochun.github.io/rhai-demo/) is available.
@ -505,7 +505,7 @@ New features
Enhancements Enhancements
------------ ------------
* [The Rhai Book](https://schungx.github.io/rhai) is online. Most content in the original `README` was transferred to the Book. * [The Rhai Book](https://rhaiscript.github.io/book) is online. Most content in the original `README` was transferred to the Book.
* New feature `internals` to expose internal data structures (e.g. the AST nodes). * New feature `internals` to expose internal data structures (e.g. the AST nodes).

4
codegen/Cargo.toml
View File

@ -4,8 +4,8 @@ version = "0.3.1"
edition = "2018" edition = "2018"
authors = ["jhwgh1968"] authors = ["jhwgh1968"]
description = "Procedural macro support package for Rhai, a scripting language for Rust" description = "Procedural macro support package for Rhai, a scripting language for Rust"
homepage = "https://schungx.github.io/rhai/plugins/index.html" homepage = "https://rhaiscript.github.io/book/plugins/index.html"
repository = "https://github.com/jonathandturner/rhai" repository = "https://github.com/rhaiscript/rhai"
license = "MIT OR Apache-2.0" license = "MIT OR Apache-2.0"
[lib] [lib]

2
codegen/README.md
View File

@ -2,4 +2,4 @@ Procedural Macros for Plugins
============================= =============================
This crate holds procedural macros for code generation, supporting the plugins system This crate holds procedural macros for code generation, supporting the plugins system
for [Rhai](https://github.com/jonathandturner/rhai). for [Rhai](https://github.com/rhaiscript/rhai).

8
doc/README.md
View File

@ -1,7 +1,7 @@
The Rhai Book The Rhai Book
============= =============
[_The Rhai Book_](https://schungx.github.io/rhai) serves as Rhai's primary [_The Rhai Book_](https://rhaiscript.github.io/book) serves as Rhai's primary
documentation and tutorial resource. documentation and tutorial resource.
@ -34,8 +34,8 @@ Configuration Settings
Settings stored in `context.json`: Settings stored in `context.json`:
| Setting | Description | | Setting | Description |
| ---------- | ------------------------------------------------------------------------------------------------- | | ---------- | -------------------------------------------------------------------------------------------- |
| `version` | version of Rhai | | `version` | version of Rhai |
| `repoHome` | points to the [root of the GitHub repo](https://github.com/jonathandturner/rhai/blob/master) | | `repoHome` | points to the [root of the GitHub repo](https://github.com/rhaiscript/rhai/blob/master) |
| `repoTree` | points to the [root of the GitHub repo tree](https://github.com/jonathandturner/rhai/tree/master) | | `repoTree` | points to the [root of the GitHub repo tree](https://github.com/rhaiscript/rhai/tree/master) |
| `rootUrl` | sub-directory for the root domain, e.g. `/rhai` | | `rootUrl` | sub-directory for the root domain, e.g. `/rhai` |

2
doc/book.toml
View File

@ -6,7 +6,7 @@ language = "en"
[output.html] [output.html]
no-section-label = true no-section-label = true
git-repository-url = "https://github.com/jonathandturner/rhai" git-repository-url = "https://github.com/rhaiscript/rhai"
curly-quotes = true curly-quotes = true
[output.html.fold] [output.html.fold]

2
doc/src/about/related.md
View File

@ -7,7 +7,7 @@ Related Resources
Online Resources for Rhai Online Resources for Rhai
------------------------- -------------------------
* [GitHub](https://github.com/jonathandturner/rhai) – Home repository * [GitHub](https://github.com/rhaiscript/rhai) – Home repository
* [`crates.io`](https://crates.io/crates/rhai) – Rhai crate * [`crates.io`](https://crates.io/crates/rhai) – Rhai crate

4
doc/src/context.json
View File

@ -1,7 +1,7 @@
{ {
"version": "0.19.10", "version": "0.19.10",
"repoHome": "https://github.com/jonathandturner/rhai/blob/master", "repoHome": "https://github.com/rhaiscript/rhai/blob/master",
"repoTree": "https://github.com/jonathandturner/rhai/tree/master", "repoTree": "https://github.com/rhaiscript/rhai/tree/master",
"rootUrl": "", "rootUrl": "",
"rootUrlX": "/rhai", "rootUrlX": "/rhai",
"rootUrlXX": "/rhai/vnext" "rootUrlXX": "/rhai/vnext"

8
doc/src/patterns/multiple.md
View File

@ -47,18 +47,18 @@ a different [features] set, by their _sources_:
* Different versions from [`crates.io`](https://crates.io/crates/rhai/) – The official crate. * Different versions from [`crates.io`](https://crates.io/crates/rhai/) – The official crate.
* Different releases from [`GitHub`](https://github.com/jonathandturner/rhai) – Crate source on GitHub. * Different releases from [`GitHub`](https://github.com/rhaiscript/rhai) – Crate source on GitHub.
* Forked copy of [https://github.com/jonathandturner/rhai](https://github.com/jonathandturner/rhai) on GitHub. * Forked copy of [https://github.com/rhaiscript/rhai](https://github.com/rhaiscript/rhai) on GitHub.
* Local copy of [https://github.com/jonathandturner/rhai](https://github.com/jonathandturner/rhai) downloaded form GitHub. * Local copy of [https://github.com/rhaiscript/rhai](https://github.com/rhaiscript/rhai) downloaded form GitHub.
Use the following configuration in `Cargo.toml` to pull in multiple copies of Rhai within the same project: Use the following configuration in `Cargo.toml` to pull in multiple copies of Rhai within the same project:
```toml ```toml
[dependencies] [dependencies]
rhai = { version = "{{version}}", features = [ "no_float" ] } rhai = { version = "{{version}}", features = [ "no_float" ] }
rhai_github = { git = "https://github.com/jonathandturner/rhai", features = [ "unchecked" ] } rhai_github = { git = "https://github.com/rhaiscript/rhai", features = [ "unchecked" ] }
rhai_my_github = { git = "https://github.com/my_github/rhai", branch = "variation1", features = [ "serde", "no_closure" ] } rhai_my_github = { git = "https://github.com/my_github/rhai", branch = "variation1", features = [ "serde", "no_closure" ] }
rhai_local = { path = "../rhai_copy" } rhai_local = { path = "../rhai_copy" }
``` ```

4
doc/src/start/install.md
View File

@ -22,9 +22,9 @@ rhai = "*"
Crate versions are released on [`crates.io`](https:/crates.io/crates/rhai/) infrequently, Crate versions are released on [`crates.io`](https:/crates.io/crates/rhai/) infrequently,
so to track the latest features, enhancements and bug fixes, pull directly from so to track the latest features, enhancements and bug fixes, pull directly from
[GitHub](https://github.com/jonathandturner/rhai): [GitHub](https://github.com/rhaiscript/rhai):
```toml ```toml
[dependencies] [dependencies]
rhai = { git = "https://github.com/jonathandturner/rhai" } rhai = { git = "https://github.com/rhaiscript/rhai" }
``` ```

4
no_std/no_std_test/Cargo.toml
View File

@ -8,8 +8,8 @@ version = "0.1.0"
edition = "2018" edition = "2018"
authors = ["Stephen Chung"] authors = ["Stephen Chung"]
description = "no-std test application" description = "no-std test application"
homepage = "https://github.com/jonathandturner/rhai/tree/no_std/no_std_test" homepage = "https://github.com/rhaiscript/rhai/tree/no_std/no_std_test"
repository = "https://github.com/jonathandturner/rhai" repository = "https://github.com/rhaiscript/rhai"
[dependencies] [dependencies]
rhai = { path = "../../", features = [ "no_std" ], default_features = false } rhai = { path = "../../", features = [ "no_std" ], default_features = false }

4
src/lib.rs
View File

@ -1,6 +1,6 @@
//! # Rhai - embedded scripting for Rust //! # Rhai - embedded scripting for Rust
//! //!
//! ![Rhai logo](https://schungx.github.io/rhai/images/logo/rhai-banner-transparent-colour.svg) //! ![Rhai logo](https://rhaiscript.github.io/book/images/logo/rhai-banner-transparent-colour.svg)
//! //!
//! Rhai is a tiny, simple and fast embedded scripting language for Rust //! Rhai is a tiny, simple and fast embedded scripting language for Rust
//! that gives you a safe and easy way to add scripting to your applications. //! that gives you a safe and easy way to add scripting to your applications.
@ -54,7 +54,7 @@
//! //!
//! # Documentation //! # Documentation
//! //!
//! See [The Rhai Book](https://schungx.github.io/rhai) for details on the Rhai scripting engine and language. //! See [The Rhai Book](https://rhaiscript.github.io/book) for details on the Rhai scripting engine and language.
#![cfg_attr(feature = "no_std", no_std)] #![cfg_attr(feature = "no_std", no_std)]

2
tests/expressions.rs
View File

@ -26,7 +26,7 @@ fn test_expressions() -> Result<(), Box<EvalAltResult>> {
Ok(()) Ok(())
} }
/// This example taken from https://github.com/jonathandturner/rhai/issues/115 /// This example taken from https://github.com/rhaiscript/rhai/issues/115
#[test] #[test]
#[cfg(not(feature = "no_object"))] #[cfg(not(feature = "no_object"))]
fn test_expressions_eval() -> Result<(), Box<EvalAltResult>> { fn test_expressions_eval() -> Result<(), Box<EvalAltResult>> {