tree_sitter_grep_tree_sitter_rust/
lib.rs

1// -*- coding: utf-8 -*-
2// ------------------------------------------------------------------------------------------------
3// Copyright © 2021, tree-sitter-rust authors.
4// See the LICENSE file in this repo for license details.
5// ------------------------------------------------------------------------------------------------
6
7//! This crate provides a Rust grammar for the [tree-sitter][] parsing library.
8//!
9//! Typically, you will use the [language][language func] function to add this grammar to a
10//! tree-sitter [Parser][], and then use the parser to parse some code:
11//!
12//! ```
13//! use tree_sitter::Parser;
14//!
15//! let code = r#"
16//!     fn double(x: i32) -> i32 {
17//!         x * 2
18//!     }
19//! "#;
20//! let mut parser = Parser::new();
21//! parser.set_language(tree_sitter_rust::language()).expect("Error loading Rust grammar");
22//! let parsed = parser.parse(code, None);
23//! # let parsed = parsed.unwrap();
24//! # let root = parsed.root_node();
25//! # assert!(!root.has_error());
26//! ```
27//!
28//! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
29//! [language func]: fn.language.html
30//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
31//! [tree-sitter]: https://tree-sitter.github.io/
32
33use tree_sitter::Language;
34
35extern "C" {
36    fn tree_sitter_rust() -> Language;
37}
38
39/// Returns the tree-sitter [Language][] for this grammar.
40///
41/// [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
42pub fn language() -> Language {
43    unsafe { tree_sitter_rust() }
44}
45
46/// The source of the Rust tree-sitter grammar description.
47pub const GRAMMAR: &str = include_str!("../../grammar.js");
48
49/// The syntax highlighting query for this language.
50pub const HIGHLIGHT_QUERY: &str = include_str!("../../queries/highlights.scm");
51
52/// The symbol tagging query for this language.
53pub const TAGGING_QUERY: &str = include_str!("../../queries/tags.scm");
54
55/// The content of the [`node-types.json`][] file for this grammar.
56///
57/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
58pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
59
60#[cfg(test)]
61mod tests {
62    #[test]
63    fn can_load_grammar() {
64        let mut parser = tree_sitter::Parser::new();
65        parser
66            .set_language(super::language())
67            .expect("Error loading Rust grammar");
68    }
69}