quoth

Crates.ioquoth
lib.rsquoth
version0.1.7
sourcesrc
created_at2023-08-21 18:44:01.84735
updated_at2024-06-21 06:29:13.632578
descriptionQuoth is a scannerless (no-lexing), developer-friendly parsing library for implementing DSLs and syntax parsers in Rust
homepagehttps://github.com/sam0x17/quoth
repositoryhttps://github.com/sam0x17/quoth
max_upload_size
id950354
size600,120
Sam Johnson (sam0x17)

documentation

README

Quoth

quoth raven

Crates.io docs.rs Build Status MIT License

Quoth is a scannerless parsing library (meaning there is no lexing/tokenization step) specifically designed for implementing languages and DSLs (domain specific languages) in Rust. It is based on the admittedly dtolnayian idea from syn that everything should implement the same Parse trait, however quoth takes this idea further to the point where lexing is no longer necessary, and what you are left with is something akin to "Object Oriented Parsing" where it is quite easy to compose, combine, parse, and even "unparse" Parsables in a myriad of ways.

Parsing

In quoth, everything implements Parsable, which brings with it a large set of requirements (and thus features) that are at best conventions in other parsing ecosystems. Some core features of quoth include:

  • anything that can be parsed with quoth can also be "unparsed" i.e. converted back to a string
  • because there is no tokenization step, the unmodified Span source text for any Parsable is always available and is cheap/free to access at any time during parsing
  • Span itself is very lightweight and is just a reference-counted string slice into a Source
  • because of this, ParseStream is also incredibly lightweight and provides normally expensive operations like forking virtually for free
  • in quoth, you can peek by Parsable type, but you can also peek by value, and even by regex
  • branching and ambiguity are much easier to deal with in quoth because forking is cheap and encouraged. This is a double-edged sword because it means you can efficiently parse ambiguous things that are normally inefficient to parse and hard to reason about, but now it is much easier to introduce ambiguity into your underlying grammar.

Peeking

Quoth also takes special care to make anything that is Parsable also automatically Peekable, making it even easier to implement Parsable. Furthermore, Peekable itself allows peeking on both a type-basis, and on a specific value basis. For example, you could peek "is an Ident next?" or "is an Ident with this specific value next?".

More information and docs will be coming in the next release

Commit count: 114

cargo fmt