Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zesterer/chumsky

Write expressive, high-performance parsers with ease.
https://github.com/zesterer/chumsky

context-free-grammar errors lexing parser parser-combinators parsing peg recursive-descent-parser

Last synced: 5 days ago
JSON representation

Write expressive, high-performance parsers with ease.

Awesome Lists containing this project

README 

        
# Chumsky



[![crates.io](https://img.shields.io/crates/v/chumsky.svg)](https://crates.io/crates/chumsky)

[![crates.io](https://docs.rs/chumsky/badge.svg)](https://docs.rs/chumsky)

[![License](https://img.shields.io/crates/l/chumsky.svg)](https://github.com/zesterer/chumsky)

[![actions-badge](https://github.com/zesterer/chumsky/workflows/Rust/badge.svg?branch=main)](https://github.com/zesterer/chumsky/actions)



A parser library for humans with powerful error recovery.





    Example usage with my own language, Tao




*Note: Error diagnostic rendering is performed by [Ariadne](https://github.com/zesterer/ariadne)*



## Contents



- [Features](#features)

- [Example Brainfuck Parser](#example-brainfuck-parser)

- [Tutorial](#tutorial)

- [*What* is a parser combinator?](#what-is-a-parser-combinator)

- [*Why* use parser combinators?](#why-use-parser-combinators)

- [Classification](#classification)

- [Error Recovery](#error-recovery)

- [Performance](#performance)

- [Planned Features](#planned-features)

- [Philosophy](#philosophy)

- [Notes](#notes)

- [License](#license)



## Features



- Lots of combinators!

- Generic across input, output, error, and span types

- Powerful error recovery strategies

- Inline mapping to your AST

- Text-specific parsers for both `u8`s and `char`s

- Recursive parsers

- Backtracking is fully supported, allowing the parsing of all known context-free grammars

- Parsing of nesting inputs, allowing you to move delimiter parsing to the lexical stage (as Rust does!)

- Built-in parser debugging



## Example [Brainfuck](https://en.wikipedia.org/wiki/Brainfuck) Parser



See [`examples/brainfuck.rs`] for the full interpreter (`cargo run --example brainfuck -- examples/sample.bf`).



```rust

use chumsky::prelude::*;



#[derive(Clone)]

enum Instr {

    Left, Right,

    Incr, Decr,

    Read, Write,

    Loop(Vec),

}



fn parser<'a>() -> impl Parser<'a, &'a str, Vec> {

    recursive(|bf| choice((

        just('<').to(Instr::Left),

        just('>').to(Instr::Right),

        just('+').to(Instr::Incr),

        just('-').to(Instr::Decr),

        just(',').to(Instr::Read),

        just('.').to(Instr::Write),

        bf.delimited_by(just('['), just(']')).map(Instr::Loop),

    ))

        .repeated()

        .collect())

}

```



Other examples include:



- A [JSON parser] (`cargo run --example json -- examples/sample.json`)

- An [interpreter for a simple Rust-y language][examples/nano_rust.rs]

  (`cargo run --example nano_rust -- examples/sample.nrs`)



## Tutorial



Chumsky has a [tutorial] that teaches you how to write a parser and interpreter for a simple dynamic language

with unary and binary operators, operator precedence, functions, let declarations, and calls.



## *What* is a parser combinator?



Parser combinators are a technique for implementing parsers by defining them in terms of other parsers. The resulting

parsers use a [recursive descent](https://en.wikipedia.org/wiki/Recursive_descent_parser) strategy to transform a stream

of tokens into an output. Using parser combinators to define parsers is roughly analogous to using Rust's

[`Iterator`](https://doc.rust-lang.org/std/iter/trait.Iterator.html) trait to define iterative algorithms: the

type-driven API of `Iterator` makes it more difficult to make mistakes and easier to encode complicated iteration logic

than if one were to write the same code by hand. The same is true of parser combinators.



## *Why* use parser combinators?



Writing parsers with good error recovery is conceptually difficult and time-consuming. It requires understanding the

intricacies of the recursive descent algorithm, and then implementing recovery strategies on top of it. If you're

developing a programming language, you'll almost certainly change your mind about syntax in the process, leading to some

slow and painful parser refactoring. Parser combinators solve both problems by providing an ergonomic API that allows

for rapidly iterating upon a syntax.



Parser combinators are also a great fit for domain-specific languages for which an existing parser does not exist.

Writing a reliable, fault-tolerant parser for such situations can go from being a multi-day task to a half-hour task

with the help of a decent parser combinator library.



## Classification



Chumsky's parsers are [recursive descent](https://en.wikipedia.org/wiki/Recursive_descent_parser) parsers and are

capable of parsing [parsing expression grammars (PEGs)](https://en.wikipedia.org/wiki/Parsing_expression_grammar), which

includes all known context-free languages. It is theoretically possible to extend Chumsky further to accept limited

context-sensitive grammars too, although this is rarely required.



## Error Recovery



Chumsky has support for error recovery, meaning that it can encounter a syntax error, report the error, and then

attempt to recover itself into a state in which it can continue parsing so that multiple errors can be produced at once

and a partial [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree) can still be generated from the input for future

compilation stages to consume.



However, there is no silver bullet strategy for error recovery. By definition, if the input to a parser is invalid then

the parser can only make educated guesses as to the meaning of the input. Different recovery strategies will work better

for different languages, and for different patterns within those languages.



Chumsky provides a variety of recovery strategies (each implementing the `Strategy` trait), but it's important to

understand that all of



- which you apply

- where you apply them

- what order you apply them



will greatly affect the quality of the errors that Chumsky is able to produce, along with the extent to which it is able

to recover a useful AST. Where possible, you should attempt more 'specific' recovery strategies first rather than those

that mindlessly skip large swathes of the input.



It is recommended that you experiment with applying different strategies in different situations and at different levels

of the parser to find a configuration that you are happy with. If none of the provided error recovery strategies cover

the specific pattern you wish to catch, you can even create your own by digging into Chumsky's internals and

implementing your own strategies! If you come up with a useful strategy, feel free to open a PR against the

[main repository](https://github.com/zesterer/chumsky/)!



## Performance



Chumsky focuses on high-quality errors and ergonomics over performance. That said, it's important that Chumsky can keep

up with the rest of your compiler! Unfortunately, it's *extremely* difficult to come up with sensible benchmarks given

that exactly how Chumsky performs depends entirely on what you are parsing, how you structure your parser, which

patterns the parser attempts to match first, how complex your error type is, what is involved in constructing your AST,

etc. All that said, here are some numbers from the

[JSON benchmark](https://github.com/zesterer/chumsky/blob/main/benches/json.rs) included in the repository running on

my Ryzen 7 3700x.



```ignore

test chumsky ... bench:   4,782,390 ns/iter (+/- 997,208)

test pom     ... bench:  12,793,490 ns/iter (+/- 1,954,583)

```



I've included results from [`pom`](https://github.com/J-F-Liu/pom), another parser combinator crate with a similar

design, as a point of reference. The sample file being parsed is broadly representative of typical JSON data and has

3,018 lines. This translates to a little over 630,000 lines of JSON per second.



Clearly, this is a little slower than a well-optimised hand-written parser: but that's okay! Chumsky's goal is to be

*fast enough*. If you've written enough code in your language that parsing performance even starts to be a problem,

you've already committed enough time and resources to your language that hand-writing a parser is the best choice going!



## Planned Features



- An optimised 'happy path' parser mode that skips error recovery & error generation

- An even faster 'validation' parser mode, guaranteed to not allocate, that doesn't generate outputs but just verifies

  the validity of an input



## Philosophy



Chumsky should:



- Be easy to use, even if you don't understand exactly what the parser is doing under the hood

- Be type-driven, pushing users away from anti-patterns at compile-time

- Be a mature, 'batteries-included' solution for context-free parsing by default. If you need to implement either

  `Parser` or `Strategy` by hand, that's a problem that needs fixing

- Be 'fast enough', but no faster (i.e: when there is a tradeoff between error quality and performance, Chumsky will

  always take the former option)

- Be modular and extensible, allowing users to implement their own parsers, recovery strategies, error types, spans, and

  be generic over both input tokens and the output AST



## Notes



My apologies to Noam for choosing such an absurd name.



## License



Chumsky is licensed under the MIT license (see `LICENSE` in the main repository).



[`examples/brainfuck.rs`]: https://github.com/zesterer/chumsky/blob/main/examples/brainfuck.rs

[JSON parser]: https://github.com/zesterer/chumsky/blob/main/examples/json.rs

[examples/nano_rust.rs]: https://github.com/zesterer/chumsky/blob/main/examples/nano_rust.rs

[tutorial]: https://github.com/zesterer/chumsky/blob/main/tutorial.md