grimoire 0.2.3

Grimoire Scripting Language


To use this package, run the following command in your project's root directory:

Grimoire

Grimoire is an concurrent programming language that can easily be embedded into another D programs. You can very easily interface your program with Grimoire's scripts.

The language itself is focused on concurrency, and feature both static and dynamic typing.

Hope you have fun with this project !

Documentation here !

Install

Use dub to include grimoire in your project (or just dump the files in your project if you're too tired). Open the "test" folder to see how to add Grimoire to your program or copy/paste it.

Grimoire is in 2 parts:

  • The compiler
  • The runtime

First you need to compile your file with grCompileFile(). It takes a GrData and the script's file path. It compiles it into a bytecode, and returns it to you.

auto data = new GrData;
// Define things in data here..
auto bytecode = grCompileFile(data, "test.gr");

The GrData object contains all binded D-functions and types definitions. If you want to bind D-functions or create types with it, you must do so before calling grCompileFile(). The GrData object will be used by the runtime as well, so it must remains the same between compilation and runtime.

Then, create the runtime's virtual machine GrEngine, load the data and bytecode then spawn the main task.

GrEngine vm = new GrEngine;
vm.load(data, bytecode);
vm.spawn();

You're not forced to spawn the main, you can spawn any other named event like this:

auto mangledName = grMangleNamedFunction("myEvent", []);
if(vm.hasEvent(mangledName))
    GrContext ev = vm.spawnEvent(mangledName);

But be aware that every function/task/event are mangled with their signature, so use grMangleNamedFunction to generate the correct function's name.

To run the virtual machine, just call the process function (check if there's any task(Coroutine) running though):

while(vm.hasCoroutines)
    vm.process();

The program will run until all tasks are finished, if you want them to run only for one step, replace the while with if.

You can then check if there are any unhandled errors that went through the VM (Caught exceptions won't trigger that).

if(vm.isPanicking)
    writeln("Unhandled Exception: " ~ to!string(vm.panicMessage));

Exemple Program

The classic Hello World ! nice to meet you !

main {
    printl("Hello World!");
}

You can find the language documentation > here ! <

Authors:
  • Enalye
Sub packages:
grimoire:test, grimoire:unittests
Dependencies:
none
Versions:
0.3.1 2020-Apr-18
0.3.0 2020-Apr-15
0.2.4 2020-Jan-20
0.2.3 2019-Dec-23
0.2.2 2019-Sep-29
Show all 21 versions
Download Stats:
  • 0 downloads today

  • 0 downloads this week

  • 2 downloads this month

  • 44 downloads total

Score:
0.4
Short URL:
grimoire.dub.pm