Skip to content

A simple script engine written in C#, including a class library with configurable parsers.

License

Notifications You must be signed in to change notification settings

zhlf1987/LapisScript

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LapisScript

A simple script engine written in C#, including a portable class library with configurable parsers. Now it has been ported to .NET Core.

The Parsers

Lapis.Script.Parser is a framework providing lexer and parser infrastructure. Below is an example of arithmetic calculator base on the parsers.

using Lapis.Script.Parser.Lexical;
using Lapis.Script.Parser.Parsing;

class ArithmeticCalculator
{
    public ArithmeticCalculator()
    {
        DefineParsingRules();
    }

    private LexerBuilder _lexerBuilder;
    private ParsingRule<double> _parsingRule;
    
    private void DefineParsingRules() 
    {            
        var lexb = new LexerBuilder();

        var digit = LexicalRule.Range('0', '9');
        var blank = lexb.DefineLexeme(0, true, LexicalRule.Chars(" \n\t\r").Repeat());
        var number = lexb.DefineLexeme(1, digit.Repeat() + (LexicalRule.Char('.') + digit.Repeat() | LexicalRule.Empty));
        var plus = lexb.DefineLexeme(2, LexicalRule.Char('+'));
        var minus = lexb.DefineLexeme(2, LexicalRule.Char('-'));
        var times = lexb.DefineLexeme(2, LexicalRule.Char('*'));
        var divide = lexb.DefineLexeme(2, LexicalRule.Char('/'));
        var bra = lexb.DefineLexeme(3, LexicalRule.Char('('));
        var ket = lexb.DefineLexeme(3, LexicalRule.Char(')'));

        var plu = plus.GetParsingRule();
        var min = minus.GetParsingRule();
        var mul = times.GetParsingRule();
        var div = divide.GetParsingRule();
        var br = bra.GetParsingRule();
        var ke = ket.GetParsingRule();
        var num = number.GetParsingRule(i => double.Parse(i.Text));

        var expr = new ParsingRuleContainer<double>();
        var term = new ParsingRuleContainer<double>();
        var factor = new ParsingRuleContainer<double>();            

        expr.Content
            = term.Concat((plu.Concat(term, (t, y) => y) | min.Concat(term, (t, y) => -y)).Repeat(i => i.Sum()), (x, y) => x + y)
            | term;

        term.Content
            = factor.Concat((mul.Concat(term, (s, y) => y) | (div.Concat(term, (s, y) => 1 / y))).Repeat(t => t.Count() == 0 ? 1 : t.Aggregate((x, y) => x * y)), (x, y) => x * y)
            | factor;

        factor.Content
            = br.Concat(expr, (s, x) => x).Concat(ke, (x, s) => x)
            | num;

        _lexerBuilder = lexb;
        _parsingRule = expr;
    }

    public bool TryEvaluate(string str, out double value)
    {
        var lexer = _lexerBuilder.GetBranchedLexer(str);
        double r;
        return _parsingRule.TryParse(lexer, out value);            
    }
}

var calculator = new ArithmeticCalculator();
string str = "1 * 5 + 2 * 3 / 5 - 3";
double result;
calculator.TryEvaluate(str, out result);
Console.WriteLine(result == 1.0 * 5.0 + 2.0 * 3.0 / 5.0 - 3.0); // True

The Interpreter

ScriptSampleApp is an interpreter app. The syntax trees and runtime contexts are in Lapis.Script.Execution. Below are example scripts reflecting the features of the script language.

Flow Control

Condition statements:

var x = 0
if (x == 1)
    x++
else
    x--
print(x)

x = 0
switch (x) {
	case 0 : print(0); break
	case 1 : print(1); break
	default : print("default")
}

Looping statements:

for (var i = 0; i < 5; i++) {
    print(i)
}

while (i > 0)
    print(i--)

do {
    print(i++)
} while (i < 5)

Function

Recursion:

function factorial(x) {
    if(x == 0)
        return 1   
    else    
        return x * factorial(x - 1)
}
print(factorial(5)); // 120

