3 [![Build Status](https://travis-ci.org/kanaka/mal.svg?branch=master)](https://travis-ci.org/kanaka/mal)
7 **1. Mal is a Clojure inspired Lisp interpreter**
9 **2. Mal is implemented in 75 languages (76 implementations total)**
11 | Language | Creator |
12 | -------- | ------- |
13 | [Ada](#ada) | [Chris Moore](https://github.com/zmower) |
14 | [Ada #2](#ada2) | [Nicolas Boulenguez](https://github.com/asarhaddon) |
15 | [GNU Awk](#gnu-awk) | [Miutsuru Kariya](https://github.com/kariya-mitsuru) |
16 | [Bash 4](#bash-4) | [Joel Martin](https://github.com/kanaka) |
17 | [BASIC](#basic-c64-and-qbasic) (C64 & QBasic) | [Joel Martin](https://github.com/kanaka) |
18 | [C](#c) | [Joel Martin](https://github.com/kanaka) |
19 | [C++](#c-1) | [Stephen Thirlwall](https://github.com/sdt) |
20 | [C#](#c-2) | [Joel Martin](https://github.com/kanaka) |
21 | [ChucK](#chuck) | [Vasilij Schneidermann](https://github.com/wasamasa) |
22 | [Clojure](#clojure) (Clojure & ClojureScript) | [Joel Martin](https://github.com/kanaka) |
23 | [CoffeeScript](#coffeescript) | [Joel Martin](https://github.com/kanaka) |
24 | [Common Lisp](#common-lisp) | [Iqbal Ansari](https://github.com/iqbalansari) |
25 | [Crystal](#crystal) | [Linda_pp](https://github.com/rhysd) |
26 | [D](#d) | [Dov Murik](https://github.com/dubek) |
27 | [Dart](#dart) | [Harry Terkelsen](https://github.com/hterkelsen) |
28 | [Elixir](#elixir) | [Martin Ek](https://github.com/ekmartin) |
29 | [Elm](#elm) | [Jos van Bakel](https://github.com/c0deaddict) |
30 | [Emacs Lisp](#emacs-lisp) | [Vasilij Schneidermann](https://github.com/wasamasa) |
31 | [Erlang](#erlang) | [Nathan Fiedler](https://github.com/nlfiedler) |
32 | [ES6](#es6-ecmascript-2015) (ECMAScript 2015) | [Joel Martin](https://github.com/kanaka) |
33 | [F#](#f) | [Peter Stephens](https://github.com/pstephens) |
34 | [Factor](#factor) | [Jordan Lewis](https://github.com/jordanlewis) |
35 | [Fantom](#fantom) | [Dov Murik](https://github.com/dubek) |
36 | [Forth](#forth) | [Chris Houser](https://github.com/chouser) |
37 | [GNU Guile](#gnu-guile-21) | [Mu Lei](https://github.com/NalaGinrut) |
38 | [GNU Smalltalk](#gnu-smalltalk) | [Vasilij Schneidermann](https://github.com/wasamasa) |
39 | [Go](#go) | [Joel Martin](https://github.com/kanaka) |
40 | [Groovy](#groovy) | [Joel Martin](https://github.com/kanaka) |
41 | [Haskell](#haskell) | [Joel Martin](https://github.com/kanaka) |
42 | [Haxe](#haxe-neko-python-c-and-javascript) (Neko, Python, C++, & JS) | [Joel Martin](https://github.com/kanaka) |
43 | [Hy](#hy) | [Joel Martin](https://github.com/kanaka) |
44 | [Io](#io) | [Dov Murik](https://github.com/dubek) |
45 | [Java](#java-17) | [Joel Martin](https://github.com/kanaka) |
46 | [JavaScript](#javascriptnode) ([Demo](http://kanaka.github.io/mal)) | [Joel Martin](https://github.com/kanaka) |
47 | [Julia](#julia) | [Joel Martin](https://github.com/kanaka) |
48 | [Kotlin](#kotlin) | [Javier Fernandez-Ivern](https://github.com/ivern) |
49 | [LiveScript](#livescript) | [Jos van Bakel](https://github.com/c0deaddict) |
50 | [Logo](#logo) | [Dov Murik](https://github.com/dubek) |
51 | [Lua](#lua) | [Joel Martin](https://github.com/kanaka) |
52 | [GNU Make](#gnu-make-381) | [Joel Martin](https://github.com/kanaka) |
53 | [mal itself](#mal) | [Joel Martin](https://github.com/kanaka) |
54 | [MATLAB](#matlab-gnu-octave-and-matlab) (GNU Octave & MATLAB) | [Joel Martin](https://github.com/kanaka) |
55 | [miniMAL](#minimal) ([Repo](https://github.com/kanaka/miniMAL), [Demo](https://kanaka.github.io/miniMAL/)) | [Joel Martin](https://github.com/kanaka) |
56 | [NASM](#nasm) | [Ben Dudson](https://github.com/bendudson) |
57 | [Nim](#nim-0170) | [Dennis Felsing](https://github.com/def-) |
58 | [Object Pascal](#object-pascal) | [Joel Martin](https://github.com/kanaka) |
59 | [Objective C](#objective-c) | [Joel Martin](https://github.com/kanaka) |
60 | [OCaml](#ocaml-4010) | [Chris Houser](https://github.com/chouser) |
61 | [Perl](#perl-58) | [Joel Martin](https://github.com/kanaka) |
62 | [Perl 6](#perl-6) | [Hinrik Örn Sigurðsson](https://github.com/hinrik) |
63 | [PHP](#php-53) | [Joel Martin](https://github.com/kanaka) |
64 | [Picolisp](#picolisp) | [Vasilij Schneidermann](https://github.com/wasamasa) |
65 | [PL/pgSQL](#plpgsql-postgres-sql-procedural-language) (Postgres) | [Joel Martin](https://github.com/kanaka) |
66 | [PL/SQL](#plsql-oracle-sql-procedural-language) (Oracle) | [Joel Martin](https://github.com/kanaka) |
67 | [PostScript](#postscript-level-23) | [Joel Martin](https://github.com/kanaka) |
68 | [PowerShell](#powershell) | [Joel Martin](https://github.com/kanaka) |
69 | [Python](#python-2x-and-3x) (2.X & 3.X) | [Joel Martin](https://github.com/kanaka) |
70 | [RPython](#rpython) | [Joel Martin](https://github.com/kanaka) |
71 | [R](#r) | [Joel Martin](https://github.com/kanaka) |
72 | [Racket](#racket-53) | [Joel Martin](https://github.com/kanaka) |
73 | [Rexx](#rexx) | [Dov Murik](https://github.com/dubek) |
74 | [Ruby](#ruby-19) | [Joel Martin](https://github.com/kanaka) |
75 | [Rust](#rust-100-nightly) | [Joel Martin](https://github.com/kanaka) |
76 | [Scala](#scala) | [Joel Martin](https://github.com/kanaka) |
77 | [Scheme (R7RS)](#scheme-r7rs) | [Vasilij Schneidermann](https://github.com/wasamasa) |
78 | [Skew](#skew) | [Dov Murik](https://github.com/dubek) |
79 | [Swift 2](#swift) | [Keith Rollin](https://github.com/keith-rollin) |
80 | [Swift 3](#swift-3) | [Joel Martin](https://github.com/kanaka) |
81 | [Swift 4](#swift-4) | [陆遥](https://github.com/LispLY) |
82 | [Tcl](#tcl-86) | [Dov Murik](https://github.com/dubek) |
83 | [TypeScript](#typescript) | [Masahiro Wakame](https://github.com/vvakame) |
84 | [VHDL](#vhdl) | [Dov Murik](https://github.com/dubek) |
85 | [Vimscript](#vimscript) | [Dov Murik](https://github.com/dubek) |
86 | [Visual Basic.NET](#visual-basicnet) | [Joel Martin](https://github.com/kanaka) |
87 | [WebAssembly](#webassembly-wasm) (wasm) | [Joel Martin](https://github.com/kanaka) |
88 | [Yorick](#yorick) | [Dov Murik](https://github.com/dubek) |
91 **3. Mal is a learning tool**
93 Each implementation of mal is separated into
94 11 incremental, self-contained (and testable) steps that demonstrate
95 core concepts of Lisp. The last step is capable of self-hosting
96 (running the mal implementation of mal). See the [make-a-lisp process
97 guide](process/guide.md).
99 The make-a-lisp steps are:
101 * [step0_repl](process/guide.md#step0)
102 * [step1_read_print](process/guide.md#step1)
103 * [step2_eval](process/guide.md#step2)
104 * [step3_env](process/guide.md#step3)
105 * [step4_if_fn_do](process/guide.md#step4)
106 * [step5_tco](process/guide.md#step5)
107 * [step6_file](process/guide.md#step6)
108 * [step7_quote](process/guide.md#step7)
109 * [step8_macros](process/guide.md#step8)
110 * [step9_try](process/guide.md#step9)
111 * [stepA_mal](process/guide.md#stepA)
113 Each make-a-lisp step has an associated architectural diagram. That elements
114 that are new for that step are highlighted in red.
115 Here is the final diagram for [step A](process/guide.md#stepA):
117 ![stepA_mal architecture](process/stepA_mal.png)
119 If you are interesting in creating a mal implementation (or just
120 interested in using mal for something), please drop by the #mal
121 channel on freenode. In addition to the [make-a-lisp process
122 guide](process/guide.md) there is also a [mal/make-a-lisp
123 FAQ](docs/FAQ.md) where I attempt to answer some common questions.
128 Mal was presented publicly for the first time in a lightning talk at
129 Clojure West 2014 (unfortunately there is no video). See
130 examples/clojurewest2014.mal for the presentation that was given at the
131 conference (yes, the presentation is a mal program).
133 At Midwest.io 2015, Joel Martin gave a presentation on Mal titled
134 "Achievement Unlocked: A Better Path to Language Learning".
135 [Video](https://www.youtube.com/watch?v=lgyOAiRtZGw),
136 [Slides](http://kanaka.github.io/midwest.io.mal/).
138 More recently Joel gave a presentation on "Make Your Own Lisp Interpreter
139 in 10 Incremental Steps" at LambdaConf 2016:
140 [Part 1](https://www.youtube.com/watch?v=jVhupfthTEk),
141 [Part 2](https://www.youtube.com/watch?v=X5OQBMGpaTU),
142 [Part 3](https://www.youtube.com/watch?v=6mARZzGgX4U),
143 [Part 4](https://www.youtube.com/watch?v=dCO1SYR5kDU),
144 [Slides](http://kanaka.github.io/lambdaconf/).
146 ## Building/running implementations
148 The simplest way to run any given implementation is to use docker.
149 Every implementation has a docker image pre-built with language
150 dependencies installed. You can launch the REPL using a convenient
151 target in the top level Makefile (where IMPL is the implementation
152 directory name and stepX is the step to run):
155 make DOCKERIZE=1 "repl^IMPL^stepX"
156 # OR stepA is the default step:
157 make DOCKERIZE=1 "repl^IMPL"
160 ## External Implementations
162 The following implementations are maintained as separate projects:
166 * [by Alexander Bagnalla](https://github.com/bagnalla/holyc_mal)
170 * [by Tim Morgan](https://github.com/seven1m/mal-rust)
171 * [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).
174 ## Other mal Projects
176 * [malc](https://github.com/dubek/malc) - Mal (Make A Lisp) compiler. Compiles a Mal program to LLVM assembly language, then binary.
177 * [malcc](https://git.sr.ht/~tim/malcc) (@seven1m) - 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.
178 * [frock](https://github.com/chr15m/frock) - Clojure-flavoured PHP. Uses mal/php to run programs.
181 ## Implementation Details
185 The Ada implementation was developed with GNAT 4.9 on debian. It also
186 compiles unchanged on windows if you have windows versions of git,
187 GNAT and (optionally) make. There are no external dependencies
188 (readline not implemented).
198 The second Ada implementation was developed with GNAT 8 and links with
199 the GNU readline library.
209 The GNU awk implementation of mal has been tested with GNU awk 4.1.1.
213 gawk -O -f stepX_YYY.awk
223 ### BASIC (C64 and QBasic)
225 The BASIC implementation uses a preprocessor that can generate BASIC
226 code that is compatible with both C64 BASIC (CBM v2) and QBasic. The
227 C64 mode has been tested with
228 [cbmbasic](https://github.com/kanaka/cbmbasic) (the patched version is
229 currently required to fix issues with line input) and the QBasic mode
230 has been tested with [qb64](http://www.qb64.net/).
232 Generate C64 code and run it using cbmbasic:
240 Generate QBasic code and load it into qb64:
244 make MODE=qbasic stepX_YYY.bas
248 Thanks to [Steven Syrek](https://github.com/sjsyrek) for the original
249 inspiration for this implementation.
254 The C implementation of mal requires the following libraries (lib and
255 header packages): glib, libffi6, libgc, and either the libedit or GNU readline
266 The C++ implementation of mal requires g++-4.9 or clang++-3.5 and
267 a readline compatible library to build. See the `cpp/README.md` for
281 The C# implementation of mal has been tested on Linux using the Mono
282 C# compiler (mcs) and the Mono runtime (version 2.10.8.1). Both are
283 required to build and run the C# implementation.
293 The ChucK implementation has been tested with ChucK 1.3.5.2.
302 For the most part the Clojure implementation requires Clojure 1.5,
303 however, to pass all tests, Clojure 1.8.0-RC4 is required.
307 lein with-profile +stepX trampoline run
313 sudo npm install -g coffee-script
320 The implementation has been tested with SBCL, CCL, CMUCL, GNU CLISP, ECL and
321 Allegro CL on Ubuntu 16.04 and Ubuntu 12.04, see
322 the [README](common-lisp/README.org) for more details. Provided you have the
323 dependencies mentioned installed, do the following to run the implementation
333 The Crystal implementation of mal has been tested with Crystal 0.26.1.
337 crystal run ./stepX_YYY.cr
339 make # needed to run tests
345 The D implementation of mal was tested with GDC 4.8. It requires the GNU
356 The Dart implementation has been tested with Dart 1.20.
365 The Emacs Lisp implementation of mal has been tested with Emacs 24.3
366 and 24.5. While there is very basic readline editing (`<backspace>`
367 and `C-d` work, `C-c` cancels the process), it is recommended to use
372 emacs -Q --batch --load stepX_YYY.el
373 # with full readline support
374 rlwrap emacs -Q --batch --load stepX_YYY.el
379 The Elixir implementation of mal has been tested with Elixir 1.0.5.
384 # Or with readline/line editing functionality:
390 The Elm implementation of mal has been tested with Elm 0.18.0
400 The Erlang implementation of mal requires [Erlang/OTP R17](http://www.erlang.org/download.html)
401 and [rebar](https://github.com/rebar/rebar) to build.
407 MAL_STEP=stepX_YYY rebar compile escriptize # build individual step
411 ### ES6 (ECMAScript 2015)
413 The ES6 / ECMAScript 2015 implementation uses the
414 [babel](https://babeljs.io) compiler to generate ES5 compatible
415 JavaScript. The generated code has been tested with Node 0.12.4.
420 node build/stepX_YYY.js
426 The F# implementation of mal has been tested on Linux using the Mono
427 F# compiler (fsharpc) and the Mono runtime (version 3.12.1). The mono C#
428 compiler (mcs) is also necessary to compile the readline dependency. All are
429 required to build and run the F# implementation.
439 The Factor implementation of mal has been tested with Factor 0.97
440 ([factorcode.org](http://factorcode.org)).
444 FACTOR_ROOTS=. factor -run=stepX_YYY
449 The Fantom implementation of mal has been tested with Fantom 1.0.70.
453 make lib/fan/stepX_YYY.pod
468 guile -L ./ stepX_YYY.scm
473 The Smalltalk implementation of mal has been tested with GNU Smalltalk 3.2.91.
482 The Go implementation of mal requires that go is installed on on the
483 path. The implementation has been tested with Go 1.3.1.
494 The Groovy implementation of mal requires Groovy to run and has been
495 tested with Groovy 1.8.6.
500 groovy ./stepX_YYY.groovy
505 The Haskell implementation requires the ghc compiler version 7.10.1 or
506 later and also the Haskell parsec and readline (or editline) packages.
514 ### Haxe (Neko, Python, C++ and JavaScript)
516 The Haxe implementation of mal requires Haxe version 3.2 to compile.
517 Four different Haxe targets are supported: Neko, Python, C++, and
527 python3 ./stepX_YYY.py
538 The Hy implementation of mal has been tested with Hy 0.13.0.
547 The Io implementation of mal has been tested with Io version 20110905.
556 The Java implementation of mal requires maven2 to build.
561 mvn -quiet exec:java -Dexec.mainClass=mal.stepX_YYY
563 mvn -quiet exec:java -Dexec.mainClass=mal.stepX_YYY -Dexec.args="CMDLINE_ARGS"
576 The Julia implementation of mal requires Julia 0.4.
585 The Kotlin implementation of mal has been tested with Kotlin 1.0.
590 java -jar stepX_YYY.jar
595 The LiveScript implementation of mal has been tested with LiveScript 1.5.
600 node_modules/.bin/lsc stepX_YYY.ls
605 The Logo implementation of mal has been tested with UCBLogo 6.0.
614 The Lua implementation of mal has been tested with Lua 5.2. The
615 implementation requires that luarocks and the lua-rex-pcre library
620 make # to build and link linenoise.so
626 Running the mal implementation of mal involves running stepA of one of
627 the other implementations and passing the mal step to run as a command
632 IMPL_STEPA_CMD ../mal/stepX_YYY.mal
645 The NASM implementation of mal is written for x86-64 Linux, and has been tested
646 with Linux 3.16.0-4-amd64 and NASM version 2.11.05.
656 The Nim implementation of mal has been tested with Nim 0.17.0.
668 The Object Pascal implementation of mal has been built and tested on
669 Linux using the Free Pascal compiler version 2.6.2 and 2.6.4.
679 The Objective C implementation of mal has been built and tested on
680 Linux using clang/LLVM 3.6. It has also been built and tested on OS
697 ### MATLAB (GNU Octave and MATLAB)
699 The MatLab implementation has been tested with GNU Octave 4.2.1.
700 It has also been tested with MATLAB version R2014a on Linux. Note that
701 MATLAB is a commercial product.
706 octave -q --no-gui --no-history --eval "stepX_YYY();quit;"
707 matlab -nodisplay -nosplash -nodesktop -nojvm -r "stepX_YYY();quit;"
708 # OR with command line arguments
709 octave -q --no-gui --no-history --eval "stepX_YYY('arg1','arg2');quit;"
710 matlab -nodisplay -nosplash -nodesktop -nojvm -r "stepX_YYY('arg1','arg2');quit;"
715 [miniMAL](https://github.com/kanaka/miniMAL) is small Lisp interpreter
716 implemented in less than 1024 bytes of JavaScript. To run the miniMAL
717 implementation of mal you need to download/install the miniMAL
718 interpreter (which requires Node.js).
721 # Download miniMAL and dependencies
723 export PATH=`pwd`/node_modules/minimal-lisp/:$PATH
724 # Now run mal implementation in miniMAL
730 For readline line editing support, install Term::ReadLine::Perl or
731 Term::ReadLine::Gnu from CPAN.
740 The Perl 6 implementation was tested on Rakudo Perl 6 2016.04.
749 The PHP implementation of mal requires the php command line interface
759 The Picolisp implementation requires libreadline and Picolisp 3.1.11
767 ### PL/pgSQL (Postgres SQL Procedural Language)
769 The PL/pgSQL implementation of mal requires a running Postgres server
770 (the "kanaka/mal-test-plpgsql" docker image automatically starts
771 a Postgres server). The implementation connects to the Postgres server
772 and create a database named "mal" to store tables and stored
773 procedures. The wrapper script uses the psql command to connect to the
774 server and defaults to the user "postgres" but this can be overridden
775 with the PSQL_USER environment variable. A password can be specified
776 using the PGPASSWORD environment variable. The implementation has been
777 tested with Postgres 9.4.
781 ./wrap.sh stepX_YYY.sql
783 PSQL_USER=myuser PGPASSWORD=mypass ./wrap.sh stepX_YYY.sql
786 ### PL/SQL (Oracle SQL Procedural Language)
788 The PL/pgSQL implementation of mal requires a running Oracle DB
789 server (the "kanaka/mal-test-plsql" docker image automatically
790 starts an Oracle Express server). The implementation connects to the
791 Oracle server to create types, tables and stored procedures. The
792 default SQL*Plus logon value (username/password@connect_identifier) is
793 "system/oracle" but this can be overridden with the ORACLE_LOGON
794 environment variable. The implementation has been tested with Oracle
795 Express Edition 11g Release 2. Note that any SQL*Plus connection
796 warnings (user password expiration, etc) will interfere with the
797 ability of the wrapper script to communicate with the DB.
801 ./wrap.sh stepX_YYY.sql
803 ORACLE_LOGON=myuser/mypass@ORCL ./wrap.sh stepX_YYY.sql
806 ### Postscript Level 2/3
808 The Postscript implementation of mal requires ghostscript to run. It
809 has been tested with ghostscript 9.10.
813 gs -q -dNODISPLAY -I./ stepX_YYY.ps
818 The PowerShell implementation of mal requires the PowerShell script
819 language. It has been tested with PowerShell 6.0.0 Alpha 9 on Linux.
823 powershell ./stepX_YYY.ps1
826 ### Python (2.X and 3.X)
835 You must have [rpython](https://rpython.readthedocs.org/) on your path
836 (included with [pypy](https://bitbucket.org/pypy/pypy/)).
840 make # this takes a very long time
846 The R implementation of mal requires R (r-base-core) to run.
850 make libs # to download and build rdyncall
856 The Racket implementation of mal requires the Racket
857 compiler/interpreter to run.
866 The Rexx implementation of mal has been tested with Regina Rexx 3.6.
871 rexx -a ./stepX_YYY.rexxpp
881 ### Rust (1.0.0 nightly)
883 The rust implementation of mal requires the rust compiler and build
884 tool (cargo) to build.
888 cargo run --release --bin stepX_YYY
893 Install scala and sbt (http://www.scala-sbt.org/0.13/tutorial/Installing-sbt-on-Linux.html):
897 sbt 'run-main stepX_YYY'
900 scala -classpath target/scala*/classes stepX_YYY
903 ### Scheme (R7RS) ###
905 The Scheme implementation of mal has been tested with Chibi-Scheme
906 0.7.3, Kawa 2.4, Gauche 0.9.5, CHICKEN 4.11.0, Sagittarius 0.8.3,
907 Cyclone 0.6.3 (Git version) and Foment 0.4 (Git version). You should
908 be able to get it running on other conforming R7RS implementations
909 after figuring out how libraries are loaded and adjusting the
910 `Makefile` and `run` script accordingly.
916 scheme_MODE=chibi ./run
919 scheme_MODE=kawa ./run
921 scheme_MODE=gauche ./run
924 scheme_MODE=chicken ./run
926 scheme_MODE=sagittarius ./run
929 scheme_MODE=cyclone ./run
931 scheme_MODE=foment ./run
936 The Skew implementation of mal has been tested with Skew 0.7.42.
947 The Swift implementation of mal requires the Swift 2.0 compiler (XCode
948 7.0) to build. Older versions will not work due to changes in the
949 language and standard library.
959 The Swift 3 implementation of mal requires the Swift 3.0 compiler. It
960 has been tested with Swift 3 Preview 3.
970 The Swift 4 implementation of mal requires the Swift 4.0 compiler. It
971 has been tested with Swift 4.2.3 release.
981 The Tcl implementation of mal requires Tcl 8.6 to run. For readline line
982 editing support, install tclreadline.
986 tclsh ./stepX_YYY.tcl
991 The TypeScript implementation of mal requires the TypeScript 2.2 compiler.
992 It has been tested with Node.js v6.
1002 The VHDL implementation of mal has been tested with GHDL 0.29.
1007 ./run_vhdl.sh ./stepX_YYY
1012 The Vimscript implementation of mal requires Vim 8.0 to run.
1016 ./run_vimscript.sh ./stepX_YYY.vim
1019 ### Visual Basic.NET ###
1021 The VB.NET implementation of mal has been tested on Linux using the Mono
1022 VB compiler (vbnc) and the Mono runtime (version 2.10.8.1). Both are
1023 required to build and run the VB.NET implementation.
1028 mono ./stepX_YYY.exe
1031 ### WebAssembly (wasm) ###
1033 The WebAssembly implementation is written in
1034 [Wam](https://github.com/kanaka/wam) (WebAssembly Macro language) and
1035 runs under several different non-web embeddings (runtimes):
1037 [wasmtime](https://github.com/CraneStation/wasmtime),
1038 [wax](https://github.com/kanaka/wac),
1039 [wace](https://github.com/kanaka/wac),
1040 [warpy](https://github.com/kanaka/warpy).
1046 ./run.js ./stepX_YYY.wasm
1048 make wasm_MODE=wasmtime
1049 wasmtime --dir=./ --dir=../ --dir=/ ./stepX_YYY.wasm
1052 wace ./stepX_YYY.wasm
1054 make wasm_MODE=wace_libc
1055 wace ./stepX_YYY.wasm
1057 make wasm_MODE=warpy
1058 warpy --argv --memory-pages 256 ./stepX_YYY.wasm
1063 The Yorick implementation of mal was tested on Yorick 2.2.04.
1067 yorick -batch ./stepX_YYY.i
1074 The top level Makefile has a number of useful targets to assist with
1075 implementation development and testing. The `help` target provides
1076 a list of the targets and options:
1082 ### Functional tests
1084 The are over 600 generic functional tests (for all implementations)
1085 in the `tests/` directory. Each step has a corresponding test file
1086 containing tests specific to that step. The `runtest.py` test harness
1087 launches a Mal step implementation and then feeds the tests one at
1088 a time to the implementation and compares the output/return value to
1089 the expected output/return value.
1091 * To run all the tests across all implementations (be prepared to wait):
1097 * To run all tests against a single implementation:
1107 * To run tests for a single step against all implementations:
1117 * To run tests for a specific step against a single implementation:
1120 make "test^IMPL^stepX"
1123 make "test^ruby^step3"
1124 make "test^ps^step4"
1127 ### Self-hosted functional tests
1129 * To run the functional tests in self-hosted mode, you specify `mal`
1130 as the test implementation and use the `MAL_IMPL` make variable
1131 to change the underlying host language (default is JavaScript):
1133 make MAL_IMPL=IMPL "test^mal^step2"
1136 make "test^mal^step2" # js is default
1137 make MAL_IMPL=ruby "test^mal^step2"
1138 make MAL_IMPL=python "test^mal^step2"
1141 ### Starting the REPL
1143 * To start the REPL of an implementation in a specific step:
1146 make "repl^IMPL^stepX"
1149 make "repl^ruby^step3"
1150 make "repl^ps^step4"
1153 * If you omit the step, then `stepA` is used:
1163 * To start the REPL of the self-hosted implementation, specify `mal` as the
1164 REPL implementation and use the `MAL_IMPL` make variable to change the
1165 underlying host language (default is JavaScript):
1167 make MAL_IMPL=IMPL "repl^mal^stepX"
1170 make "repl^mal^step2" # js is default
1171 make MAL_IMPL=ruby "repl^mal^step2"
1172 make MAL_IMPL=python "repl^mal"
1175 ### Performance tests
1177 Warning: These performance tests are neither statistically valid nor
1178 comprehensive; runtime performance is a not a primary goal of mal. If
1179 you draw any serious conclusions from these performance tests, then
1180 please contact me about some amazing oceanfront property in Kansas
1181 that I'm willing to sell you for cheap.
1183 * To run performance tests against a single implementation:
1191 * To run performance tests against all implementations:
1196 ### Generating language statistics
1198 * To report line and byte statistics for a single implementation:
1206 ## Dockerized testing
1208 Every implementation directory contains a Dockerfile to create
1209 a docker image containing all the dependencies for that
1210 implementation. In addition, the top-level Makefile contains support
1211 for running the tests target (and perf, stats, repl, etc) within
1212 a docker container for that implementation by passing *"DOCKERIZE=1"*
1213 on the make command line. For example:
1216 make DOCKERIZE=1 "test^js^step3"
1219 Existing implementations already have docker images built and pushed
1220 to the docker registry. However, if
1221 you wish to build or rebuild a docker image locally, the toplevel
1222 Makefile provides a rule for building docker images:
1225 make "docker-build^IMPL"
1230 * Docker images are named *"kanaka/mal-test-IMPL"*
1231 * JVM-based language implementations (Groovy, Java, Clojure, Scala):
1232 you will probably need to run this command once manually
1233 first `make DOCKERIZE=1 "repl^IMPL"` before you can run tests because
1234 runtime dependencies need to be downloaded to avoid the tests timing
1235 out. These dependencies are downloaded to dot-files in the /mal
1236 directory so they will persist between runs.
1241 Mal (make-a-lisp) is licensed under the MPL 2.0 (Mozilla Public
1242 License 2.0). See LICENSE.txt for more details.