3 个版本

0.20.14 2023 年 10 月 5 日
0.20.13 2023 年 10 月 5 日
0.20.12 2023 年 9 月 13 日

#1203 in 解析器实现


jellybean-tree-sitter-hig… 中使用

MIT 许可证

525KB
13K SLoC

C 10K SLoC // 0.0% comments Rust 3K SLoC // 0.0% comments

Rust Tree-sitter

crates.io badge

Rust 对 Tree-sitter 解析库的绑定。

基本用法

首先创建一个解析器

use tree_sitter::{Parser, Language};

let mut parser = Parser::new();

cc 仓库添加到您的 Cargo.toml 中的 [build-dependencies]

[build-dependencies]
cc="*"

然后添加一个语言作为依赖项

[dependencies]
tree-sitter = "0.20.10"
tree-sitter-rust = "0.20.3"

然后,将这些语言分配给解析器。

parser.set_language(tree_sitter_rust::language()).expect("Error loading Rust grammar");

现在您可以解析源代码

let source_code = "fn test() {}";
let tree = parser.parse(source_code, None).unwrap();
let root_node = tree.root_node();

assert_eq!(root_node.kind(), "source_file");
assert_eq!(root_node.start_position().column, 0);
assert_eq!(root_node.end_position().column, 12);

编辑

一旦您有了语法树,当源代码更改时,您可以更新它。传递先前编辑的树可以让 parse 运行得更快

let new_source_code = "fn test(a: u32) {}"

tree.edit(InputEdit {
  start_byte: 8,
  old_end_byte: 8,
  new_end_byte: 14,
  start_position: Point::new(0, 8),
  old_end_position: Point::new(0, 8),
  new_end_position: Point::new(0, 14),
});

let new_tree = parser.parse(new_source_code, Some(&tree));

文本输入

要解析的源代码可以提供为字符串、切片、向量或返回切片的函数。文本可以编码为 UTF8 或 UTF16

// Store some source code in an array of lines.
let lines = &[
    "pub fn foo() {",
    "  1",
    "}",
];

// Parse the source code using a custom callback. The callback is called
// with both a byte offset and a row/column offset.
let tree = parser.parse_with(&mut |_byte: u32, position: Point| -> &[u8] {
    let row = position.row as usize;
    let column = position.column as usize;
    if row < lines.len() {
        if column < lines[row].as_bytes().len() {
            &lines[row].as_bytes()[column..]
        } else {
            "\n".as_bytes()
        }
    } else {
        &[]
    }
}, None).unwrap();

assert_eq!(
  tree.root_node().to_sexp(),
  "(source_file (function_item (visibility_modifier) (identifier) (parameters) (block (number_literal))))"
);

依赖项

~2.2–3.5MB
~62K SLoC