12 个版本
0.4.2 | 2024年4月19日 |
---|---|
0.4.1 | 2023年11月5日 |
0.3.4 | 2023年6月11日 |
0.3.2 | 2023年3月27日 |
0.1.2 | 2022年8月23日 |
#975 in 开发工具
7,405 个月下载量
在 4 个 软件包中使用(直接使用 2 个)
59KB
1K SLoC
Rust Sitter
Rust Sitter 通过利用 Tree Sitter 解析器生成器,使您能够在 Rust 中轻松创建高效的解析器。使用 Rust Sitter,您可以使用 Rust 代码中的注释来定义整个语法,并让宏为您生成解析器和类型安全的绑定!
安装
首先,将 Rust/Tree Sitter 添加到您的 Cargo.toml
[dependencies]
rust-sitter = "0.4.2"
[build-dependencies]
rust-sitter-tool = "0.4.2"
注意:默认情况下,Rust Sitter 使用 Tree Sitter 的一个分支,并使用纯 Rust 运行时来支持 wasm32-unknown-unknown
。要使用标准 C 运行时,请禁用默认功能并启用 tree-sitter-standard
功能
第一步是配置您的 build.rs
以编译和链接生成的 Tree Sitter 解析器
use std::path::PathBuf;
fn main() {
println!("cargo:rerun-if-changed=src");
rust_sitter_tool::build_parsers(&PathBuf::from("src/main.rs"));
}
定义语法
现在我们已经将 Rust Sitter 添加到我们的项目中,我们可以定义我们的语法。Rust Sitter 语法是在注释的 Rust 模块中定义的。首先,我们定义将包含我们语法的模块
#[rust_sitter::grammar("arithmetic")]
mod grammar {
}
然后,在模块内部,我们可以定义单个 AST 节点。在这个简单的示例中,我们将定义一个可以用于数学表达式的表达式。请注意,我们将此类型注释为 #[rust_sitter::language]
,以表示它是根 AST 类型。
#[rust_sitter::language]
pub enum Expr {
Number(u32),
Add(Box<Expr>, Box<Expr>)
}
现在我们已经定义了类型,我们必须注释枚举变体来描述如何在解析的文本中识别它们。首先,我们可以使用 rust_sitter::leaf
应用正则表达式来匹配对应于数字的数字,并定义一个将结果字符串解析为 u32
的转换。
Number(
#[rust_sitter::leaf(pattern = r"\d+", transform = |v| v.parse().unwrap())]
u32,
)
对于Add
变体,事情要复杂一些。首先,我们需要添加一个额外的字段,对应于两个子表达式之间的+
。这可以通过text
参数实现,该参数属于rust_sitter::leaf
,该参数指示解析器匹配特定的字符串。因为我们正在解析到()
,所以不需要提供转换。
Add(
Box<Expr>,
#[rust_sitter::leaf(text = "+")] (),
Box<Expr>,
)
然而,如果我们尝试编译这个语法,我们会看到一个错误,这是因为表达式如1 + 2 + 3
存在冲突的解析树,这些表达式可以解析为(1 + 2) + 3
或1 + (2 + 3)
。我们想要前者,所以我们可以添加进一步的注释,指定我们想要这个规则具有左结合性。
#[rust_sitter::prec_left(1)]
Add(
Box<Expr>,
#[rust_sitter::leaf(text = "+")] (),
Box<Expr>,
)
全部加起来,我们的语法看起来是这样的
#[rust_sitter::grammar("arithmetic")]
mod grammar {
#[rust_sitter::language]
pub enum Expr {
Number(
#[rust_sitter::leaf(pattern = r"\d+", transform = |v| v.parse().unwrap())]
u32,
),
#[rust_sitter::prec_left(1)]
Add(
Box<Expr>,
#[rust_sitter::leaf(text = "+")] (),
Box<Expr>,
)
}
}
然后我们可以使用这个语法解析文本
dbg!(grammar::parse("1+2+3"));
/*
grammar::parse("1+2+3") = Ok(Add(
Add(
Number(
1,
),
(),
Number(
2,
),
),
(),
Number(
3,
),
))
*/
类型注解
Rust Sitter支持多种注解,可以应用于语法中的类型和字段。这些注解可以用来控制解析器的行为以及如何构建结果AST。
#[rust_sitter::language]
这个注解标记了解析的入口点,并确定从解析返回的AST类型。语法中只能标记一个类型作为入口点。
#[rust_sitter::language]
struct Code {
...
}
#[rust_sitter::extra]
这个注解标记一个节点为额外节点,在解析过程中可以安全地跳过。这对于处理空白符/换行符/注释很有用。
#[rust_sitter::extra]
struct Whitespace {
#[rust_sitter::leaf(pattern = r"\s")]
_whitespace: (),
}
字段注解
#[rust_sitter::leaf(...)]
可以使用#[rust_sitter::leaf(...)]
注解来定义AST中的叶子节点。这个注解接受一些参数,用于控制解析器的行为
pattern
参数接受一个正则表达式,用于匹配叶子节点的文本。这个参数是必需的。text
参数接受一个字符串,用于匹配叶子节点的文本。这个参数与pattern
参数是互斥的。transform
参数接受一个函数,用于将匹配的文本(一个&str
)转换为所需的类型。如果目标类型是()
,则此参数是可选的。
leaf
可以应用于结构体/枚举变体中的字段(如上所示),也可以直接应用于没有字段的类型
#[rust_sitter::leaf(text = "9")]
struct BigDigit;
enum SmallDigit {
#[rust_sitter::leaf(text = "0")]
Zero,
#[rust_sitter::leaf(text = "1")]
One,
}
#[rust_sitter::prec(...)]
/ #[rust_sitter::prec_left(...)]
/ #[rust_sitter::prec_right(...)]
此注释可用于定义非左/右结合的运算符。此注释接受一个参数,即运算符的优先级(越高越紧密绑定)。
#[rust_sitter::跳过(...)]
此注释可用于定义不对应输入字符串中任何内容的字段,例如一些元数据。此注释接受一个参数,即在运行时填充该字段应使用的值。
#[rust_sitter::单词]
此注释将字段标记为 Tree Sitter 关键字,在处理涉及关键字的错误时很有用。语法中只有一个字段可以标记为关键字。
特殊类型
Rust Sitter 有几个特殊类型,可用于定义更复杂的语法。
Vec<T>
要解析重复的结构,您可以使用 Vec<T>
来解析 T
的列表。请注意,Vec<T>
类型 不能 被另一个 Vec
包装(如果需要,请创建额外的结构体)。可以将两个特殊属性应用于 Vec
字段以控制解析行为。
#[rust_sitter::delimited(...)]
属性可用于指定列表元素之间的分隔符,并接受与匿名字段相同格式的参数。例如,我们可以定义一个解析逗号分隔表达式列表的语法
pub struct CommaSeparatedExprs {
#[rust_sitter::delimited(
#[rust_sitter::leaf(text = ",")]
()
)]
numbers: Vec<Expr>,
}
#[rust_sitter::repeat(...)]
属性可用于指定解析器的额外配置。目前,只有一个可用的参数:non_empty
,它接受一个布尔值,指定列表是否必须包含至少一个元素。例如,我们可以定义一个解析非空逗号分隔数字列表的语法
pub struct CommaSeparatedExprs {
#[rust_sitter::repeat(non_empty = true)]
#[rust_sitter::delimited(
#[rust_sitter::leaf(text = ",")]
()
)]
numbers: Vec<Expr>,
}
Option<T>
要解析可选结构,您可以使用一个 Option<T>
来解析单个 T
或无内容。和 Vec
一样,Option<T>
类型 不能 被另一个 Option
包裹(如果需要,请创建额外的结构)。例如,我们可以使前一个示例中的列表元素变为可选的,以便可以解析像 1,,2
这样的字符串。
pub struct CommaSeparatedExprs {
#[rust_sitter::repeat(non_empty = true)]
#[rust_sitter::delimited(
#[rust_sitter::leaf(text = ",")]
()
)]
numbers: Vec<Option<Expr>>,
}
rust_sitter::跨距<T>
当使用 Rust Sitter 为诊断工具提供动力时,访问标记与解析节点对应的文本部分的跨距可能会有所帮助。为此,您可以使用 Spanned<T>
类型,它捕获了底层的解析 T
以及对应子串的开始(包含)和结束(不包含)的索引对。Spanned
类型可以在任何地方使用,并且不会影响解析逻辑。例如,我们可以在前一个示例中捕获表达式的跨距。
pub struct CommaSeparatedExprs {
#[rust_sitter::repeat(non_empty = true)]
#[rust_sitter::delimited(
#[rust_sitter::leaf(text = ",")]
()
)]
numbers: Vec<Option<Spanned<Expr>>>,
}
Box<T>
在解析时,会在内部类型周围自动构造 Box,但 Rust Sitter 不会做更多的事情。
依赖关系
~1–16MB
~211K SLoC