Crate spl

Using SPL as a crate

SPL has a complete API for use in applications and libraries. To start a file, use start_file with the path, which is relatively straightforward, just like start_file_in_runtime, which is the same as start_file but doesn’t create and set a runtime.

To start code more customizably, you will have to create a stack and a runtime yourself, then call add_std to include the standard library.

Example:

use spl::*;
fn main() -> OError {
    Runtime::new().set();
    let mut stack = Stack::new();
    add_std(&mut stack)?;
    Words::new(vec![
        Word::Const(Value::Str("Hello, World!".to_owned())),
        Word::Call("println".to_owned(), /*pop result:*/ false, /*reference:*/ 0)
    ]).exec(&mut stack);
    Ok(())
}

Re-exports

• pub use lexer::*;
• pub use runtime::*;

Modules

• dyn_fns
• lexer
• mutex
• oxidizer
  This module creates a rust application that runs the desired SPL. At its current stage, this is just parsing and rewriting @rust functions from SPL into actual rust. The future plan is for this to effectively become a compiler.
• runtime
• sasm
• std_fns
• stdlib
• stream

Macros

• require_array
• require_array_on_stack
• require_int_on_stack
• require_mut_array
• require_mut_array_on_stack
• require_on_stack
• type_err

Functions

• add_std
  Include the standard library in a runtime-stack-pair, where the runtime has been .set().
• start_file
  Creates a runtime, lexes and executes some SPL code from a file, returning the stack that was used for the operations, which should be empty in most cases.
• start_file_in_runtime
  TO START A STANDALONE PIECE OF CODE, USE start_file!! Lexes and starts some SPL code from a file, returning the stack.