1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
//! # BLisp
//!
//! BLisp is a well typed Lisp like programming language which adopts effect
//! system for no_std environments.
//! BLisp supports higher order RPCs like higher order functions
//! of functional programing languages.
//!
//! This repository provides only a library crate.
//! Please see [blisp-repl](https://github.com/ytakano/blisp-repl) to use BLisp,
//! or [baremetalisp](https://github.com/ytakano/baremetalisp) which is a toy OS.
//!
//! [Homepage](https://ytakano.github.io/blisp/) is here.
//!
//! ## Features
//!
//! - Algebraic data type
//! - Generics
//! - Hindley–Milner based type inference
//! - Effect system to separate side effects from pure functions
//! - Big integer
//! - Supporting no_std environments
//!
//! ## Examples
//!
//! ### Simple Eval
//!
//! ```
//! let code = "
//! (export factorial (n) (Pure (-> (Int) Int))
//! (factorial' n 1))
//!
//! (defun factorial' (n total) (Pure (-> (Int Int) Int))
//! (if (<= n 0)
//! total
//! (factorial' (- n 1) (* n total))))";
//!
//! let exprs = blisp::init(code, vec![]).unwrap();
//! let ctx = blisp::typing(exprs).unwrap();
//! let expr = "(factorial 10)";
//! for result in blisp::eval(expr, &ctx).unwrap() {
//! println!("{}", result.unwrap());
//! }
//! ```
//!
//! ### Foreign Function Interface
//!
//! ```
//! use blisp::{self, embedded};
//! use num_bigint::BigInt;
//!
//! #[embedded]
//! fn add_four_ints(a: BigInt, b: (BigInt, BigInt), c: Option<BigInt>) -> Result<BigInt, String> {
//! let mut result = a + b.0 + b.1;
//! if let Some(n) = c {
//! result += n;
//! }
//!
//! Ok(result)
//! }
//!
//! let code = "
//! (export call_add_four_ints (n)
//! (IO (-> ((Option Int)) (Result Int String)))
//! (add_four_ints 1 [2 3] n))"; // call `add_four_ints` in Rust here.
//!
//! let exprs = blisp::init(code, vec![Box::new(AddFourInts)]).unwrap(); // extern `add_four_ints`
//! let ctx = blisp::typing(exprs).unwrap();
//! let result = blisp::eval("(call_add_four_ints (Some 4))", &ctx).unwrap();
//!
//! let front = result.front().unwrap().as_ref().unwrap();
//! assert_eq!(front, "(Ok 10)");
//! ```
//!
//! ### Expressions
//!
//! ```lisp
//! "Hello, World!" ; string
//! (+ 0x10 0x20) ; 48
//! (+ 0b111 0b101) ; 12
//! (+ 0o777 0o444) ; 803
//! (car '(1 2 3)) ; (Some 1)
//! (cdr '(1 2 3)) ; '(2 3)
//! (map (lambda (x) (* x 2)) '(8 9 10)) ; '(16 18 20)
//! (fold + 0 '(1 2 3 4 5 6 7 8 9)) ; 45
//! (reverse '(1 2 3 4 5 6 7 8 9)) ; '(9 8 7 6 5 4 3 2 1)
//! (filter (lambda (x) (= (% x 2) 0)) '(1 2 3 4 5 6 7 8 9)) ; '(2 4 6 8)
//! ```
#![cfg_attr(not(test), no_std)]
extern crate alloc;
use core::fmt::Display;
use alloc::{
boxed::Box,
collections::linked_list::LinkedList,
format,
string::{String, ToString},
vec::Vec,
};
pub mod coq;
pub mod r#macro;
pub mod parser;
pub mod runtime;
pub mod semantics;
pub use blisp_embedded::embedded;
use r#macro::{process_macros, Macros};
use runtime::FFI;
#[derive(Debug, Clone, Copy)]
pub enum FileType {
Prelude,
User,
Eval,
Extern(u64),
}
/// indicate a position of file
#[derive(Debug, Clone, Copy)]
pub struct Pos {
pub file_id: FileType,
pub line: usize, // line number, 0 origin
pub column: usize, // column number, 0 origin
}
impl Display for Pos {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
write!(f, "{:?}:{}:{}", self.file_id, self.line, self.column)
}
}
/// error message
#[derive(Debug)]
pub struct LispErr {
pub msg: String,
pub pos: Pos,
}
impl LispErr {
fn new(msg: String, pos: Pos) -> LispErr {
LispErr { msg, pos }
}
}
pub struct TypingContext {
exprs: LinkedList<parser::Expr>,
ext_funs: Vec<Box<dyn FFI + Send>>,
macros: Macros,
}
/// initialize BLisp with code
///
/// # Example
///
/// ```
/// let code = "(export factorial (n) (Pure (-> (Int) Int))
/// (if (<= n 0)
/// 1
/// (* n (factorial (- n 1)))))";
///
/// blisp::init(code, vec![]).unwrap();
/// ```
pub fn init(code: &str, ext_funs: Vec<Box<dyn FFI + Send>>) -> Result<TypingContext, LispErr> {
let prelude = include_str!("prelude.lisp");
// let prelude = "";
let mut ps = parser::Parser::new(prelude, FileType::Prelude);
let mut exprs = match ps.parse() {
Ok(e) => e,
Err(e) => {
let msg = format!("Syntax Error: {}", e.msg);
return Err(LispErr::new(msg, e.pos));
}
};
for (i, fun) in ext_funs.iter().enumerate() {
let mut ps = parser::Parser::new(fun.blisp_extern(), FileType::Extern(i as u64));
match ps.parse() {
Ok(mut e) => {
exprs.append(&mut e);
}
Err(e) => {
let msg = format!("Syntax Error: {}", e.msg);
return Err(LispErr::new(msg, e.pos));
}
}
}
let mut ps = parser::Parser::new(code, FileType::User);
match ps.parse() {
Ok(mut e) => {
exprs.append(&mut e);
let macros = match process_macros(&mut exprs) {
Ok(macros) => macros,
Err(e) => {
let msg = format!("Macro Error: {}", e.msg);
return Err(LispErr::new(msg, e.pos));
}
};
Ok(TypingContext {
exprs,
ext_funs,
macros,
})
}
Err(e) => {
let msg = format!("Syntax Error: {}", e.msg);
Err(LispErr::new(msg, e.pos))
}
}
}
/// perform type checking and inference
///
/// # Example
///
/// ```
/// let code = "(export factorial (n) (Pure (-> (Int) Int))
/// (if (<= n 0)
/// 1
/// (* n (factorial (- n 1)))))";
///
/// let exprs = blisp::init(code, vec![]).unwrap();
/// blisp::typing(exprs).unwrap();
/// ```
pub fn typing(exprs: TypingContext) -> Result<semantics::Context, LispErr> {
match semantics::exprs2context(exprs) {
Ok(c) => Ok(c),
Err(e) => {
let msg = format!("Typing Error: {}", e.msg);
Err(LispErr::new(msg, e.pos))
}
}
}
/// evaluate an expression
///
/// # Example
///
/// ```
/// let code = "(export factorial (n) (Pure (-> (Int) Int))
/// (if (<= n 0)
/// 1
/// (* n (factorial (- n 1)))))";
///
/// let exprs = blisp::init(code, vec![]).unwrap();
/// let ctx = blisp::typing(exprs).unwrap();
/// let expr = "(factorial 30)";
/// for result in blisp::eval(expr, &ctx).unwrap() {
/// println!("{}", result.unwrap());
/// }
/// ```
pub fn eval(
code: &str,
ctx: &semantics::Context,
) -> Result<LinkedList<Result<String, String>>, LispErr> {
runtime::eval(code, ctx)
}
pub fn transpile(ctx: &semantics::Context) -> String {
let mut s = "".to_string();
for (_, d) in ctx.data.iter() {
s = format!("{}{}\n", s, coq::to_coq_data(d));
}
for (_, f) in ctx.funs.iter() {
s = format!("{}{}\n", s, coq::to_coq_func(f));
}
format!("{}\n\n{}", coq::import(), s)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_macro() {
let expr = "
(macro add
((add $e1 $e2) (+ $e1 $e2))
((add $e1 $e2 $e3 ...) (+ $e1 (add $e2 $e3 ...))))
(macro minus
((_ $e1 $e2) (- $e1 $e2))
((_ $e1 $e2 $e3 ...) (- $e1 (minus $e2 $e3 ...))))
(macro tuple_to_list
((_ []) ((lambda (x) x) '()))
((_ [$e ...]) ((lambda (x) x) '($e ...))))
(macro none ((_ _) ([])))
(tuple_to_list [])
(tuple_to_list [1 2 3])
(add 1 2 3 4 5)
(defun test_add () (Pure (-> () Int))
(add 1 2 3 4 (minus 5 6 7) 8))
(add 1)
(none 123)
";
let typing_context = init(expr, vec![]).unwrap();
for expr in typing_context.exprs.iter() {
println!("{expr}");
}
}
fn eval_result(code: &str, ctx: &semantics::Context) {
for r in eval(code, ctx).unwrap() {
println!("{} -> {}", code, r.unwrap());
}
}
#[test]
fn ops() {
let exprs = init("", vec![]).unwrap();
let ctx = typing(exprs).unwrap();
eval_result("(neq (Some \"Hello\") 10)", &ctx);
eval_result("(chars \"Hello, World!\")", &ctx);
eval_result("(str '(`H` `e` `l` `l` `o`))", &ctx);
eval_result("`\\``", &ctx);
eval_result("(= `h` `h`)", &ctx);
eval_result("(<< 8 4)", &ctx);
eval_result("(>> 128 4)", &ctx);
eval_result("\"Hello, World!\"", &ctx);
eval_result("(= \"Hello, World!\" \"Hello, World!\")", &ctx);
eval_result("(= (Some 1) (Some 2))", &ctx);
eval_result("(< (Some 1) (Some 2))", &ctx);
eval_result("(> (Some 1) (Some 2))", &ctx);
eval_result("(= \"Hello\" \"Hel\")", &ctx);
eval_result("(eq \"Hello\" 10)", &ctx);
eval_result("(lt \"Hello\" 10)", &ctx);
eval_result("(lt 5 10)", &ctx);
eval_result("(+ 0x10 0x20)", &ctx);
eval_result("(+ 0b111 0b101)", &ctx);
eval_result("(+ 0o777 0o444)", &ctx);
eval_result("(+ 10 20)", &ctx);
eval_result("(pow 10 20)", &ctx);
eval_result("(band 1 0)", &ctx);
eval_result("(band 1 1)", &ctx);
eval_result("(bor 1 0)", &ctx);
eval_result("(bor 1 1)", &ctx);
eval_result("(bxor 1 0)", &ctx);
eval_result("(bxor 1 1)", &ctx);
eval_result("(sqrt 16)", &ctx);
eval_result("(sqrt -1)", &ctx);
}
#[test]
fn lambda() {
let expr = "(export lambda-test (f)
(Pure (-> ((Pure (-> (Int Int) Int))) Int))
(f 10 20))
";
let exprs = init(expr, vec![]).unwrap();
let ctx = typing(exprs).unwrap();
let e = "(lambda-test (lambda (x y) (* x y)))";
eval_result(e, &ctx);
let e = "(lambda-test +)";
eval_result(e, &ctx);
}
#[test]
fn list() {
let expr = "
(export head (x) (Pure (-> ('(Int)) (Option Int)))
(match x
((Cons n _) (Some n))
(_ None)))
(export tail (x) (Pure (-> ('(Int)) (Option Int)))
; match expression
(match x
(Nil None)
((Cons n Nil) (Some n))
((Cons _ l) (tail l))))
";
let exprs = init(expr, vec![]).unwrap();
let ctx = typing(exprs).unwrap();
let e = "(head '(30 40 50))";
eval_result(e, &ctx);
let e = "(tail '(30 40 50))";
eval_result(e, &ctx);
}
#[test]
fn tuple() {
let expr = "(export first (x) (Pure (-> ([Int Bool]) Int))
(match x
([n _] n)))
";
let exprs = init(expr, vec![]).unwrap();
let ctx = typing(exprs).unwrap();
let e = "(first [10 false])";
eval_result(e, &ctx);
}
#[test]
fn prelude() {
let expr = "
(export factorial (n) (Pure (-> (Int) Int))
(factorial' n 1))
(defun factorial' (n total) (Pure (-> (Int Int) Int))
(if (<= n 0)
total
(factorial' (- n 1) (* n total))))
";
let exprs = init(expr, vec![]).unwrap();
let ctx = typing(exprs).unwrap();
let e = "(Some 10)";
eval_result(e, &ctx);
let e = "(car '(1 2 3))";
eval_result(e, &ctx);
let e = "(cdr '(1 2 3))";
eval_result(e, &ctx);
let e = "(map (lambda (x) (* x 2)) '(8 9 10))";
eval_result(e, &ctx);
let e = "(fold + 0 '(1 2 3 4 5 6 7 8 9))";
eval_result(e, &ctx);
let e = "(reverse '(1 2 3 4 5 6 7 8 9))";
eval_result(e, &ctx);
let e = "(filter (lambda (x) (= (% x 2) 0)) '(1 2 3 4 5 6 7 8 9))";
eval_result(e, &ctx);
let e = "(factorial 2000)";
eval_result(e, &ctx);
}
#[test]
fn callback() {
let expr = "
(export callback (x y z) (IO (-> (Int Int Int) (Option Int)))
(call-rust x y z))";
let exprs = init(expr, vec![]).unwrap();
let mut ctx = typing(exprs).unwrap();
use num_bigint::BigInt;
use std::boxed::Box;
let fun = |x: &BigInt, y: &BigInt, z: &BigInt| {
let n = x * y * z;
println!("n = {}", n);
Some(n)
};
ctx.set_callback(Box::new(fun));
let e = "(callback 100 2000 30000)";
eval_result(e, &ctx);
}
#[test]
fn do_transpile() {
let expr = "
(defun snoc (l y)
(Pure (-> (
'(t) t)
'(t)))
(match l
(nil (Cons y nil))
((Cons h b) (Cons h (snoc b y)))))
(defun rev (l)
(Pure (-> (
'(t))
'(t)))
(match l
(nil nil)
((Cons h t) (snoc (rev t) h))))
";
let exprs = init(expr, vec![]).unwrap();
let ctx = typing(exprs).unwrap();
println!("{}", transpile(&ctx));
}
#[test]
fn test_multibyte() {
let expr = "あ";
let _exprs = init(expr, vec![]).unwrap();
let expr = "";
let exprs = init(expr, vec![]).unwrap();
let ctx = typing(exprs).unwrap();
let e = "\"あ\"";
let r = eval(e, &ctx).unwrap();
println!("{r:?}");
let e = "`あ`";
let r = eval(e, &ctx).unwrap();
println!("{r:?}");
}
}