Rust调用tree-sitter解析C语言

一、Rust 调用 tree-sitter 解析 C 语言代码

要使用 Rust 调用 tree-sitter 解析 C 语言代码，你可以遵循以下详细步骤：

1. 设置 Rust 项目

首先，你需要初始化一个新的 Rust 项目。如果你还没有安装 Rust，可以按照 Rust 官方指南 进行安装。

然后，使用 cargo 创建一个新的项目：

cargo new tree_sitter_c_example
cd tree_sitter_c_example

2. 添加 tree-sitter 依赖

在 Cargo.toml 文件中，添加 tree-sitter 和 tree-sitter-c 依赖，这些是解析 C 语言所需的库。

[dependencies]
tree-sitter = "0.23"
tree-sitter-c = "0.23"

3. 编写 Rust 代码

在 src/main.rs 文件中，编写代码来加载 tree-sitter 解析器并解析 C 语言代码。

use tree_sitter::{Parser, Language};

// 引入 tree-sitter-c 的解析器
extern "C" { fn tree_sitter_c() -> Language; }

fn main() {
    // Initialize the parser
    let mut parser = Parser::new();

    // Set the language to C
    let language = unsafe { tree_sitter_c() };
    parser.set_language(&language).expect("Error loading C grammar"); // Borrow here

    // Code to parse
    let source_code = r#"
    int main() {
        printf("Hello, World!");
        return 0;
    }
    "#;

    // Parse the source code
    let tree = parser.parse(source_code, None).unwrap();

    // Get the root node of the syntax tree
    let root_node = tree.root_node();

    // Output the parsed result
    println!("Parsed C code:\n{:?}", root_node);

    // Traverse the syntax tree and print each node
    traverse_tree(root_node, source_code);
}


fn traverse_tree(node: tree_sitter::Node, source_code: &str) {
    let kind = node.kind();
    let start = node.start_position();
    let end = node.end_position();
    let text = &source_code[node.byte_range()];

    println!("Node type: {}, range: {:?} - {:?}, code: \n{}", kind, start, end, text);

    // 递归遍历子节点
    for child in node.children(&mut node.walk()) {
        traverse_tree(child, source_code);
    }
}

4. 运行程序

现在你可以运行程序来解析 C 语言代码：

cargo run

这段程序会解析一个简单的 C 语言代码片段并输出语法树的根节点信息，同时递归遍历并打印语法树中的所有节点。

5. 编译出错

运行程序后，你可能会看到类似以下的输出：

  = note: /home/dev2/tree_sitter_c_example/target/debug/deps/tree_sitter_c_example-4b36636fa00ecd52.0gq5053ay0orez5jtdb9nuh83.rcgu.o: In function tree_sitter_c_example::main':          /home/dev2/tree_sitter_c_example/src/main.rs:11: undefined reference to tree_sitter_c'          collect2: error: ld returned 1 exit status

  = note: some extern functions couldn't be found; some native libraries may need to be installed or have their path specified
  = note: use the -l flag to specify native libraries to link
  = note: use the cargo:rustc-link-lib directive to specify the native libraries to link with Cargo (see https://doc.rust-lang.org/cargo/reference/build-scripts.html#rustc-link-lib)

错误信息表明，在链接过程中，Rust 代码未能找到 tree_sitter_c 函数。这种情况通常发生在原生库（在这种情况下是 tree-sitter-c 解析器）没有正确链接的时候。以下是如何解决这个问题的步骤：

二、解决步骤

1. 添加 tree-sitter 构建依赖

tree-sitter-c 是一个原生库，因此你需要显式地在构建中包含 C 解析器库。在项目根目录中添加一个 build.rs 文件来处理 C 库的链接。

在项目根目录创建 build.rs 文件：

touch build.rs

在 build.rs 中添加以下代码：

fn main() {
    println!("cargo:rustc-link-lib=static=tree-sitter-c");
}

2. 添加 tree-sitter-c 源代码

你需要在项目中包含 tree-sitter-c 的源代码。你可以通过克隆 tree-sitter-c 仓库作为一个 Git 子模块，或者直接将其添加到项目中。

克隆 tree-sitter-c：

git submodule add https://github.com/tree-sitter/tree-sitter-c.git

3. 修改 build.rs 以编译 tree-sitter-c 库

修改 build.rs 文件以编译 tree-sitter-c 库：

extern crate cc;

fn main() {
    cc::Build::new()
        .include("tree-sitter-c/src")
        .file("tree-sitter-c/src/parser.c")
        .compile("tree-sitter-c");
    println!("cargo:rerun-if-changed=tree-sitter-c/src/parser.c");
}

这段代码使用 cc crate 来编译 tree-sitter-c 的 C 源代码，并将编译后的库链接到 Rust 项目中。

4. 修改 Cargo.toml

确保在 Cargo.toml 文件中有必要的依赖项：

[build-dependencies]
cc = "1.0"

5. 重新构建项目

最后，重新构建并运行项目：

cargo build
cargo run

这样做应该可以通过编译和链接 C 解析器来解决链接错误。