Leekscript V2 Save
A dynamically typed, compiled just-in-time programming language used in Leek Wars' AIs
LeekScript is a dynamically typed, compiled just-in-time programming language initially designed for Leek Wars AIs, and for games in general. Design to be simple to use for beginners, but with rich syntax and functionnalities, and a good speed thanks to an optimized compiler.
Contents
- Demonstration - try it online
-
Building - build instructions
2.1 Shared library - build and use
2.2 WebAssembly - build analyzer for the web -
Usage - usage
3.1 Command-line options - CLI options description - Tests - run tests, coverage, benchmark and more
- Troubleshooting - common pitfalls and useful tools
- Projects using LeekScript - discover projects using LeekScript language
- Libraries - check library dependencies
- License - license information
Demonstration
Play with online editor at https://leekscript.com/editor including syntax highlighting, smart completion and execution.
Building
make
The executable leekscript is in the build/ folder.
Shared library
Use make lib to build libleekscript.so in build/ folder. You can use sudo make install to copy it in /usr/lib/ and make it available everywhere.
WebAssembly analyzer
Run make analyzer-web to build the analyzer to target browsers in WebAssembly. Try it by running a small web server with python tool/wasm_server.py and browsing the link. Then check the console for the output result.
Usage
After building, enter a LeekScript top-level (REPL):
leekscript
Execute a file or a code snippet:
leekscript my_file.leek
leekscript "[5, 6, 7] ~~ x -> x ** 2"
Command-line options
The following command-line options are available when calling leekscript command. You can use multiple option by combining them (example: leekscript -dijt).
| Option | Description |
|---|---|
-b | --bitcode |
Output the program's bitcode file (LLVM's .bc file). |
-c | --execute_bitcode |
Execute input as a bitcode file (LLVM's .bc file). |
-d | --debug |
Print debug information : types. |
-e | --example |
Output a simple one-liner example code. |
-f | --format |
Output the program nicely-formatted. |
-s | --sections |
Display program sections. |
-h | --help |
Display help. |
-i | --intermediate |
Output the program's intermediate representation (LLVM's .ll file). |
-j | --json |
Get all the results in JSON format. |
-l | --legacy |
Use legacy mode (LeekScript 1.0): enable old functions, arrays and other behaviors. |
-o | --operations |
Enable operations counter and limit to 20 millions. |
-O<level> |
Optimization level. |
-r | --execute_ir |
Execute input as an IR file (LLVM's .ll file). |
-t | --time |
Print compilation and execution time and operations (if enabled). |
-v | --version |
Print the current version. |
Tests
LeekScript has a large set of tests to validate parsing, compilation and execution. They are located in the test/ folder. They can run on multiple threads to speed-up testing process. Simply use the following command to run all the tests on your machine:
make test
Coverage
You can also get a test coverage report, using gcov + lcov tools. This build will be unoptimized (-O0) to be able to get line coverage properly. Use the following command then browse build/html/index.html to inspect the HTML test coverage report:
make coverage
Benchmark
Build and run the benchmark comparing the performance of LeekScript against C, Java and Python for several algorithms:
make benchmark
Troubleshooting
Valgrind
To help debugging, you can use valgrind with the following commands:
make valgrind # valgrind default tool
make callgrind # valgrind callgrind tool
Clang C++ IR output
https://godbolt.org/ is a great tool to explore C/C++ generated assembly. Using -S -emit-llvm -g0 -O1 options, you can discover LLVM IR for given C++ code.
For a detailed and more technical list of troubleshooting entries, read document/troubleshooting.md.
If you don't find any answer in these documents, check issues page on GitHub and feel free to post a new one.
Projects using LeekScript
- Leek Wars, online programming game, for AI execution in fight generation.
Libraries used
- LLVM Version 8.0.0
- GNU MP, by Torbjörn Granlund, under GPL license
- JSON for modern C++, by Niels Lohmann, under MIT license
- CLI11, by Henry Schreinern under NSF AWARD 1414736
License
Distributed under the GPL3 license. Copyright (c) 2016-2022, Pilow
Open Source Agenda Badge
