https://github.com/lofcz/sxscript
Embeddable scripting language for C#. WIP. Goals: async/await, il bytecode, safe by default, performance.
https://github.com/lofcz/sxscript
ast bytecode csharp embeddable-scripting-language evaluation language scripting
Last synced: 4 months ago
JSON representation
Embeddable scripting language for C#. WIP. Goals: async/await, il bytecode, safe by default, performance.
- Host: GitHub
- URL: https://github.com/lofcz/sxscript
- Owner: lofcz
- Created: 2021-10-01T23:38:40.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-11-28T02:32:38.000Z (over 3 years ago)
- Last Synced: 2025-02-15T18:58:25.198Z (4 months ago)
- Topics: ast, bytecode, csharp, embeddable-scripting-language, evaluation, language, scripting
- Language: C#
- Homepage:
- Size: 456 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SxScript
Embeddable scripting language for C# written in C#.
```
Install-Package SxScript
```
Hello world:
```csharp
SxScript.SxScript script = new SxScript.SxScript();
string stdout = await script.Interpret("print \"hello world\"");
```
First 10 Fibonacci numbers, recursive:
```csharp
function fib(n) {
if (n <= 1) return n;
return fib(n - 2) + fib(n - 1);
}
for (var i = 0; i < 10; i++) {
print fib(i);
}
// result: 0 1 1 2 3 5 8 13 21 34
```
Check https://github.com/lofcz/sxscript/tree/master/SxScriptTests/Programs for more programs.
### Goals of this project are (in order of priority, desc)
- good test coverage
- support both adhoc evaluation and il bytecode + vm
- high IO throughput via async/await
- safe by default, require explicit whitelisting of CLR interop
- allow limitation of execution time, memory used, intructions executed, recursion depth, enumerables length, iterations in looping statements
- syntactically be a relaxed subset of C# (inclined towards Lua, JS)
- visitable AST
### Progress tracker
- statements
- branching
- [x] if
- [x] else if / else
- [x] ternary (a ? b : c)
- [ ] switch
- looping
- [x] while
- [x] for
- [ ] foreach
- jump
- [x] goto
- [x] break
- [x] continue
- [x] return
- labeled
- [x] label
- [ ] case
- [ ] default
- scope
- [x] code block {}
- [x] global scope
- [x] variable shadowing
- logical
- [x] and / &&
- [x] or / ||
- [x] short circuit
- bitwise
- [ ] &
- [ ] |
- modifiers
- [x] await
- [ ] async
- [ ] public
- [ ] private
- [x] static
- base types
- [x] function
- [x] null / nill
- [x] int
- [x] double
- [x] string
- [x] bool
- [x] object
- [x] true, false
- [x] array (hashmap)
- operators
- [x] assignment
- [x] unary +, -
- [x] binary +, -, *, /, %, ^
- [x] compound assignment +=, *=, /=, -=, %=, ^=
- [ ] null coalescing ??, ??=
- postfix
- [x] ++, --
- [ ] arrays
- [ ] object members
- comments
- [x] // single line
- [ ] /* */ multiline comment. nesting won't be allowed
- evaluation
- [x] interpretation
- [ ] bytecode + vm
- OOP
- [x] classes
- [x] this
- [x] constructors
- [x] static methods
- [ ] access modifiers (public, private)
- [x] inheritance
- [ ] polymorphism
- [ ] getters & setters
- [ ] traits
- FFI
- [x] (partially) calling FFI functions, this should support both `Func` + `Action` and `Func>` + `Action>`
- sugar
- [x] default parameter values `fn sum(a = 1, b = 2) {}`
- [x] parameter by name `myFn(myParam: 1)`
- misc
- [x] local functions
- [x] anonymous functions (lambdas)
- [ ] params `fn sum(params numbers)`
### Notes
- semicolons are optional
- parenthesis around keywords are optional. Both `if (condition)` and `if condition` are valid
- scopes are optional. Implicit scope is one statement. `a = 0 if 1 > 2 a = 2 print a` is valid
- tabs are always discarded (no ident / dedent)
- newlines are almost always discarded
- dynamic type control. Optional static types. Implicit var declaration. Both `a = 0` and `var a = 0` is valid. In future `int a = 0` should be valid too.
- SxScript is as permissive as possible. Aborting execution is always considered the last option. This is probably not a very good design but I love languages with this behavior (Lua).
- exceptions are not used to control flow (return, continue, break..)
### Great projects I'd like to mention here
- https://github.com/codingseb/ExpressionEvaluator
- https://github.com/moonsharp-devs/moonsharp/
- https://github.com/scriban/scriban
- https://github.com/sebastienros/fluid
- https://github.com/sebastienros/jint
- https://github.com/microsoft/ClearScript
- https://github.com/munificent/craftinginterpreters (literature)