tree_sitter_cpp/
lib.rs

1//! This crate provides C++ language support for the [tree-sitter] parsing library.
2//!
3//! Typically, you will use the [`LANGUAGE`] constant to add this language to a
4//! tree-sitter [`Parser`], and then use the parser to parse some code:
5//!
6//! ```
7//! let code = "#include <iostream>\n\nint main() {\n    std::cout << \"Hello\\n\";\n}\n";
8//! let mut parser = tree_sitter::Parser::new();
9//! let language = tree_sitter_cpp::LANGUAGE;
10//! parser
11//!     .set_language(&language.into())
12//!     .expect("Error loading C++ parser");
13//! let tree = parser.parse(code, None).unwrap();
14//! assert!(!tree.root_node().has_error());
15//! ```
16//!
17//! [`Parser`]: https://docs.rs/willbooster-tree-sitter/1/tree_sitter/struct.Parser.html
18//! [tree-sitter]: https://tree-sitter.github.io/
19
20use tree_sitter_language::LanguageFn;
21
22unsafe extern "C" {
23    fn tree_sitter_cpp() -> *const ();
24}
25
26/// The tree-sitter [`LanguageFn`] for this grammar.
27pub const LANGUAGE: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_cpp) };
28
29/// The content of the [`node-types.json`] file for this grammar.
30///
31/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers/6-static-node-types
32pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
33
34/// The query for extracting symbol definitions from C++ source.
35pub const TAGS_QUERY: &str = include_str!("../../queries/tags.scm");
36
37#[cfg(test)]
38mod tests {
39    use tree_sitter::StreamingIterator;
40
41    #[test]
42    fn test_can_load_grammar() {
43        let mut parser = tree_sitter::Parser::new();
44        parser
45            .set_language(&super::LANGUAGE.into())
46            .expect("Error loading C++ parser");
47    }
48
49    #[test]
50    fn extracts_symbol_definitions() {
51        let source = "struct Example { void method() {} };\nvoid function() {}\n";
52        let language = super::LANGUAGE.into();
53        let mut parser = tree_sitter::Parser::new();
54        parser.set_language(&language).unwrap();
55        let tree = parser.parse(source, None).unwrap();
56        assert!(!tree.root_node().has_error());
57
58        let query = tree_sitter::Query::new(&language, super::TAGS_QUERY).unwrap();
59        let name_index = query.capture_index_for_name("name").unwrap();
60        let mut cursor = tree_sitter::QueryCursor::new();
61        let mut captures = cursor.captures(&query, tree.root_node(), source.as_bytes());
62        let mut names = Vec::new();
63        while let Some((query_match, capture_index)) = captures.next() {
64            let capture = query_match.captures()[*capture_index];
65            if capture.index == name_index {
66                names.push(capture.node.utf8_text(source.as_bytes()).unwrap());
67            }
68        }
69        assert_eq!(names, ["Example", "method", "function"]);
70    }
71}
tree_sitter_cpp/lib.rs

tree_sitter_cpp/
lib.rs
