kjuulh/rhai
1
0
Fork 0
Code Issues 1 Pull Requests 1 Packages Projects Releases Wiki Activity
0206f776db
rhai/src/README.md

32 lines
1.8 KiB
Markdown
Raw Normal View History

Split Engine into eval folder.
2022-01-07 04:43:47 +01:00
Source Structure
================
Fix builds.
2022-01-07 05:19:01 +01:00
Root Sources
------------
Split Engine into eval folder.
2022-01-07 04:43:47 +01:00
| Source file | Description |
| -------------- | ------------------------------------------------------------------------------- |
| `lib.rs` | Crate root |
| `engine.rs` | The scripting engine, defines the `Engine` type |
| `tokenizer.rs` | Script tokenizer/lexer |
| `parser.rs` | Script parser |
| `optimizer.rs` | Script optimizer |
Remove unsound casting functions The casting functions in `unsafe.rs` were unsound (i.e., they allowed safe code to cause undefined behavior). While they did appear to be used in a way that wouldn't cause UB the fact that there exists unsound functions is unsettling. This commit removes those functions and replaces it with a macro that performs the same reification - the difference is that the macro call will also include the checks which are required to prevent UB. A macro was chosen instead of a function for two reasons: 1. A macro can keep the same code generation whereas a function would require going through an `Option` which has negative impacts on code generation (niche values cause poor DCE). 2. There exist other `unsafe` code blocks in the crate and an attempt to make Rhai 100% safe is completely out-of-scope for this merge request, so we may as well use `unsafe` in the macro. Regarding (2) above, I may come back at a later date with a 100% safe `reify` function but only once the other `unsafe` blocks are removed. For posterity, said function would look something like: ```rust fn reify<A: Any, C>(value: A) -> Option<C> { let mut v = Some(value); let v: &mut dyn Any = &mut v; v.downcast_mut::<Option<C>>().map(Option::take) } ```
2022-02-06 01:29:05 +01:00
| `reify.rs` | Utilities for making generic types concrete |
Split Engine into eval folder.
2022-01-07 04:43:47 +01:00
| `tests.rs` | Unit tests (not integration tests, which are in the `rhai/tests` sub-directory) |
Fix builds.
2022-01-07 05:19:01 +01:00
Sub-Directories
---------------
Split Engine into eval folder.
2022-01-07 04:43:47 +01:00
| Sub-directory | Description |
| ------------- | ----------------------------------------------------- |
| `types` | Common data types (e.g. `Dynamic`, errors) |
| `api` | Public API for the scripting engine |
| `ast` | AST definition |
| `module` | Support for modules |
| `packages` | Pre-defined packages |
| `func` | Support for function calls |
| `eval` | Evaluation engine |
| `serde` | Support for [`serde`](https://crates.io/crates/serde) |
| `bin` | Pre-built CLI binaries (e.g. `rhai-run`, `rhai-repl`) |
Reference in New Issue Copy Permalink