search

wolfgangj / bone-lisp

The Bone Lisp programming language
Other
321 stars 21 forks source link

readme

Bone Lisp

The Bone Lisp programming language

Note: This software seems to work pretty well, but it's neither full-featured nor battle-tested, so it should be considered beta-quality. Furthermore, it will probably stay there forever as I have moved on to work on other projects. If you are interested in researching the approach of combining explicit regions and immutability, don't hesitate to contact me if you want to know what I would do differently today compared to what I did here.

(defsub (len xs)
  "Calculate the length of the list `xs`."
  (with loop (lambda (remain n)
               (if (nil? remain)
                   n
                 (loop (cdr remain) (++ n))))
    (loop xs 0)))

What?

Bone is an interpreter for a lexically scoped Lisp-1. It is based on immutable values and does tail-call elimination. The special feature that distinguishes it from other Lisps is the semi-automatic memory management: It uses explicit regions instead of garbage collection.

It is inspired by Pico Lisp, R5RS Scheme, Forth, Common Lisp and Ruby.

It is written for 64 bit systems and runs on GNU/Linux, though it should also work on other Unices (with minimal porting).

Note: If you were looking for the great Bones Scheme Compiler, that's a different project.

Why?

Garbage collection is not a solved problem. It becomes extremely complex if you want to support multi-threading, avoid pause-times and handle large heaps well. But doing manual memory management is time-consuming for the programmer - and usually also error-prone. Explicit regions are both very simple and very fast, but how far can one get with them? I want to find out, so I am developing this interpreter.

A language like Bone Lisp could maybe become useful for soft real-time systems (e.g. as a scripting language for games), some kinds of multi-threaded servers and maybe even embedded systems with enough memory.

Status

Build Status

What it does

What it does not

Getting started

To make embedding as easy as possible, the whole interpreter is in a single C file. Optional modules have their own C files (currently only boneposix.c for the POSIX bindings). The main function is in main.c; it just initializes everything and calls the REPL. You can compile it all with make.

Quick Intro

Bone Lisp doesn't try to be an overly innovative Lisp (like e.g. Clojure), nor does it try hard to be compatible with tradition. I hope you'll like the few things Bone does different than traditional Lisps.

One important piece of terminology is changed: Keeping with the times, we reserve the term "function" for pure functions without side-effects. Since Bone Lisp allows some side-effects (like I/O), we mostly speak about using subroutines in our code. Usually, we abbreviate "subroutine" as "sub", like it is done in modern BASIC dialects.

To the usual syntactic sugar (like 'x for quoting) we only add a shortcut for subs with a single expression in the body:

| a b c (foo)   ; => (lambda (a b c) (foo))

We use this only for one-liners, though.

Rest arguments work like they do in Scheme:

(lambda args foo)
(lambda (a b c . args) foo)

Booleans and the empty list work almost like they do in Scheme:

The names of predicates end with a question mark (e.g. nil?). Subs which may return a useful value or #f (false) also follow this convention (eg. assoc?). This helps to prevent forgetting about the possbility of returning #f.

Most names in the library are taken from Scheme and Common Lisp. Often, we provide several names for the same thing (like Ruby does). For example, len, length and size are the same. See core.bn for docstrings describing the builtins. (We also have gendoc.bn, which extracts the docstrings from a source file and generates a markdown file from them. But this needs improvement.)

A subroutine can be defined with defsub; note that the docstring is required!

(defsub (sum xs)
  "Add all numbers in `xs`."
  (apply + xs))

(sum '(1 2 3))  ; => 6

For local helper subs you can use mysub, which does not require a docstring and introduces a binding that may be overwritten later. Note that the environment is hyperstatic (as in Forth): If you redefine something, the subs previously defined will continue to use the old definition.

Quasiquoting works as usual, so you can define macros (with defmac or mymac):

(defmac (when expr . body)
  "Evaluate all of `body` if `expr` is true."
  `(if ,expr (do ,@body)))

The primitive form that introduces a (single) new binding - which may be recusive as in Schemes letrec - is with:

(with loop | xs (if (nil? xs)
                    0
                  (++ (loop (cdr xs))))
  (loop '(a b c d)))
;; => 4

let is simply defined as a macro that expands to nested withs. Therefore it works like a combination of traditional let* and letrec.

Dynamic scope can be used by defining a variable first with defvar. Then you can set it for the dynamic extent of some expressions with with-var:

(defvar *depth* 0)
(with-var *depth* (++ *depth*)
  (list *depth*))
;; => (1)

*depth*
;; => 0

The use of regions is available via:

(in-reg expr1 expr2 ...)

The given exprs will be evaluated with objects allocated in a new region. The return value (of the last expr) will be copied to the previous region. Finally, the new region will be freed.

A source file should declare which version of Bone Lisp it was written for:

(version 0 4)  ; for v0.4.x

There is no real module system, but you can load files with:

(use foo)

This will load foo.bn. Each file will be loaded only once. Recursive loading will be detected and reported as an error.

There's much more, but currently you'll have to look into the source code. If you don't understand something, feel free to ask.

License

This is Free Software distributed under the terms of the ISC license. (A very simple non-copyleft license.) See the file LICENSE for details.

Who?

It is being developed by Wolfgang Jaehrling (wolfgang at conseptizer dot org)

Links

Bone Lisp is influenced by:

Somewhat related Free Software projects: