mal – Make a Lisp
mal – Make a Lisp
1. Mal is a Clojure inspired Lisp interpreter
2. Mal is implemented in 79 languages (82 different implementations and 102 runtime modes)
3. Mal is a learning tool
Each implementation of mal is separated into11 incremental, self-contained (and testable) steps that demonstratecore concepts of Lisp. The last step is capable of self-hosting(running the mal implementation of mal). See the make-a-lisp processguide.
The make-a-lisp steps are:
Each make-a-lisp step has an associated architectural diagram. That elementsthat are new for that step are highlighted in red.Here is the final diagram for step A:
If you are interested in creating a mal implementation (or justinterested in using mal for something), please drop by the #malchannel on freenode. In addition to the make-a-lisp processguide there is also a mal/make-a-lispFAQ where I attempt to answer some common questions.
Mal was presented publicly for the first time in a lightning talk atClojure West 2014 (unfortunately there is no video). Seeexamples/clojurewest2014.mal for the presentation that was given at theconference (yes, the presentation is a mal program).
The simplest way to run any given implementation is to use docker.Every implementation has a docker image pre-built with languagedependencies installed. You can launch the REPL using a convenienttarget in the top level Makefile (where IMPL is the implementationdirectory name and stepX is the step to run):
make DOCKERIZE=1 "repl^IMPL^stepX" # OR stepA is the default step:make DOCKERIZE=1 "repl^IMPL"
The following implementations are maintained as separate projects:
- by Tim Morgan
- by vi – using Pest grammar, not using typical Mal infrastructure (cargo-ized steps and built-in converted tests).
Other mal Projects
- malc – Mal (Make A Lisp) compiler. Compiles a Mal program to LLVM assembly language, then binary.
- 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” post about the process.
- frock – Clojure-flavoured PHP. Uses mal/php to run programs.
- flk – A LISP that runs wherever Bash is
The Ada implementation was developed with GNAT 4.9 on debian. It alsocompiles unchanged on windows if you have windows versions of git,GNAT and (optionally) make. There are no external dependencies(readline not implemented).
The second Ada implementation was developed with GNAT 8 and links withthe GNU readline library.
The GNU awk implementation of mal has been tested with GNU awk 4.1.1.
cd gawkgawk -O -f stepX_YYY.awk
cd bashbash stepX_YYY.sh
BASIC (C64 and QBasic)
The BASIC implementation uses a preprocessor that can generate BASICcode that is compatible with both C64 BASIC (CBM v2) and QBasic. TheC64 mode has been tested withcbmbasic (the patched version iscurrently required to fix issues with line input) and the QBasic modehas been tested with qb64.
Generate C64 code and run it using cbmbasic:
cd basicmake stepX_YYY.basSTEP=stepX_YYY ./run
Generate QBasic code and load it into qb64:
cd basicmake MODE=qbasic stepX_YYY.bas./qb64 stepX_YYY.bas
Thanks to Steven Syrek for the originalinspiration for this implementation.
BBC BASIC V
The BBC BASIC V implementation can run in the Brandy interpreter:
cd bbc-basicbrandy -quit stepX_YYY.bbc
Or in ARM BBC BASIC V under RISC OS 3 or later:
*Dir bbc-basic.riscos*Run setup*Run stepX_YYY
The C implementation of mal requires the following libraries (lib andheader packages): glib, libffi6, libgc, and either the libedit or GNU readlinelibrary.
The C++ implementation of mal requires g++-4.9 or clang++-3.5 anda readline compatible library to build. See the
cpp/README.md formore details:
cd cppmake # ORmake CXX=clang++-3.5./stepX_YYY
The C# implementation of mal has been tested on Linux using the MonoC# compiler (mcs) and the Mono runtime (version 126.96.36.199). Both arerequired to build and run the C# implementation.
cd csmakemono ./stepX_YYY.exe
The ChucK implementation has been tested with ChucK 188.8.131.52.
For the most part the Clojure implementation requires Clojure 1.5,however, to pass all tests, Clojure 1.8.0-RC4 is required.
cd clojurelein with-profile +stepX trampoline run
sudo npm install -g coffee-scriptcd coffeecoffee ./stepX_YYY
The implementation has been tested with SBCL, CCL, CMUCL, GNU CLISP, ECL andAllegro CL on Ubuntu 16.04 and Ubuntu 12.04, seethe README for more details. Provided you have thedependencies mentioned installed, do the following to run the implementation
The Crystal implementation of mal has been tested with Crystal 0.26.1.
cd crystalcrystal run ./stepX_YYY.cr # ORmake # needed to run tests./stepX_YYY
The D implementation of mal was tested with GDC 4.8. It requires the GNUreadline library.
The Dart implementation has been tested with Dart 1.20.
cd dartdart ./stepX_YYY
The Emacs Lisp implementation of mal has been tested with Emacs 24.3and 24.5. While there is very basic readline editing (
C-c cancels the process), it is recommended to use
“`cd elispemacs -Q –batch –load stepX_YYY.el
with full readline support
rlwrap emacs -Q –batch –load stepX_YYY.el“`
The Elixir implementation of mal has been tested with Elixir 1.0.5.
“`cd elixirmix stepX_YYY
Or with readline/line editing functionality:
iex -S mix stepX_YYY“`
The Elm implementation of mal has been tested with Elm 0.18.0
cd elmmake stepX_YYY.jsSTEP=stepX_YYY ./run
cd erlangmake # ORMAL_STEP=stepX_YYY rebar compile escriptize # build individual step./stepX_YYY
ES6 (ECMAScript 2015)
cd es6makenode build/stepX_YYY.js
The F# implementation of mal has been tested on Linux using the MonoF# compiler (fsharpc) and the Mono runtime (version 3.12.1). The mono C#compiler (mcs) is also necessary to compile the readline dependency. All arerequired to build and run the F# implementation.
cd fsharpmakemono ./stepX_YYY.exe
The Factor implementation of mal has been tested with Factor 0.97(factorcode.org).
cd factorFACTOR_ROOTS=. factor -run=stepX_YYY
The Fantom implementation of mal has been tested with Fantom 1.0.70.
cd fantommake lib/fan/stepX_YYY.podSTEP=stepX_YYY ./run
cd forthgforth stepX_YYY.fs
GNU Guile 2.1+
cd guileguile -L ./ stepX_YYY.scm
The Smalltalk implementation of mal has been tested with GNU Smalltalk 3.2.91.
The Go implementation of mal requires that go is installed on on thepath. The implementation has been tested with Go 1.3.1.
The Groovy implementation of mal requires Groovy to run and has beentested with Groovy 1.8.6.
cd groovymakegroovy ./stepX_YYY.groovy
The Haskell implementation requires the ghc compiler version 7.10.1 orlater and also the Haskell parsec and readline (or editline) packages.
make all-nekoneko ./stepX_YYY.n
make all-pythonpython3 ./stepX_YYY.py
make all-jsnode ./stepX_YYY.js“`
The Hy implementation of mal has been tested with Hy 0.13.0.
The Io implementation of mal has been tested with Io version 20110905.
cd ioio ./stepX_YYY.io
The Java implementation of mal requires maven2 to build.
cd javamvn compilemvn -quiet exec:java -Dexec.mainClass=mal.stepX_YYY # ORmvn -quiet exec:java -Dexec.mainClass=mal.stepX_YYY -Dexec.args="CMDLINE_ARGS"
cd jsnpm updatenode stepX_YYY.js
The Julia implementation of mal requires Julia 0.4.
cd juliajulia stepX_YYY.jl
The Kotlin implementation of mal has been tested with Kotlin 1.0.
cd kotlinmakejava -jar stepX_YYY.jar
The LiveScript implementation of mal has been tested with LiveScript 1.5.
cd livescriptmakenode_modules/.bin/lsc stepX_YYY.ls
The Logo implementation of mal has been tested with UCBLogo 6.0.
cd logologo stepX_YYY.lg
The Lua implementation of mal has been tested with Lua 5.2. Theimplementation requires that luarocks and the lua-rex-pcre libraryare installed.
cd luamake # to build and link linenoise.so./stepX_YYY.lua
Running the mal implementation of mal involves running stepA of one ofthe other implementations and passing the mal step to run as a commandline argument.
“`cd IMPLIMPLSTEPACMD ../mal/stepX_YYY.mal
GNU Make 3.81
cd makemake -f stepX_YYY.mk
The NASM implementation of mal is written for x86-64 Linux, and has been testedwith Linux 3.16.0-4-amd64 and NASM version 2.11.05.
The Nim implementation of mal has been tested with Nim 0.17.0.
cd nimmake # ORnimble build./stepX_YYY
The Object Pascal implementation of mal has been built and tested onLinux using the Free Pascal compiler version 2.6.2 and 2.6.4.
The Objective C implementation of mal has been built and tested onLinux using clang/LLVM 3.6. It has also been built and tested on OSX using XCode 7.
MATLAB (GNU Octave and MATLAB)
The MatLab implementation has been tested with GNU Octave 4.2.1.It has also been tested with MATLAB version R2014a on Linux. Note thatMATLAB is a commercial product.
cd matlab./stepX_YYYoctave -q --no-gui --no-history --eval "stepX_YYY();quit;"matlab -nodisplay -nosplash -nodesktop -nojvm -r "stepX_YYY();quit;" # OR with command line argumentsoctave -q --no-gui --no-history --eval "stepX_YYY('arg1','arg2');quit;"matlab -nodisplay -nosplash -nodesktop -nojvm -r "stepX_YYY('arg1','arg2');quit;"
Download miniMAL and dependencies
npm installexport PATH=
Now run mal implementation in miniMAL
The Perl 5 implementation should work with perl 5.19.3 and later.
For readline line editing support, install Term::ReadLine::Perl orTerm::ReadLine::Gnu from CPAN.
cd perlperl stepX_YYY.pl
The Perl 6 implementation was tested on Rakudo Perl 6 2016.04.
cd perl6perl6 stepX_YYY.pl
The PHP implementation of mal requires the php command line interfaceto run.
cd phpphp stepX_YYY.php
The Picolisp implementation requires libreadline and Picolisp 3.1.11or later.
The Pike implementation was tested on Pike 8.0.
cd pikepike stepX_YYY.pike
PL/pgSQL (PostgreSQL SQL Procedural Language)
The PL/pgSQL implementation of mal requires a running PostgreSQL server(the “kanaka/mal-test-plpgsql” docker image automatically startsa PostgreSQL server). The implementation connects to the PostgreSQL serverand create a database named “mal” to store tables and storedprocedures. The wrapper script uses the psql command to connect to theserver and defaults to the user “postgres” but this can be overriddenwith the PSQL_USER environment variable. A password can be specifiedusing the PGPASSWORD environment variable. The implementation has beentested with PostgreSQL 9.4.
cd plpgsql./wrap.sh stepX_YYY.sql # ORPSQL_USER=myuser PGPASSWORD=mypass ./wrap.sh stepX_YYY.sql
PL/SQL (Oracle SQL Procedural Language)
The PL/SQL implementation of mal requires a running Oracle DBserver (the “kanaka/mal-test-plsql” docker image automaticallystarts an Oracle Express server). The implementation connects to theOracle server to create types, tables and stored procedures. Thedefault SQL*Plus logon value (username/password@connectidentifier) is”system/oracle” but this can be overridden with the ORACLELOGONenvironment variable. The implementation has been tested with OracleExpress Edition 11g Release 2. Note that any SQL*Plus connectionwarnings (user password expiration, etc) will interfere with theability of the wrapper script to communicate with the DB.
cd plsql./wrap.sh stepX_YYY.sql # ORORACLE_LOGON=myuser/mypass@ORCL ./wrap.sh stepX_YYY.sql
PostScript Level 2/3
The PostScript implementation of mal requires Ghostscript to run. Ithas been tested with Ghostscript 9.10.
cd psgs -q -dNODISPLAY -I./ stepX_YYY.ps
The PowerShell implementation of mal requires the PowerShell scriptlanguage. It has been tested with PowerShell 6.0.0 Alpha 9 on Linux.
cd powershellpowershell ./stepX_YYY.ps1
Python (2.X and 3.X)
cd pythonpython stepX_YYY.py
The second Python implementation makes heavy use of type annotations and uses the Arpeggio parser library.
Recommended: do these steps in a Python virtual environment.
pip3 install Arpeggio==1.9.0python3 stepX_YYY.py“`
cd rpythonmake # this takes a very long time./stepX_YYY
The R implementation of mal requires R (r-base-core) to run.
cd rmake libs # to download and build rdyncallRscript stepX_YYY.r
The Racket implementation of mal requires the Racketcompiler/interpreter to run.
The Rexx implementation of mal has been tested with Regina Rexx 3.6.
cd rexxmakerexx -a ./stepX_YYY.rexxpp
cd rubyruby stepX_YYY.rb
The rust implementation of mal requires the rust compiler and buildtool (cargo) to build.
cd rustcargo run --release --bin stepX_YYY
Install scala and sbt (http://www.scala-sbt.org/0.13/tutorial/Installing-sbt-on-Linux.html):
cd scalasbt 'run-main stepX_YYY' # ORsbt compilescala -classpath target/scala*/classes stepX_YYY
The Scheme implementation of mal has been tested with Chibi-Scheme0.7.3, Kawa 2.4, Gauche 0.9.5, CHICKEN 4.11.0, Sagittarius 0.8.3,Cyclone 0.6.3 (Git version) and Foment 0.4 (Git version). You shouldbe able to get it running on other conforming R7RS implementationsafter figuring out how libraries are loaded and adjusting the
run script accordingly.
“`cd schememake symlinks
make kawascheme_MODE=kawa ./run
make chickenscheme_MODE=chicken ./run
make cyclonescheme_MODE=cyclone ./run
The Skew implementation of mal has been tested with Skew 0.7.42.
cd skewmakenode stepX_YYY.js
The Swift implementation of mal requires the Swift 2.0 compiler (XCode7.0) to build. Older versions will not work due to changes in thelanguage and standard library.
The Swift 3 implementation of mal requires the Swift 3.0 compiler. Ithas been tested with Swift 3 Preview 3.
The Swift 4 implementation of mal requires the Swift 4.0 compiler. Ithas been tested with Swift 4.2.3 release.
The Swift 5 implementation of mal requires the Swift 5.0 compiler. Ithas been tested with Swift 5.1.1 release.
cd swift5swift run stepX_YYY
The Tcl implementation of mal requires Tcl 8.6 to run. For readline lineediting support, install tclreadline.
cd tcltclsh ./stepX_YYY.tcl
The TypeScript implementation of mal requires the TypeScript 2.2 compiler.It has been tested with Node.js v6.
cd tsmakenode ./stepX_YYY.js
The Vala implementation of mal has been tested with the Vala 0.40.8compiler. You will need to install
The VHDL implementation of mal has been tested with GHDL 0.29.
cd vhdlmake./run_vhdl.sh ./stepX_YYY
The Vimscript implementation of mal requires Vim 8.0 to run.
cd vimscript./run_vimscript.sh ./stepX_YYY.vim
The VB.NET implementation of mal has been tested on Linux using the MonoVB compiler (vbnc) and the Mono runtime (version 184.108.40.206). Both arerequired to build and run the VB.NET implementation.
cd vbmakemono ./stepX_YYY.exe
make wasmMODE=node./run.js ./stepXYYY.wasm
make wasmMODE=wasmtimewasmtime –dir=./ –dir=../ –dir=/ ./stepXYYY.wasm
make wasmMODE=wasmerwasmer run –dir=./ –dir=../ –dir=/ ./stepXYYY.wasm
make wasmMODE=lucetlucet-wasi –dir=./:./ –dir=../:../ –dir=/:/ ./stepXYYY.so
make wasmMODE=waxwax ./stepXYYY.wasm
make wasmMODE=wacelibcwace ./stepX_YYY.wasm
make wasmMODE=warpywarpy –argv –memory-pages 256 ./stepXYYY.wasm“`
The Wren implementation of mal was tested on Wren 0.2.0.
cd wrenwren ./stepX_YYY.wren
The Yorick implementation of mal was tested on Yorick 2.2.04.
cd yorickyorick -batch ./stepX_YYY.i
The top level Makefile has a number of useful targets to assist withimplementation development and testing. The
help target providesa list of the targets and options:
The are almost 800 generic functional tests (for all implementations)in the
tests/ directory. Each step has a corresponding test filecontaining tests specific to that step. The
runtest.py test harnesslaunches a Mal step implementation and then feeds the tests one ata time to the implementation and compares the output/return value tothe expected output/return value.
- To run all the tests across all implementations (be prepared to wait):
- To run all tests against a single implementation:
make “test^clojure”make “test^js”“`
- To run tests for a single step against all implementations:
make “test^step2″make “test^step7″“`
- To run tests for a specific step against a single implementation:
make “test^ruby^step3″make “test^ps^step4″“`
Self-hosted functional tests
- To run the functional tests in self-hosted mode, you specify
malas the test implementation and use the
make “test^mal^step2” # js is defaultmake MALIMPL=ruby “test^mal^step2″make MALIMPL=python “test^mal^step2″“`
Starting the REPL
- To start the REPL of an implementation in a specific step:
make “repl^ruby^step3″make “repl^ps^step4″“`
- If you omit the step, then
make “repl^ruby”make “repl^ps”“`
- To start the REPL of the self-hosted implementation, specify
malas theREPL implementation and use the
make “repl^mal^step2” # js is defaultmake MALIMPL=ruby “repl^mal^step2″make MALIMPL=python “repl^mal”“`
Warning: These performance tests are neither statistically valid norcomprehensive; runtime performance is a not a primary goal of mal. Ifyou draw any serious conclusions from these performance tests, thenplease contact me about some amazing oceanfront property in Kansasthat I’m willing to sell you for cheap.
- To run performance tests against a single implementation:“`make “perf^IMPL”
- To run performance tests against all implementations:
Generating language statistics
- To report line and byte statistics for a single implementation:“`make “stats^IMPL”
Every implementation directory contains a Dockerfile to createa docker image containing all the dependencies for thatimplementation. In addition, the top-level Makefile contains supportfor running the tests target (and perf, stats, repl, etc) withina docker container for that implementation by passing “DOCKERIZE=1”on the make command line. For example:
make DOCKERIZE=1 "test^js^step3"
Existing implementations already have docker images built and pushedto the docker registry. However, ifyou wish to build or rebuild a docker image locally, the toplevelMakefile provides a rule for building docker images:
Notes:* Docker images are named “kanaka/mal-test-IMPL”* JVM-based language implementations (Groovy, Java, Clojure, Scala): you will probably need to run this command once manually first
make DOCKERIZE=1 "repl^IMPL" before you can run tests because runtime dependencies need to be downloaded to avoid the tests timing out. These dependencies are downloaded to dot-files in the /mal directory so they will persist between runs.
Mal (make-a-lisp) is licensed under the MPL 2.0 (Mozilla PublicLicense 2.0). See LICENSE.txt for more details.
To restore the repository download the bundle
git clone kanaka-mal_-_2019-12-02_16-40-25.bundle