fomoscript

Crates.iofomoscript
lib.rsfomoscript
version0.2.5
sourcesrc
created_at2023-08-31 21:29:23.986559
updated_at2023-09-04 20:22:21.716825
descriptionToy scripting language
homepagehttps://github.com/Ruddle/fomoscript
repositoryhttps://github.com/Ruddle/fomoscript
max_upload_size
id960417
size46,984
Thomas SIMON (Ruddle)

documentation

README

Crates.io

fomoscript

Toy scripting language, built with Rust

  • 0 dependencies*
  • 1 file
  • no_std with alloc

Only a few days old. Not production ready. One goal is to use it in Fomos as a shell. But you can ship it anywhere.

* except log, doesn't count ;)

Demo inside Fomos

https://github.com/Ruddle/fomoscript/assets/14235713/a69e00cd-1985-4a54-9f75-e1e91a19949a

Examples

Simple script

{
    let x = 0
    while x<5 {
        x = x+1
    }
    x
}

returns 5

Support of higher order functions

{
    let x = 0
    let f = (e) => {e+1}
    let g = (f,e) => f(e)
    g(f,x)
}

returns 1

Usage

Add this to your Cargo.toml:

[dependencies]
fomoscript = "0.2.4"

Parse and evaluate a script:

let result = fomoscript::parse_eval("{
    let x = 0
    while x<5 {
        x = x+1
    }
    x
}");

The result will have this type.

Go see the tests for more examples.

parse_eval is a high level function hiding the lower level Ctx.

You can explicitly instantiate an interpreter called Ctx to implement a REPL or explore/modify the state during execution.

By default, there is no side effect possible from the script during eval (except inside ctx)

You can insert native rust closure with (or without) side effects into the Ctx, and use it from inside the script. Example with the print function:

use fomoscript::*;
let code = r#"
{
    my_print(1+1)
}
"#;

let mut ctx = Ctx::new();
ctx.insert_code(code);

let print_closure = Rc::new(|a: N, _, _, _| {
    println!("{}", a.to_str());
    N::Unit
});
ctx.set_val("my_print", N::FuncNativeDef(Native(print_closure)));

let expr = ctx.parse_next_expr().unwrap();
let _ = eval(&expr, &mut ctx);

REPL

Build your own REPL with this code snippet. For simplicity, std is used here, but you can replace it with any input and output impl.

use fomoscript::*;
let mut ctx = Ctx::new();
let mut buffer = String::new();
loop {
    buffer.clear();
    std::io::stdin().read_line(&mut buffer).unwrap();
    ctx.insert_code(&buffer);
    while let Ok(parent) = ctx.parse_next_expr() {
        let res = eval(&parent, &mut ctx);
        println!("> {:?}", res);
    }
}

Cruelly missing

  • Standard library
  • Javascript-like objects
  • Error handling
  • Escape characters in quoted strings
  • Months of work
  • Pattern matching

Also the inner workings are not very rust-like, no unsafe though ;) Should be panic free during eval. Don't trust the parser just yet.

Features

  • String type
  • Number type (f64)
  • Scoped variable assignment
  • Binary operators +,-,/,*,>,<,==,!=,&,|
  • Operator precedence
  • Higher order function
  • Control flow if/else/while
  • Custom native function
  • Anonymous function call$
  • REPL example
  • Arrays

Performance

Parsing is instantaneous (50+GB/sec).

Evaluation is slow, but reasonable for scripting:

  • Worst case 1:1000 compared to native
  • Common case 1:20 when using native functions reasonably.

See for yourself with cargo bench

Unstructured number crunching will stay slow. Typed arrays (like in js) could be added in the future for fast structured operation.

Fun facts

Everything is an expression in fomoscript. For instance if/else acts as a ternary operator.

let x= if 1 99 else 45

now x is 99

When there is a doubt, the interpreter defaults to N::Unit. For instance let's not put an else branch:

let x= if 0 1

x is now N::Unit

No parenthesis needed for the if condition or body, the previous expression is equivalent to:

let x = if 0 {
    1
} else {
    N::Unit
}

Same goes for while, it returns N::Unit if it never runs the body, or the last body expression if it runs at least once.

Same goes for brackets :

let x = {1 2 3} is equivalent to let x = {3} or let x = 3 or

let x = {
    1
    2
    3
}

There is no parenthesis, use brackets to force factorization, precedence, and remove any ambiguity.

\n is just a whitespace like space. It doesn't separate statements more than space, unlike most languages.

Boolean operation automatically cast operand to bool (lookup to_bool to see how)

the (and,or) operators are (&,|)

1 & 0 evaluate to 0

1 | 0 evaluate to 1

No bitwise operation yet.

Arrays

Concatenation

[1,2,3] ++ [4,5,6]

returns [1,2,3,4,5,6]

Push

[1,2,3] + 4

returns [1,2,3,4]

[1,2,3] + [4,5,6]

returns [1,2,3,[4,5,6]]

Prepend

4 + [1,2,3]

returns [4,1,2,3]

Get

[1,2,3](1)

returns 2

Get in reverse order

[1,2,3](-1)

returns 3

Map

[1,2,3]((e) => e*2)

returns [2,4,6]

2nd argument is the index of the element:

[1,2,3]((e,i) => i)

returns [0,1,2]

Filter

[1,2,3] & (e)=> e<3

returns [1,2]

[1,2,3] & (e,i)=> i!=1

returns [1,3]

Reduce

[1,2,3,4] | (a,b)=> a+b

returns 10

["hello","beautiful", "world"] | (a,b) => a+" "+b

returns "hello beautiful world"

Length

[0,1,2]()

returns 3

Commit count: 25

cargo fmt