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 79 languages (82 different implementations and 102 runtime modes)**
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 | [BBC BASIC V](#bbc-basic-v) | [Ben Harris](https://github.com/bjh21) |
19 | [C](#c) | [Joel Martin](https://github.com/kanaka) |
20 | [C++](#c-1) | [Stephen Thirlwall](https://github.com/sdt) |
21 | [C#](#c-2) | [Joel Martin](https://github.com/kanaka) |
22 | [ChucK](#chuck) | [Vasilij Schneidermann](https://github.com/wasamasa) |
23 | [Clojure](#clojure) (Clojure & ClojureScript) | [Joel Martin](https://github.com/kanaka) |
24 | [CoffeeScript](#coffeescript) | [Joel Martin](https://github.com/kanaka) |
25 | [Common Lisp](#common-lisp) | [Iqbal Ansari](https://github.com/iqbalansari) |
26 | [Crystal](#crystal) | [Linda_pp](https://github.com/rhysd) |
27 | [D](#d) | [Dov Murik](https://github.com/dubek) |
28 | [Dart](#dart) | [Harry Terkelsen](https://github.com/hterkelsen) |
29 | [Elixir](#elixir) | [Martin Ek](https://github.com/ekmartin) |
30 | [Elm](#elm) | [Jos van Bakel](https://github.com/c0deaddict) |
31 | [Emacs Lisp](#emacs-lisp) | [Vasilij Schneidermann](https://github.com/wasamasa) |
32 | [Erlang](#erlang) | [Nathan Fiedler](https://github.com/nlfiedler) |
33 | [ES6](#es6-ecmascript-2015) (ECMAScript 2015) | [Joel Martin](https://github.com/kanaka) |
34 | [F#](#f) | [Peter Stephens](https://github.com/pstephens) |
35 | [Factor](#factor) | [Jordan Lewis](https://github.com/jordanlewis) |
36 | [Fantom](#fantom) | [Dov Murik](https://github.com/dubek) |
37 | [Forth](#forth) | [Chris Houser](https://github.com/chouser) |
38 | [GNU Guile](#gnu-guile-21) | [Mu Lei](https://github.com/NalaGinrut) |
39 | [GNU Smalltalk](#gnu-smalltalk) | [Vasilij Schneidermann](https://github.com/wasamasa) |
40 | [Go](#go) | [Joel Martin](https://github.com/kanaka) |
41 | [Groovy](#groovy) | [Joel Martin](https://github.com/kanaka) |
42 | [Haskell](#haskell) | [Joel Martin](https://github.com/kanaka) |
43 | [Haxe](#haxe-neko-python-c-and-javascript) (Neko, Python, C++, & JS) | [Joel Martin](https://github.com/kanaka) |
44 | [Hy](#hy) | [Joel Martin](https://github.com/kanaka) |
45 | [Io](#io) | [Dov Murik](https://github.com/dubek) |
46 | [Java](#java-17) | [Joel Martin](https://github.com/kanaka) |
47 | [JavaScript](#javascriptnode) ([Demo](http://kanaka.github.io/mal)) | [Joel Martin](https://github.com/kanaka) |
48 | [Julia](#julia) | [Joel Martin](https://github.com/kanaka) |
49 | [Kotlin](#kotlin) | [Javier Fernandez-Ivern](https://github.com/ivern) |
50 | [LiveScript](#livescript) | [Jos van Bakel](https://github.com/c0deaddict) |
51 | [Logo](#logo) | [Dov Murik](https://github.com/dubek) |
52 | [Lua](#lua) | [Joel Martin](https://github.com/kanaka) |
53 | [GNU Make](#gnu-make-381) | [Joel Martin](https://github.com/kanaka) |
54 | [mal itself](#mal) | [Joel Martin](https://github.com/kanaka) |
55 | [MATLAB](#matlab-gnu-octave-and-matlab) (GNU Octave & MATLAB) | [Joel Martin](https://github.com/kanaka) |
56 | [miniMAL](#minimal) ([Repo](https://github.com/kanaka/miniMAL), [Demo](https://kanaka.github.io/miniMAL/)) | [Joel Martin](https://github.com/kanaka) |
57 | [NASM](#nasm) | [Ben Dudson](https://github.com/bendudson) |
58 | [Nim](#nim-0170) | [Dennis Felsing](https://github.com/def-) |
59 | [Object Pascal](#object-pascal) | [Joel Martin](https://github.com/kanaka) |
60 | [Objective C](#objective-c) | [Joel Martin](https://github.com/kanaka) |
61 | [OCaml](#ocaml-4010) | [Chris Houser](https://github.com/chouser) |
62 | [Perl](#perl-5) | [Joel Martin](https://github.com/kanaka) |
63 | [Perl 6](#perl-6) | [Hinrik Örn Sigurðsson](https://github.com/hinrik) |
64 | [PHP](#php-53) | [Joel Martin](https://github.com/kanaka) |
65 | [Picolisp](#picolisp) | [Vasilij Schneidermann](https://github.com/wasamasa) |
66 | [Pike](#pike) | [Dov Murik](https://github.com/dubek) |
67 | [PL/pgSQL](#plpgsql-postgresql-sql-procedural-language) (PostgreSQL) | [Joel Martin](https://github.com/kanaka) |
68 | [PL/SQL](#plsql-oracle-sql-procedural-language) (Oracle) | [Joel Martin](https://github.com/kanaka) |
69 | [PostScript](#postscript-level-23) | [Joel Martin](https://github.com/kanaka) |
70 | [PowerShell](#powershell) | [Joel Martin](https://github.com/kanaka) |
71 | [Python](#python-2x-and-3x) (2.X & 3.X) | [Joel Martin](https://github.com/kanaka) |
72 | [Python #2](#python2-3x) (3.X) | [Gavin Lewis](https://github.com/epylar) |
73 | [RPython](#rpython) | [Joel Martin](https://github.com/kanaka) |
74 | [R](#r) | [Joel Martin](https://github.com/kanaka) |
75 | [Racket](#racket-53) | [Joel Martin](https://github.com/kanaka) |
76 | [Rexx](#rexx) | [Dov Murik](https://github.com/dubek) |
77 | [Ruby](#ruby-19) | [Joel Martin](https://github.com/kanaka) |
78 | [Rust](#rust-138) | [Joel Martin](https://github.com/kanaka) |
79 | [Scala](#scala) | [Joel Martin](https://github.com/kanaka) |
80 | [Scheme (R7RS)](#scheme-r7rs) | [Vasilij Schneidermann](https://github.com/wasamasa) |
81 | [Skew](#skew) | [Dov Murik](https://github.com/dubek) |
82 | [Swift 2](#swift) | [Keith Rollin](https://github.com/keith-rollin) |
83 | [Swift 3](#swift-3) | [Joel Martin](https://github.com/kanaka) |
84 | [Swift 4](#swift-4) | [陆遥](https://github.com/LispLY) |
85 | [Swift 5](#swift-5) | [Oleg Montak](https://github.com/MontakOleg) |
86 | [Tcl](#tcl-86) | [Dov Murik](https://github.com/dubek) |
87 | [TypeScript](#typescript) | [Masahiro Wakame](https://github.com/vvakame) |
88 | [Vala](#vala) | [Simon Tatham](https://github.com/sgtatham) |
89 | [VHDL](#vhdl) | [Dov Murik](https://github.com/dubek) |
90 | [Vimscript](#vimscript) | [Dov Murik](https://github.com/dubek) |
91 | [Visual Basic.NET](#visual-basicnet) | [Joel Martin](https://github.com/kanaka) |
92 | [WebAssembly](#webassembly-wasm) (wasm) | [Joel Martin](https://github.com/kanaka) |
93 | [Wren](#wren) | [Dov Murik](https://github.com/dubek) |
94 | [Yorick](#yorick) | [Dov Murik](https://github.com/dubek) |
97 **3. Mal is a learning tool**
99 Each implementation of mal is separated into
100 11 incremental, self-contained (and testable) steps that demonstrate
101 core concepts of Lisp. The last step is capable of self-hosting
102 (running the mal implementation of mal). See the [make-a-lisp process
103 guide](process/guide.md).
105 The make-a-lisp steps are:
107 * [step0_repl](process/guide.md#step0)
108 * [step1_read_print](process/guide.md#step1)
109 * [step2_eval](process/guide.md#step2)
110 * [step3_env](process/guide.md#step3)
111 * [step4_if_fn_do](process/guide.md#step4)
112 * [step5_tco](process/guide.md#step5)
113 * [step6_file](process/guide.md#step6)
114 * [step7_quote](process/guide.md#step7)
115 * [step8_macros](process/guide.md#step8)
116 * [step9_try](process/guide.md#step9)
117 * [stepA_mal](process/guide.md#stepA)
119 Each make-a-lisp step has an associated architectural diagram. That elements
120 that are new for that step are highlighted in red.
121 Here is the final diagram for [step A](process/guide.md#stepA):
123 ![stepA_mal architecture](process/stepA_mal.png)
125 If you are interested in creating a mal implementation (or just
126 interested in using mal for something), please drop by the #mal
127 channel on freenode. In addition to the [make-a-lisp process
128 guide](process/guide.md) there is also a [mal/make-a-lisp
129 FAQ](docs/FAQ.md) where I attempt to answer some common questions.
134 Mal was presented publicly for the first time in a lightning talk at
135 Clojure West 2014 (unfortunately there is no video). See
136 examples/clojurewest2014.mal for the presentation that was given at the
137 conference (yes, the presentation is a mal program).
139 At Midwest.io 2015, Joel Martin gave a presentation on Mal titled
140 "Achievement Unlocked: A Better Path to Language Learning".
141 [Video](https://www.youtube.com/watch?v=lgyOAiRtZGw),
142 [Slides](http://kanaka.github.io/midwest.io.mal/).
144 More recently Joel gave a presentation on "Make Your Own Lisp Interpreter
145 in 10 Incremental Steps" at LambdaConf 2016:
146 [Part 1](https://www.youtube.com/watch?v=jVhupfthTEk),
147 [Part 2](https://www.youtube.com/watch?v=X5OQBMGpaTU),
148 [Part 3](https://www.youtube.com/watch?v=6mARZzGgX4U),
149 [Part 4](https://www.youtube.com/watch?v=dCO1SYR5kDU),
150 [Slides](http://kanaka.github.io/lambdaconf/).
152 ## Building/running implementations
154 The simplest way to run any given implementation is to use docker.
155 Every implementation has a docker image pre-built with language
156 dependencies installed. You can launch the REPL using a convenient
157 target in the top level Makefile (where IMPL is the implementation
158 directory name and stepX is the step to run):
161 make DOCKERIZE=1 "repl^IMPL^stepX"
162 # OR stepA is the default step:
163 make DOCKERIZE=1 "repl^IMPL"
166 ## External Implementations
168 The following implementations are maintained as separate projects:
172 * [by Alexander Bagnalla](https://github.com/bagnalla/holyc_mal)
176 * [by Tim Morgan](https://github.com/seven1m/mal-rust)
177 * [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).
180 ## Other mal Projects
182 * [malc](https://github.com/dubek/malc) - Mal (Make A Lisp) compiler. Compiles a Mal program to LLVM assembly language, then binary.
183 * [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.
184 * [frock](https://github.com/chr15m/frock) - Clojure-flavoured PHP. Uses mal/php to run programs.
185 * [flk](https://github.com/chr15m/flk) - A LISP that runs wherever Bash is
188 ## Implementation Details
192 The Ada implementation was developed with GNAT 4.9 on debian. It also
193 compiles unchanged on windows if you have windows versions of git,
194 GNAT and (optionally) make. There are no external dependencies
195 (readline not implemented).
205 The second Ada implementation was developed with GNAT 8 and links with
206 the GNU readline library.
216 The GNU awk implementation of mal has been tested with GNU awk 4.1.1.
220 gawk -O -f stepX_YYY.awk
230 ### BASIC (C64 and QBasic)
232 The BASIC implementation uses a preprocessor that can generate BASIC
233 code that is compatible with both C64 BASIC (CBM v2) and QBasic. The
234 C64 mode has been tested with
235 [cbmbasic](https://github.com/kanaka/cbmbasic) (the patched version is
236 currently required to fix issues with line input) and the QBasic mode
237 has been tested with [qb64](http://www.qb64.net/).
239 Generate C64 code and run it using cbmbasic:
247 Generate QBasic code and load it into qb64:
251 make MODE=qbasic stepX_YYY.bas
255 Thanks to [Steven Syrek](https://github.com/sjsyrek) for the original
256 inspiration for this implementation.
260 The BBC BASIC V implementation can run in the Brandy interpreter:
264 brandy -quit stepX_YYY.bbc
267 Or in ARM BBC BASIC V under RISC OS 3 or later:
270 *Dir bbc-basic.riscos
277 The C implementation of mal requires the following libraries (lib and
278 header packages): glib, libffi6, libgc, and either the libedit or GNU readline
289 The C++ implementation of mal requires g++-4.9 or clang++-3.5 and
290 a readline compatible library to build. See the `cpp/README.md` for
304 The C# implementation of mal has been tested on Linux using the Mono
305 C# compiler (mcs) and the Mono runtime (version 2.10.8.1). Both are
306 required to build and run the C# implementation.
316 The ChucK implementation has been tested with ChucK 1.3.5.2.
325 For the most part the Clojure implementation requires Clojure 1.5,
326 however, to pass all tests, Clojure 1.8.0-RC4 is required.
330 lein with-profile +stepX trampoline run
336 sudo npm install -g coffee-script
343 The implementation has been tested with SBCL, CCL, CMUCL, GNU CLISP, ECL and
344 Allegro CL on Ubuntu 16.04 and Ubuntu 12.04, see
345 the [README](common-lisp/README.org) for more details. Provided you have the
346 dependencies mentioned installed, do the following to run the implementation
356 The Crystal implementation of mal has been tested with Crystal 0.26.1.
360 crystal run ./stepX_YYY.cr
362 make # needed to run tests
368 The D implementation of mal was tested with GDC 4.8. It requires the GNU
379 The Dart implementation has been tested with Dart 1.20.
388 The Emacs Lisp implementation of mal has been tested with Emacs 24.3
389 and 24.5. While there is very basic readline editing (`<backspace>`
390 and `C-d` work, `C-c` cancels the process), it is recommended to use
395 emacs -Q --batch --load stepX_YYY.el
396 # with full readline support
397 rlwrap emacs -Q --batch --load stepX_YYY.el
402 The Elixir implementation of mal has been tested with Elixir 1.0.5.
407 # Or with readline/line editing functionality:
413 The Elm implementation of mal has been tested with Elm 0.18.0
423 The Erlang implementation of mal requires [Erlang/OTP R17](http://www.erlang.org/download.html)
424 and [rebar](https://github.com/rebar/rebar) to build.
430 MAL_STEP=stepX_YYY rebar compile escriptize # build individual step
434 ### ES6 (ECMAScript 2015)
436 The ES6 / ECMAScript 2015 implementation uses the
437 [babel](https://babeljs.io) compiler to generate ES5 compatible
438 JavaScript. The generated code has been tested with Node 0.12.4.
443 node build/stepX_YYY.js
449 The F# implementation of mal has been tested on Linux using the Mono
450 F# compiler (fsharpc) and the Mono runtime (version 3.12.1). The mono C#
451 compiler (mcs) is also necessary to compile the readline dependency. All are
452 required to build and run the F# implementation.
462 The Factor implementation of mal has been tested with Factor 0.97
463 ([factorcode.org](http://factorcode.org)).
467 FACTOR_ROOTS=. factor -run=stepX_YYY
472 The Fantom implementation of mal has been tested with Fantom 1.0.70.
476 make lib/fan/stepX_YYY.pod
491 guile -L ./ stepX_YYY.scm
496 The Smalltalk implementation of mal has been tested with GNU Smalltalk 3.2.91.
505 The Go implementation of mal requires that go is installed on on the
506 path. The implementation has been tested with Go 1.3.1.
517 The Groovy implementation of mal requires Groovy to run and has been
518 tested with Groovy 1.8.6.
523 groovy ./stepX_YYY.groovy
528 The Haskell implementation requires the ghc compiler version 7.10.1 or
529 later and also the Haskell parsec and readline (or editline) packages.
537 ### Haxe (Neko, Python, C++ and JavaScript)
539 The Haxe implementation of mal requires Haxe version 3.2 to compile.
540 Four different Haxe targets are supported: Neko, Python, C++, and
550 python3 ./stepX_YYY.py
561 The Hy implementation of mal has been tested with Hy 0.13.0.
570 The Io implementation of mal has been tested with Io version 20110905.
579 The Java implementation of mal requires maven2 to build.
584 mvn -quiet exec:java -Dexec.mainClass=mal.stepX_YYY
586 mvn -quiet exec:java -Dexec.mainClass=mal.stepX_YYY -Dexec.args="CMDLINE_ARGS"
599 The Julia implementation of mal requires Julia 0.4.
608 The Kotlin implementation of mal has been tested with Kotlin 1.0.
613 java -jar stepX_YYY.jar
618 The LiveScript implementation of mal has been tested with LiveScript 1.5.
623 node_modules/.bin/lsc stepX_YYY.ls
628 The Logo implementation of mal has been tested with UCBLogo 6.0.
637 The Lua implementation of mal has been tested with Lua 5.2. The
638 implementation requires that luarocks and the lua-rex-pcre library
643 make # to build and link linenoise.so
649 Running the mal implementation of mal involves running stepA of one of
650 the other implementations and passing the mal step to run as a command
655 IMPL_STEPA_CMD ../mal/stepX_YYY.mal
668 The NASM implementation of mal is written for x86-64 Linux, and has been tested
669 with Linux 3.16.0-4-amd64 and NASM version 2.11.05.
679 The Nim implementation of mal has been tested with Nim 0.17.0.
691 The Object Pascal implementation of mal has been built and tested on
692 Linux using the Free Pascal compiler version 2.6.2 and 2.6.4.
702 The Objective C implementation of mal has been built and tested on
703 Linux using clang/LLVM 3.6. It has also been built and tested on OS
720 ### MATLAB (GNU Octave and MATLAB)
722 The MatLab implementation has been tested with GNU Octave 4.2.1.
723 It has also been tested with MATLAB version R2014a on Linux. Note that
724 MATLAB is a commercial product.
729 octave -q --no-gui --no-history --eval "stepX_YYY();quit;"
730 matlab -nodisplay -nosplash -nodesktop -nojvm -r "stepX_YYY();quit;"
731 # OR with command line arguments
732 octave -q --no-gui --no-history --eval "stepX_YYY('arg1','arg2');quit;"
733 matlab -nodisplay -nosplash -nodesktop -nojvm -r "stepX_YYY('arg1','arg2');quit;"
738 [miniMAL](https://github.com/kanaka/miniMAL) is small Lisp interpreter
739 implemented in less than 1024 bytes of JavaScript. To run the miniMAL
740 implementation of mal you need to download/install the miniMAL
741 interpreter (which requires Node.js).
744 # Download miniMAL and dependencies
746 export PATH=`pwd`/node_modules/minimal-lisp/:$PATH
747 # Now run mal implementation in miniMAL
753 The Perl 5 implementation should work with perl 5.19.3 and later.
755 For readline line editing support, install Term::ReadLine::Perl or
756 Term::ReadLine::Gnu from CPAN.
765 The Perl 6 implementation was tested on Rakudo Perl 6 2016.04.
774 The PHP implementation of mal requires the php command line interface
784 The Picolisp implementation requires libreadline and Picolisp 3.1.11
794 The Pike implementation was tested on Pike 8.0.
801 ### PL/pgSQL (PostgreSQL SQL Procedural Language)
803 The PL/pgSQL implementation of mal requires a running PostgreSQL server
804 (the "kanaka/mal-test-plpgsql" docker image automatically starts
805 a PostgreSQL server). The implementation connects to the PostgreSQL server
806 and create a database named "mal" to store tables and stored
807 procedures. The wrapper script uses the psql command to connect to the
808 server and defaults to the user "postgres" but this can be overridden
809 with the PSQL_USER environment variable. A password can be specified
810 using the PGPASSWORD environment variable. The implementation has been
811 tested with PostgreSQL 9.4.
815 ./wrap.sh stepX_YYY.sql
817 PSQL_USER=myuser PGPASSWORD=mypass ./wrap.sh stepX_YYY.sql
820 ### PL/SQL (Oracle SQL Procedural Language)
822 The PL/SQL implementation of mal requires a running Oracle DB
823 server (the "kanaka/mal-test-plsql" docker image automatically
824 starts an Oracle Express server). The implementation connects to the
825 Oracle server to create types, tables and stored procedures. The
826 default SQL\*Plus logon value (username/password@connect_identifier) is
827 "system/oracle" but this can be overridden with the ORACLE_LOGON
828 environment variable. The implementation has been tested with Oracle
829 Express Edition 11g Release 2. Note that any SQL\*Plus connection
830 warnings (user password expiration, etc) will interfere with the
831 ability of the wrapper script to communicate with the DB.
835 ./wrap.sh stepX_YYY.sql
837 ORACLE_LOGON=myuser/mypass@ORCL ./wrap.sh stepX_YYY.sql
840 ### PostScript Level 2/3
842 The PostScript implementation of mal requires Ghostscript to run. It
843 has been tested with Ghostscript 9.10.
847 gs -q -dNODISPLAY -I./ stepX_YYY.ps
852 The PowerShell implementation of mal requires the PowerShell script
853 language. It has been tested with PowerShell 6.0.0 Alpha 9 on Linux.
857 powershell ./stepX_YYY.ps1
860 ### Python (2.X and 3.X)
869 The second Python implementation makes heavy use of type annotations and uses the Arpeggio parser library.
872 # Recommended: do these steps in a Python virtual environment.
873 pip3 install Arpeggio==1.9.0
879 You must have [rpython](https://rpython.readthedocs.org/) on your path
880 (included with [pypy](https://bitbucket.org/pypy/pypy/)).
884 make # this takes a very long time
890 The R implementation of mal requires R (r-base-core) to run.
894 make libs # to download and build rdyncall
900 The Racket implementation of mal requires the Racket
901 compiler/interpreter to run.
910 The Rexx implementation of mal has been tested with Regina Rexx 3.6.
915 rexx -a ./stepX_YYY.rexxpp
927 The rust implementation of mal requires the rust compiler and build
928 tool (cargo) to build.
932 cargo run --release --bin stepX_YYY
937 Install scala and sbt (http://www.scala-sbt.org/0.13/tutorial/Installing-sbt-on-Linux.html):
941 sbt 'run-main stepX_YYY'
944 scala -classpath target/scala*/classes stepX_YYY
947 ### Scheme (R7RS) ###
949 The Scheme implementation of mal has been tested with Chibi-Scheme
950 0.7.3, Kawa 2.4, Gauche 0.9.5, CHICKEN 4.11.0, Sagittarius 0.8.3,
951 Cyclone 0.6.3 (Git version) and Foment 0.4 (Git version). You should
952 be able to get it running on other conforming R7RS implementations
953 after figuring out how libraries are loaded and adjusting the
954 `Makefile` and `run` script accordingly.
960 scheme_MODE=chibi ./run
963 scheme_MODE=kawa ./run
965 scheme_MODE=gauche ./run
968 scheme_MODE=chicken ./run
970 scheme_MODE=sagittarius ./run
973 scheme_MODE=cyclone ./run
975 scheme_MODE=foment ./run
980 The Skew implementation of mal has been tested with Skew 0.7.42.
991 The Swift implementation of mal requires the Swift 2.0 compiler (XCode
992 7.0) to build. Older versions will not work due to changes in the
993 language and standard library.
1003 The Swift 3 implementation of mal requires the Swift 3.0 compiler. It
1004 has been tested with Swift 3 Preview 3.
1014 The Swift 4 implementation of mal requires the Swift 4.0 compiler. It
1015 has been tested with Swift 4.2.3 release.
1025 The Swift 5 implementation of mal requires the Swift 5.0 compiler. It
1026 has been tested with Swift 5.1.1 release.
1035 The Tcl implementation of mal requires Tcl 8.6 to run. For readline line
1036 editing support, install tclreadline.
1040 tclsh ./stepX_YYY.tcl
1045 The TypeScript implementation of mal requires the TypeScript 2.2 compiler.
1046 It has been tested with Node.js v6.
1056 The Vala implementation of mal has been tested with the Vala 0.40.8
1057 compiler. You will need to install `valac` and `libreadline-dev` or
1068 The VHDL implementation of mal has been tested with GHDL 0.29.
1073 ./run_vhdl.sh ./stepX_YYY
1078 The Vimscript implementation of mal requires Vim 8.0 to run.
1082 ./run_vimscript.sh ./stepX_YYY.vim
1085 ### Visual Basic.NET ###
1087 The VB.NET implementation of mal has been tested on Linux using the Mono
1088 VB compiler (vbnc) and the Mono runtime (version 2.10.8.1). Both are
1089 required to build and run the VB.NET implementation.
1094 mono ./stepX_YYY.exe
1097 ### WebAssembly (wasm) ###
1099 The WebAssembly implementation is written in
1100 [Wam](https://github.com/kanaka/wam) (WebAssembly Macro language) and
1101 runs under several different non-web embeddings (runtimes):
1102 [node](https://nodejs.org),
1103 [wasmtime](https://github.com/CraneStation/wasmtime),
1104 [wasmer](https://wasmer.io),
1105 [lucet](https://github.com/fastly/lucet),
1106 [wax](https://github.com/kanaka/wac),
1107 [wace](https://github.com/kanaka/wac),
1108 [warpy](https://github.com/kanaka/warpy).
1114 ./run.js ./stepX_YYY.wasm
1116 make wasm_MODE=wasmtime
1117 wasmtime --dir=./ --dir=../ --dir=/ ./stepX_YYY.wasm
1119 make wasm_MODE=wasmer
1120 wasmer run --dir=./ --dir=../ --dir=/ ./stepX_YYY.wasm
1122 make wasm_MODE=lucet
1123 lucet-wasi --dir=./:./ --dir=../:../ --dir=/:/ ./stepX_YYY.so
1126 wax ./stepX_YYY.wasm
1128 make wasm_MODE=wace_libc
1129 wace ./stepX_YYY.wasm
1131 make wasm_MODE=warpy
1132 warpy --argv --memory-pages 256 ./stepX_YYY.wasm
1137 The Wren implementation of mal was tested on Wren 0.2.0.
1141 wren ./stepX_YYY.wren
1146 The Yorick implementation of mal was tested on Yorick 2.2.04.
1150 yorick -batch ./stepX_YYY.i
1157 The top level Makefile has a number of useful targets to assist with
1158 implementation development and testing. The `help` target provides
1159 a list of the targets and options:
1165 ### Functional tests
1167 The are almost 800 generic functional tests (for all implementations)
1168 in the `tests/` directory. Each step has a corresponding test file
1169 containing tests specific to that step. The `runtest.py` test harness
1170 launches a Mal step implementation and then feeds the tests one at
1171 a time to the implementation and compares the output/return value to
1172 the expected output/return value.
1174 * To run all the tests across all implementations (be prepared to wait):
1180 * To run all tests against a single implementation:
1190 * To run tests for a single step against all implementations:
1200 * To run tests for a specific step against a single implementation:
1203 make "test^IMPL^stepX"
1206 make "test^ruby^step3"
1207 make "test^ps^step4"
1210 ### Self-hosted functional tests
1212 * To run the functional tests in self-hosted mode, you specify `mal`
1213 as the test implementation and use the `MAL_IMPL` make variable
1214 to change the underlying host language (default is JavaScript):
1216 make MAL_IMPL=IMPL "test^mal^step2"
1219 make "test^mal^step2" # js is default
1220 make MAL_IMPL=ruby "test^mal^step2"
1221 make MAL_IMPL=python "test^mal^step2"
1224 ### Starting the REPL
1226 * To start the REPL of an implementation in a specific step:
1229 make "repl^IMPL^stepX"
1232 make "repl^ruby^step3"
1233 make "repl^ps^step4"
1236 * If you omit the step, then `stepA` is used:
1246 * To start the REPL of the self-hosted implementation, specify `mal` as the
1247 REPL implementation and use the `MAL_IMPL` make variable to change the
1248 underlying host language (default is JavaScript):
1250 make MAL_IMPL=IMPL "repl^mal^stepX"
1253 make "repl^mal^step2" # js is default
1254 make MAL_IMPL=ruby "repl^mal^step2"
1255 make MAL_IMPL=python "repl^mal"
1258 ### Performance tests
1260 Warning: These performance tests are neither statistically valid nor
1261 comprehensive; runtime performance is a not a primary goal of mal. If
1262 you draw any serious conclusions from these performance tests, then
1263 please contact me about some amazing oceanfront property in Kansas
1264 that I'm willing to sell you for cheap.
1266 * To run performance tests against a single implementation:
1274 * To run performance tests against all implementations:
1279 ### Generating language statistics
1281 * To report line and byte statistics for a single implementation:
1289 ## Dockerized testing
1291 Every implementation directory contains a Dockerfile to create
1292 a docker image containing all the dependencies for that
1293 implementation. In addition, the top-level Makefile contains support
1294 for running the tests target (and perf, stats, repl, etc) within
1295 a docker container for that implementation by passing *"DOCKERIZE=1"*
1296 on the make command line. For example:
1299 make DOCKERIZE=1 "test^js^step3"
1302 Existing implementations already have docker images built and pushed
1303 to the docker registry. However, if
1304 you wish to build or rebuild a docker image locally, the toplevel
1305 Makefile provides a rule for building docker images:
1308 make "docker-build^IMPL"
1313 * Docker images are named *"kanaka/mal-test-IMPL"*
1314 * JVM-based language implementations (Groovy, Java, Clojure, Scala):
1315 you will probably need to run this command once manually
1316 first `make DOCKERIZE=1 "repl^IMPL"` before you can run tests because
1317 runtime dependencies need to be downloaded to avoid the tests timing
1318 out. These dependencies are downloaded to dot-files in the /mal
1319 directory so they will persist between runs.
1324 Mal (make-a-lisp) is licensed under the MPL 2.0 (Mozilla Public
1325 License 2.0). See LICENSE.txt for more details.