pest. 精美的解析器

pest 是一个通用的解析器，用 Rust 编写，注重可访问性、正确性和性能。它使用解析表达式文法（或 PEG）作为输入，类似于正则表达式，但提供了解析复杂语言所需的增强表达能力。

入门

开始使用 pest 解析的推荐方法是阅读官方的 书籍。

其他有用的资源

• 在 docs.rs 上的 API 参考文档
• 在我们的 fiddle 上尝试文法并分享它们
• 在 GitHub 讨论区 上找到之前常见的问题或提问
• 在 Gitter 或 Discord 上留下反馈、提问或问候我们

示例

以下是一个用于列表中所有标识符都不以数字开头的字母数字标识符的文法示例

alpha = { 'a'..'z' | 'A'..'Z' }
digit = { '0'..'9' }

ident = { !digit ~ (alpha | digit)+ }

ident_list = _{ ident ~ (" " ~ ident)* }
          // ^
          // ident_list rule is silent which means it produces no tokens

文法保存在单独的 .pest 文件中，这些文件永远不会与过程性代码混合。这结果是一个总是最新的语言形式化，易于阅读和维护。

有意义的错误报告

基于文法定义，解析器还包含自动错误报告。对于上面的示例，输入 "123" 将导致

thread 'main' panicked at ' --> 1:1
  |
1 | 123
  | ^---
  |
  = unexpected digit', src/main.rs:12

而 "ab *" 将导致

thread 'main' panicked at ' --> 1:1
  |
1 | ab *
  |    ^---
  |
  = expected ident', src/main.rs:12

这些错误信息可以从它们的默认 Display 实现中获取，例如 panic!("{}", parser_result.unwrap_err()) 或 println!("{}", e)。

对API

该语法可用于自动推导一个 Parser 实现。解析返回嵌套标记对的迭代器

use pest_derive::Parser;
use pest::Parser;

#[derive(Parser)]
#[grammar = "ident.pest"]
struct IdentParser;

fn main() {
    let pairs = IdentParser::parse(Rule::ident_list, "a1 b2").unwrap_or_else(|e| panic!("{}", e));

    // Because ident_list is silent, the iterator will contain idents
    for pair in pairs {
        // A pair is a combination of the rule which matched and a span of input
        println!("Rule:    {:?}", pair.as_rule());
        println!("Span:    {:?}", pair.as_span());
        println!("Text:    {}", pair.as_str());

        // A pair can be converted to an iterator of the tokens which make it up:
        for inner_pair in pair.into_inner() {
            match inner_pair.as_rule() {
                Rule::alpha => println!("Letter:  {}", inner_pair.as_str()),
                Rule::digit => println!("Digit:   {}", inner_pair.as_str()),
                _ => unreachable!()
            };
        }
    }
}

这将产生以下输出

Rule:    ident
Span:    Span { start: 0, end: 2 }
Text:    a1
Letter:  a
Digit:   1
Rule:    ident
Span:    Span { start: 3, end: 5 }
Text:    b2
Letter:  b
Digit:   2

在单个文件中定义多个解析器

当前的自动 Parser 推导将生成 Rule 枚举，如果尝试定义多个这样的结构体来自动推导 Parser，则会出现名称冲突。一种可能的解决方案是将每个解析器结构体放入一个单独的命名空间

mod a {
    #[derive(Parser)]
    #[grammar = "a.pest"]
    pub struct ParserA;
}
mod b {
    #[derive(Parser)]
    #[grammar = "b.pest"]
    pub struct ParserB;
}

其他功能

• 优先级提升
• 输入处理
• 自定义错误
• 在稳定的Rust上运行

使用pest的项目

您可以在awesome-pest存储库中找到更多项目和生态系统工具。

• pest_meta（自举）
• AshPaper
• 大脑
• 蝉
• comrak
• elastic-rs
• graphql-parser
• handlebars-rust
• hexdino
• Huia
• insta
• jql
• json5-rs
• mt940
• Myoxine
• py_literal
• rouler
• RuSh
• rs_pbrt
• stache
• tera
• ui_gen
• ukhasnet-parser
• ZoKrates
• 向量
• 自动纠正
• yaml-peg
• 量子比特
• caith（一个骰子投掷包）
• 旋律
• json5-nodes
• prisma

最低支持的Rust版本（MSRV）

此库应始终与默认功能在 Rust 1.61.0 上编译。

无标准库支持

pest 和 pest_derive 包可以构建不带Rust标准库并针对嵌入式环境。要这样做，您需要禁用其默认功能。在您的 Cargo.toml 中，您可以指定如下

[dependencies]
# ...
pest = { version = "2", default-features = false }
pest_derive = { version = "2", default-features = false }

如果您想在pest存储库的工作空间中构建这些包，您可以将 --no-default-features 标志传递给 cargo 并使用 --package（-p）标志指定这些包。例如

$ cargo build --target thumbv7em-none-eabihf --no-default-features -p pest
$ cargo bootstrap
$ cargo build --target thumbv7em-none-eabihf --no-default-features -p pest_derive

特别感谢

特别感谢Marius Minea教授的指导和所有pest贡献者，其中一些是我的朋友。