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 a learning tool**
11 Each implementation of mal is separated into
12 11 incremental, self-contained (and testable) steps that demonstrate
13 core concepts of Lisp. The last step is capable of self-hosting
14 (running the mal implementation of mal). See the [make-a-lisp process
15 guide](process/guide.md).
17 The make-a-lisp steps are:
19 * [step0_repl](process/guide.md#step0)
20 * [step1_read_print](process/guide.md#step1)
21 * [step2_eval](process/guide.md#step2)
22 * [step3_env](process/guide.md#step3)
23 * [step4_if_fn_do](process/guide.md#step4)
24 * [step5_tco](process/guide.md#step5)
25 * [step6_file](process/guide.md#step6)
26 * [step7_quote](process/guide.md#step7)
27 * [step8_macros](process/guide.md#step8)
28 * [step9_try](process/guide.md#step9)
29 * [stepA_mal](process/guide.md#stepA)
31 Each make-a-lisp step has an associated architectural diagram. That elements
32 that are new for that step are highlighted in red.
33 Here is the final diagram for [step A](process/guide.md#stepA):
35 ![stepA_mal architecture](process/stepA_mal.png)
37 If you are interested in creating a mal implementation (or just
38 interested in using mal for something), please drop by the #mal
39 channel on freenode. In addition to the [make-a-lisp process
40 guide](process/guide.md) there is also a [mal/make-a-lisp
41 FAQ](docs/FAQ.md) where I attempt to answer some common questions.
44 **3. Mal is implemented in 81 languages (84 different implementations and 104 runtime modes)**
46 | Language | Creator |
47 | -------- | ------- |
48 | [Ada](#ada) | [Chris Moore](https://github.com/zmower) |
49 | [Ada #2](#ada2) | [Nicolas Boulenguez](https://github.com/asarhaddon) |
50 | [GNU Awk](#gnu-awk) | [Miutsuru Kariya](https://github.com/kariya-mitsuru) |
51 | [Bash 4](#bash-4) | [Joel Martin](https://github.com/kanaka) |
52 | [BASIC](#basic-c64-and-qbasic) (C64 & QBasic) | [Joel Martin](https://github.com/kanaka) |
53 | [BBC BASIC V](#bbc-basic-v) | [Ben Harris](https://github.com/bjh21) |
54 | [C](#c) | [Joel Martin](https://github.com/kanaka) |
55 | [C++](#c-1) | [Stephen Thirlwall](https://github.com/sdt) |
56 | [C#](#c-2) | [Joel Martin](https://github.com/kanaka) |
57 | [ChucK](#chuck) | [Vasilij Schneidermann](https://github.com/wasamasa) |
58 | [Clojure](#clojure) (Clojure & ClojureScript) | [Joel Martin](https://github.com/kanaka) |
59 | [CoffeeScript](#coffeescript) | [Joel Martin](https://github.com/kanaka) |
60 | [Common Lisp](#common-lisp) | [Iqbal Ansari](https://github.com/iqbalansari) |
61 | [Crystal](#crystal) | [Linda_pp](https://github.com/rhysd) |
62 | [D](#d) | [Dov Murik](https://github.com/dubek) |
63 | [Dart](#dart) | [Harry Terkelsen](https://github.com/hterkelsen) |
64 | [Elixir](#elixir) | [Martin Ek](https://github.com/ekmartin) |
65 | [Elm](#elm) | [Jos van Bakel](https://github.com/c0deaddict) |
66 | [Emacs Lisp](#emacs-lisp) | [Vasilij Schneidermann](https://github.com/wasamasa) |
67 | [Erlang](#erlang) | [Nathan Fiedler](https://github.com/nlfiedler) |
68 | [ES6](#es6-ecmascript-2015) (ECMAScript 2015) | [Joel Martin](https://github.com/kanaka) |
69 | [F#](#f) | [Peter Stephens](https://github.com/pstephens) |
70 | [Factor](#factor) | [Jordan Lewis](https://github.com/jordanlewis) |
71 | [Fantom](#fantom) | [Dov Murik](https://github.com/dubek) |
72 | [Forth](#forth) | [Chris Houser](https://github.com/chouser) |
73 | [GNU Guile](#gnu-guile-21) | [Mu Lei](https://github.com/NalaGinrut) |
74 | [GNU Smalltalk](#gnu-smalltalk) | [Vasilij Schneidermann](https://github.com/wasamasa) |
75 | [Go](#go) | [Joel Martin](https://github.com/kanaka) |
76 | [Groovy](#groovy) | [Joel Martin](https://github.com/kanaka) |
77 | [Haskell](#haskell) | [Joel Martin](https://github.com/kanaka) |
78 | [Haxe](#haxe-neko-python-c-and-javascript) (Neko, Python, C++, & JS) | [Joel Martin](https://github.com/kanaka) |
79 | [Hy](#hy) | [Joel Martin](https://github.com/kanaka) |
80 | [Io](#io) | [Dov Murik](https://github.com/dubek) |
81 | [Java](#java-17) | [Joel Martin](https://github.com/kanaka) |
82 | [JavaScript](#javascriptnode) ([Demo](http://kanaka.github.io/mal)) | [Joel Martin](https://github.com/kanaka) |
83 | [jq](#jq) | [Ali MohammadPur](https://github.com/alimpfard) |
84 | [Julia](#julia) | [Joel Martin](https://github.com/kanaka) |
85 | [Kotlin](#kotlin) | [Javier Fernandez-Ivern](https://github.com/ivern) |
86 | [LiveScript](#livescript) | [Jos van Bakel](https://github.com/c0deaddict) |
87 | [Logo](#logo) | [Dov Murik](https://github.com/dubek) |
88 | [Lua](#lua) | [Joel Martin](https://github.com/kanaka) |
89 | [GNU Make](#gnu-make-381) | [Joel Martin](https://github.com/kanaka) |
90 | [mal itself](#mal) | [Joel Martin](https://github.com/kanaka) |
91 | [MATLAB](#matlab-gnu-octave-and-matlab) (GNU Octave & MATLAB) | [Joel Martin](https://github.com/kanaka) |
92 | [miniMAL](#minimal) ([Repo](https://github.com/kanaka/miniMAL), [Demo](https://kanaka.github.io/miniMAL/)) | [Joel Martin](https://github.com/kanaka) |
93 | [NASM](#nasm) | [Ben Dudson](https://github.com/bendudson) |
94 | [Nim](#nim-104) | [Dennis Felsing](https://github.com/def-) |
95 | [Object Pascal](#object-pascal) | [Joel Martin](https://github.com/kanaka) |
96 | [Objective C](#objective-c) | [Joel Martin](https://github.com/kanaka) |
97 | [OCaml](#ocaml-4010) | [Chris Houser](https://github.com/chouser) |
98 | [Perl](#perl-5) | [Joel Martin](https://github.com/kanaka) |
99 | [Perl 6](#perl-6) | [Hinrik Örn Sigurðsson](https://github.com/hinrik) |
100 | [PHP](#php-53) | [Joel Martin](https://github.com/kanaka) |
101 | [Picolisp](#picolisp) | [Vasilij Schneidermann](https://github.com/wasamasa) |
102 | [Pike](#pike) | [Dov Murik](https://github.com/dubek) |
103 | [PL/pgSQL](#plpgsql-postgresql-sql-procedural-language) (PostgreSQL) | [Joel Martin](https://github.com/kanaka) |
104 | [PL/SQL](#plsql-oracle-sql-procedural-language) (Oracle) | [Joel Martin](https://github.com/kanaka) |
105 | [PostScript](#postscript-level-23) | [Joel Martin](https://github.com/kanaka) |
106 | [PowerShell](#powershell) | [Joel Martin](https://github.com/kanaka) |
107 | [Python](#python-2x-and-3x) (2.X & 3.X) | [Joel Martin](https://github.com/kanaka) |
108 | [Python #2](#python2-3x) (3.X) | [Gavin Lewis](https://github.com/epylar) |
109 | [RPython](#rpython) | [Joel Martin](https://github.com/kanaka) |
110 | [R](#r) | [Joel Martin](https://github.com/kanaka) |
111 | [Racket](#racket-53) | [Joel Martin](https://github.com/kanaka) |
112 | [Rexx](#rexx) | [Dov Murik](https://github.com/dubek) |
113 | [Ruby](#ruby-19) | [Joel Martin](https://github.com/kanaka) |
114 | [Rust](#rust-138) | [Joel Martin](https://github.com/kanaka) |
115 | [Scala](#scala) | [Joel Martin](https://github.com/kanaka) |
116 | [Scheme (R7RS)](#scheme-r7rs) | [Vasilij Schneidermann](https://github.com/wasamasa) |
117 | [Skew](#skew) | [Dov Murik](https://github.com/dubek) |
118 | [Swift 2](#swift) | [Keith Rollin](https://github.com/keith-rollin) |
119 | [Swift 3](#swift-3) | [Joel Martin](https://github.com/kanaka) |
120 | [Swift 4](#swift-4) | [陆遥](https://github.com/LispLY) |
121 | [Swift 5](#swift-5) | [Oleg Montak](https://github.com/MontakOleg) |
122 | [Tcl](#tcl-86) | [Dov Murik](https://github.com/dubek) |
123 | [TypeScript](#typescript) | [Masahiro Wakame](https://github.com/vvakame) |
124 | [Vala](#vala) | [Simon Tatham](https://github.com/sgtatham) |
125 | [VHDL](#vhdl) | [Dov Murik](https://github.com/dubek) |
126 | [Vimscript](#vimscript) | [Dov Murik](https://github.com/dubek) |
127 | [Visual Basic.NET](#visual-basicnet) | [Joel Martin](https://github.com/kanaka) |
128 | [WebAssembly](#webassembly-wasm) (wasm) | [Joel Martin](https://github.com/kanaka) |
129 | [Wren](#wren) | [Dov Murik](https://github.com/dubek) |
130 | [Yorick](#yorick) | [Dov Murik](https://github.com/dubek) |
131 | [Zig](#zig) | [Josh Tobin](https://github.com/rjtobin) |
136 Mal was presented publicly for the first time in a lightning talk at
137 Clojure West 2014 (unfortunately there is no video). See
138 examples/clojurewest2014.mal for the presentation that was given at the
139 conference (yes, the presentation is a mal program).
141 At Midwest.io 2015, Joel Martin gave a presentation on Mal titled
142 "Achievement Unlocked: A Better Path to Language Learning".
143 [Video](https://www.youtube.com/watch?v=lgyOAiRtZGw),
144 [Slides](http://kanaka.github.io/midwest.io.mal/).
146 More recently Joel gave a presentation on "Make Your Own Lisp Interpreter
147 in 10 Incremental Steps" at LambdaConf 2016:
148 [Part 1](https://www.youtube.com/watch?v=jVhupfthTEk),
149 [Part 2](https://www.youtube.com/watch?v=X5OQBMGpaTU),
150 [Part 3](https://www.youtube.com/watch?v=6mARZzGgX4U),
151 [Part 4](https://www.youtube.com/watch?v=dCO1SYR5kDU),
152 [Slides](http://kanaka.github.io/lambdaconf/).
154 ## Building/running implementations
156 The simplest way to run any given implementation is to use docker.
157 Every implementation has a docker image pre-built with language
158 dependencies installed. You can launch the REPL using a convenient
159 target in the top level Makefile (where IMPL is the implementation
160 directory name and stepX is the step to run):
163 make DOCKERIZE=1 "repl^IMPL^stepX"
164 # OR stepA is the default step:
165 make DOCKERIZE=1 "repl^IMPL"
168 ## External Implementations
170 The following implementations are maintained as separate projects:
174 * [by Alexander Bagnalla](https://github.com/bagnalla/holyc_mal)
178 * [by Tim Morgan](https://github.com/seven1m/mal-rust)
179 * [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).
182 ## Other mal Projects
184 * [malc](https://github.com/dubek/malc) - Mal (Make A Lisp) compiler. Compiles a Mal program to LLVM assembly language, then binary.
185 * [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.
186 * [frock](https://github.com/chr15m/frock) - Clojure-flavoured PHP. Uses mal/php to run programs.
187 * [flk](https://github.com/chr15m/flk) - A LISP that runs wherever Bash is
190 ## Implementation Details
194 The Ada implementation was developed with GNAT 4.9 on debian. It also
195 compiles unchanged on windows if you have windows versions of git,
196 GNAT and (optionally) make. There are no external dependencies
197 (readline not implemented).
207 The second Ada implementation was developed with GNAT 8 and links with
208 the GNU readline library.
218 The GNU awk implementation of mal has been tested with GNU awk 4.1.1.
222 gawk -O -f stepX_YYY.awk
232 ### BASIC (C64 and QBasic)
234 The BASIC implementation uses a preprocessor that can generate BASIC
235 code that is compatible with both C64 BASIC (CBM v2) and QBasic. The
236 C64 mode has been tested with
237 [cbmbasic](https://github.com/kanaka/cbmbasic) (the patched version is
238 currently required to fix issues with line input) and the QBasic mode
239 has been tested with [qb64](http://www.qb64.net/).
241 Generate C64 code and run it using cbmbasic:
249 Generate QBasic code and load it into qb64:
253 make MODE=qbasic stepX_YYY.bas
257 Thanks to [Steven Syrek](https://github.com/sjsyrek) for the original
258 inspiration for this implementation.
262 The BBC BASIC V implementation can run in the Brandy interpreter:
266 brandy -quit stepX_YYY.bbc
269 Or in ARM BBC BASIC V under RISC OS 3 or later:
272 *Dir bbc-basic.riscos
279 The C implementation of mal requires the following libraries (lib and
280 header packages): glib, libffi6, libgc, and either the libedit or GNU readline
291 The C++ implementation of mal requires g++-4.9 or clang++-3.5 and
292 a readline compatible library to build. See the `cpp/README.md` for
306 The C# implementation of mal has been tested on Linux using the Mono
307 C# compiler (mcs) and the Mono runtime (version 2.10.8.1). Both are
308 required to build and run the C# implementation.
318 The ChucK implementation has been tested with ChucK 1.3.5.2.
327 For the most part the Clojure implementation requires Clojure 1.5,
328 however, to pass all tests, Clojure 1.8.0-RC4 is required.
332 lein with-profile +stepX trampoline run
338 sudo npm install -g coffee-script
345 The implementation has been tested with SBCL, CCL, CMUCL, GNU CLISP, ECL and
346 Allegro CL on Ubuntu 16.04 and Ubuntu 12.04, see
347 the [README](common-lisp/README.org) for more details. Provided you have the
348 dependencies mentioned installed, do the following to run the implementation
358 The Crystal implementation of mal has been tested with Crystal 0.26.1.
362 crystal run ./stepX_YYY.cr
364 make # needed to run tests
370 The D implementation of mal was tested with GDC 4.8. It requires the GNU
381 The Dart implementation has been tested with Dart 1.20.
390 The Emacs Lisp implementation of mal has been tested with Emacs 24.3
391 and 24.5. While there is very basic readline editing (`<backspace>`
392 and `C-d` work, `C-c` cancels the process), it is recommended to use
397 emacs -Q --batch --load stepX_YYY.el
398 # with full readline support
399 rlwrap emacs -Q --batch --load stepX_YYY.el
404 The Elixir implementation of mal has been tested with Elixir 1.0.5.
409 # Or with readline/line editing functionality:
415 The Elm implementation of mal has been tested with Elm 0.18.0
425 The Erlang implementation of mal requires [Erlang/OTP R17](http://www.erlang.org/download.html)
426 and [rebar](https://github.com/rebar/rebar) to build.
432 MAL_STEP=stepX_YYY rebar compile escriptize # build individual step
436 ### ES6 (ECMAScript 2015)
438 The ES6 / ECMAScript 2015 implementation uses the
439 [babel](https://babeljs.io) compiler to generate ES5 compatible
440 JavaScript. The generated code has been tested with Node 0.12.4.
445 node build/stepX_YYY.js
451 The F# implementation of mal has been tested on Linux using the Mono
452 F# compiler (fsharpc) and the Mono runtime (version 3.12.1). The mono C#
453 compiler (mcs) is also necessary to compile the readline dependency. All are
454 required to build and run the F# implementation.
464 The Factor implementation of mal has been tested with Factor 0.97
465 ([factorcode.org](http://factorcode.org)).
469 FACTOR_ROOTS=. factor -run=stepX_YYY
474 The Fantom implementation of mal has been tested with Fantom 1.0.70.
478 make lib/fan/stepX_YYY.pod
493 guile -L ./ stepX_YYY.scm
498 The Smalltalk implementation of mal has been tested with GNU Smalltalk 3.2.91.
501 cd impls/gnu-smalltalk
507 The Go implementation of mal requires that go is installed on on the
508 path. The implementation has been tested with Go 1.3.1.
519 The Groovy implementation of mal requires Groovy to run and has been
520 tested with Groovy 1.8.6.
525 groovy ./stepX_YYY.groovy
530 The Haskell implementation requires the ghc compiler version 7.10.1 or
531 later and also the Haskell parsec and readline (or editline) packages.
539 ### Haxe (Neko, Python, C++ and JavaScript)
541 The Haxe implementation of mal requires Haxe version 3.2 to compile.
542 Four different Haxe targets are supported: Neko, Python, C++, and
552 python3 ./stepX_YYY.py
563 The Hy implementation of mal has been tested with Hy 0.13.0.
572 The Io implementation of mal has been tested with Io version 20110905.
581 The Java implementation of mal requires maven2 to build.
586 mvn -quiet exec:java -Dexec.mainClass=mal.stepX_YYY
588 mvn -quiet exec:java -Dexec.mainClass=mal.stepX_YYY -Dexec.args="CMDLINE_ARGS"
601 The Julia implementation of mal requires Julia 0.4.
610 Tested against version 1.6, with a lot of cheating in the IO department
616 DEBUG=true STEP=stepA_YYY ./run
621 The Kotlin implementation of mal has been tested with Kotlin 1.0.
626 java -jar stepX_YYY.jar
631 The LiveScript implementation of mal has been tested with LiveScript 1.5.
636 node_modules/.bin/lsc stepX_YYY.ls
641 The Logo implementation of mal has been tested with UCBLogo 6.0.
650 The Lua implementation of mal has been tested with Lua 5.3.5 The
651 implementation requires luarocks to be installed.
655 make # to build and link linenoise.so and rex_pcre.so
661 Running the mal implementation of mal involves running stepA of one of
662 the other implementations and passing the mal step to run as a command
667 IMPL_STEPA_CMD ../mal/stepX_YYY.mal
680 The NASM implementation of mal is written for x86-64 Linux, and has been tested
681 with Linux 3.16.0-4-amd64 and NASM version 2.11.05.
691 The Nim implementation of mal has been tested with Nim 1.0.4.
703 The Object Pascal implementation of mal has been built and tested on
704 Linux using the Free Pascal compiler version 2.6.2 and 2.6.4.
714 The Objective C implementation of mal has been built and tested on
715 Linux using clang/LLVM 3.6. It has also been built and tested on OS
732 ### MATLAB (GNU Octave and MATLAB)
734 The MatLab implementation has been tested with GNU Octave 4.2.1.
735 It has also been tested with MATLAB version R2014a on Linux. Note that
736 MATLAB is a commercial product.
741 octave -q --no-gui --no-history --eval "stepX_YYY();quit;"
742 matlab -nodisplay -nosplash -nodesktop -nojvm -r "stepX_YYY();quit;"
743 # OR with command line arguments
744 octave -q --no-gui --no-history --eval "stepX_YYY('arg1','arg2');quit;"
745 matlab -nodisplay -nosplash -nodesktop -nojvm -r "stepX_YYY('arg1','arg2');quit;"
750 [miniMAL](https://github.com/kanaka/miniMAL) is small Lisp interpreter
751 implemented in less than 1024 bytes of JavaScript. To run the miniMAL
752 implementation of mal you need to download/install the miniMAL
753 interpreter (which requires Node.js).
756 # Download miniMAL and dependencies
758 export PATH=`pwd`/node_modules/minimal-lisp/:$PATH
759 # Now run mal implementation in miniMAL
765 The Perl 5 implementation should work with perl 5.19.3 and later.
767 For readline line editing support, install Term::ReadLine::Perl or
768 Term::ReadLine::Gnu from CPAN.
777 The Perl 6 implementation was tested on Rakudo Perl 6 2016.04.
786 The PHP implementation of mal requires the php command line interface
796 The Picolisp implementation requires libreadline and Picolisp 3.1.11
806 The Pike implementation was tested on Pike 8.0.
813 ### PL/pgSQL (PostgreSQL SQL Procedural Language)
815 The PL/pgSQL implementation of mal requires a running PostgreSQL server
816 (the "kanaka/mal-test-plpgsql" docker image automatically starts
817 a PostgreSQL server). The implementation connects to the PostgreSQL server
818 and create a database named "mal" to store tables and stored
819 procedures. The wrapper script uses the psql command to connect to the
820 server and defaults to the user "postgres" but this can be overridden
821 with the PSQL_USER environment variable. A password can be specified
822 using the PGPASSWORD environment variable. The implementation has been
823 tested with PostgreSQL 9.4.
827 ./wrap.sh stepX_YYY.sql
829 PSQL_USER=myuser PGPASSWORD=mypass ./wrap.sh stepX_YYY.sql
832 ### PL/SQL (Oracle SQL Procedural Language)
834 The PL/SQL implementation of mal requires a running Oracle DB
835 server (the "kanaka/mal-test-plsql" docker image automatically
836 starts an Oracle Express server). The implementation connects to the
837 Oracle server to create types, tables and stored procedures. The
838 default SQL\*Plus logon value (username/password@connect_identifier) is
839 "system/oracle" but this can be overridden with the ORACLE_LOGON
840 environment variable. The implementation has been tested with Oracle
841 Express Edition 11g Release 2. Note that any SQL\*Plus connection
842 warnings (user password expiration, etc) will interfere with the
843 ability of the wrapper script to communicate with the DB.
847 ./wrap.sh stepX_YYY.sql
849 ORACLE_LOGON=myuser/mypass@ORCL ./wrap.sh stepX_YYY.sql
852 ### PostScript Level 2/3
854 The PostScript implementation of mal requires Ghostscript to run. It
855 has been tested with Ghostscript 9.10.
859 gs -q -dNODISPLAY -I./ stepX_YYY.ps
864 The PowerShell implementation of mal requires the PowerShell script
865 language. It has been tested with PowerShell 6.0.0 Alpha 9 on Linux.
869 powershell ./stepX_YYY.ps1
872 ### Python (2.X and 3.X)
881 The second Python implementation makes heavy use of type annotations and uses the Arpeggio parser library.
884 # Recommended: do these steps in a Python virtual environment.
885 pip3 install Arpeggio==1.9.0
891 You must have [rpython](https://rpython.readthedocs.org/) on your path
892 (included with [pypy](https://bitbucket.org/pypy/pypy/)).
896 make # this takes a very long time
902 The R implementation of mal requires R (r-base-core) to run.
906 make libs # to download and build rdyncall
912 The Racket implementation of mal requires the Racket
913 compiler/interpreter to run.
922 The Rexx implementation of mal has been tested with Regina Rexx 3.6.
927 rexx -a ./stepX_YYY.rexxpp
939 The rust implementation of mal requires the rust compiler and build
940 tool (cargo) to build.
944 cargo run --release --bin stepX_YYY
949 Install scala and sbt (http://www.scala-sbt.org/0.13/tutorial/Installing-sbt-on-Linux.html):
953 sbt 'run-main stepX_YYY'
956 scala -classpath target/scala*/classes stepX_YYY
959 ### Scheme (R7RS) ###
961 The Scheme implementation of mal has been tested with Chibi-Scheme
962 0.7.3, Kawa 2.4, Gauche 0.9.5, CHICKEN 4.11.0, Sagittarius 0.8.3,
963 Cyclone 0.6.3 (Git version) and Foment 0.4 (Git version). You should
964 be able to get it running on other conforming R7RS implementations
965 after figuring out how libraries are loaded and adjusting the
966 `Makefile` and `run` script accordingly.
972 scheme_MODE=chibi ./run
975 scheme_MODE=kawa ./run
977 scheme_MODE=gauche ./run
980 scheme_MODE=chicken ./run
982 scheme_MODE=sagittarius ./run
985 scheme_MODE=cyclone ./run
987 scheme_MODE=foment ./run
992 The Skew implementation of mal has been tested with Skew 0.7.42.
1003 The Swift implementation of mal requires the Swift 2.0 compiler (XCode
1004 7.0) to build. Older versions will not work due to changes in the
1005 language and standard library.
1015 The Swift 3 implementation of mal requires the Swift 3.0 compiler. It
1016 has been tested with Swift 3 Preview 3.
1026 The Swift 4 implementation of mal requires the Swift 4.0 compiler. It
1027 has been tested with Swift 4.2.3 release.
1037 The Swift 5 implementation of mal requires the Swift 5.0 compiler. It
1038 has been tested with Swift 5.1.1 release.
1047 The Tcl implementation of mal requires Tcl 8.6 to run. For readline line
1048 editing support, install tclreadline.
1052 tclsh ./stepX_YYY.tcl
1057 The TypeScript implementation of mal requires the TypeScript 2.2 compiler.
1058 It has been tested with Node.js v6.
1068 The Vala implementation of mal has been tested with the Vala 0.40.8
1069 compiler. You will need to install `valac` and `libreadline-dev` or
1080 The VHDL implementation of mal has been tested with GHDL 0.29.
1085 ./run_vhdl.sh ./stepX_YYY
1090 The Vimscript implementation of mal requires Vim 8.0 to run.
1094 ./run_vimscript.sh ./stepX_YYY.vim
1097 ### Visual Basic.NET ###
1099 The VB.NET implementation of mal has been tested on Linux using the Mono
1100 VB compiler (vbnc) and the Mono runtime (version 2.10.8.1). Both are
1101 required to build and run the VB.NET implementation.
1106 mono ./stepX_YYY.exe
1109 ### WebAssembly (wasm) ###
1111 The WebAssembly implementation is written in
1112 [Wam](https://github.com/kanaka/wam) (WebAssembly Macro language) and
1113 runs under several different non-web embeddings (runtimes):
1114 [node](https://nodejs.org),
1115 [wasmtime](https://github.com/CraneStation/wasmtime),
1116 [wasmer](https://wasmer.io),
1117 [lucet](https://github.com/fastly/lucet),
1118 [wax](https://github.com/kanaka/wac),
1119 [wace](https://github.com/kanaka/wac),
1120 [warpy](https://github.com/kanaka/warpy).
1126 ./run.js ./stepX_YYY.wasm
1128 make wasm_MODE=wasmtime
1129 wasmtime --dir=./ --dir=../ --dir=/ ./stepX_YYY.wasm
1131 make wasm_MODE=wasmer
1132 wasmer run --dir=./ --dir=../ --dir=/ ./stepX_YYY.wasm
1134 make wasm_MODE=lucet
1135 lucet-wasi --dir=./:./ --dir=../:../ --dir=/:/ ./stepX_YYY.so
1138 wax ./stepX_YYY.wasm
1140 make wasm_MODE=wace_libc
1141 wace ./stepX_YYY.wasm
1143 make wasm_MODE=warpy
1144 warpy --argv --memory-pages 256 ./stepX_YYY.wasm
1149 The Wren implementation of mal was tested on Wren 0.2.0.
1153 wren ./stepX_YYY.wren
1158 The Yorick implementation of mal was tested on Yorick 2.2.04.
1162 yorick -batch ./stepX_YYY.i
1167 The Zig implementation of mal was tested on Zig 0.5.
1178 The top level Makefile has a number of useful targets to assist with
1179 implementation development and testing. The `help` target provides
1180 a list of the targets and options:
1186 ### Functional tests
1188 The are almost 800 generic functional tests (for all implementations)
1189 in the `tests/` directory. Each step has a corresponding test file
1190 containing tests specific to that step. The `runtest.py` test harness
1191 launches a Mal step implementation and then feeds the tests one at
1192 a time to the implementation and compares the output/return value to
1193 the expected output/return value.
1195 * To run all the tests across all implementations (be prepared to wait):
1201 * To run all tests against a single implementation:
1211 * To run tests for a single step against all implementations:
1221 * To run tests for a specific step against a single implementation:
1224 make "test^IMPL^stepX"
1227 make "test^ruby^step3"
1228 make "test^ps^step4"
1231 ### Self-hosted functional tests
1233 * To run the functional tests in self-hosted mode, you specify `mal`
1234 as the test implementation and use the `MAL_IMPL` make variable
1235 to change the underlying host language (default is JavaScript):
1237 make MAL_IMPL=IMPL "test^mal^step2"
1240 make "test^mal^step2" # js is default
1241 make MAL_IMPL=ruby "test^mal^step2"
1242 make MAL_IMPL=python "test^mal^step2"
1245 ### Starting the REPL
1247 * To start the REPL of an implementation in a specific step:
1250 make "repl^IMPL^stepX"
1253 make "repl^ruby^step3"
1254 make "repl^ps^step4"
1257 * If you omit the step, then `stepA` is used:
1267 * To start the REPL of the self-hosted implementation, specify `mal` as the
1268 REPL implementation and use the `MAL_IMPL` make variable to change the
1269 underlying host language (default is JavaScript):
1271 make MAL_IMPL=IMPL "repl^mal^stepX"
1274 make "repl^mal^step2" # js is default
1275 make MAL_IMPL=ruby "repl^mal^step2"
1276 make MAL_IMPL=python "repl^mal"
1279 ### Performance tests
1281 Warning: These performance tests are neither statistically valid nor
1282 comprehensive; runtime performance is a not a primary goal of mal. If
1283 you draw any serious conclusions from these performance tests, then
1284 please contact me about some amazing oceanfront property in Kansas
1285 that I'm willing to sell you for cheap.
1287 * To run performance tests against a single implementation:
1295 * To run performance tests against all implementations:
1300 ### Generating language statistics
1302 * To report line and byte statistics for a single implementation:
1310 ## Dockerized testing
1312 Every implementation directory contains a Dockerfile to create
1313 a docker image containing all the dependencies for that
1314 implementation. In addition, the top-level Makefile contains support
1315 for running the tests target (and perf, stats, repl, etc) within
1316 a docker container for that implementation by passing *"DOCKERIZE=1"*
1317 on the make command line. For example:
1320 make DOCKERIZE=1 "test^js^step3"
1323 Existing implementations already have docker images built and pushed
1324 to the docker registry. However, if
1325 you wish to build or rebuild a docker image locally, the toplevel
1326 Makefile provides a rule for building docker images:
1329 make "docker-build^IMPL"
1334 * Docker images are named *"kanaka/mal-test-IMPL"*
1335 * JVM-based language implementations (Groovy, Java, Clojure, Scala):
1336 you will probably need to run this command once manually
1337 first `make DOCKERIZE=1 "repl^IMPL"` before you can run tests because
1338 runtime dependencies need to be downloaded to avoid the tests timing
1339 out. These dependencies are downloaded to dot-files in the /mal
1340 directory so they will persist between runs.
1345 Mal (make-a-lisp) is licensed under the MPL 2.0 (Mozilla Public
1346 License 2.0). See LICENSE.txt for more details.