Awesome

pilisp

• Introduction
• Language
• Documentation
• Installation

Introduction

Pilisp aims to be a small LISP interpreter for the 1.5 version of the language described here.

Features

• Lambdas: (lambda ({args}) {body}) syntax allowed
• Garbage Collector: mark and sweep garbage collector
• Bytecode virtual machine interpreter: some simple lambdas can be compiled to a bytecode faster version
• Memory dump builtin: (md) prints the structure of the allocated memory

Performance

These are the performances compared to other Lisp interpreters: CLisp, Yoctolisp (similar performances to Femtolisp) and SBCL.

Language

The language accepted by the interpreter is inspired to the Common Lisp, but keeps the homoiconicity feature of the original definition of the LISP 1.5: data and instructions are kept together in the same data structure, the cons cell.

Builtin functions

• Lisp basic functions
  • car
  • cdr
  • cons
  • atom
  • eq
  • quote
  • cond
• Arithmetic
  • +
  • -
  • *
  • /
• Logic
  • or
  • and
  • not
• Comparison
  • >
  • >=
  • <
  • <=
  • integerp
  • symbolp
• Lists operations
  • list
  • reverse
  • member
  • nth
  • concatenate
  • append
  • length
  • subseq
• Common Lisp inherited functions
  • set
  • write
  • load
  • bye
• Macros
  • setq
  • defun
  • let
  • dotimes
  • map
  • time
  • defmacro
• Pilisp special functions
  • md: prints the memory
  • env: prints the global env
  • cg: calls the garbage collector

Bytecode instruction set

You can optionally produce one mid-representation for some expression. The bytecode will run faster than normal LISP code. To achieve this goal Pilisp interpreter adds these instructions to the language:

• plc: PiLisp Compiler. Called on one sexpression tries to produce the corresponding bytecode of one quoted expression.

  (plc '(car '(a))) => (ASM "!$B" (A) CAR)
  

• asm: c-like notation for assembly. This instruction can be interpreted. The first arg is the machine code. Refer here for the list of codes. The other arguments are the parameters.

  (ASM "!$B" (A) CAR)
  

  has to be read as: load a const -> that const is (A) -> apply a builtin function -> That function is car -> That function has 1 parameter -> Put the result on the top of the stack . The result of a computation is always the top of the stack.

• lasm: lambda-asm. Represents a asm computation that accepts input parameters: it is a compiled lambda. The first parameter represents the number of parameters. The rest of the parameters are the same as asm.

  ((LASM 1 "@A!$C" 1 +) 2)
  

  The last is an example of the 1+ function compiled and applied to the number 2

• compile: tries to compile one function. If this is possible the new definition will be substituted to the old one.

  (defun id (x) x)
  (compile id)
  

  will produce a new and faster identity function.

Instruction set

Documentation

Full code documentation can be found on github pages. It is automatically generated using Doxygen, with Bootstrap CSS (using this guide). The code documentation is generated every push with Travis CI, so it should be always up to date.

Installation

Prerequisites

• Meson (version 0.44 or newer)
• Python (version 3.5 or newer)
• Ninja (version 1.5 or newer)

Installing with Meson

These commands should run on any OS. To build the ninja.build file run. The -Dc_args will add optimizations.

meson build -Dc_args=-Og

To build the executable in the build directory run

ninja -C build

To install pilisp run with root permissions

ninja install -C build

To run tests use

ninja test -C build

By default Meson won't allow debugging: if you want to run a debbuger you have to write:

meson build -Db_coverage=true

Run with Valngrid:

meson test --wrap=valgrind 'testname'