## Description
-Mal is a Clojure inspired Lisp interpreter.
-
-Mal is implemented in 73 languages:
-
-* Ada
-* GNU awk
-* Bash shell
-* BASIC (C64 and QBasic)
-* C
-* C++
-* C#
-* ChucK
-* Common Lisp
-* Clojure (Clojure and ClojureScript)
-* CoffeeScript
-* Crystal
-* D
-* Dart
-* Elixir
-* Elm
-* Emacs Lisp
-* Erlang
-* ES6 (ECMAScript 6 / ECMAScript 2015)
-* F#
-* Factor
-* Fantom
-* Forth
-* Go
-* Groovy
-* GNU Guile
-* GNU Smalltalk
-* Haskell
-* Haxe (Neko, Python, C++ and JavaScript)
-* Hy
-* Io
-* Java
-* JavaScript ([Online Demo](http://kanaka.github.io/mal))
-* Julia
-* Kotlin
-* LiveScript
-* Logo
-* Lua
-* GNU Make
-* mal itself
-* Matlab (GNU Octave and MATLAB)
-* [miniMAL](https://github.com/kanaka/miniMAL)
-* NASM
-* Nim
-* Object Pascal
-* Objective C
-* OCaml
-* Perl
-* Perl 6
-* PHP
-* Picolisp
-* PL/pgSQL (Postgres)
-* PL/SQL (Oracle)
-* Postscript
-* PowerShell
-* Python (2.X and 3.X)
-* RPython
-* R
-* Racket
-* Rexx
-* Ruby
-* Rust
-* Scala
-* Scheme (R7RS)
-* Skew
-* Swift
-* Swift 3
-* Tcl
-* TypeScript
-* VHDL
-* Vimscript
-* Visual Basic.NET
-* Yorick
-
-
-Mal is a learning tool. See the [make-a-lisp process
-guide](process/guide.md). Each implementation of mal is separated into
+**1. Mal is a Clojure inspired Lisp interpreter**
+
+**2. Mal is a learning tool**
+
+Each implementation of mal is separated into
11 incremental, self-contained (and testable) steps that demonstrate
core concepts of Lisp. The last step is capable of self-hosting
-(running the mal implementation of mal).
+(running the mal implementation of mal). See the [make-a-lisp process
+guide](process/guide.md).
-The mal (make a lisp) steps are:
+The make-a-lisp steps are:
* [step0_repl](process/guide.md#step0)
* [step1_read_print](process/guide.md#step1)
* [step9_try](process/guide.md#step9)
* [stepA_mal](process/guide.md#stepA)
+Each make-a-lisp step has an associated architectural diagram. That elements
+that are new for that step are highlighted in red.
+Here is the final diagram for [step A](process/guide.md#stepA):
-Mal was presented publicly for the first time in a lightning talk at
-Clojure West 2014 (unfortunately there is no video). See
-examples/clojurewest2014.mal for the presentation that was given at the
-conference (yes the presentation is a mal program). At Midwest.io
-2015, Joel Martin gave a presentation on Mal titled "Achievement
-Unlocked: A Better Path to Language Learning".
-[Video](https://www.youtube.com/watch?v=lgyOAiRtZGw),
-[Slides](http://kanaka.github.io/midwest.io.mal/). More recently
-Joel gave a presentation on "Make Your Own Lisp Interpreter in
-10 Incremental Steps" at LambdaConf 2016: [Part
-1](https://www.youtube.com/watch?v=jVhupfthTEk), [Part
-2](https://www.youtube.com/watch?v=X5OQBMGpaTU),
-[Slides](http://kanaka.github.io/lambdaconf/).
+
-If you are interesting in creating a mal implementation (or just
+If you are interested in creating a mal implementation (or just
interested in using mal for something), please drop by the #mal
channel on freenode. In addition to the [make-a-lisp process
guide](process/guide.md) there is also a [mal/make-a-lisp
FAQ](docs/FAQ.md) where I attempt to answer some common questions.
+
+**3. Mal is implemented in 81 languages (84 different implementations and 104 runtime modes)**
+
+| Language | Creator |
+| -------- | ------- |
+| [Ada](#ada) | [Chris Moore](https://github.com/zmower) |
+| [Ada #2](#ada2) | [Nicolas Boulenguez](https://github.com/asarhaddon) |
+| [GNU Awk](#gnu-awk) | [Miutsuru Kariya](https://github.com/kariya-mitsuru) |
+| [Bash 4](#bash-4) | [Joel Martin](https://github.com/kanaka) |
+| [BASIC](#basic-c64-and-qbasic) (C64 & QBasic) | [Joel Martin](https://github.com/kanaka) |
+| [BBC BASIC V](#bbc-basic-v) | [Ben Harris](https://github.com/bjh21) |
+| [C](#c) | [Joel Martin](https://github.com/kanaka) |
+| [C++](#c-1) | [Stephen Thirlwall](https://github.com/sdt) |
+| [C#](#c-2) | [Joel Martin](https://github.com/kanaka) |
+| [ChucK](#chuck) | [Vasilij Schneidermann](https://github.com/wasamasa) |
+| [Clojure](#clojure) (Clojure & ClojureScript) | [Joel Martin](https://github.com/kanaka) |
+| [CoffeeScript](#coffeescript) | [Joel Martin](https://github.com/kanaka) |
+| [Common Lisp](#common-lisp) | [Iqbal Ansari](https://github.com/iqbalansari) |
+| [Crystal](#crystal) | [Linda_pp](https://github.com/rhysd) |
+| [D](#d) | [Dov Murik](https://github.com/dubek) |
+| [Dart](#dart) | [Harry Terkelsen](https://github.com/hterkelsen) |
+| [Elixir](#elixir) | [Martin Ek](https://github.com/ekmartin) |
+| [Elm](#elm) | [Jos van Bakel](https://github.com/c0deaddict) |
+| [Emacs Lisp](#emacs-lisp) | [Vasilij Schneidermann](https://github.com/wasamasa) |
+| [Erlang](#erlang) | [Nathan Fiedler](https://github.com/nlfiedler) |
+| [ES6](#es6-ecmascript-2015) (ECMAScript 2015) | [Joel Martin](https://github.com/kanaka) |
+| [F#](#f) | [Peter Stephens](https://github.com/pstephens) |
+| [Factor](#factor) | [Jordan Lewis](https://github.com/jordanlewis) |
+| [Fantom](#fantom) | [Dov Murik](https://github.com/dubek) |
+| [Forth](#forth) | [Chris Houser](https://github.com/chouser) |
+| [GNU Guile](#gnu-guile-21) | [Mu Lei](https://github.com/NalaGinrut) |
+| [GNU Smalltalk](#gnu-smalltalk) | [Vasilij Schneidermann](https://github.com/wasamasa) |
+| [Go](#go) | [Joel Martin](https://github.com/kanaka) |
+| [Groovy](#groovy) | [Joel Martin](https://github.com/kanaka) |
+| [Haskell](#haskell) | [Joel Martin](https://github.com/kanaka) |
+| [Haxe](#haxe-neko-python-c-and-javascript) (Neko, Python, C++, & JS) | [Joel Martin](https://github.com/kanaka) |
+| [Hy](#hy) | [Joel Martin](https://github.com/kanaka) |
+| [Io](#io) | [Dov Murik](https://github.com/dubek) |
+| [Java](#java-17) | [Joel Martin](https://github.com/kanaka) |
+| [JavaScript](#javascriptnode) ([Demo](http://kanaka.github.io/mal)) | [Joel Martin](https://github.com/kanaka) |
+| [jq](#jq) | [Ali MohammadPur](https://github.com/alimpfard) |
+| [Julia](#julia) | [Joel Martin](https://github.com/kanaka) |
+| [Kotlin](#kotlin) | [Javier Fernandez-Ivern](https://github.com/ivern) |
+| [LiveScript](#livescript) | [Jos van Bakel](https://github.com/c0deaddict) |
+| [Logo](#logo) | [Dov Murik](https://github.com/dubek) |
+| [Lua](#lua) | [Joel Martin](https://github.com/kanaka) |
+| [GNU Make](#gnu-make-381) | [Joel Martin](https://github.com/kanaka) |
+| [mal itself](#mal) | [Joel Martin](https://github.com/kanaka) |
+| [MATLAB](#matlab-gnu-octave-and-matlab) (GNU Octave & MATLAB) | [Joel Martin](https://github.com/kanaka) |
+| [miniMAL](#minimal) ([Repo](https://github.com/kanaka/miniMAL), [Demo](https://kanaka.github.io/miniMAL/)) | [Joel Martin](https://github.com/kanaka) |
+| [NASM](#nasm) | [Ben Dudson](https://github.com/bendudson) |
+| [Nim](#nim-104) | [Dennis Felsing](https://github.com/def-) |
+| [Object Pascal](#object-pascal) | [Joel Martin](https://github.com/kanaka) |
+| [Objective C](#objective-c) | [Joel Martin](https://github.com/kanaka) |
+| [OCaml](#ocaml-4010) | [Chris Houser](https://github.com/chouser) |
+| [Perl](#perl-5) | [Joel Martin](https://github.com/kanaka) |
+| [Perl 6](#perl-6) | [Hinrik Örn Sigurðsson](https://github.com/hinrik) |
+| [PHP](#php-53) | [Joel Martin](https://github.com/kanaka) |
+| [Picolisp](#picolisp) | [Vasilij Schneidermann](https://github.com/wasamasa) |
+| [Pike](#pike) | [Dov Murik](https://github.com/dubek) |
+| [PL/pgSQL](#plpgsql-postgresql-sql-procedural-language) (PostgreSQL) | [Joel Martin](https://github.com/kanaka) |
+| [PL/SQL](#plsql-oracle-sql-procedural-language) (Oracle) | [Joel Martin](https://github.com/kanaka) |
+| [PostScript](#postscript-level-23) | [Joel Martin](https://github.com/kanaka) |
+| [PowerShell](#powershell) | [Joel Martin](https://github.com/kanaka) |
+| [Python](#python-2x-and-3x) (2.X & 3.X) | [Joel Martin](https://github.com/kanaka) |
+| [Python #2](#python2-3x) (3.X) | [Gavin Lewis](https://github.com/epylar) |
+| [RPython](#rpython) | [Joel Martin](https://github.com/kanaka) |
+| [R](#r) | [Joel Martin](https://github.com/kanaka) |
+| [Racket](#racket-53) | [Joel Martin](https://github.com/kanaka) |
+| [Rexx](#rexx) | [Dov Murik](https://github.com/dubek) |
+| [Ruby](#ruby-19) | [Joel Martin](https://github.com/kanaka) |
+| [Rust](#rust-138) | [Joel Martin](https://github.com/kanaka) |
+| [Scala](#scala) | [Joel Martin](https://github.com/kanaka) |
+| [Scheme (R7RS)](#scheme-r7rs) | [Vasilij Schneidermann](https://github.com/wasamasa) |
+| [Skew](#skew) | [Dov Murik](https://github.com/dubek) |
+| [Swift 2](#swift) | [Keith Rollin](https://github.com/keith-rollin) |
+| [Swift 3](#swift-3) | [Joel Martin](https://github.com/kanaka) |
+| [Swift 4](#swift-4) | [陆遥](https://github.com/LispLY) |
+| [Swift 5](#swift-5) | [Oleg Montak](https://github.com/MontakOleg) |
+| [Tcl](#tcl-86) | [Dov Murik](https://github.com/dubek) |
+| [TypeScript](#typescript) | [Masahiro Wakame](https://github.com/vvakame) |
+| [Vala](#vala) | [Simon Tatham](https://github.com/sgtatham) |
+| [VHDL](#vhdl) | [Dov Murik](https://github.com/dubek) |
+| [Vimscript](#vimscript) | [Dov Murik](https://github.com/dubek) |
+| [Visual Basic.NET](#visual-basicnet) | [Joel Martin](https://github.com/kanaka) |
+| [WebAssembly](#webassembly-wasm) (wasm) | [Joel Martin](https://github.com/kanaka) |
+| [Wren](#wren) | [Dov Murik](https://github.com/dubek) |
+| [Yorick](#yorick) | [Dov Murik](https://github.com/dubek) |
+| [Zig](#zig) | [Josh Tobin](https://github.com/rjtobin) |
+
+
+## Presentations
+
+Mal was presented publicly for the first time in a lightning talk at
+Clojure West 2014 (unfortunately there is no video). See
+examples/clojurewest2014.mal for the presentation that was given at the
+conference (yes, the presentation is a mal program).
+
+At Midwest.io 2015, Joel Martin gave a presentation on Mal titled
+"Achievement Unlocked: A Better Path to Language Learning".
+[Video](https://www.youtube.com/watch?v=lgyOAiRtZGw),
+[Slides](http://kanaka.github.io/midwest.io.mal/).
+
+More recently Joel gave a presentation on "Make Your Own Lisp Interpreter
+in 10 Incremental Steps" at LambdaConf 2016:
+[Part 1](https://www.youtube.com/watch?v=jVhupfthTEk),
+[Part 2](https://www.youtube.com/watch?v=X5OQBMGpaTU),
+[Part 3](https://www.youtube.com/watch?v=6mARZzGgX4U),
+[Part 4](https://www.youtube.com/watch?v=dCO1SYR5kDU),
+[Slides](http://kanaka.github.io/lambdaconf/).
+
## Building/running implementations
The simplest way to run any given implementation is to use docker.
Every implementation has a docker image pre-built with language
-dependencies installed. You can launch the REPL using a convenience
+dependencies installed. You can launch the REPL using a convenient
target in the top level Makefile (where IMPL is the implementation
directory name and stepX is the step to run):
make DOCKERIZE=1 "repl^IMPL"
```
+## External Implementations
-### Ada
+The following implementations are maintained as separate projects:
+
+### HolyC
+
+* [by Alexander Bagnalla](https://github.com/bagnalla/holyc_mal)
+
+### Rust
+
+* [by Tim Morgan](https://github.com/seven1m/mal-rust)
+* [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).
+
+
+## Other mal Projects
+
+ * [malc](https://github.com/dubek/malc) - Mal (Make A Lisp) compiler. Compiles a Mal program to LLVM assembly language, then binary.
+ * [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.
+ * [frock](https://github.com/chr15m/frock) - Clojure-flavoured PHP. Uses mal/php to run programs.
+ * [flk](https://github.com/chr15m/flk) - A LISP that runs wherever Bash is
-*The Ada implementation was created by [Chris Moore](https://github.com/zmower)*
+
+## Implementation Details
+
+### Ada
The Ada implementation was developed with GNAT 4.9 on debian. It also
compiles unchanged on windows if you have windows versions of git,
(readline not implemented).
```
-cd ada
+cd impls/ada
make
./stepX_YYY
```
-### GNU awk
+### Ada.2
+
+The second Ada implementation was developed with GNAT 8 and links with
+the GNU readline library.
-*The GNU awk implementation was created by [Miutsuru kariya](https://github.com/kariya-mitsuru)*
+```
+cd impls/ada
+make
+./stepX_YYY
+```
+
+### GNU awk
The GNU awk implementation of mal has been tested with GNU awk 4.1.1.
```
-cd gawk
+cd impls/gawk
gawk -O -f stepX_YYY.awk
```
### Bash 4
```
-cd bash
+cd impls/bash
bash stepX_YYY.sh
```
Generate C64 code and run it using cbmbasic:
```
-cd basic
+cd impls/basic
make stepX_YYY.bas
STEP=stepX_YYY ./run
```
Generate QBasic code and load it into qb64:
```
-cd basic
+cd impls/basic
make MODE=qbasic stepX_YYY.bas
./qb64 stepX_YYY.bas
```
Thanks to [Steven Syrek](https://github.com/sjsyrek) for the original
inspiration for this implementation.
+### BBC BASIC V
+
+The BBC BASIC V implementation can run in the Brandy interpreter:
+
+```
+cd impls/bbc-basic
+brandy -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
+```
### C
library.
```
-cd c
+cd impls/c
make
./stepX_YYY
```
### C++
-*The C++ implementation was created by [Stephen Thirlwall (sdt)](https://github.com/sdt)*
-
The C++ implementation of mal requires g++-4.9 or clang++-3.5 and
a readline compatible library to build. See the `cpp/README.md` for
more details:
```
-cd cpp
+cd impls/cpp
make
# OR
make CXX=clang++-3.5
required to build and run the C# implementation.
```
-cd cs
+cd impls/cs
make
mono ./stepX_YYY.exe
```
### ChucK
-*The ChucK implementation was created by [Vasilij Schneidermann](https://github.com/wasamasa)*
-
The ChucK implementation has been tested with ChucK 1.3.5.2.
```
-cd chuck
-./run
-```
-
-### Common Lisp
-
-*The Common Lisp implementation was created by [Iqbal Ansari](https://github.com/iqbalansari)*
-
-The implementation has been tested with SBCL, CCL, CMUCL, GNU CLISP, ECL and
-Allegro CL on Ubuntu 16.04 and Ubuntu 12.04, see
-the [README](common-lisp/README.org) for more details. Provided you have the
-dependencies mentioned installed, do the following to run the implementation
-
-```
-cd common-lisp
-make
+cd impls/chuck
./run
```
however, to pass all tests, Clojure 1.8.0-RC4 is required.
```
-cd clojure
+cd impls/clojure
lein with-profile +stepX trampoline run
```
```
sudo npm install -g coffee-script
-cd coffee
+cd impls/coffee
coffee ./stepX_YYY
```
-### Crystal
+### Common Lisp
-*The Crystal implementation of mal was created by [Linda_pp](https://github.com/rhysd)*
+The implementation has been tested with SBCL, CCL, CMUCL, GNU CLISP, ECL and
+Allegro CL on Ubuntu 16.04 and Ubuntu 12.04, see
+the [README](common-lisp/README.org) for more details. Provided you have the
+dependencies mentioned installed, do the following to run the implementation
+
+```
+cd impls/common-lisp
+make
+./run
+```
+
+### Crystal
The Crystal implementation of mal has been tested with Crystal 0.26.1.
```
-cd crystal
+cd impls/crystal
crystal run ./stepX_YYY.cr
# OR
make # needed to run tests
### D
-*The D implementation was created by [Dov Murik](https://github.com/dubek)*
-
The D implementation of mal was tested with GDC 4.8. It requires the GNU
readline library.
```
-cd d
+cd impls/d
make
./stepX_YYY
```
### Dart
-*The Dart implementation was created by [Harry Terkelsen](https://github.com/hterkelsen)*
-
The Dart implementation has been tested with Dart 1.20.
```
-cd dart
+cd impls/dart
dart ./stepX_YYY
```
### Emacs Lisp
-*The Emacs Lisp implementation was created by [Vasilij Schneidermann](https://github.com/wasamasa)*
-
The Emacs Lisp implementation of mal has been tested with Emacs 24.3
and 24.5. While there is very basic readline editing (`<backspace>`
and `C-d` work, `C-c` cancels the process), it is recommended to use
`rlwrap`.
```
-cd elisp
+cd impls/elisp
emacs -Q --batch --load stepX_YYY.el
# with full readline support
rlwrap emacs -Q --batch --load stepX_YYY.el
### Elixir
-*The Elixir implementation was created by [Martin Ek (ekmartin)](https://github.com/ekmartin)*
-
The Elixir implementation of mal has been tested with Elixir 1.0.5.
```
-cd elixir
+cd impls/elixir
mix stepX_YYY
# Or with readline/line editing functionality:
iex -S mix stepX_YYY
### Elm
-*The Elm implementation was created by [Jos van Bakel](https://github.com/c0deaddict)*
-
The Elm implementation of mal has been tested with Elm 0.18.0
```
-cd elm
+cd impls/elm
make stepX_YYY.js
STEP=stepX_YYY ./run
```
### Erlang
-*The Erlang implementation was created by [Nathan Fiedler (nlfiedler)](https://github.com/nlfiedler)*
-
The Erlang implementation of mal requires [Erlang/OTP R17](http://www.erlang.org/download.html)
and [rebar](https://github.com/rebar/rebar) to build.
```
-cd erlang
+cd impls/erlang
make
# OR
MAL_STEP=stepX_YYY rebar compile escriptize # build individual step
./stepX_YYY
```
-### ES6 (ECMAScript 6 / ECMAScript 2015)
+### ES6 (ECMAScript 2015)
-The ES6 implementation uses the [babel](https://babeljs.io) compiler
-to generate ES5 compatible JavaScript. The generated code has been
-tested with Node 0.12.4.
+The ES6 / ECMAScript 2015 implementation uses the
+[babel](https://babeljs.io) compiler to generate ES5 compatible
+JavaScript. The generated code has been tested with Node 0.12.4.
```
-cd es6
+cd impls/es6
make
node build/stepX_YYY.js
```
### F# ###
-*The F# implementation was created by [Peter Stephens (pstephens)](https://github.com/pstephens)*
-
The F# implementation of mal has been tested on Linux using the Mono
F# compiler (fsharpc) and the Mono runtime (version 3.12.1). The mono C#
compiler (mcs) is also necessary to compile the readline dependency. All are
required to build and run the F# implementation.
```
-cd fsharp
+cd impls/fsharp
make
mono ./stepX_YYY.exe
```
### Factor
-*The Factor implementation was created by [Jordan Lewis (jordanlewis)](https://github.com/jordanlewis)*
-
The Factor implementation of mal has been tested with Factor 0.97
([factorcode.org](http://factorcode.org)).
```
-cd factor
+cd impls/factor
FACTOR_ROOTS=. factor -run=stepX_YYY
```
### Fantom
-*The Fantom implementation was created by [Dov Murik](https://github.com/dubek)*
-
The Fantom implementation of mal has been tested with Fantom 1.0.70.
```
-cd fantom
+cd impls/fantom
make lib/fan/stepX_YYY.pod
STEP=stepX_YYY ./run
```
### Forth
-*The Forth implementation was created by [Chris Houser (chouser)](https://github.com/chouser)*
-
```
-cd forth
+cd impls/forth
gforth stepX_YYY.fs
```
+### GNU Guile 2.1+
+
+```
+cd impls/guile
+guile -L ./ stepX_YYY.scm
+```
+
+### GNU Smalltalk
+
+The Smalltalk implementation of mal has been tested with GNU Smalltalk 3.2.91.
+
+```
+cd impls/gnu-smalltalk
+./run
+```
+
### Go
The Go implementation of mal requires that go is installed on on the
path. The implementation has been tested with Go 1.3.1.
```
-cd go
+cd impls/go
make
./stepX_YYY
```
tested with Groovy 1.8.6.
```
-cd groovy
+cd impls/groovy
make
groovy ./stepX_YYY.groovy
```
-### GNU Guile 2.1+
-
-*The Guile implementation was created by [Mu Lei (NalaGinrut)](https://github.com/NalaGinrut).*
-
-```
-cd guile
-guile -L ./ stepX_YYY.scm
-```
-
-### GNU Smalltalk
-
-*The Smalltalk implementation was created by [Vasilij Schneidermann](https://github.com/wasamasa)*
-
-The Smalltalk implementation of mal has been tested with GNU Smalltalk 3.2.91.
-
-```
-cd gnu-smalltalk
-./run
-```
-
### Haskell
The Haskell implementation requires the ghc compiler version 7.10.1 or
later and also the Haskell parsec and readline (or editline) packages.
```
-cd haskell
+cd impls/haskell
make
./stepX_YYY
```
JavaScript.
```
-cd haxe
+cd impls/haxe
# Neko
make all-neko
neko ./stepX_YYY.n
The Hy implementation of mal has been tested with Hy 0.13.0.
```
-cd hy
+cd impls/hy
./stepX_YYY.hy
```
### Io
-*The Io implementation was created by [Dov Murik](https://github.com/dubek)*
-
The Io implementation of mal has been tested with Io version 20110905.
```
-cd io
+cd impls/io
io ./stepX_YYY.io
```
The Java implementation of mal requires maven2 to build.
```
-cd java
+cd impls/java
mvn compile
mvn -quiet exec:java -Dexec.mainClass=mal.stepX_YYY
# OR
### JavaScript/Node
```
-cd js
-npm update
+cd impls/js
+npm install
node stepX_YYY.js
```
The Julia implementation of mal requires Julia 0.4.
```
-cd julia
+cd impls/julia
julia stepX_YYY.jl
```
-### Kotlin
+### jq
+
+Tested against version 1.6, with a lot of cheating in the IO department
+
+```
+cd impls/jq
+STEP=stepA_YYY ./run
+ # with Debug
+DEBUG=true STEP=stepA_YYY ./run
+```
-*The Kotlin implementation was created by [Javier Fernandez-Ivern](https://github.com/ivern)*
+### Kotlin
The Kotlin implementation of mal has been tested with Kotlin 1.0.
```
-cd kotlin
+cd impls/kotlin
make
java -jar stepX_YYY.jar
```
### LiveScript
-*The LiveScript implementation was created by [Jos van Bakel](https://github.com/c0deaddict)*
-
The LiveScript implementation of mal has been tested with LiveScript 1.5.
```
-cd livescript
+cd impls/livescript
make
node_modules/.bin/lsc stepX_YYY.ls
```
### Logo
-*The Logo implementation was created by [Dov Murik](https://github.com/dubek)*
-
The Logo implementation of mal has been tested with UCBLogo 6.0.
```
-cd logo
+cd impls/logo
logo stepX_YYY.lg
```
### Lua
-Running the Lua implementation of mal requires lua 5.1 or later,
-luarocks and the lua-rex-pcre library installed.
+The Lua implementation of mal has been tested with Lua 5.3.5 The
+implementation requires luarocks to be installed.
```
-cd lua
-make # to build and link linenoise.so
+cd impls/lua
+make # to build and link linenoise.so and rex_pcre.so
./stepX_YYY.lua
```
line argument.
```
-cd IMPL
+cd impls/IMPL
IMPL_STEPA_CMD ../mal/stepX_YYY.mal
```
### GNU Make 3.81
```
-cd make
+cd impls/make
make -f stepX_YYY.mk
```
### NASM
-*The NASM implementation was created by [Ben Dudson](https://github.com/bendudson)*
-
The NASM implementation of mal is written for x86-64 Linux, and has been tested
with Linux 3.16.0-4-amd64 and NASM version 2.11.05.
```
-cd nasm
+cd impls/nasm
make
./stepX_YYY
```
-### Nim 0.17.0
+### Nim 1.0.4
-*The Nim implementation was created by [Dennis Felsing (def-)](https://github.com/def-)*
-
-The Nim implementation of mal has been tested with Nim 0.17.0.
+The Nim implementation of mal has been tested with Nim 1.0.4.
```
-cd nim
+cd impls/nim
make
# OR
nimble build
Linux using the Free Pascal compiler version 2.6.2 and 2.6.4.
```
-cd objpascal
+cd impls/objpascal
make
./stepX_YYY
```
X using XCode 7.
```
-cd objc
+cd impls/objc
make
./stepX_YYY
```
### OCaml 4.01.0
-*The OCaml implementation was created by [Chris Houser (chouser)](https://github.com/chouser)*
-
```
-cd ocaml
+cd impls/ocaml
make
./stepX_YYY
```
-### MatLab (GNU Octave and MATLAB)
+### 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 that
MATLAB is a commercial product.
```
-cd matlab
+cd impls/matlab
./stepX_YYY
octave -q --no-gui --no-history --eval "stepX_YYY();quit;"
matlab -nodisplay -nosplash -nodesktop -nojvm -r "stepX_YYY();quit;"
implementation of mal you need to download/install the miniMAL
interpreter (which requires Node.js).
```
-cd miniMAL
+cd impls/miniMAL
# Download miniMAL and dependencies
npm install
export PATH=`pwd`/node_modules/minimal-lisp/:$PATH
miniMAL ./stepX_YYY
```
-### Perl 5.8
+### Perl 5
+
+The Perl 5 implementation should work with perl 5.19.3 and later.
For readline line editing support, install Term::ReadLine::Perl or
Term::ReadLine::Gnu from CPAN.
```
-cd perl
+cd impls/perl
perl stepX_YYY.pl
```
### Perl 6
-*The Perl 6 implementation was created by [Hinrik Örn Sigurðsson](https://github.com/hinrik)*
-
The Perl 6 implementation was tested on Rakudo Perl 6 2016.04.
```
-cd perl6
+cd impls/perl6
perl6 stepX_YYY.pl
```
to run.
```
-cd php
+cd impls/php
php stepX_YYY.php
```
### Picolisp
-*The Picolisp implementation was created by [Vasilij Schneidermann](https://github.com/wasamasa)*
-
The Picolisp implementation requires libreadline and Picolisp 3.1.11
or later.
```
-cd picolisp
+cd impls/picolisp
./run
```
-### PL/pgSQL (Postgres SQL Procedural Language)
+### Pike
+
+The Pike implementation was tested on Pike 8.0.
-The PL/pgSQL implementation of mal requires a running Postgres server
+```
+cd impls/pike
+pike 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 starts
-a Postgres server). The implementation connects to the Postgres server
+a PostgreSQL server). The implementation connects to the PostgreSQL server
and create a database named "mal" to store tables and stored
procedures. The wrapper script uses the psql command to connect to the
server and defaults to the user "postgres" but this can be overridden
with the PSQL_USER environment variable. A password can be specified
using the PGPASSWORD environment variable. The implementation has been
-tested with Postgres 9.4.
+tested with PostgreSQL 9.4.
```
-cd plpgsql
+cd impls/plpgsql
./wrap.sh stepX_YYY.sql
# OR
PSQL_USER=myuser PGPASSWORD=mypass ./wrap.sh stepX_YYY.sql
### PL/SQL (Oracle SQL Procedural Language)
-The PL/pgSQL implementation of mal requires a running Oracle DB
+The PL/SQL implementation of mal requires a running Oracle DB
server (the "kanaka/mal-test-plsql" docker image automatically
starts an Oracle Express server). The implementation connects to the
Oracle server to create types, tables and stored procedures. The
-default SQL*Plus logon value (username/password@connect_identifier) is
+default SQL\*Plus logon value (username/password@connect_identifier) is
"system/oracle" but this can be overridden with the ORACLE_LOGON
environment variable. The implementation has been tested with Oracle
-Express Edition 11g Release 2. Note that any SQL*Plus connection
+Express Edition 11g Release 2. Note that any SQL\*Plus connection
warnings (user password expiration, etc) will interfere with the
ability of the wrapper script to communicate with the DB.
```
-cd plsql
+cd impls/plsql
./wrap.sh stepX_YYY.sql
# OR
ORACLE_LOGON=myuser/mypass@ORCL ./wrap.sh stepX_YYY.sql
```
-### Postscript Level 2/3
+### PostScript Level 2/3
-The Postscript implementation of mal requires ghostscript to run. It
-has been tested with ghostscript 9.10.
+The PostScript implementation of mal requires Ghostscript to run. It
+has been tested with Ghostscript 9.10.
```
-cd ps
+cd impls/ps
gs -q -dNODISPLAY -I./ stepX_YYY.ps
```
language. It has been tested with PowerShell 6.0.0 Alpha 9 on Linux.
```
-cd powershell
+cd impls/powershell
powershell ./stepX_YYY.ps1
```
### Python (2.X and 3.X)
```
-cd python
+cd impls/python
python stepX_YYY.py
```
+### Python.2 (3.X)
+
+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.0
+python3 stepX_YYY.py
+```
+
### RPython
You must have [rpython](https://rpython.readthedocs.org/) on your path
(included with [pypy](https://bitbucket.org/pypy/pypy/)).
```
-cd rpython
+cd impls/rpython
make # this takes a very long time
./stepX_YYY
```
The R implementation of mal requires R (r-base-core) to run.
```
-cd r
+cd impls/r
make libs # to download and build rdyncall
Rscript stepX_YYY.r
```
compiler/interpreter to run.
```
-cd racket
+cd impls/racket
./stepX_YYY.rkt
```
### Rexx
-*The Rexx implementation was created by [Dov Murik](https://github.com/dubek)*
-
The Rexx implementation of mal has been tested with Regina Rexx 3.6.
```
-cd rexx
+cd impls/rexx
make
rexx -a ./stepX_YYY.rexxpp
```
### Ruby (1.9+)
```
-cd ruby
+cd impls/ruby
ruby stepX_YYY.rb
```
-### Rust (1.0.0 nightly)
+### Rust (1.38+)
The rust implementation of mal requires the rust compiler and build
tool (cargo) to build.
```
-cd rust
+cd impls/rust
cargo run --release --bin stepX_YYY
```
-Alternative out-of-tee Rust implementations:
-
-* [by Tim Morgan](https://github.com/seven1m/mal-rust).
-* [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).
-
### Scala ###
Install scala and sbt (http://www.scala-sbt.org/0.13/tutorial/Installing-sbt-on-Linux.html):
```
-cd scala
+cd impls/scala
sbt 'run-main stepX_YYY'
# OR
sbt compile
### Scheme (R7RS) ###
-*The Scheme implementation was created by [Vasilij Schneidermann](https://github.com/wasamasa)*
-
The Scheme implementation of mal has been tested with Chibi-Scheme
0.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 should
`Makefile` and `run` script accordingly.
```
-cd scheme
+cd impls/scheme
make symlinks
# chibi
scheme_MODE=chibi ./run
### Skew ###
-*The Skew implementation was created by [Dov Murik](https://github.com/dubek)*
-
The Skew implementation of mal has been tested with Skew 0.7.42.
```
-cd skew
+cd impls/skew
make
node stepX_YYY.js
```
### Swift
-*The Swift implementation was created by [Keith Rollin](https://github.com/keith-rollin)*
-
The Swift implementation of mal requires the Swift 2.0 compiler (XCode
7.0) to build. Older versions will not work due to changes in the
language and standard library.
```
-cd swift
+cd impls/swift
make
./stepX_YYY
```
has been tested with Swift 3 Preview 3.
```
-cd swift3
+cd impls/swift3
make
./stepX_YYY
```
-### Tcl 8.6
+### Swift 4
-*The Tcl implementation was created by [Dov Murik](https://github.com/dubek)*
+The Swift 4 implementation of mal requires the Swift 4.0 compiler. It
+has been tested with Swift 4.2.3 release.
+
+```
+cd impls/swift4
+make
+./stepX_YYY
+```
+
+### Swift 5
+
+The Swift 5 implementation of mal requires the Swift 5.0 compiler. It
+has been tested with Swift 5.1.1 release.
+
+```
+cd impls/swift5
+swift run stepX_YYY
+```
+
+### Tcl 8.6
The Tcl implementation of mal requires Tcl 8.6 to run. For readline line
editing support, install tclreadline.
```
-cd tcl
+cd impls/tcl
tclsh ./stepX_YYY.tcl
```
### TypeScript
-*The TypeScript implementation was created by [vvakame](https://github.com/vvakame)*
-
The TypeScript implementation of mal requires the TypeScript 2.2 compiler.
It has been tested with Node.js v6.
```
-cd ts
+cd impls/ts
make
node ./stepX_YYY.js
```
-### VHDL
+### Vala
-*The VHDL implementation was created by [Dov Murik](https://github.com/dubek)*
+The Vala implementation of mal has been tested with the Vala 0.40.8
+compiler. You will need to install `valac` and `libreadline-dev` or
+equivalent.
+
+```
+cd impls/vala
+make
+./stepX_YYY
+```
+
+### VHDL
The VHDL implementation of mal has been tested with GHDL 0.29.
```
-cd vhdl
+cd impls/vhdl
make
./run_vhdl.sh ./stepX_YYY
```
### Vimscript
-*The Vimscript implementation was created by [Dov Murik](https://github.com/dubek)*
-
The Vimscript implementation of mal requires Vim 8.0 to run.
```
-cd vimscript
+cd impls/vimscript
./run_vimscript.sh ./stepX_YYY.vim
```
required to build and run the VB.NET implementation.
```
-cd vb
+cd impls/vb
make
mono ./stepX_YYY.exe
```
-### Yorick
+### WebAssembly (wasm) ###
+
+The WebAssembly implementation is written in
+[Wam](https://github.com/kanaka/wam) (WebAssembly Macro language) and
+runs under several different non-web embeddings (runtimes):
+[node](https://nodejs.org),
+[wasmtime](https://github.com/CraneStation/wasmtime),
+[wasmer](https://wasmer.io),
+[lucet](https://github.com/fastly/lucet),
+[wax](https://github.com/kanaka/wac),
+[wace](https://github.com/kanaka/wac),
+[warpy](https://github.com/kanaka/warpy).
+
+```
+cd impls/wasm
+# node
+make wasm_MODE=node
+./run.js ./stepX_YYY.wasm
+# wasmtime
+make wasm_MODE=wasmtime
+wasmtime --dir=./ --dir=../ --dir=/ ./stepX_YYY.wasm
+# wasmer
+make wasm_MODE=wasmer
+wasmer run --dir=./ --dir=../ --dir=/ ./stepX_YYY.wasm
+# lucet
+make wasm_MODE=lucet
+lucet-wasi --dir=./:./ --dir=../:../ --dir=/:/ ./stepX_YYY.so
+# wax
+make wasm_MODE=wax
+wax ./stepX_YYY.wasm
+# wace
+make wasm_MODE=wace_libc
+wace ./stepX_YYY.wasm
+# warpy
+make wasm_MODE=warpy
+warpy --argv --memory-pages 256 ./stepX_YYY.wasm
+```
-*The Yorick implementation was created by [Dov Murik](https://github.com/dubek)*
+### Wren
+
+The Wren implementation of mal was tested on Wren 0.2.0.
+
+```
+cd impls/wren
+wren ./stepX_YYY.wren
+```
+
+### Yorick
The Yorick implementation of mal was tested on Yorick 2.2.04.
```
-cd yorick
+cd impls/yorick
yorick -batch ./stepX_YYY.i
```
+### Zig
+
+The Zig implementation of mal was tested on Zig 0.5.
+
+```
+cd impls/zig
+zig build stepX_YYY
+```
+
## Running tests
+The top level Makefile has a number of useful targets to assist with
+implementation development and testing. The `help` target provides
+a list of the targets and options:
+
+```
+make help
+```
+
### Functional tests
-The are over 600 generic functional tests (for all implementations)
+The are almost 800 generic functional tests (for all implementations)
in the `tests/` directory. Each step has a corresponding test file
containing tests specific to that step. The `runtest.py` test harness
launches a Mal step implementation and then feeds the tests one at
a time to the implementation and compares the output/return value to
the expected output/return value.
-To simplify the process of running tests, a top level Makefile is
-provided with convenient test targets.
-
* To run all the tests across all implementations (be prepared to wait):
```
make "stats^js"
```
-* To report line and bytes statistics for general Lisp code (env, core
- and stepA):
-```
-make "stats-lisp^IMPL"
-
-# e.g.
-make "stats-lisp^js"
-```
-
## Dockerized testing
Every implementation directory contains a Dockerfile to create
**Notes**:
* Docker images are named *"kanaka/mal-test-IMPL"*
* JVM-based language implementations (Groovy, Java, Clojure, Scala):
- you will probably need to run these implementations once manually
- first (make DOCKERIZE=1 "repl^IMPL")before you can run tests because
+ 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 download to dot-files in the /mal
+ out. These dependencies are downloaded to dot-files in the /mal
directory so they will persist between runs.
-## Projects using mal
-
- * [malc](https://github.com/dubek/malc) - Mal (Make A Lisp) compiler. Compiles a Mal program to LLVM assembly language, then binary.
- * [frock](https://github.com/chr15m/frock) - Clojure-flavoured PHP. Uses mal/php to run programs.
## License
HCoop / jackhill / mal.git / blobdiff