tree_sitter_test/lib.rs
1//! This crate provides TS corpus test 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 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/*/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`][LanguageFn] for this grammar.
45///
46/// [LanguageFn]: https://docs.rs/tree-sitter-language/*/tree_sitter_language/struct.LanguageFn.html
47pub const LANGUAGE: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_test) };
48
49/// The content of the [`node-types.json`][] file for this grammar.
50///
51/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
52pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
53
54/// The syntax highlight queries for this grammar.
55pub const HIGHLIGHTS_QUERY: &str = include_str!("../../queries/test/highlights.scm");
56
57/// The language injection queries for this grammar.
58pub const INJECTIONS_QUERY: &str = include_str!("../../queries/test/injections.scm");
59
60#[cfg(test)]
61mod tests {
62 #[test]
63 fn test_can_load_grammar() {
64 let mut parser = tree_sitter::Parser::new();
65 parser
66 .set_language(&super::LANGUAGE.into())
67 .expect("Error loading Test parser");
68 }
69}