2014-03-30 00:17:00 +04:00
|
|
|
# mal - Make a Lisp
|
|
|
|
|
2014-03-30 04:01:14 +04:00
|
|
|
## Description
|
|
|
|
|
2015-02-28 16:48:13 +03:00
|
|
|
Mal is a Clojure inspired Lisp interpreter.
|
2014-12-24 06:35:48 +03:00
|
|
|
|
2015-03-04 06:17:43 +03:00
|
|
|
Mal is implemented in 27 different languages:
|
2014-03-30 04:01:14 +04:00
|
|
|
|
2014-04-10 07:15:54 +04:00
|
|
|
* Bash shell
|
2014-03-30 04:01:14 +04:00
|
|
|
* C
|
2014-04-10 07:15:54 +04:00
|
|
|
* C#
|
|
|
|
* Clojure
|
2014-11-09 01:56:36 +03:00
|
|
|
* CoffeeScript
|
2015-02-21 21:14:58 +03:00
|
|
|
* Forth
|
2014-10-10 07:10:15 +04:00
|
|
|
* Go
|
2014-12-24 06:35:48 +03:00
|
|
|
* Haskell
|
2014-03-30 04:01:14 +04:00
|
|
|
* Java
|
2014-04-28 03:36:27 +04:00
|
|
|
* Javascript ([Online Demo](http://kanaka.github.io/mal))
|
2015-01-09 08:25:40 +03:00
|
|
|
* Lua
|
2014-03-30 04:01:14 +04:00
|
|
|
* GNU Make
|
|
|
|
* mal itself
|
2015-02-10 21:15:24 +03:00
|
|
|
* MATLAB
|
2015-02-25 09:27:37 +03:00
|
|
|
* [miniMAL](https://github.com/kanaka/miniMAL)
|
2015-03-04 06:17:43 +03:00
|
|
|
* Nim
|
2015-01-30 20:53:52 +03:00
|
|
|
* OCaml
|
2014-04-24 06:59:50 +04:00
|
|
|
* Perl
|
2014-04-10 07:15:54 +04:00
|
|
|
* PHP
|
|
|
|
* Postscript
|
|
|
|
* Python
|
2014-11-04 08:50:55 +03:00
|
|
|
* R
|
2015-01-03 08:20:00 +03:00
|
|
|
* Racket
|
2014-04-14 00:36:02 +04:00
|
|
|
* Ruby
|
2014-10-25 20:42:07 +04:00
|
|
|
* Rust
|
2014-12-19 08:21:39 +03:00
|
|
|
* Scala
|
2014-11-16 08:15:09 +03:00
|
|
|
* Visual Basic.NET
|
2014-03-30 04:01:14 +04:00
|
|
|
|
|
|
|
|
2015-03-03 02:57:45 +03:00
|
|
|
Mal is a learning tool. See the ([make-a-lisp process
|
2015-03-03 02:59:41 +03:00
|
|
|
guide](process/guide.md)). Each implementation of mal is separated
|
2015-03-03 02:57:45 +03:00
|
|
|
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 implemenation of mal).
|
2014-03-30 04:01:14 +04:00
|
|
|
|
|
|
|
The mal (make a lisp) steps are:
|
|
|
|
|
2015-01-30 06:59:09 +03:00
|
|
|
* [step0_repl](process/guide.md#step0)
|
|
|
|
* [step1_read_print](process/guide.md#step1)
|
|
|
|
* [step2_eval](process/guide.md#step2)
|
|
|
|
* [step3_env](process/guide.md#step3)
|
|
|
|
* [step4_if_fn_do](process/guide.md#step4)
|
|
|
|
* [step5_tco](process/guide.md#step5)
|
|
|
|
* [step6_file](process/guide.md#step6)
|
|
|
|
* [step7_quote](process/guide.md#step7)
|
|
|
|
* [step8_macros](process/guide.md#step8)
|
|
|
|
* [step9_try](process/guide.md#step9)
|
2015-02-28 20:09:54 +03:00
|
|
|
* [stepA_mal](process/guide.md#stepA)
|
2014-03-30 04:01:14 +04:00
|
|
|
|
|
|
|
|
|
|
|
Mal was presented publicly for the first time in a lightning talk at
|
|
|
|
Clojure West 2014 (unfortunately there is no video). See
|
|
|
|
mal/clojurewest2014.mal for the presentation that was given at the
|
|
|
|
conference (yes the presentation is a mal program).
|
2014-03-30 00:17:00 +04:00
|
|
|
|
|
|
|
## Building/running implementations
|
|
|
|
|
2014-03-30 04:01:14 +04:00
|
|
|
### Bash 4
|
2014-03-30 00:17:00 +04:00
|
|
|
|
|
|
|
```
|
|
|
|
cd bash
|
|
|
|
bash stepX_YYY.sh
|
|
|
|
```
|
|
|
|
|
2014-03-30 04:01:14 +04:00
|
|
|
### C
|
2014-03-30 00:17:00 +04:00
|
|
|
|
2014-10-10 08:48:47 +04:00
|
|
|
The C implementation of mal requires the following libraries (lib and
|
|
|
|
header packages): glib, libffi6 and either the libedit or GNU readline library.
|
2014-03-31 01:39:44 +04:00
|
|
|
|
2014-03-30 00:17:00 +04:00
|
|
|
```
|
|
|
|
cd c
|
|
|
|
make
|
|
|
|
./stepX_YYY
|
|
|
|
```
|
|
|
|
|
2014-04-24 08:07:16 +04:00
|
|
|
### C# ###
|
2014-04-10 07:15:54 +04:00
|
|
|
|
|
|
|
The C# implementation of mal has been tested on Linux using the Mono
|
|
|
|
C# compiler (mcs) and the Mono runtime (version 2.10.8.1). Both are
|
|
|
|
required to build and run the C# implementation.
|
|
|
|
|
|
|
|
```
|
|
|
|
cd cs
|
|
|
|
make
|
2014-11-16 08:15:09 +03:00
|
|
|
mono ./stepX_YYY.exe
|
2014-04-10 07:15:54 +04:00
|
|
|
```
|
|
|
|
|
|
|
|
|
2014-03-30 04:01:14 +04:00
|
|
|
### Clojure
|
2014-03-30 00:17:00 +04:00
|
|
|
|
|
|
|
```
|
|
|
|
cd clojure
|
|
|
|
lein with-profile +stepX trampoline run
|
|
|
|
```
|
|
|
|
|
2014-11-09 01:56:36 +03:00
|
|
|
### CoffeeScript
|
|
|
|
|
|
|
|
```
|
|
|
|
sudo npm install -g coffee-script
|
|
|
|
cd coffee
|
|
|
|
coffee ./stepX_YYY
|
|
|
|
```
|
|
|
|
|
2015-02-21 21:14:58 +03:00
|
|
|
### Forth
|
|
|
|
|
|
|
|
```
|
|
|
|
cd forth
|
|
|
|
gforth stepX_YYY.fs
|
|
|
|
```
|
|
|
|
|
2014-10-10 07:10:15 +04:00
|
|
|
### Go
|
|
|
|
|
2015-01-09 07:56:12 +03:00
|
|
|
You Go implementation of mal requires that go is installed on on the
|
|
|
|
path. The implementation has been tested with Go 1.3.1.
|
|
|
|
|
2014-10-10 07:10:15 +04:00
|
|
|
```
|
|
|
|
cd go
|
|
|
|
make
|
|
|
|
./stepX_YYY
|
|
|
|
```
|
|
|
|
|
|
|
|
|
2014-12-24 06:35:48 +03:00
|
|
|
### Haskell
|
|
|
|
|
2014-12-24 09:49:23 +03:00
|
|
|
Install the Haskell compiler (ghc/ghci), the Haskell platform and
|
2014-12-25 09:17:38 +03:00
|
|
|
either the editline package (BSD) or the readline package (GPL). On
|
|
|
|
Ubuntu these packages are: ghc, haskell-platform,
|
|
|
|
libghc-readline-dev/libghc-editline-dev
|
2014-12-24 06:35:48 +03:00
|
|
|
|
|
|
|
```
|
|
|
|
cd haskell
|
|
|
|
make
|
|
|
|
./stepX_YYY
|
|
|
|
```
|
|
|
|
|
|
|
|
|
2014-03-30 04:01:14 +04:00
|
|
|
### Java 1.7
|
2014-03-30 00:17:00 +04:00
|
|
|
|
2014-10-10 08:48:47 +04:00
|
|
|
The Java implementation of mal requires maven2 to build.
|
|
|
|
|
2014-03-30 00:17:00 +04:00
|
|
|
```
|
|
|
|
cd java
|
|
|
|
mvn compile
|
|
|
|
mvn -quiet exec:java -Dexec.mainClass=mal.stepX_YYY
|
|
|
|
# OR
|
|
|
|
mvn -quiet exec:java -Dexec.mainClass=mal.stepX_YYY -Dexec.args="CMDLINE_ARGS"
|
|
|
|
```
|
|
|
|
|
2014-03-30 04:01:14 +04:00
|
|
|
### Javascript/Node
|
2014-03-30 00:17:00 +04:00
|
|
|
|
|
|
|
```
|
|
|
|
cd js
|
2014-03-31 01:39:44 +04:00
|
|
|
npm update
|
2014-03-30 00:17:00 +04:00
|
|
|
node stepX_YYY.js
|
|
|
|
```
|
|
|
|
|
2015-01-09 08:25:40 +03:00
|
|
|
### Lua
|
|
|
|
|
2015-02-10 21:15:24 +03:00
|
|
|
Running the Lua implementation of mal requires lua 5.1 or later,
|
2015-01-09 08:25:40 +03:00
|
|
|
luarocks and the lua-rex-pcre library installed.
|
|
|
|
|
|
|
|
```
|
|
|
|
cd lua
|
|
|
|
make # to build and link linenoise.so
|
|
|
|
./stepX_YYY.lua
|
|
|
|
```
|
|
|
|
|
2014-03-30 04:01:14 +04:00
|
|
|
### Mal
|
2014-03-30 00:17:00 +04:00
|
|
|
|
|
|
|
Running the mal implementation of mal involves running stepA of one of
|
|
|
|
the other implementations and passing the mal step to run as a command
|
2014-03-30 03:37:20 +04:00
|
|
|
line argument.
|
2014-03-30 00:17:00 +04:00
|
|
|
|
|
|
|
```
|
|
|
|
cd IMPL
|
|
|
|
IMPL_STEPA_CMD ../mal/stepX_YYY.mal
|
|
|
|
|
|
|
|
```
|
|
|
|
|
2014-03-30 04:01:14 +04:00
|
|
|
### GNU Make 3.81
|
2014-03-30 00:17:00 +04:00
|
|
|
|
|
|
|
```
|
|
|
|
cd make
|
|
|
|
make -f stepX_YYY.mk
|
|
|
|
```
|
|
|
|
|
2015-03-04 06:17:43 +03:00
|
|
|
### Nim 0.10.3
|
|
|
|
|
|
|
|
Running the Nim implementation of mal requires Nim's current devel branch
|
|
|
|
(0.10.3) or later, and the nre library installed.
|
|
|
|
|
|
|
|
```
|
|
|
|
cd nim
|
|
|
|
make
|
|
|
|
# OR
|
|
|
|
nimble build
|
|
|
|
./stepX_YYY
|
|
|
|
```
|
|
|
|
|
2015-01-30 20:53:52 +03:00
|
|
|
### OCaml 4.01.0
|
|
|
|
|
|
|
|
```
|
|
|
|
cd ocaml
|
|
|
|
make
|
|
|
|
./stepX_YYY
|
|
|
|
```
|
|
|
|
|
2015-02-10 21:15:24 +03:00
|
|
|
### MATLAB
|
|
|
|
|
|
|
|
The MATLAB implementation of mal has been tested with MATLAB version
|
|
|
|
R2014a on Linux. Note that MATLAB is a commercial product. It should
|
|
|
|
be fairly simple to support GNU Octave once it support classdef object
|
|
|
|
syntax.
|
|
|
|
|
|
|
|
```
|
|
|
|
cd matlab
|
|
|
|
./stepX_YYY
|
|
|
|
matlab -nodisplay -nosplash -nodesktop -nojvm -r "stepX_YYY();quit;"
|
|
|
|
# OR with command line arguments
|
|
|
|
matlab -nodisplay -nosplash -nodesktop -nojvm -r "stepX_YYY('arg1','arg2');quit;"
|
|
|
|
```
|
|
|
|
|
2015-02-25 09:27:37 +03:00
|
|
|
### miniMAL
|
|
|
|
|
|
|
|
[miniMAL](https://github.com/kanaka/miniMAL) is small Lisp interpreter
|
|
|
|
implemented in less than 1024 bytes of JavaScript. To run the miniMAL
|
|
|
|
implementation of mal you need to download/install the miniMAL
|
|
|
|
interpreter (which requires Node.js).
|
|
|
|
```
|
|
|
|
cd miniMAL
|
2015-03-02 22:20:55 +03:00
|
|
|
# Download miniMAL and dependencies
|
|
|
|
npm install
|
|
|
|
export PATH=`pwd`/node_modules/minimal-lisp/:$PATH
|
|
|
|
# Now run mal implementation in miniMAL
|
2015-02-25 09:27:37 +03:00
|
|
|
miniMAL ./stepX_YYY
|
|
|
|
```
|
|
|
|
|
2014-04-24 08:07:16 +04:00
|
|
|
### Perl 5.8
|
2014-04-19 22:55:30 +04:00
|
|
|
|
|
|
|
For readline line editing support, install Term::ReadLine::Perl or
|
|
|
|
Term::ReadLine::Gnu from CPAN.
|
|
|
|
|
|
|
|
```
|
|
|
|
cd perl
|
|
|
|
perl stepX_YYY.pl
|
|
|
|
```
|
|
|
|
|
|
|
|
|
2014-03-30 04:01:14 +04:00
|
|
|
### PHP 5.3
|
2014-03-30 00:17:00 +04:00
|
|
|
|
2014-10-10 08:48:47 +04:00
|
|
|
The PHP implementation of mal requires the php command line interface
|
|
|
|
to run.
|
|
|
|
|
2014-03-30 00:17:00 +04:00
|
|
|
```
|
|
|
|
cd php
|
|
|
|
php stepX_YYY.php
|
|
|
|
```
|
|
|
|
|
2014-03-30 04:01:14 +04:00
|
|
|
### Postscript Level 2/3
|
2014-03-30 00:17:00 +04:00
|
|
|
|
2014-10-10 08:48:47 +04:00
|
|
|
The Postscript implementation of mal requires ghostscript to run. It
|
|
|
|
has been tested with ghostscript 9.10.
|
|
|
|
|
2014-03-30 00:17:00 +04:00
|
|
|
```
|
|
|
|
cd ps
|
2014-05-11 01:29:07 +04:00
|
|
|
gs -q -dNODISPLAY -I./ stepX_YYY.ps
|
2014-03-30 00:17:00 +04:00
|
|
|
```
|
|
|
|
|
2014-04-17 07:42:17 +04:00
|
|
|
### Python (2 or 3)
|
2014-03-30 00:17:00 +04:00
|
|
|
|
|
|
|
```
|
|
|
|
cd python
|
|
|
|
python stepX_YYY.py
|
|
|
|
```
|
2014-04-14 00:36:02 +04:00
|
|
|
|
2014-11-04 08:50:55 +03:00
|
|
|
### R
|
|
|
|
|
|
|
|
The R implementation of mal requires R (r-base-core) to run.
|
|
|
|
|
|
|
|
```
|
|
|
|
cd r
|
2015-01-09 08:25:40 +03:00
|
|
|
make libs # to download and build rdyncall
|
2015-01-03 08:20:00 +03:00
|
|
|
Rscript stepX_YYY.r
|
|
|
|
```
|
|
|
|
|
|
|
|
### Racket (5.3)
|
|
|
|
|
|
|
|
The Racket implementation of mal requires the Racket
|
|
|
|
compiler/interpreter to run.
|
|
|
|
|
|
|
|
```
|
|
|
|
cd racket
|
|
|
|
./stepX_YYY.rb
|
2014-11-04 08:50:55 +03:00
|
|
|
```
|
|
|
|
|
2015-02-28 02:36:27 +03:00
|
|
|
### Ruby (1.9+)
|
2014-04-14 00:36:02 +04:00
|
|
|
|
|
|
|
```
|
|
|
|
cd ruby
|
|
|
|
ruby stepX_YYY.rb
|
|
|
|
```
|
2014-04-24 07:59:41 +04:00
|
|
|
|
2014-10-25 20:42:07 +04:00
|
|
|
### Rust (0.13)
|
|
|
|
|
|
|
|
The rust implementation of mal requires the rust compiler and build
|
|
|
|
tool (cargo) to build.
|
|
|
|
|
|
|
|
```
|
|
|
|
cd rust
|
2014-10-28 07:52:41 +03:00
|
|
|
# Need patched pcre lib (should be temporary)
|
|
|
|
git clone https://github.com/kanaka/rust-pcre cadencemarseille-pcre
|
2014-10-25 20:42:07 +04:00
|
|
|
cargo build
|
|
|
|
./target/stepX_YYY
|
|
|
|
```
|
|
|
|
|
2014-12-19 08:21:39 +03:00
|
|
|
### Scala ###
|
|
|
|
|
|
|
|
Install scala and sbt (http://www.scala-sbt.org/0.13/tutorial/Installing-sbt-on-Linux.html):
|
|
|
|
|
|
|
|
```
|
|
|
|
cd scala
|
|
|
|
sbt 'run-main stepX_YYY'
|
|
|
|
# OR
|
|
|
|
sbt compile
|
|
|
|
scala -classpath target/scala*/classes stepX_YYY
|
|
|
|
```
|
|
|
|
|
2014-11-16 08:15:09 +03:00
|
|
|
### Visual Basic.NET ###
|
|
|
|
|
|
|
|
The VB.NET implementation of mal has been tested on Linux using the Mono
|
|
|
|
VB compiler (vbnc) and the Mono runtime (version 2.10.8.1). Both are
|
|
|
|
required to build and run the VB.NET implementation.
|
|
|
|
|
|
|
|
```
|
|
|
|
cd vb
|
|
|
|
make
|
|
|
|
mono ./stepX_YYY.exe
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
2014-04-24 07:59:41 +04:00
|
|
|
## Running tests
|
|
|
|
|
2015-03-03 02:57:45 +03:00
|
|
|
### Functional tests
|
|
|
|
|
|
|
|
The are nearly 500 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
|
|
|
|
uses pexpect to launch 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.
|
2014-04-24 07:59:41 +04:00
|
|
|
|
|
|
|
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 test
|
|
|
|
```
|
|
|
|
|
|
|
|
* To run all tests against a single implementation:
|
|
|
|
|
|
|
|
```
|
|
|
|
make test^IMPL
|
|
|
|
|
|
|
|
# e.g.
|
|
|
|
make test^clojure
|
|
|
|
make test^js
|
|
|
|
```
|
|
|
|
|
|
|
|
* To run tests for a single step against all implementations:
|
|
|
|
|
|
|
|
```
|
|
|
|
make test^stepX
|
|
|
|
|
|
|
|
# e.g.
|
|
|
|
make test^step2
|
|
|
|
make test^step7
|
|
|
|
```
|
|
|
|
|
2015-03-03 02:57:45 +03:00
|
|
|
* To run tests for a specifc step against a single implementation:
|
2014-04-24 07:59:41 +04:00
|
|
|
|
|
|
|
```
|
|
|
|
make test^IMPL^stepX
|
|
|
|
|
|
|
|
# e.g
|
|
|
|
make test^ruby^step3
|
|
|
|
make test^ps^step4
|
|
|
|
```
|
2015-01-09 07:56:12 +03:00
|
|
|
|
2015-03-03 02:57:45 +03:00
|
|
|
### Self-hosted functional tests
|
|
|
|
|
|
|
|
* To run the functional tests in self-hosted mode, you specify `mal`
|
|
|
|
as the test implementation and use the `MAL_IMPL` make variable
|
|
|
|
to change the underlying host language (default is JavaScript):
|
|
|
|
```
|
|
|
|
make MAL_IMPL=IMPL test^mal^step2
|
|
|
|
|
|
|
|
# e.g.
|
|
|
|
make test^mal^step2 # js is default
|
|
|
|
make MAL_IMPL=ruby test^mal^step2
|
|
|
|
make MAL_IMPL=python test^mal^step2
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Performance tests
|
|
|
|
|
|
|
|
* To run performance tests against a single implementation:
|
|
|
|
```
|
|
|
|
make perf^IMPL
|
|
|
|
|
|
|
|
# e.g.
|
|
|
|
make perf^js
|
|
|
|
```
|
|
|
|
|
|
|
|
* To run performance tests against all implementations:
|
|
|
|
```
|
|
|
|
make perf
|
|
|
|
```
|
|
|
|
|
|
|
|
### Generating language statistics
|
|
|
|
|
|
|
|
* To report line and byte stastics for a single implementation:
|
|
|
|
```
|
|
|
|
make stats^IMPL
|
|
|
|
|
|
|
|
# e.g.
|
|
|
|
make stats^js
|
|
|
|
```
|
|
|
|
|
|
|
|
* To report line and bytes stastics for general Lisp code (env, core
|
|
|
|
and stepA):
|
|
|
|
```
|
|
|
|
make stats-lisp^IMPL
|
|
|
|
|
|
|
|
# e.g.
|
|
|
|
make stats-lisp^js
|
|
|
|
```
|
|
|
|
|
|
|
|
|
2015-01-09 07:56:12 +03:00
|
|
|
## License
|
|
|
|
|
|
|
|
Mal (make-a-lisp) is licensed under the MPL 2.0 (Mozilla Public
|
|
|
|
License 2.0). See LICENSE.txt for more details.
|
|
|
|
|