[email protected]
  [email protected]
    [email protected] "256"
  [email protected] " "
  [email protected]
    [email protected] "/"
  [email protected] " "
  [email protected]
    [email protected] "2"
  [email protected] " "
  [email protected]
    [email protected] "+"
  [email protected] " "
  [email protected]
    [email protected]
      [email protected] "64"
    [email protected] " "
    [email protected]
      [email protected] "*"
    [email protected] " "
    [email protected]
      [email protected] "2"

自己尝试一下

cargo run --example calculator -- "256 / 2 + 64 * 2"

syntree 和 rowan 之间的主要区别在于我们不将原始源存储在语法树中。相反，库的使用者负责在必要时提供它。就像调用 print_with_source 一样。

通过 Builder 提供 API 来构建语法树，它实现了流式构建方法。内部，构建器被表示为一个连续的内存块。一旦构建了树，就可以通过 Tree 类型查询树的架构。

请注意，syntree::tree! 只是一个辅助宏，用于简化构建示例树。它完全对应于在 open、close 和 token 上对 Builder 进行指定的调用。

use syntree::{Builder, Span};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum Syntax {
    Number,
    Lit,
    Nested,
}

use Syntax::*;

let mut tree = Builder::new();

tree.open(Number)?;
tree.token(Lit, 1)?;
tree.token(Lit, 3)?;

tree.open(Nested)?;
tree.token(Lit, 1)?;
tree.close()?;

tree.close()?;

let tree = tree.build()?;

let expected = syntree::tree! {
    Number => {
        (Lit, 1),
        (Lit, 3),
        Nested => {
            (Lit, 1)
        }
    }
};

assert_eq!(tree, expected);

let number = tree.first().ok_or("missing number")?;
assert_eq!(number.span(), Span::new(0, 5));

注意，对于 Number 的结果 Span 如何对应其 Lit 子元素的完整范围。包括 Nested 内的元素。

树通常是通过解析输入来构建的。这个库鼓励使用手写的 Pratt 解析器。请参阅 计算器示例 以获取完整用例。

紧凑或空范围

默认情况下，范围使用基于 u32 的索引和基于 usize 的指针，这可以通过使用 Builder::new_with 构造函数从其默认值更改

use syntree::{Builder, Span, Tree};

let mut tree = Builder::<_, usize, u16>::new_with();

tree.open("root")?;
tree.open("child")?;
tree.token("token", 100)?;
tree.close()?;
tree.open("child2")?;
tree.close()?;
tree.close()?;

let tree = tree.build()?;

let expected: Tree<_, usize, u32> = syntree::tree_with! {
    "root" => {
        "child" => { ("token", 100) },
        "child2" => {}
    }
};

assert_eq!(tree, expected);
assert_eq!(tree.span(), Span::new(0, 100));

结合 Empty，这允许在不使用范围的情况下构建树，如果您想这样做的话

use syntree::{Builder, Empty, Tree};

let mut tree = Builder::<_, Empty, u32>::new_with();

tree.open("root")?;
tree.open("child")?;
tree.token("token", Empty)?;
tree.close()?;
tree.open("child2")?;
tree.close()?;
tree.close()?;

let tree = tree.build()?;

let expected: Tree<_, Empty, usize> = syntree::tree_with! {
    "root" => {
        "child" => { "token" },
        "child2" => {}
    }
};

assert_eq!(tree, expected);
assert!(tree.span().is_empty());

为什么不使用 rowan 呢？

我喜欢 rowan。这就是我开始这个项目的原因。但这个 crate 仍然存在，因为它存在一些哲学上的差异，这些差异在 rowan 中很难直接调和。

rowan 只支持添加可以以某种方式强制转换为 repr(u16) 的类型的语法树的一部分。我认为这个决定是合理的，但它阻止了您设计包含除了源引用以外的任何内容的树，而不必执行某种形式的间接查找。这是将 Rune 移动到无损语法树所需的东西（参见 Kind::Str 变体的表示）。

#[derive(Debug, Clone, Copy)]
enum Syntax {
    /// A string referenced somewhere else using the provided ID.
    Synthetic(usize),
    /// A literal string from the source.
    Lit,
    /// Whitespace.
    Whitespace,
    /// A lexer error.
    Error,
}

cargo run --example synthetic_strings -- "Hello $world"

Tree:
[email protected] "Hello"
[email protected] " "
Synthetic(0)@6..12 "$world"
Eval:
0 = "Hello"
1 = "Earth"