https://github.com/shsms/tulisp
An embeddable lisp interpreter written in Rust.
https://github.com/shsms/tulisp
lisp rust
Last synced: 2 months ago
JSON representation
An embeddable lisp interpreter written in Rust.
- Host: GitHub
- URL: https://github.com/shsms/tulisp
- Owner: shsms
- License: gpl-3.0
- Created: 2022-10-02T00:44:53.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-23T23:02:40.000Z (9 months ago)
- Last Synced: 2025-02-27T01:47:32.357Z (3 months ago)
- Topics: lisp, rust
- Language: Rust
- Homepage:
- Size: 896 KB
- Stars: 19
- Watchers: 1
- Forks: 4
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# _Tulisp_
[
](https://docs.rs/tulisp/latest/tulisp/)
[
](https://crates.io/crates/tulisp)
Tulisp is a Lisp interpreter that can be embedded into Rust programs. The
syntax tries to closely match that of Emacs Lisp. It was primarily designed to
be a configuration language, but it also works well as a general purpose
embedded scripting language.
One of the many benefits of using the Emacs Lisp syntax is that we can reuse its
documentation for the builtin functions and macros. And for people who are
already familiar with Emacs Lisp, there's no need to learn an extra language.
## Getting started
Tulisp requires `rustc` version 1.70 or higher.
It is very easy to get started. Here's an example:
```rust
use tulisp::{TulispContext, tulisp_fn, Error};
fn main() -> Result<(), Error> {
// Create a new Tulisp execution context.
let mut ctx = TulispContext::new();
// Add a function called `add_nums` to `ctx`.
#[tulisp_fn(add_func = "ctx")]
fn add_nums(num1: i64, num2: i64) -> i64 {
num1 + num2
}
// Write a lisp program that calls `add_nums`
let program = "(add_nums 10 20)";
// Evaluate the program, and save the result.
let sum: i64 = ctx.eval_string(program)?.try_into()?;
assert_eq!(sum, 30);
Ok(())
}
```
## Features
- `defun`s, `defmacro`s and `lambda`s
- `intern` to find/create symbols dynamically
- Backquote/Unquote forms (for example `` `(answer . ,(+ 2 3)) ``)
- Threading macros (`thread-first` and `thread-last`)
- Methods for reading from alists and plists
- Lexical scopes and lexical binding
- Tailcall Optimization
- Proc macros for exposing rust functions to tulisp
- Decl macros for
[creating lists](https://docs.rs/tulisp/latest/tulisp/macro.list.html)
and
[destructuring lists](https://docs.rs/tulisp/latest/tulisp/macro.destruct_bind.html)
quickly.
- Easy to use [interpreter](https://docs.rs/tulisp/latest/tulisp/struct.TulispContext.html) and [object](https://docs.rs/tulisp/latest/tulisp/struct.TulispObject.html)s
- Backtraces for errors
## Performance
Tulisp has a light-weight tree-walking interpreter with very low startup times and sufficient speed for many config/simulation needs.
## Builtin functions
A list of currently available builtin functions can be found [here](https://docs.rs/tulisp/latest/tulisp/builtin).
## Projects using Tulisp
- [slippy](https://github.com/shsms/slippy) - a configuration tool for the Sway window manager.
- [microsim](https://github.com/shsms/microsim) - a microgrid simulator.