2014-03-30 00:17:00 +04:00
# mal - Make a Lisp
2015-10-06 05:14:59 +03:00
[![Build Status ](https://travis-ci.org/kanaka/mal.svg?branch=master )](https://travis-ci.org/kanaka/mal)
2014-03-30 04:01:14 +04:00
## Description
2019-02-12 22:10:42 +03:00
**1. Mal is a Clojure inspired Lisp interpreter**
2014-12-24 06:35:48 +03:00
2020-01-12 14:41:47 +03:00
**2. Mal is implemented in 81 languages (84 different implementations and 104 runtime modes)**
2014-03-30 04:01:14 +04:00
2019-02-20 00:40:02 +03:00
| Language | Creator |
| -------- | ------- |
| [Ada ](#ada ) | [Chris Moore ](https://github.com/zmower ) |
2019-03-28 08:17:07 +03:00
| [Ada #2 ](#ada2 ) | [Nicolas Boulenguez ](https://github.com/asarhaddon ) |
2019-03-21 06:50:03 +03:00
| [GNU Awk ](#gnu-awk ) | [Miutsuru Kariya ](https://github.com/kariya-mitsuru ) |
2019-02-20 00:40:02 +03:00
| [Bash 4 ](#bash-4 ) | [Joel Martin ](https://github.com/kanaka ) |
| [BASIC ](#basic-c64-and-qbasic ) (C64 & QBasic) | [Joel Martin ](https://github.com/kanaka ) |
2019-05-19 01:07:45 +03:00
| [BBC BASIC V ](#bbc-basic-v ) | [Ben Harris ](https://github.com/bjh21 ) |
2019-02-20 00:40:02 +03:00
| [C ](#c ) | [Joel Martin ](https://github.com/kanaka ) |
| [C++ ](#c-1 ) | [Stephen Thirlwall ](https://github.com/sdt ) |
| [C# ](#c-2 ) | [Joel Martin ](https://github.com/kanaka ) |
| [ChucK ](#chuck ) | [Vasilij Schneidermann ](https://github.com/wasamasa ) |
| [Clojure ](#clojure ) (Clojure & ClojureScript) | [Joel Martin ](https://github.com/kanaka ) |
| [CoffeeScript ](#coffeescript ) | [Joel Martin ](https://github.com/kanaka ) |
2019-03-21 06:50:03 +03:00
| [Common Lisp ](#common-lisp ) | [Iqbal Ansari ](https://github.com/iqbalansari ) |
2019-02-20 00:40:02 +03:00
| [Crystal ](#crystal ) | [Linda_pp ](https://github.com/rhysd ) |
| [D ](#d ) | [Dov Murik ](https://github.com/dubek ) |
| [Dart ](#dart ) | [Harry Terkelsen ](https://github.com/hterkelsen ) |
| [Elixir ](#elixir ) | [Martin Ek ](https://github.com/ekmartin ) |
| [Elm ](#elm ) | [Jos van Bakel ](https://github.com/c0deaddict ) |
| [Emacs Lisp ](#emacs-lisp ) | [Vasilij Schneidermann ](https://github.com/wasamasa ) |
| [Erlang ](#erlang ) | [Nathan Fiedler ](https://github.com/nlfiedler ) |
| [ES6 ](#es6-ecmascript-2015 ) (ECMAScript 2015) | [Joel Martin ](https://github.com/kanaka ) |
| [F# ](#f ) | [Peter Stephens ](https://github.com/pstephens ) |
| [Factor ](#factor ) | [Jordan Lewis ](https://github.com/jordanlewis ) |
| [Fantom ](#fantom ) | [Dov Murik ](https://github.com/dubek ) |
| [Forth ](#forth ) | [Chris Houser ](https://github.com/chouser ) |
| [GNU Guile ](#gnu-guile-21 ) | [Mu Lei ](https://github.com/NalaGinrut ) |
| [GNU Smalltalk ](#gnu-smalltalk ) | [Vasilij Schneidermann ](https://github.com/wasamasa ) |
2019-03-21 06:50:03 +03:00
| [Go ](#go ) | [Joel Martin ](https://github.com/kanaka ) |
| [Groovy ](#groovy ) | [Joel Martin ](https://github.com/kanaka ) |
2019-02-20 00:40:02 +03:00
| [Haskell ](#haskell ) | [Joel Martin ](https://github.com/kanaka ) |
| [Haxe ](#haxe-neko-python-c-and-javascript ) (Neko, Python, C++, & JS) | [Joel Martin ](https://github.com/kanaka ) |
| [Hy ](#hy ) | [Joel Martin ](https://github.com/kanaka ) |
| [Io ](#io ) | [Dov Murik ](https://github.com/dubek ) |
| [Java ](#java-17 ) | [Joel Martin ](https://github.com/kanaka ) |
| [JavaScript ](#javascriptnode ) ([Demo](http://kanaka.github.io/mal)) | [Joel Martin ](https://github.com/kanaka ) |
2020-01-12 14:41:47 +03:00
| [Jq ](#jq ) | [Ali MohammadPur ](https://github.com/alimpfard ) |
2019-02-20 00:40:02 +03:00
| [Julia ](#julia ) | [Joel Martin ](https://github.com/kanaka ) |
| [Kotlin ](#kotlin ) | [Javier Fernandez-Ivern ](https://github.com/ivern ) |
| [LiveScript ](#livescript ) | [Jos van Bakel ](https://github.com/c0deaddict ) |
| [Logo ](#logo ) | [Dov Murik ](https://github.com/dubek ) |
| [Lua ](#lua ) | [Joel Martin ](https://github.com/kanaka ) |
| [GNU Make ](#gnu-make-381 ) | [Joel Martin ](https://github.com/kanaka ) |
| [mal itself ](#mal ) | [Joel Martin ](https://github.com/kanaka ) |
2019-03-21 06:50:03 +03:00
| [MATLAB ](#matlab-gnu-octave-and-matlab ) (GNU Octave & MATLAB) | [Joel Martin ](https://github.com/kanaka ) |
2019-02-20 00:40:02 +03:00
| [miniMAL ](#minimal ) ([Repo](https://github.com/kanaka/miniMAL), [Demo ](https://kanaka.github.io/miniMAL/ )) | [Joel Martin ](https://github.com/kanaka ) |
| [NASM ](#nasm ) | [Ben Dudson ](https://github.com/bendudson ) |
| [Nim ](#nim-0170 ) | [Dennis Felsing ](https://github.com/def- ) |
| [Object Pascal ](#object-pascal ) | [Joel Martin ](https://github.com/kanaka ) |
| [Objective C ](#objective-c ) | [Joel Martin ](https://github.com/kanaka ) |
| [OCaml ](#ocaml-4010 ) | [Chris Houser ](https://github.com/chouser ) |
2019-08-04 18:50:09 +03:00
| [Perl ](#perl-5 ) | [Joel Martin ](https://github.com/kanaka ) |
2019-02-20 00:40:02 +03:00
| [Perl 6 ](#perl-6 ) | [Hinrik Örn Sigurðsson ](https://github.com/hinrik ) |
| [PHP ](#php-53 ) | [Joel Martin ](https://github.com/kanaka ) |
| [Picolisp ](#picolisp ) | [Vasilij Schneidermann ](https://github.com/wasamasa ) |
2019-09-18 08:53:48 +03:00
| [Pike ](#pike ) | [Dov Murik ](https://github.com/dubek ) |
2019-05-19 14:33:52 +03:00
| [PL/pgSQL ](#plpgsql-postgresql-sql-procedural-language ) (PostgreSQL) | [Joel Martin ](https://github.com/kanaka ) |
2019-02-20 00:40:02 +03:00
| [PL/SQL ](#plsql-oracle-sql-procedural-language ) (Oracle) | [Joel Martin ](https://github.com/kanaka ) |
2019-03-21 06:50:03 +03:00
| [PostScript ](#postscript-level-23 ) | [Joel Martin ](https://github.com/kanaka ) |
2019-02-20 00:40:02 +03:00
| [PowerShell ](#powershell ) | [Joel Martin ](https://github.com/kanaka ) |
| [Python ](#python-2x-and-3x ) (2.X & 3.X) | [Joel Martin ](https://github.com/kanaka ) |
2019-10-22 07:01:33 +03:00
| [Python #2 ](#python2-3x ) (3.X) | [Gavin Lewis ](https://github.com/epylar ) |
2019-02-20 00:40:02 +03:00
| [RPython ](#rpython ) | [Joel Martin ](https://github.com/kanaka ) |
| [R ](#r ) | [Joel Martin ](https://github.com/kanaka ) |
| [Racket ](#racket-53 ) | [Joel Martin ](https://github.com/kanaka ) |
| [Rexx ](#rexx ) | [Dov Murik ](https://github.com/dubek ) |
| [Ruby ](#ruby-19 ) | [Joel Martin ](https://github.com/kanaka ) |
2019-11-03 02:43:24 +03:00
| [Rust ](#rust-138 ) | [Joel Martin ](https://github.com/kanaka ) |
2019-02-20 00:40:02 +03:00
| [Scala ](#scala ) | [Joel Martin ](https://github.com/kanaka ) |
| [Scheme (R7RS) ](#scheme-r7rs ) | [Vasilij Schneidermann ](https://github.com/wasamasa ) |
| [Skew ](#skew ) | [Dov Murik ](https://github.com/dubek ) |
2019-03-21 06:50:03 +03:00
| [Swift 2 ](#swift ) | [Keith Rollin ](https://github.com/keith-rollin ) |
2019-02-20 00:40:02 +03:00
| [Swift 3 ](#swift-3 ) | [Joel Martin ](https://github.com/kanaka ) |
2019-03-06 04:35:31 +03:00
| [Swift 4 ](#swift-4 ) | [陆遥 ](https://github.com/LispLY ) |
2019-11-08 19:57:33 +03:00
| [Swift 5 ](#swift-5 ) | [Oleg Montak ](https://github.com/MontakOleg ) |
2019-02-20 00:40:02 +03:00
| [Tcl ](#tcl-86 ) | [Dov Murik ](https://github.com/dubek ) |
| [TypeScript ](#typescript ) | [Masahiro Wakame ](https://github.com/vvakame ) |
2019-05-10 11:34:20 +03:00
| [Vala ](#vala ) | [Simon Tatham ](https://github.com/sgtatham ) |
2019-02-20 00:40:02 +03:00
| [VHDL ](#vhdl ) | [Dov Murik ](https://github.com/dubek ) |
| [Vimscript ](#vimscript ) | [Dov Murik ](https://github.com/dubek ) |
| [Visual Basic.NET ](#visual-basicnet ) | [Joel Martin ](https://github.com/kanaka ) |
| [WebAssembly ](#webassembly-wasm ) (wasm) | [Joel Martin ](https://github.com/kanaka ) |
2019-10-31 16:27:46 +03:00
| [Wren ](#wren ) | [Dov Murik ](https://github.com/dubek ) |
2019-02-20 00:40:02 +03:00
| [Yorick ](#yorick ) | [Dov Murik ](https://github.com/dubek ) |
2019-12-20 07:24:54 +03:00
| [Zig ](#zig ) | [Josh Tobin ](https://github.com/rjtobin ) |
2014-03-30 04:01:14 +04:00
2019-02-12 22:10:42 +03:00
**3. Mal is a learning tool**
Each implementation of mal is separated into
2015-03-08 08:56:00 +03:00
11 incremental, self-contained (and testable) steps that demonstrate
core concepts of Lisp. The last step is capable of self-hosting
2019-02-12 22:10:42 +03:00
(running the mal implementation of mal). See the [make-a-lisp process
guide](process/guide.md).
2014-03-30 04:01:14 +04:00
2019-02-12 22:10:42 +03:00
The make-a-lisp steps are:
2014-03-30 04:01:14 +04:00
2015-01-30 06:59:09 +03:00
* [step0_repl ](process/guide.md#step0 )
* [step1_read_print ](process/guide.md#step1 )
* [step2_eval ](process/guide.md#step2 )
* [step3_env ](process/guide.md#step3 )
* [step4_if_fn_do ](process/guide.md#step4 )
* [step5_tco ](process/guide.md#step5 )
* [step6_file ](process/guide.md#step6 )
* [step7_quote ](process/guide.md#step7 )
* [step8_macros ](process/guide.md#step8 )
* [step9_try ](process/guide.md#step9 )
2015-02-28 20:09:54 +03:00
* [stepA_mal ](process/guide.md#stepA )
2014-03-30 04:01:14 +04:00
2019-02-12 22:13:46 +03:00
Each make-a-lisp step has an associated architectural diagram. That elements
that are new for that step are highlighted in red.
Here is the final diagram for [step A ](process/guide.md#stepA ):
2019-02-12 22:10:42 +03:00
![stepA_mal architecture ](process/stepA_mal.png )
2019-07-05 21:01:14 +03:00
If you are interested in creating a mal implementation (or just
2019-02-12 22:10:42 +03:00
interested in using mal for something), please drop by the #mal
channel on freenode. In addition to the [make-a-lisp process
guide](process/guide.md) there is also a [mal/make-a-lisp
FAQ](docs/FAQ.md) where I attempt to answer some common questions.
## Presentations
2014-03-30 04:01:14 +04:00
Mal was presented publicly for the first time in a lightning talk at
Clojure West 2014 (unfortunately there is no video). See
2016-04-16 19:43:50 +03:00
examples/clojurewest2014.mal for the presentation that was given at the
2019-02-12 22:10:42 +03:00
conference (yes, the presentation is a mal program).
At Midwest.io 2015, Joel Martin gave a presentation on Mal titled
"Achievement Unlocked: A Better Path to Language Learning".
2016-04-16 19:43:50 +03:00
[Video ](https://www.youtube.com/watch?v=lgyOAiRtZGw ),
2019-02-12 22:10:42 +03:00
[Slides ](http://kanaka.github.io/midwest.io.mal/ ).
More recently Joel gave a presentation on "Make Your Own Lisp Interpreter
in 10 Incremental Steps" at LambdaConf 2016:
2018-12-09 03:29:28 +03:00
[Part 1 ](https://www.youtube.com/watch?v=jVhupfthTEk ),
[Part 2 ](https://www.youtube.com/watch?v=X5OQBMGpaTU ),
[Part 3 ](https://www.youtube.com/watch?v=6mARZzGgX4U ),
[Part 4 ](https://www.youtube.com/watch?v=dCO1SYR5kDU ),
2017-03-31 18:25:24 +03:00
[Slides ](http://kanaka.github.io/lambdaconf/ ).
2014-03-30 00:17:00 +04:00
## Building/running implementations
2016-03-08 08:33:45 +03:00
The simplest way to run any given implementation is to use docker.
Every implementation has a docker image pre-built with language
2019-01-11 00:30:21 +03:00
dependencies installed. You can launch the REPL using a convenient
2016-03-08 08:33:45 +03:00
target in the top level Makefile (where IMPL is the implementation
directory name and stepX is the step to run):
```
make DOCKERIZE=1 "repl^IMPL^stepX"
# OR stepA is the default step:
make DOCKERIZE=1 "repl^IMPL"
```
2019-04-13 19:57:15 +03:00
## External Implementations
The following implementations are maintained as separate projects:
### HolyC
* [by Alexander Bagnalla ](https://github.com/bagnalla/holyc_mal )
### Rust
* [by Tim Morgan ](https://github.com/seven1m/mal-rust )
* [by vi ](https://github.com/vi/mal-rust-vi ) - using [Pest ](https://pest.rs/ ) grammar, not using typical Mal infrastructure (cargo-ized steps and built-in converted tests).
## Other mal Projects
* [malc ](https://github.com/dubek/malc ) - Mal (Make A Lisp) compiler. Compiles a Mal program to LLVM assembly language, then binary.
2019-10-04 07:51:13 +03:00
* [malcc ](https://github.com/seven1m/malcc ) - malcc is an incremental compiler implementation for the Mal language. It uses the Tiny C Compiler as the compiler backend and has full support for the Mal language, including macros, tail-call elimination, and even run-time eval. ["I Built a Lisp Compiler" ](https://mpov.timmorgan.org/i-built-a-lisp-compiler/ ) post about the process.
2019-04-13 19:57:15 +03:00
* [frock ](https://github.com/chr15m/frock ) - Clojure-flavoured PHP. Uses mal/php to run programs.
2019-12-02 19:38:29 +03:00
* [flk ](https://github.com/chr15m/flk ) - A LISP that runs wherever Bash is
2019-04-13 19:57:15 +03:00
## Implementation Details
2016-03-08 08:33:45 +03:00
2016-03-26 18:33:29 +03:00
### Ada
2016-03-28 00:42:47 +03:00
The Ada implementation was developed with GNAT 4.9 on debian. It also
compiles unchanged on windows if you have windows versions of git,
GNAT and (optionally) make. There are no external dependencies
(readline not implemented).
2016-03-26 18:33:29 +03:00
```
cd ada
make
./stepX_YYY
```
2019-03-27 19:22:32 +03:00
### Ada.2
The second Ada implementation was developed with GNAT 8 and links with
the GNU readline library.
```
cd ada
make
./stepX_YYY
```
2015-08-25 18:46:31 +03:00
### GNU awk
The GNU awk implementation of mal has been tested with GNU awk 4.1.1.
```
cd gawk
gawk -O -f stepX_YYY.awk
```
2014-03-30 04:01:14 +04:00
### Bash 4
2014-03-30 00:17:00 +04:00
```
cd bash
bash stepX_YYY.sh
```
2016-11-01 01:50:13 +03:00
### BASIC (C64 and QBasic)
2016-11-01 01:38:28 +03:00
2016-11-01 01:50:13 +03:00
The BASIC implementation uses a preprocessor that can generate BASIC
code that is compatible with both C64 BASIC (CBM v2) and QBasic. The
2016-11-01 01:38:28 +03:00
C64 mode has been tested with
[cbmbasic ](https://github.com/kanaka/cbmbasic ) (the patched version is
currently required to fix issues with line input) and the QBasic mode
has been tested with [qb64 ](http://www.qb64.net/ ).
Generate C64 code and run it using cbmbasic:
```
cd basic
make stepX_YYY.bas
STEP=stepX_YYY ./run
```
Generate QBasic code and load it into qb64:
```
cd basic
make MODE=qbasic stepX_YYY.bas
./qb64 stepX_YYY.bas
```
Thanks to [Steven Syrek ](https://github.com/sjsyrek ) for the original
inspiration for this implementation.
2019-05-19 01:07:45 +03:00
### BBC BASIC V
The BBC BASIC V implementation can run in the Brandy interpreter:
```
cd bbc-basic
brandy -quit stepX_YYY.bbc
```
Or in ARM BBC BASIC V under RISC OS 3 or later:
```
*Dir bbc-basic.riscos
*Run setup
*Run stepX_YYY
```
2016-11-01 01:38:28 +03:00
2014-03-30 04:01:14 +04:00
### C
2014-03-30 00:17:00 +04:00
2014-10-10 08:48:47 +04:00
The C implementation of mal requires the following libraries (lib and
2015-12-09 23:41:41 +03:00
header packages): glib, libffi6, libgc, and either the libedit or GNU readline
library.
2014-03-31 01:39:44 +04:00
2014-03-30 00:17:00 +04:00
```
cd c
make
./stepX_YYY
```
2015-03-28 19:41:16 +03:00
### C++
The C++ implementation of mal requires g++-4.9 or clang++-3.5 and
a readline compatible library to build. See the `cpp/README.md` for
more details:
```
cd cpp
make
# OR
make CXX=clang++-3.5
./stepX_YYY
```
2014-04-24 08:07:16 +04:00
### C# ###
2014-04-10 07:15:54 +04:00
The C# implementation of mal has been tested on Linux using the Mono
C# compiler (mcs) and the Mono runtime (version 2.10.8.1). Both are
required to build and run the C# implementation.
```
cd cs
make
2014-11-16 08:15:09 +03:00
mono ./stepX_YYY.exe
2014-04-10 07:15:54 +04:00
```
2016-08-08 02:19:05 +03:00
### ChucK
2016-11-05 06:52:05 +03:00
The ChucK implementation has been tested with ChucK 1.3.5.2.
2016-08-08 02:19:05 +03:00
```
cd chuck
./run
```
2014-04-10 07:15:54 +04:00
2014-03-30 04:01:14 +04:00
### Clojure
2014-03-30 00:17:00 +04:00
2015-12-18 01:14:43 +03:00
For the most part the Clojure implementation requires Clojure 1.5,
however, to pass all tests, Clojure 1.8.0-RC4 is required.
2014-03-30 00:17:00 +04:00
```
cd clojure
lein with-profile +stepX trampoline run
```
2014-11-09 01:56:36 +03:00
### CoffeeScript
```
sudo npm install -g coffee-script
cd coffee
coffee ./stepX_YYY
```
2019-03-21 06:50:03 +03:00
### Common Lisp
The implementation has been tested with SBCL, CCL, CMUCL, GNU CLISP, ECL and
Allegro CL on Ubuntu 16.04 and Ubuntu 12.04, see
the [README ](common-lisp/README.org ) for more details. Provided you have the
dependencies mentioned installed, do the following to run the implementation
```
cd common-lisp
make
./run
```
2015-05-01 19:45:03 +03:00
### Crystal
2018-10-27 23:20:36 +03:00
The Crystal implementation of mal has been tested with Crystal 0.26.1.
2015-06-03 20:53:20 +03:00
2015-05-01 19:45:03 +03:00
```
cd crystal
crystal run ./stepX_YYY.cr
2015-06-03 20:53:20 +03:00
# OR
make # needed to run tests
./stepX_YYY
2015-05-01 19:45:03 +03:00
```
2015-11-17 06:17:13 +03:00
### D
The D implementation of mal was tested with GDC 4.8. It requires the GNU
readline library.
```
cd d
make
./stepX_YYY
```
2016-11-14 01:35:35 +03:00
### Dart
The Dart implementation has been tested with Dart 1.20.
```
cd dart
dart ./stepX_YYY
```
2016-03-02 03:08:59 +03:00
### Emacs Lisp
The Emacs Lisp implementation of mal has been tested with Emacs 24.3
and 24.5. While there is very basic readline editing (`< backspace > `
and `C-d` work, `C-c` cancels the process), it is recommended to use
`rlwrap` .
```
cd elisp
emacs -Q --batch --load stepX_YYY.el
# with full readline support
rlwrap emacs -Q --batch --load stepX_YYY.el
```
2015-09-10 02:41:44 +03:00
### Elixir
The Elixir implementation of mal has been tested with Elixir 1.0.5.
```
cd elixir
2015-09-10 23:10:40 +03:00
mix stepX_YYY
# Or with readline/line editing functionality:
2015-09-10 02:41:44 +03:00
iex -S mix stepX_YYY
```
2017-07-22 23:18:35 +03:00
### Elm
The Elm implementation of mal has been tested with Elm 0.18.0
```
cd elm
make stepX_YYY.js
STEP=stepX_YYY ./run
```
2015-03-15 17:13:47 +03:00
### Erlang
2015-10-24 23:39:13 +03:00
The Erlang implementation of mal requires [Erlang/OTP R17 ](http://www.erlang.org/download.html )
and [rebar ](https://github.com/rebar/rebar ) to build.
2015-03-15 17:13:47 +03:00
```
cd erlang
2015-04-06 17:54:48 +03:00
make
# OR
MAL_STEP=stepX_YYY rebar compile escriptize # build individual step
2015-03-15 17:13:47 +03:00
./stepX_YYY
```
2019-02-20 00:40:02 +03:00
### ES6 (ECMAScript 2015)
2015-08-06 23:52:42 +03:00
2019-02-20 00:40:02 +03:00
The ES6 / ECMAScript 2015 implementation uses the
[babel ](https://babeljs.io ) compiler to generate ES5 compatible
JavaScript. The generated code has been tested with Node 0.12.4.
2015-08-06 23:52:42 +03:00
```
cd es6
make
node build/stepX_YYY.js
```
2015-07-06 05:45:13 +03:00
### F# ###
The F# implementation of mal has been tested on Linux using the Mono
F# compiler (fsharpc) and the Mono runtime (version 3.12.1). The mono C#
2015-07-06 05:47:59 +03:00
compiler (mcs) is also necessary to compile the readline dependency. All are
2015-07-06 05:45:13 +03:00
required to build and run the F# implementation.
```
cd fsharp
make
mono ./stepX_YYY.exe
```
2015-03-13 23:23:11 +03:00
### Factor
2015-04-03 01:36:16 +03:00
The Factor implementation of mal has been tested with Factor 0.97
2016-04-30 14:18:24 +03:00
([factorcode.org](http://factorcode.org)).
2015-04-03 01:36:16 +03:00
2015-03-13 23:23:11 +03:00
```
cd factor
2015-10-29 02:16:43 +03:00
FACTOR_ROOTS=. factor -run=stepX_YYY
2015-03-13 23:23:11 +03:00
```
2018-04-29 15:53:32 +03:00
### Fantom
The Fantom implementation of mal has been tested with Fantom 1.0.70.
```
cd fantom
make lib/fan/stepX_YYY.pod
STEP=stepX_YYY ./run
```
2015-02-21 21:14:58 +03:00
### Forth
```
cd forth
gforth stepX_YYY.fs
```
2019-03-21 06:50:03 +03:00
### GNU Guile 2.1+
```
cd guile
guile -L ./ stepX_YYY.scm
```
### GNU Smalltalk
The Smalltalk implementation of mal has been tested with GNU Smalltalk 3.2.91.
```
cd gnu-smalltalk
./run
```
2014-10-10 07:10:15 +04:00
### Go
2015-04-03 01:36:16 +03:00
The Go implementation of mal requires that go is installed on on the
2015-01-09 07:56:12 +03:00
path. The implementation has been tested with Go 1.3.1.
2014-10-10 07:10:15 +04:00
```
cd go
make
./stepX_YYY
```
2015-05-19 21:06:06 +03:00
### Groovy
The Groovy implementation of mal requires Groovy to run and has been
tested with Groovy 1.8.6.
```
cd groovy
make
groovy ./stepX_YYY.groovy
```
2014-12-24 06:35:48 +03:00
### Haskell
2016-10-07 01:55:58 +03:00
The Haskell implementation requires the ghc compiler version 7.10.1 or
later and also the Haskell parsec and readline (or editline) packages.
2014-12-24 06:35:48 +03:00
```
cd haskell
make
./stepX_YYY
```
2017-09-12 01:49:26 +03:00
### Haxe (Neko, Python, C++ and JavaScript)
2016-01-27 01:20:12 +03:00
The Haxe implementation of mal requires Haxe version 3.2 to compile.
Four different Haxe targets are supported: Neko, Python, C++, and
JavaScript.
```
cd haxe
# Neko
make all-neko
neko ./stepX_YYY.n
# Python
make all-python
python3 ./stepX_YYY.py
# C++
make all-cpp
./cpp/stepX_YYY
# JavaScript
make all-js
node ./stepX_YYY.js
```
2017-09-22 20:16:54 +03:00
### Hy
The Hy implementation of mal has been tested with Hy 0.13.0.
```
cd hy
./stepX_YYY.hy
```
2016-03-05 00:02:58 +03:00
### Io
The Io implementation of mal has been tested with Io version 20110905.
```
cd io
io ./stepX_YYY.io
```
2014-12-24 06:35:48 +03:00
2014-03-30 04:01:14 +04:00
### Java 1.7
2014-03-30 00:17:00 +04:00
2014-10-10 08:48:47 +04:00
The Java implementation of mal requires maven2 to build.
2014-03-30 00:17:00 +04:00
```
cd java
mvn compile
mvn -quiet exec:java -Dexec.mainClass=mal.stepX_YYY
# OR
mvn -quiet exec:java -Dexec.mainClass=mal.stepX_YYY -Dexec.args="CMDLINE_ARGS"
```
2015-04-01 17:47:29 +03:00
### JavaScript/Node
2014-03-30 00:17:00 +04:00
```
cd js
2019-12-04 11:20:34 +03:00
npm install
2014-03-30 00:17:00 +04:00
node stepX_YYY.js
```
2015-04-01 17:47:29 +03:00
### Julia
2015-10-24 23:39:13 +03:00
The Julia implementation of mal requires Julia 0.4.
2015-04-01 17:47:29 +03:00
```
cd julia
julia stepX_YYY.jl
```
2020-01-12 14:41:47 +03:00
### Jq
Tested against version 1.6, with a lot of cheating in the IO department
```
cd jq
STEP=stepA_YYY ./run
# with Debug
DEBUG=true STEP=stepA_YYY ./run
```
2015-10-25 06:10:53 +03:00
### Kotlin
2016-02-16 04:25:32 +03:00
The Kotlin implementation of mal has been tested with Kotlin 1.0.
2015-10-25 06:10:53 +03:00
```
cd kotlin
make
java -jar stepX_YYY.jar
```
2017-05-24 20:12:00 +03:00
### LiveScript
The LiveScript implementation of mal has been tested with LiveScript 1.5.
```
cd livescript
make
node_modules/.bin/lsc stepX_YYY.ls
```
2016-05-11 20:32:51 +03:00
### Logo
The Logo implementation of mal has been tested with UCBLogo 6.0.
```
cd logo
logo stepX_YYY.lg
```
2015-01-09 08:25:40 +03:00
### Lua
2019-01-28 22:44:24 +03:00
The Lua implementation of mal has been tested with Lua 5.2. The
implementation requires that luarocks and the lua-rex-pcre library
are installed.
2015-01-09 08:25:40 +03:00
```
cd lua
make # to build and link linenoise.so
./stepX_YYY.lua
```
2014-03-30 04:01:14 +04:00
### Mal
2014-03-30 00:17:00 +04:00
Running the mal implementation of mal involves running stepA of one of
the other implementations and passing the mal step to run as a command
2014-03-30 03:37:20 +04:00
line argument.
2014-03-30 00:17:00 +04:00
```
cd IMPL
IMPL_STEPA_CMD ../mal/stepX_YYY.mal
```
2014-03-30 04:01:14 +04:00
### GNU Make 3.81
2014-03-30 00:17:00 +04:00
```
cd make
make -f stepX_YYY.mk
```
2017-12-28 02:33:03 +03:00
### NASM
The NASM implementation of mal is written for x86-64 Linux, and has been tested
with Linux 3.16.0-4-amd64 and NASM version 2.11.05.
```
cd nasm
make
./stepX_YYY
```
2017-05-23 15:46:37 +03:00
### Nim 0.17.0
2015-03-04 06:17:43 +03:00
2017-05-23 15:46:37 +03:00
The Nim implementation of mal has been tested with Nim 0.17.0.
2015-03-04 06:17:43 +03:00
```
cd nim
make
# OR
nimble build
./stepX_YYY
```
2016-03-14 00:59:46 +03:00
### Object Pascal
The Object Pascal implementation of mal has been built and tested on
Linux using the Free Pascal compiler version 2.6.2 and 2.6.4.
```
cd objpascal
make
./stepX_YYY
```
2016-03-04 10:56:54 +03:00
### Objective C
The Objective C implementation of mal has been built and tested on
2016-03-06 10:16:32 +03:00
Linux using clang/LLVM 3.6. It has also been built and tested on OS
X using XCode 7.
2016-03-04 10:56:54 +03:00
```
cd objc
make
./stepX_YYY
```
2015-01-30 20:53:52 +03:00
### OCaml 4.01.0
```
cd ocaml
make
./stepX_YYY
```
2019-03-21 06:50:03 +03:00
### MATLAB (GNU Octave and MATLAB)
2015-02-10 21:15:24 +03:00
2017-09-12 00:45:53 +03:00
The MatLab implementation has been tested with GNU Octave 4.2.1.
It has also been tested with MATLAB version R2014a on Linux. Note that
MATLAB is a commercial product.
2015-02-10 21:15:24 +03:00
```
cd matlab
./stepX_YYY
2017-09-12 00:45:53 +03:00
octave -q --no-gui --no-history --eval "stepX_YYY();quit;"
2015-02-10 21:15:24 +03:00
matlab -nodisplay -nosplash -nodesktop -nojvm -r "stepX_YYY();quit;"
# OR with command line arguments
2017-09-12 00:45:53 +03:00
octave -q --no-gui --no-history --eval "stepX_YYY('arg1','arg2');quit;"
2015-02-10 21:15:24 +03:00
matlab -nodisplay -nosplash -nodesktop -nojvm -r "stepX_YYY('arg1','arg2');quit;"
```
2015-02-25 09:27:37 +03:00
### miniMAL
[miniMAL ](https://github.com/kanaka/miniMAL ) is small Lisp interpreter
implemented in less than 1024 bytes of JavaScript. To run the miniMAL
implementation of mal you need to download/install the miniMAL
interpreter (which requires Node.js).
```
cd miniMAL
2015-03-02 22:20:55 +03:00
# Download miniMAL and dependencies
npm install
export PATH=`pwd`/node_modules/minimal-lisp/:$PATH
# Now run mal implementation in miniMAL
2015-02-25 09:27:37 +03:00
miniMAL ./stepX_YYY
```
2019-08-04 18:50:09 +03:00
### Perl 5
The Perl 5 implementation should work with perl 5.19.3 and later.
2014-04-19 22:55:30 +04:00
For readline line editing support, install Term::ReadLine::Perl or
Term::ReadLine::Gnu from CPAN.
```
cd perl
perl stepX_YYY.pl
```
2016-06-07 00:11:29 +03:00
### Perl 6
The Perl 6 implementation was tested on Rakudo Perl 6 2016.04.
```
cd perl6
perl6 stepX_YYY.pl
```
2014-04-19 22:55:30 +04:00
2014-03-30 04:01:14 +04:00
### PHP 5.3
2014-03-30 00:17:00 +04:00
2014-10-10 08:48:47 +04:00
The PHP implementation of mal requires the php command line interface
to run.
2014-03-30 00:17:00 +04:00
```
cd php
php stepX_YYY.php
```
2016-10-26 00:43:32 +03:00
### Picolisp
The Picolisp implementation requires libreadline and Picolisp 3.1.11
or later.
```
2018-06-22 19:20:38 +03:00
cd picolisp
2016-10-26 00:43:32 +03:00
./run
```
2019-09-18 08:53:48 +03:00
### Pike
The Pike implementation was tested on Pike 8.0.
```
cd pike
pike stepX_YYY.pike
```
2019-05-19 14:33:52 +03:00
### PL/pgSQL (PostgreSQL SQL Procedural Language)
2016-03-31 09:09:08 +03:00
2019-05-19 14:33:52 +03:00
The PL/pgSQL implementation of mal requires a running PostgreSQL server
2016-05-04 08:38:02 +03:00
(the "kanaka/mal-test-plpgsql" docker image automatically starts
2019-05-19 14:33:52 +03:00
a PostgreSQL server). The implementation connects to the PostgreSQL server
2016-05-04 08:38:02 +03:00
and create a database named "mal" to store tables and stored
procedures. The wrapper script uses the psql command to connect to the
server and defaults to the user "postgres" but this can be overridden
with the PSQL_USER environment variable. A password can be specified
using the PGPASSWORD environment variable. The implementation has been
2019-05-19 14:33:52 +03:00
tested with PostgreSQL 9.4.
2016-03-31 09:09:08 +03:00
```
cd plpgsql
./wrap.sh stepX_YYY.sql
2016-05-04 08:38:02 +03:00
# OR
PSQL_USER=myuser PGPASSWORD=mypass ./wrap.sh stepX_YYY.sql
```
### PL/SQL (Oracle SQL Procedural Language)
2019-05-19 14:27:25 +03:00
The PL/SQL implementation of mal requires a running Oracle DB
2016-05-04 08:38:02 +03:00
server (the "kanaka/mal-test-plsql" docker image automatically
starts an Oracle Express server). The implementation connects to the
Oracle server to create types, tables and stored procedures. The
2019-05-19 14:22:36 +03:00
default SQL\*Plus logon value (username/password@connect_identifier) is
2016-05-04 08:38:02 +03:00
"system/oracle" but this can be overridden with the ORACLE_LOGON
environment variable. The implementation has been tested with Oracle
2019-05-19 14:22:36 +03:00
Express Edition 11g Release 2. Note that any SQL\*Plus connection
2016-05-04 08:38:02 +03:00
warnings (user password expiration, etc) will interfere with the
ability of the wrapper script to communicate with the DB.
```
cd plsql
./wrap.sh stepX_YYY.sql
# OR
ORACLE_LOGON=myuser/mypass@ORCL ./wrap.sh stepX_YYY.sql
2016-03-31 09:09:08 +03:00
```
2019-05-19 14:26:35 +03:00
### PostScript Level 2/3
2016-08-25 01:42:19 +03:00
2019-05-19 14:26:35 +03:00
The PostScript implementation of mal requires Ghostscript to run. It
has been tested with Ghostscript 9.10.
2016-08-25 01:42:19 +03:00
```
cd ps
gs -q -dNODISPLAY -I./ stepX_YYY.ps
```
### PowerShell
The PowerShell implementation of mal requires the PowerShell script
language. It has been tested with PowerShell 6.0.0 Alpha 9 on Linux.
```
cd powershell
powershell ./stepX_YYY.ps1
```
2017-09-12 01:49:26 +03:00
### Python (2.X and 3.X)
2014-03-30 00:17:00 +04:00
```
cd python
python stepX_YYY.py
```
2014-04-14 00:36:02 +04:00
2019-10-15 23:55:29 +03:00
### Python.2 (3.X)
The second Python implementation makes heavy use of type annotations and uses the Arpeggio parser library.
```
# Recommended: do these steps in a Python virtual environment.
pip3 install Arpeggio==1.9.0
python3 stepX_YYY.py
```
2015-06-11 18:01:16 +03:00
### RPython
You must have [rpython ](https://rpython.readthedocs.org/ ) on your path
(included with [pypy ](https://bitbucket.org/pypy/pypy/ )).
```
cd rpython
2015-10-09 22:36:57 +03:00
make # this takes a very long time
2015-06-11 18:01:16 +03:00
./stepX_YYY
```
2014-11-04 08:50:55 +03:00
### R
The R implementation of mal requires R (r-base-core) to run.
```
cd r
2015-01-09 08:25:40 +03:00
make libs # to download and build rdyncall
2015-01-03 08:20:00 +03:00
Rscript stepX_YYY.r
```
### Racket (5.3)
The Racket implementation of mal requires the Racket
compiler/interpreter to run.
```
cd racket
2015-03-15 20:01:50 +03:00
./stepX_YYY.rkt
2014-11-04 08:50:55 +03:00
```
2017-07-20 15:07:01 +03:00
### Rexx
The Rexx implementation of mal has been tested with Regina Rexx 3.6.
```
cd rexx
make
rexx -a ./stepX_YYY.rexxpp
```
2015-02-28 02:36:27 +03:00
### Ruby (1.9+)
2014-04-14 00:36:02 +04:00
```
cd ruby
ruby stepX_YYY.rb
```
2014-04-24 07:59:41 +04:00
2019-11-03 02:43:24 +03:00
### Rust (1.38+)
2014-10-25 20:42:07 +04:00
The rust implementation of mal requires the rust compiler and build
tool (cargo) to build.
```
cd rust
2015-03-05 11:22:43 +03:00
cargo run --release --bin stepX_YYY
2014-10-25 20:42:07 +04:00
```
2014-12-19 08:21:39 +03:00
### Scala ###
Install scala and sbt (http://www.scala-sbt.org/0.13/tutorial/Installing-sbt-on-Linux.html):
```
cd scala
sbt 'run-main stepX_YYY'
# OR
sbt compile
scala -classpath target/scala*/classes stepX_YYY
```
2017-09-12 10:44:51 +03:00
### Scheme (R7RS) ###
2017-09-10 13:24:55 +03:00
The Scheme implementation of mal has been tested with Chibi-Scheme
0.7.3, Kawa 2.4, Gauche 0.9.5, CHICKEN 4.11.0, Sagittarius 0.8.3,
Cyclone 0.6.3 (Git version) and Foment 0.4 (Git version). You should
be able to get it running on other conforming R7RS implementations
after figuring out how libraries are loaded and adjusting the
`Makefile` and `run` script accordingly.
```
2017-09-12 00:54:50 +03:00
cd scheme
2017-09-10 13:24:55 +03:00
make symlinks
# chibi
2017-09-12 10:44:51 +03:00
scheme_MODE=chibi ./run
2017-09-10 13:24:55 +03:00
# kawa
make kawa
2017-09-12 10:44:51 +03:00
scheme_MODE=kawa ./run
2017-09-10 13:24:55 +03:00
# gauche
2017-09-12 10:44:51 +03:00
scheme_MODE=gauche ./run
2017-09-10 13:24:55 +03:00
# chicken
make chicken
2017-09-12 10:44:51 +03:00
scheme_MODE=chicken ./run
2017-09-10 13:24:55 +03:00
# sagittarius
2017-09-12 10:44:51 +03:00
scheme_MODE=sagittarius ./run
2017-09-10 13:24:55 +03:00
# cyclone
make cyclone
2017-09-12 10:44:51 +03:00
scheme_MODE=cyclone ./run
2017-09-10 13:24:55 +03:00
# foment
2017-09-12 10:44:51 +03:00
scheme_MODE=foment ./run
2017-09-10 13:24:55 +03:00
```
2016-11-09 00:40:18 +03:00
### Skew ###
The Skew implementation of mal has been tested with Skew 0.7.42.
```
cd skew
make
node stepX_YYY.js
```
2015-03-18 09:32:35 +03:00
### Swift
2015-09-22 07:28:38 +03:00
The Swift implementation of mal requires the Swift 2.0 compiler (XCode
7.0) to build. Older versions will not work due to changes in the
language and standard library.
2015-03-24 18:29:53 +03:00
2015-03-18 09:32:35 +03:00
```
cd swift
make
./stepX_YYY
```
2016-02-24 10:09:57 +03:00
### Swift 3
The Swift 3 implementation of mal requires the Swift 3.0 compiler. It
2016-08-01 07:25:23 +03:00
has been tested with Swift 3 Preview 3.
2016-02-24 10:09:57 +03:00
```
cd swift3
make
./stepX_YYY
```
2019-03-06 04:35:31 +03:00
### Swift 4
The Swift 4 implementation of mal requires the Swift 4.0 compiler. It
has been tested with Swift 4.2.3 release.
```
cd swift4
make
./stepX_YYY
```
2019-11-08 19:57:33 +03:00
### Swift 5
The Swift 5 implementation of mal requires the Swift 5.0 compiler. It
has been tested with Swift 5.1.1 release.
```
cd swift5
2019-11-08 20:29:42 +03:00
swift run stepX_YYY
2019-11-08 19:57:33 +03:00
```
2015-07-09 18:14:16 +03:00
### Tcl 8.6
The Tcl implementation of mal requires Tcl 8.6 to run. For readline line
editing support, install tclreadline.
```
cd tcl
tclsh ./stepX_YYY.tcl
```
2017-02-25 08:32:18 +03:00
### TypeScript
The TypeScript implementation of mal requires the TypeScript 2.2 compiler.
2017-02-26 05:02:46 +03:00
It has been tested with Node.js v6.
2017-02-25 08:32:18 +03:00
```
cd ts
make
node ./stepX_YYY.js
```
2019-05-10 11:34:20 +03:00
### Vala
The Vala implementation of mal has been tested with the Vala 0.40.8
compiler. You will need to install `valac` and `libreadline-dev` or
equivalent.
```
cd vala
make
./stepX_YYY
```
2016-03-23 23:03:58 +03:00
### VHDL
The VHDL implementation of mal has been tested with GHDL 0.29.
```
cd vhdl
make
./run_vhdl.sh ./stepX_YYY
```
2015-10-20 22:02:00 +03:00
### Vimscript
2016-10-25 22:55:14 +03:00
The Vimscript implementation of mal requires Vim 8.0 to run.
2015-10-20 22:02:00 +03:00
```
cd vimscript
./run_vimscript.sh ./stepX_YYY.vim
```
2014-11-16 08:15:09 +03:00
### Visual Basic.NET ###
The VB.NET implementation of mal has been tested on Linux using the Mono
VB compiler (vbnc) and the Mono runtime (version 2.10.8.1). Both are
required to build and run the VB.NET implementation.
```
cd vb
make
mono ./stepX_YYY.exe
```
2018-12-09 01:56:59 +03:00
### WebAssembly (wasm) ###
2018-12-09 03:26:13 +03:00
The WebAssembly implementation is written in
2018-12-09 01:56:59 +03:00
[Wam ](https://github.com/kanaka/wam ) (WebAssembly Macro language) and
2019-04-17 08:35:39 +03:00
runs under several different non-web embeddings (runtimes):
2019-08-12 09:09:55 +03:00
[node ](https://nodejs.org ),
2019-04-17 08:35:39 +03:00
[wasmtime ](https://github.com/CraneStation/wasmtime ),
2019-08-12 09:09:55 +03:00
[wasmer ](https://wasmer.io ),
[lucet ](https://github.com/fastly/lucet ),
2019-04-19 09:07:08 +03:00
[wax ](https://github.com/kanaka/wac ),
2019-04-17 08:35:39 +03:00
[wace ](https://github.com/kanaka/wac ),
[warpy ](https://github.com/kanaka/warpy ).
2018-12-09 01:56:59 +03:00
```
cd wasm
2019-04-17 08:35:39 +03:00
# node
make wasm_MODE=node
./run.js ./stepX_YYY.wasm
# wasmtime
make wasm_MODE=wasmtime
wasmtime --dir=./ --dir=../ --dir=/ ./stepX_YYY.wasm
2019-08-12 09:09:55 +03:00
# wasmer
make wasm_MODE=wasmer
wasmer run --dir=./ --dir=../ --dir=/ ./stepX_YYY.wasm
# lucet
make wasm_MODE=lucet
lucet-wasi --dir=./:./ --dir=../:../ --dir=/:/ ./stepX_YYY.so
2019-04-19 09:07:08 +03:00
# wax
make wasm_MODE=wax
2019-08-12 09:09:55 +03:00
wax ./stepX_YYY.wasm
2019-04-17 08:35:39 +03:00
# wace
make wasm_MODE=wace_libc
2018-12-09 01:56:59 +03:00
wace ./stepX_YYY.wasm
2019-04-17 08:35:39 +03:00
# warpy
make wasm_MODE=warpy
warpy --argv --memory-pages 256 ./stepX_YYY.wasm
2018-12-09 01:56:59 +03:00
```
2019-10-31 16:27:46 +03:00
### Wren
The Wren implementation of mal was tested on Wren 0.2.0.
```
cd wren
wren ./stepX_YYY.wren
```
2017-09-23 00:14:35 +03:00
### Yorick
The Yorick implementation of mal was tested on Yorick 2.2.04.
```
cd yorick
yorick -batch ./stepX_YYY.i
```
2019-12-20 07:24:54 +03:00
### Zig
The Zig implementation of mal was tested on Zig 0.5.
```
cd zig
zig build stepX_YYY
```
2017-09-23 00:14:35 +03:00
2014-11-16 08:15:09 +03:00
2014-04-24 07:59:41 +04:00
## Running tests
2019-01-30 21:05:34 +03:00
The top level Makefile has a number of useful targets to assist with
implementation development and testing. The `help` target provides
a list of the targets and options:
```
make help
```
2015-03-03 02:57:45 +03:00
### Functional tests
2019-08-12 09:09:55 +03:00
The are almost 800 generic functional tests (for all implementations)
2015-03-03 02:57:45 +03:00
in the `tests/` directory. Each step has a corresponding test file
containing tests specific to that step. The `runtest.py` test harness
2015-03-26 05:53:53 +03:00
launches a Mal step implementation and then feeds the tests one at
a time to the implementation and compares the output/return value to
the expected output/return value.
2014-04-24 07:59:41 +04:00
* To run all the tests across all implementations (be prepared to wait):
```
make test
```
* To run all tests against a single implementation:
```
2015-12-09 22:49:15 +03:00
make "test^IMPL"
2014-04-24 07:59:41 +04:00
# e.g.
2015-12-09 22:49:15 +03:00
make "test^clojure"
make "test^js"
2014-04-24 07:59:41 +04:00
```
* To run tests for a single step against all implementations:
```
2015-12-09 22:49:15 +03:00
make "test^stepX"
2014-04-24 07:59:41 +04:00
# e.g.
2015-12-09 22:49:15 +03:00
make "test^step2"
make "test^step7"
2014-04-24 07:59:41 +04:00
```
2015-09-22 07:29:50 +03:00
* To run tests for a specific step against a single implementation:
2014-04-24 07:59:41 +04:00
```
2015-12-09 22:49:15 +03:00
make "test^IMPL^stepX"
2014-04-24 07:59:41 +04:00
# e.g
2015-12-09 22:49:15 +03:00
make "test^ruby^step3"
make "test^ps^step4"
2014-04-24 07:59:41 +04:00
```
2015-01-09 07:56:12 +03:00
2015-03-03 02:57:45 +03:00
### Self-hosted functional tests
* To run the functional tests in self-hosted mode, you specify `mal`
as the test implementation and use the `MAL_IMPL` make variable
to change the underlying host language (default is JavaScript):
```
2015-12-09 22:49:15 +03:00
make MAL_IMPL=IMPL "test^mal^step2"
2015-03-03 02:57:45 +03:00
# e.g.
2015-12-09 22:49:15 +03:00
make "test^mal^step2" # js is default
make MAL_IMPL=ruby "test^mal^step2"
make MAL_IMPL=python "test^mal^step2"
2015-03-03 02:57:45 +03:00
```
2015-12-14 16:50:27 +03:00
### Starting the REPL
* To start the REPL of an implementation in a specific step:
```
make "repl^IMPL^stepX"
# e.g
make "repl^ruby^step3"
make "repl^ps^step4"
```
* If you omit the step, then `stepA` is used:
```
make "repl^IMPL"
# e.g
make "repl^ruby"
make "repl^ps"
```
* To start the REPL of the self-hosted implementation, specify `mal` as the
REPL implementation and use the `MAL_IMPL` make variable to change the
underlying host language (default is JavaScript):
```
make MAL_IMPL=IMPL "repl^mal^stepX"
# e.g.
make "repl^mal^step2" # js is default
make MAL_IMPL=ruby "repl^mal^step2"
make MAL_IMPL=python "repl^mal"
```
2015-03-03 02:57:45 +03:00
### Performance tests
2015-03-12 06:08:21 +03:00
Warning: These performance tests are neither statistically valid nor
comprehensive; runtime performance is a not a primary goal of mal. If
you draw any serious conclusions from these performance tests, then
please contact me about some amazing oceanfront property in Kansas
that I'm willing to sell you for cheap.
2015-03-03 02:57:45 +03:00
* To run performance tests against a single implementation:
```
2015-12-09 22:49:15 +03:00
make "perf^IMPL"
2015-03-03 02:57:45 +03:00
# e.g.
2015-12-09 22:49:15 +03:00
make "perf^js"
2015-03-03 02:57:45 +03:00
```
* To run performance tests against all implementations:
```
2015-12-09 22:49:15 +03:00
make "perf"
2015-03-03 02:57:45 +03:00
```
### Generating language statistics
2015-09-22 07:29:50 +03:00
* To report line and byte statistics for a single implementation:
2015-03-03 02:57:45 +03:00
```
2015-12-09 22:49:15 +03:00
make "stats^IMPL"
2015-03-03 02:57:45 +03:00
# e.g.
2015-12-09 22:49:15 +03:00
make "stats^js"
2015-03-03 02:57:45 +03:00
```
2016-03-08 08:33:45 +03:00
## Dockerized testing
2015-03-13 01:29:34 +03:00
2016-03-08 08:33:45 +03:00
Every implementation directory contains a Dockerfile to create
a docker image containing all the dependencies for that
implementation. In addition, the top-level Makefile contains support
for running the tests target (and perf, stats, repl, etc) within
a docker container for that implementation by passing *"DOCKERIZE=1"*
on the make command line. For example:
2015-03-13 01:29:34 +03:00
```
2016-03-08 08:33:45 +03:00
make DOCKERIZE=1 "test^js^step3"
2015-03-13 01:29:34 +03:00
```
2016-03-08 08:33:45 +03:00
Existing implementations already have docker images built and pushed
to the docker registry. However, if
you wish to build or rebuild a docker image locally, the toplevel
Makefile provides a rule for building docker images:
2015-03-13 01:29:34 +03:00
```
2016-03-08 08:33:45 +03:00
make "docker-build^IMPL"
```
2015-03-13 01:29:34 +03:00
**Notes**:
2016-03-08 08:33:45 +03:00
* Docker images are named *"kanaka/mal-test-IMPL"*
* JVM-based language implementations (Groovy, Java, Clojure, Scala):
2019-01-11 00:30:21 +03:00
you will probably need to run this command once manually
first `make DOCKERIZE=1 "repl^IMPL"` before you can run tests because
2016-03-08 08:33:45 +03:00
runtime dependencies need to be downloaded to avoid the tests timing
2019-01-11 00:30:21 +03:00
out. These dependencies are downloaded to dot-files in the /mal
2016-03-08 08:33:45 +03:00
directory so they will persist between runs.
2015-03-13 01:29:34 +03:00
2019-01-29 01:07:27 +03:00
2015-01-09 07:56:12 +03:00
## License
Mal (make-a-lisp) is licensed under the MPL 2.0 (Mozilla Public
License 2.0). See LICENSE.txt for more details.