tree_sitter_test/lib.rs
1//! This crate provides TS corpus test 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 = r#"
8//! ==================
9//! Return statements
10//! ==================
11//!
12//! func x() int {
13//! return 1;
14//! }
15//!
16//! ---
17//!
18//! (source_file
19//! (function_definition
20//! (identifier)
21//! (parameter_list)
22//! (primitive_type)
23//! (block
24//! (return_statement (number)))))
25//! "#;
26//! let mut parser = tree_sitter::Parser::new();
27//! let language = tree_sitter_test::LANGUAGE;
28//! parser
29//! .set_language(&language.into())
30//! .expect("Error loading TS corpus test parser");
31//! let tree = parser.parse(code, None).unwrap();
32//! assert!(!tree.root_node().has_error());
33//! ```
34//!
35//! [`Parser`]: https://docs.rs/tree-sitter/0.25.6/tree_sitter/struct.Parser.html
36//! [tree-sitter]: https://tree-sitter.github.io/
37
38use tree_sitter_language::LanguageFn;
39
40extern "C" {
41 fn tree_sitter_test() -> *const ();
42}
43
44/// The tree-sitter [`LanguageFn`] for this grammar.
45pub const LANGUAGE: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_test) };
46
47/// The content of the [`node-types.json`] file for this grammar.
48///
49/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers/6-static-node-types
50pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
51
52/// The syntax highlight queries for this grammar.
53pub const HIGHLIGHTS_QUERY: &str = include_str!("../../queries/test/highlights.scm");
54
55/// The language injection queries for this grammar.
56pub const INJECTIONS_QUERY: &str = include_str!("../../queries/test/injections.scm");
57
58#[cfg(test)]
59mod tests {
60 #[test]
61 fn test_can_load_grammar() {
62 let mut parser = tree_sitter::Parser::new();
63 parser
64 .set_language(&super::LANGUAGE.into())
65 .expect("Error loading TS corpus test parser");
66 }
67}