Closure:

var x = 0
function clousure() {
    print(x++)    
}
clousure() // 0
clousure() // 1

A lambda expression:

print((x => -x)(2)) // -2

Complex Object

An array:

var array = [ 0, 1, 2 ]
print(array[1])

Array decomposition:

var a = 0; 
var b = 0; 
var c = 0;
[a, [b, c]] = [ 1, [2, 3]]
print(a, b, c) // 1 2 3

An object:

var dict = { x : 0, y : 1 }
print(dict.x)

Class

A simple class with a field, a constructor, and a method:

class Greeter {
    greeting;

    constructor(message) {
        this.greeting = message;
    }

    greet() {
        return "Hello, " + this.greeting;
    }
}

var greeter = new Greeter("world");
print(greeter.greet()); // Hello, world

Property and Indexer

A class with property accessors:

class Person {
    private m_name = "N/A";
    private m_Age = 0;

    public Name {
        get { return this.m_name; }
        set { this.m_name = value; }
    }
    public Age {
        get { return this.m_Age; }
        set { this.m_Age = value; }
    }

    public ToString() {
        return "Name = " + this.Name + ", Age = " + this.Age;
    }
}

var person = new Person();
print("Person details - " + person.ToString());
// Person details - Name = N/A, Age = 0

person.Name = "Joe";
person.Age = 99;
print("Person details - " + person.ToString());
// Person details - Name = Joe, Age = 99

person.Age += 1;
print("Person details - " + person.ToString());
// Person details - Name = Joe, Age = 100

A class with an indexer:

class DayCollection {
    private days = [ "Sun", "Mon", "Tues", "Wed", "Thurs", "Fri", "Sat" ];

    private GetDay(testDay) {
        for (var i = 0; i < this.days.length; i++) {
            if (this.days[i] == testDay) {
                return i;
            }       
        }
        return -1;
    }

    public this[day] {
        get { return (this.GetDay(day)); }
    }
}

var week = new DayCollection();
print(week["Fri"]); // 5
print(week["Made-up Day"]); // -1

Event

The publisher-subscriber pattern:

class EventArgs {
    constructor(s) { this.message = s; }    

    public Message {
        get { return this.message; }   
		set { this.message = value; }     
    }

    private message;
}

class Publisher {
    public Name { get; set; }

	constructor(name) { this.Name = name; }

    public RaiseEvent;

    public DoSomething() {      
		this.OnRaiseEvent(new EventArgs("Did something"));
    }

    protected OnRaiseEvent(e) {        
	    var handler = this.RaiseEvent;
        if (handler != null) {            
            e.Message += " by " + this.Name;
            handler(this, e);
        }
    }
}

class Subscriber {
    private id;

    constructor(id, pub) {
        this.id = id;        
        pub.RaiseEvent = this.HandleCustomEvent;
    }

    HandleCustomEvent(sender, e) {
        print(this.id + " received this message: " + e.Message);
    }
}

var pub = new Publisher("pub");
var sub1 = new Subscriber("sub1", pub);
var sub2 = new Subscriber("sub2", pub);
pub.DoSomething();
// sub2 received this message: Did something by pub

Inheritance

Class inheritance and method overriding:

class Animal {
    name;

    constructor(name) { this.name = name; }
	
    move(meters) {
        print(this.name + " moved " + meters + "m.");
    }
}

class Snake extends Animal {
    constructor(name) { super(name); }

    move() {
        print("Slithering...");
        super.move(5);
    }
}

class Horse extends Animal {
    constructor(name) { super(name); }
    
    move() {
        print("Galloping...");
        super.move(45);
    }
}

var sam = new Snake("Sammy the Python");
var tom = new Horse("Tommy the Palomino");
sam.move();
// Slithering...
// Sammy the Python moved 5m.
tom.move();
// Galloping...
// Tommy the Palomino moved 45m.

About

A simple script engine written in C#, including a class library with configurable parsers.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 100.0%