47 个版本

0.22.6 2024 年 5 月 5 日
0.22.2 2024 年 3 月 17 日
0.20.10 2023 年 4 月 5 日
0.20.9 2022 年 9 月 2 日
0.3.1 2018 年 7 月 20 日

#1 in 编程语言

Download history 55405/week @ 2024-05-03 58599/week @ 2024-05-10 55346/week @ 2024-05-17 60469/week @ 2024-05-24 61965/week @ 2024-05-31 57276/week @ 2024-06-07 56999/week @ 2024-06-14 62730/week @ 2024-06-21 55733/week @ 2024-06-28 52108/week @ 2024-07-05 51444/week @ 2024-07-12 51595/week @ 2024-07-19 52877/week @ 2024-07-26 51123/week @ 2024-08-02 50550/week @ 2024-08-09 51903/week @ 2024-08-16

216,364 每月下载量
514 个包中(401 个直接使用) 使用

MIT 许可证

600KB
15K SLoC

C 11K SLoC // 0.1% comments Rust 3.5K SLoC // 0.0% comments

Rust Tree-sitter

crates.io badge

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

基本用法

首先创建一个解析器

use tree_sitter::{InputEdit, Language, Parser, Point};

let mut parser = Parser::new();

cc 包添加到你的 Cargo.toml 中的 [build-dependencies]

[build-dependencies]
cc="*"

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

[dependencies]
tree-sitter = "0.22"
tree-sitter-rust = "0.21"

为了使用语言,你需要将它们分配给解析器。

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

现在你可以解析源代码了

let source_code = "fn test() {}";
let mut 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: usize, 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 {
            b"\n"
        }
    } else {
        &[]
    }
}, None).unwrap();

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

依赖关系

~2–15MB
~196K SLoC