lispexp 0.1.1

A pure-Rust reader (lexer + parser) for S-expression syntax across many Lisp dialects
Documentation 
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

//! lispexp — a pure-Rust reader (lexer + parser) for S-expression syntax across
//! many Lisp dialects.
//!
//! The crate is deliberately reader-only: it does not evaluate, expand macros,
//! or interpret the numeric tower. See `docs/design.md` and `docs/adr/` for the
//! design and the decisions behind it.
//!
//! Two public layers sit over the same [`Options`] (ADR-0015):
//!
//! - [`lex`] / [`Lexer`] — a linear token stream that tiles the input, for
//!   consumers like a parinfer backend that need lexical state, not a tree.
//! - [`parse`] — builds the [`Parsed`] datum tree on top of the lexer.
//!
//! # Example
//!
//! ```
//! use lispexp::{parse, DatumKind, Options};
//!
//! let parsed = parse("(define (square x) (* x x))", &Options::scheme());
//! assert!(parsed.errors.is_empty());
//! let DatumKind::List { items, .. } = &parsed.data[0].kind else { unreachable!() };
//! assert_eq!(items[0].kind, DatumKind::Symbol("define"));
//! ```
#![forbid(unsafe_code)]
#![warn(missing_docs)]

pub mod annotate;
mod datum;
mod error;
mod lexer;
mod options;
mod reader;
mod span;
mod token;

pub use datum::{Datum, DatumKind, Delim, Notation, Prefix};
pub use error::ParseError;
pub use lexer::{lex, Lexer};
pub use options::{BlockComment, CharSyntax, DelimRole, Dialect, HashParen, Options};
pub use reader::{parse, read_all, Parsed};
pub use span::Span;
pub use token::{Token, TokenKind};