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 78 languages (79 different implementations and 100 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 | [RPython](#rpython) | [Joel Martin](https://github.com/kanaka) |
73 | [R](#r) | [Joel Martin](https://github.com/kanaka) |
74 | [Racket](#racket-53) | [Joel Martin](https://github.com/kanaka) |
75 | [Rexx](#rexx) | [Dov Murik](https://github.com/dubek) |
76 | [Ruby](#ruby-19) | [Joel Martin](https://github.com/kanaka) |
77 | [Rust](#rust-100-nightly) | [Joel Martin](https://github.com/kanaka) |
78 | [Scala](#scala) | [Joel Martin](https://github.com/kanaka) |
79 | [Scheme (R7RS)](#scheme-r7rs) | [Vasilij Schneidermann](https://github.com/wasamasa) |
80 | [Skew](#skew) | [Dov Murik](https://github.com/dubek) |
81 | [Swift 2](#swift) | [Keith Rollin](https://github.com/keith-rollin) |
82 | [Swift 3](#swift-3) | [Joel Martin](https://github.com/kanaka) |
83 | [Swift 4](#swift-4) | [陆遥](https://github.com/LispLY) |
84 | [Tcl](#tcl-86) | [Dov Murik](https://github.com/dubek) |
85 | [TypeScript](#typescript) | [Masahiro Wakame](https://github.com/vvakame) |
86 | [Vala](#vala) | [Simon Tatham](https://github.com/sgtatham) |
87 | [VHDL](#vhdl) | [Dov Murik](https://github.com/dubek) |
88 | [Vimscript](#vimscript) | [Dov Murik](https://github.com/dubek) |
89 | [Visual Basic.NET](#visual-basicnet) | [Joel Martin](https://github.com/kanaka) |
90 | [WebAssembly](#webassembly-wasm) (wasm) | [Joel Martin](https://github.com/kanaka) |
91 | [Yorick](#yorick) | [Dov Murik](https://github.com/dubek) |
94 **3. Mal is a learning tool**
96 Each implementation of mal is separated into
97 11 incremental, self-contained (and testable) steps that demonstrate
98 core concepts of Lisp. The last step is capable of self-hosting
99 (running the mal implementation of mal). See the [make-a-lisp process
100 guide](process/guide.md).
102 The make-a-lisp steps are:
104 * [step0_repl](process/guide.md#step0)
105 * [step1_read_print](process/guide.md#step1)
106 * [step2_eval](process/guide.md#step2)
107 * [step3_env](process/guide.md#step3)
108 * [step4_if_fn_do](process/guide.md#step4)
109 * [step5_tco](process/guide.md#step5)
110 * [step6_file](process/guide.md#step6)
111 * [step7_quote](process/guide.md#step7)
112 * [step8_macros](process/guide.md#step8)
113 * [step9_try](process/guide.md#step9)
114 * [stepA_mal](process/guide.md#stepA)
116 Each make-a-lisp step has an associated architectural diagram. That elements
117 that are new for that step are highlighted in red.
118 Here is the final diagram for [step A](process/guide.md#stepA):
120 ![stepA_mal architecture](process/stepA_mal.png)
122 If you are interested in creating a mal implementation (or just
123 interested in using mal for something), please drop by the #mal
124 channel on freenode. In addition to the [make-a-lisp process
125 guide](process/guide.md) there is also a [mal/make-a-lisp
126 FAQ](docs/FAQ.md) where I attempt to answer some common questions.
131 Mal was presented publicly for the first time in a lightning talk at
132 Clojure West 2014 (unfortunately there is no video). See
133 examples/clojurewest2014.mal for the presentation that was given at the
134 conference (yes, the presentation is a mal program).
136 At Midwest.io 2015, Joel Martin gave a presentation on Mal titled
137 "Achievement Unlocked: A Better Path to Language Learning".
138 [Video](https://www.youtube.com/watch?v=lgyOAiRtZGw),
139 [Slides](http://kanaka.github.io/midwest.io.mal/).
141 More recently Joel gave a presentation on "Make Your Own Lisp Interpreter
142 in 10 Incremental Steps" at LambdaConf 2016:
143 [Part 1](https://www.youtube.com/watch?v=jVhupfthTEk),
144 [Part 2](https://www.youtube.com/watch?v=X5OQBMGpaTU),
145 [Part 3](https://www.youtube.com/watch?v=6mARZzGgX4U),
146 [Part 4](https://www.youtube.com/watch?v=dCO1SYR5kDU),
147 [Slides](http://kanaka.github.io/lambdaconf/).
149 ## Building/running implementations
151 The simplest way to run any given implementation is to use docker.
152 Every implementation has a docker image pre-built with language
153 dependencies installed. You can launch the REPL using a convenient
154 target in the top level Makefile (where IMPL is the implementation
155 directory name and stepX is the step to run):
158 make DOCKERIZE=1 "repl^IMPL^stepX"
159 # OR stepA is the default step:
160 make DOCKERIZE=1 "repl^IMPL"
163 ## External Implementations
165 The following implementations are maintained as separate projects:
169 * [by Alexander Bagnalla](https://github.com/bagnalla/holyc_mal)
173 * [by Tim Morgan](https://github.com/seven1m/mal-rust)
174 * [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).
177 ## Other mal Projects
179 * [malc](https://github.com/dubek/malc) - Mal (Make A Lisp) compiler. Compiles a Mal program to LLVM assembly language, then binary.
180 * [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.
181 * [frock](https://github.com/chr15m/frock) - Clojure-flavoured PHP. Uses mal/php to run programs.
184 ## Implementation Details
188 The Ada implementation was developed with GNAT 4.9 on debian. It also
189 compiles unchanged on windows if you have windows versions of git,
190 GNAT and (optionally) make. There are no external dependencies
191 (readline not implemented).
201 The second Ada implementation was developed with GNAT 8 and links with
202 the GNU readline library.
212 The GNU awk implementation of mal has been tested with GNU awk 4.1.1.
216 gawk -O -f stepX_YYY.awk
226 ### BASIC (C64 and QBasic)
228 The BASIC implementation uses a preprocessor that can generate BASIC
229 code that is compatible with both C64 BASIC (CBM v2) and QBasic. The
230 C64 mode has been tested with
231 [cbmbasic](https://github.com/kanaka/cbmbasic) (the patched version is
232 currently required to fix issues with line input) and the QBasic mode
233 has been tested with [qb64](http://www.qb64.net/).
235 Generate C64 code and run it using cbmbasic:
243 Generate QBasic code and load it into qb64:
247 make MODE=qbasic stepX_YYY.bas
251 Thanks to [Steven Syrek](https://github.com/sjsyrek) for the original
252 inspiration for this implementation.
256 The BBC BASIC V implementation can run in the Brandy interpreter:
260 brandy -quit stepX_YYY.bbc
263 Or in ARM BBC BASIC V under RISC OS 3 or later:
266 *Dir bbc-basic.riscos
273 The C implementation of mal requires the following libraries (lib and
274 header packages): glib, libffi6, libgc, and either the libedit or GNU readline
285 The C++ implementation of mal requires g++-4.9 or clang++-3.5 and
286 a readline compatible library to build. See the `cpp/README.md` for
300 The C# implementation of mal has been tested on Linux using the Mono
301 C# compiler (mcs) and the Mono runtime (version 2.10.8.1). Both are
302 required to build and run the C# implementation.
312 The ChucK implementation has been tested with ChucK 1.3.5.2.
321 For the most part the Clojure implementation requires Clojure 1.5,
322 however, to pass all tests, Clojure 1.8.0-RC4 is required.
326 lein with-profile +stepX trampoline run
332 sudo npm install -g coffee-script
339 The implementation has been tested with SBCL, CCL, CMUCL, GNU CLISP, ECL and
340 Allegro CL on Ubuntu 16.04 and Ubuntu 12.04, see
341 the [README](common-lisp/README.org) for more details. Provided you have the
342 dependencies mentioned installed, do the following to run the implementation
352 The Crystal implementation of mal has been tested with Crystal 0.26.1.
356 crystal run ./stepX_YYY.cr
358 make # needed to run tests
364 The D implementation of mal was tested with GDC 4.8. It requires the GNU
375 The Dart implementation has been tested with Dart 1.20.
384 The Emacs Lisp implementation of mal has been tested with Emacs 24.3
385 and 24.5. While there is very basic readline editing (`<backspace>`
386 and `C-d` work, `C-c` cancels the process), it is recommended to use
391 emacs -Q --batch --load stepX_YYY.el
392 # with full readline support
393 rlwrap emacs -Q --batch --load stepX_YYY.el
398 The Elixir implementation of mal has been tested with Elixir 1.0.5.
403 # Or with readline/line editing functionality:
409 The Elm implementation of mal has been tested with Elm 0.18.0
419 The Erlang implementation of mal requires [Erlang/OTP R17](http://www.erlang.org/download.html)
420 and [rebar](https://github.com/rebar/rebar) to build.
426 MAL_STEP=stepX_YYY rebar compile escriptize # build individual step
430 ### ES6 (ECMAScript 2015)
432 The ES6 / ECMAScript 2015 implementation uses the
433 [babel](https://babeljs.io) compiler to generate ES5 compatible
434 JavaScript. The generated code has been tested with Node 0.12.4.
439 node build/stepX_YYY.js
445 The F# implementation of mal has been tested on Linux using the Mono
446 F# compiler (fsharpc) and the Mono runtime (version 3.12.1). The mono C#
447 compiler (mcs) is also necessary to compile the readline dependency. All are
448 required to build and run the F# implementation.
458 The Factor implementation of mal has been tested with Factor 0.97
459 ([factorcode.org](http://factorcode.org)).
463 FACTOR_ROOTS=. factor -run=stepX_YYY
468 The Fantom implementation of mal has been tested with Fantom 1.0.70.
472 make lib/fan/stepX_YYY.pod
487 guile -L ./ stepX_YYY.scm
492 The Smalltalk implementation of mal has been tested with GNU Smalltalk 3.2.91.
501 The Go implementation of mal requires that go is installed on on the
502 path. The implementation has been tested with Go 1.3.1.
513 The Groovy implementation of mal requires Groovy to run and has been
514 tested with Groovy 1.8.6.
519 groovy ./stepX_YYY.groovy
524 The Haskell implementation requires the ghc compiler version 7.10.1 or
525 later and also the Haskell parsec and readline (or editline) packages.
533 ### Haxe (Neko, Python, C++ and JavaScript)
535 The Haxe implementation of mal requires Haxe version 3.2 to compile.
536 Four different Haxe targets are supported: Neko, Python, C++, and
546 python3 ./stepX_YYY.py
557 The Hy implementation of mal has been tested with Hy 0.13.0.
566 The Io implementation of mal has been tested with Io version 20110905.
575 The Java implementation of mal requires maven2 to build.
580 mvn -quiet exec:java -Dexec.mainClass=mal.stepX_YYY
582 mvn -quiet exec:java -Dexec.mainClass=mal.stepX_YYY -Dexec.args="CMDLINE_ARGS"
595 The Julia implementation of mal requires Julia 0.4.
604 The Kotlin implementation of mal has been tested with Kotlin 1.0.
609 java -jar stepX_YYY.jar
614 The LiveScript implementation of mal has been tested with LiveScript 1.5.
619 node_modules/.bin/lsc stepX_YYY.ls
624 The Logo implementation of mal has been tested with UCBLogo 6.0.
633 The Lua implementation of mal has been tested with Lua 5.2. The
634 implementation requires that luarocks and the lua-rex-pcre library
639 make # to build and link linenoise.so
645 Running the mal implementation of mal involves running stepA of one of
646 the other implementations and passing the mal step to run as a command
651 IMPL_STEPA_CMD ../mal/stepX_YYY.mal
664 The NASM implementation of mal is written for x86-64 Linux, and has been tested
665 with Linux 3.16.0-4-amd64 and NASM version 2.11.05.
675 The Nim implementation of mal has been tested with Nim 0.17.0.
687 The Object Pascal implementation of mal has been built and tested on
688 Linux using the Free Pascal compiler version 2.6.2 and 2.6.4.
698 The Objective C implementation of mal has been built and tested on
699 Linux using clang/LLVM 3.6. It has also been built and tested on OS
716 ### MATLAB (GNU Octave and MATLAB)
718 The MatLab implementation has been tested with GNU Octave 4.2.1.
719 It has also been tested with MATLAB version R2014a on Linux. Note that
720 MATLAB is a commercial product.
725 octave -q --no-gui --no-history --eval "stepX_YYY();quit;"
726 matlab -nodisplay -nosplash -nodesktop -nojvm -r "stepX_YYY();quit;"
727 # OR with command line arguments
728 octave -q --no-gui --no-history --eval "stepX_YYY('arg1','arg2');quit;"
729 matlab -nodisplay -nosplash -nodesktop -nojvm -r "stepX_YYY('arg1','arg2');quit;"
734 [miniMAL](https://github.com/kanaka/miniMAL) is small Lisp interpreter
735 implemented in less than 1024 bytes of JavaScript. To run the miniMAL
736 implementation of mal you need to download/install the miniMAL
737 interpreter (which requires Node.js).
740 # Download miniMAL and dependencies
742 export PATH=`pwd`/node_modules/minimal-lisp/:$PATH
743 # Now run mal implementation in miniMAL
749 The Perl 5 implementation should work with perl 5.19.3 and later.
751 For readline line editing support, install Term::ReadLine::Perl or
752 Term::ReadLine::Gnu from CPAN.
761 The Perl 6 implementation was tested on Rakudo Perl 6 2016.04.
770 The PHP implementation of mal requires the php command line interface
780 The Picolisp implementation requires libreadline and Picolisp 3.1.11
790 The Pike implementation was tested on Pike 8.0.
797 ### PL/pgSQL (PostgreSQL SQL Procedural Language)
799 The PL/pgSQL implementation of mal requires a running PostgreSQL server
800 (the "kanaka/mal-test-plpgsql" docker image automatically starts
801 a PostgreSQL server). The implementation connects to the PostgreSQL server
802 and create a database named "mal" to store tables and stored
803 procedures. The wrapper script uses the psql command to connect to the
804 server and defaults to the user "postgres" but this can be overridden
805 with the PSQL_USER environment variable. A password can be specified
806 using the PGPASSWORD environment variable. The implementation has been
807 tested with PostgreSQL 9.4.
811 ./wrap.sh stepX_YYY.sql
813 PSQL_USER=myuser PGPASSWORD=mypass ./wrap.sh stepX_YYY.sql
816 ### PL/SQL (Oracle SQL Procedural Language)
818 The PL/SQL implementation of mal requires a running Oracle DB
819 server (the "kanaka/mal-test-plsql" docker image automatically
820 starts an Oracle Express server). The implementation connects to the
821 Oracle server to create types, tables and stored procedures. The
822 default SQL\*Plus logon value (username/password@connect_identifier) is
823 "system/oracle" but this can be overridden with the ORACLE_LOGON
824 environment variable. The implementation has been tested with Oracle
825 Express Edition 11g Release 2. Note that any SQL\*Plus connection
826 warnings (user password expiration, etc) will interfere with the
827 ability of the wrapper script to communicate with the DB.
831 ./wrap.sh stepX_YYY.sql
833 ORACLE_LOGON=myuser/mypass@ORCL ./wrap.sh stepX_YYY.sql
836 ### PostScript Level 2/3
838 The PostScript implementation of mal requires Ghostscript to run. It
839 has been tested with Ghostscript 9.10.
843 gs -q -dNODISPLAY -I./ stepX_YYY.ps
848 The PowerShell implementation of mal requires the PowerShell script
849 language. It has been tested with PowerShell 6.0.0 Alpha 9 on Linux.
853 powershell ./stepX_YYY.ps1
856 ### Python (2.X and 3.X)
865 You must have [rpython](https://rpython.readthedocs.org/) on your path
866 (included with [pypy](https://bitbucket.org/pypy/pypy/)).
870 make # this takes a very long time
876 The R implementation of mal requires R (r-base-core) to run.
880 make libs # to download and build rdyncall
886 The Racket implementation of mal requires the Racket
887 compiler/interpreter to run.
896 The Rexx implementation of mal has been tested with Regina Rexx 3.6.
901 rexx -a ./stepX_YYY.rexxpp
911 ### Rust (1.0.0 nightly)
913 The rust implementation of mal requires the rust compiler and build
914 tool (cargo) to build.
918 cargo run --release --bin stepX_YYY
923 Install scala and sbt (http://www.scala-sbt.org/0.13/tutorial/Installing-sbt-on-Linux.html):
927 sbt 'run-main stepX_YYY'
930 scala -classpath target/scala*/classes stepX_YYY
933 ### Scheme (R7RS) ###
935 The Scheme implementation of mal has been tested with Chibi-Scheme
936 0.7.3, Kawa 2.4, Gauche 0.9.5, CHICKEN 4.11.0, Sagittarius 0.8.3,
937 Cyclone 0.6.3 (Git version) and Foment 0.4 (Git version). You should
938 be able to get it running on other conforming R7RS implementations
939 after figuring out how libraries are loaded and adjusting the
940 `Makefile` and `run` script accordingly.
946 scheme_MODE=chibi ./run
949 scheme_MODE=kawa ./run
951 scheme_MODE=gauche ./run
954 scheme_MODE=chicken ./run
956 scheme_MODE=sagittarius ./run
959 scheme_MODE=cyclone ./run
961 scheme_MODE=foment ./run
966 The Skew implementation of mal has been tested with Skew 0.7.42.
977 The Swift implementation of mal requires the Swift 2.0 compiler (XCode
978 7.0) to build. Older versions will not work due to changes in the
979 language and standard library.
989 The Swift 3 implementation of mal requires the Swift 3.0 compiler. It
990 has been tested with Swift 3 Preview 3.
1000 The Swift 4 implementation of mal requires the Swift 4.0 compiler. It
1001 has been tested with Swift 4.2.3 release.
1011 The Tcl implementation of mal requires Tcl 8.6 to run. For readline line
1012 editing support, install tclreadline.
1016 tclsh ./stepX_YYY.tcl
1021 The TypeScript implementation of mal requires the TypeScript 2.2 compiler.
1022 It has been tested with Node.js v6.
1032 The Vala implementation of mal has been tested with the Vala 0.40.8
1033 compiler. You will need to install `valac` and `libreadline-dev` or
1044 The VHDL implementation of mal has been tested with GHDL 0.29.
1049 ./run_vhdl.sh ./stepX_YYY
1054 The Vimscript implementation of mal requires Vim 8.0 to run.
1058 ./run_vimscript.sh ./stepX_YYY.vim
1061 ### Visual Basic.NET ###
1063 The VB.NET implementation of mal has been tested on Linux using the Mono
1064 VB compiler (vbnc) and the Mono runtime (version 2.10.8.1). Both are
1065 required to build and run the VB.NET implementation.
1070 mono ./stepX_YYY.exe
1073 ### WebAssembly (wasm) ###
1075 The WebAssembly implementation is written in
1076 [Wam](https://github.com/kanaka/wam) (WebAssembly Macro language) and
1077 runs under several different non-web embeddings (runtimes):
1078 [node](https://nodejs.org),
1079 [wasmtime](https://github.com/CraneStation/wasmtime),
1080 [wasmer](https://wasmer.io),
1081 [lucet](https://github.com/fastly/lucet),
1082 [wax](https://github.com/kanaka/wac),
1083 [wace](https://github.com/kanaka/wac),
1084 [warpy](https://github.com/kanaka/warpy).
1090 ./run.js ./stepX_YYY.wasm
1092 make wasm_MODE=wasmtime
1093 wasmtime --dir=./ --dir=../ --dir=/ ./stepX_YYY.wasm
1095 make wasm_MODE=wasmer
1096 wasmer run --dir=./ --dir=../ --dir=/ ./stepX_YYY.wasm
1098 make wasm_MODE=lucet
1099 lucet-wasi --dir=./:./ --dir=../:../ --dir=/:/ ./stepX_YYY.so
1102 wax ./stepX_YYY.wasm
1104 make wasm_MODE=wace_libc
1105 wace ./stepX_YYY.wasm
1107 make wasm_MODE=warpy
1108 warpy --argv --memory-pages 256 ./stepX_YYY.wasm
1113 The Yorick implementation of mal was tested on Yorick 2.2.04.
1117 yorick -batch ./stepX_YYY.i
1124 The top level Makefile has a number of useful targets to assist with
1125 implementation development and testing. The `help` target provides
1126 a list of the targets and options:
1132 ### Functional tests
1134 The are almost 800 generic functional tests (for all implementations)
1135 in the `tests/` directory. Each step has a corresponding test file
1136 containing tests specific to that step. The `runtest.py` test harness
1137 launches a Mal step implementation and then feeds the tests one at
1138 a time to the implementation and compares the output/return value to
1139 the expected output/return value.
1141 * To run all the tests across all implementations (be prepared to wait):
1147 * To run all tests against a single implementation:
1157 * To run tests for a single step against all implementations:
1167 * To run tests for a specific step against a single implementation:
1170 make "test^IMPL^stepX"
1173 make "test^ruby^step3"
1174 make "test^ps^step4"
1177 ### Self-hosted functional tests
1179 * To run the functional tests in self-hosted mode, you specify `mal`
1180 as the test implementation and use the `MAL_IMPL` make variable
1181 to change the underlying host language (default is JavaScript):
1183 make MAL_IMPL=IMPL "test^mal^step2"
1186 make "test^mal^step2" # js is default
1187 make MAL_IMPL=ruby "test^mal^step2"
1188 make MAL_IMPL=python "test^mal^step2"
1191 ### Starting the REPL
1193 * To start the REPL of an implementation in a specific step:
1196 make "repl^IMPL^stepX"
1199 make "repl^ruby^step3"
1200 make "repl^ps^step4"
1203 * If you omit the step, then `stepA` is used:
1213 * To start the REPL of the self-hosted implementation, specify `mal` as the
1214 REPL implementation and use the `MAL_IMPL` make variable to change the
1215 underlying host language (default is JavaScript):
1217 make MAL_IMPL=IMPL "repl^mal^stepX"
1220 make "repl^mal^step2" # js is default
1221 make MAL_IMPL=ruby "repl^mal^step2"
1222 make MAL_IMPL=python "repl^mal"
1225 ### Performance tests
1227 Warning: These performance tests are neither statistically valid nor
1228 comprehensive; runtime performance is a not a primary goal of mal. If
1229 you draw any serious conclusions from these performance tests, then
1230 please contact me about some amazing oceanfront property in Kansas
1231 that I'm willing to sell you for cheap.
1233 * To run performance tests against a single implementation:
1241 * To run performance tests against all implementations:
1246 ### Generating language statistics
1248 * To report line and byte statistics for a single implementation:
1256 ## Dockerized testing
1258 Every implementation directory contains a Dockerfile to create
1259 a docker image containing all the dependencies for that
1260 implementation. In addition, the top-level Makefile contains support
1261 for running the tests target (and perf, stats, repl, etc) within
1262 a docker container for that implementation by passing *"DOCKERIZE=1"*
1263 on the make command line. For example:
1266 make DOCKERIZE=1 "test^js^step3"
1269 Existing implementations already have docker images built and pushed
1270 to the docker registry. However, if
1271 you wish to build or rebuild a docker image locally, the toplevel
1272 Makefile provides a rule for building docker images:
1275 make "docker-build^IMPL"
1280 * Docker images are named *"kanaka/mal-test-IMPL"*
1281 * JVM-based language implementations (Groovy, Java, Clojure, Scala):
1282 you will probably need to run this command once manually
1283 first `make DOCKERIZE=1 "repl^IMPL"` before you can run tests because
1284 runtime dependencies need to be downloaded to avoid the tests timing
1285 out. These dependencies are downloaded to dot-files in the /mal
1286 directory so they will persist between runs.
1291 Mal (make-a-lisp) is licensed under the MPL 2.0 (Mozilla Public
1292 License 2.0). See LICENSE.txt for more details.