tree_sitter_freemarker/lib.rs
1//! This crate provides FreeMarker 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//! let mut parser = tree_sitter::Parser::new();
10//! let language = tree_sitter_freemarker::LANGUAGE;
11//! parser
12//! .set_language(&language.into())
13//! .expect("Error loading FreeMarker parser");
14//! let tree = parser.parse(code, None).unwrap();
15//! assert!(!tree.root_node().has_error());
16//! ```
17//!
18//! [`Parser`]: https://docs.rs/tree-sitter/0.26.3/tree_sitter/struct.Parser.html
19//! [tree-sitter]: https://tree-sitter.github.io/
20
21use tree_sitter_language::LanguageFn;
22
23unsafe extern "C" {
24 unsafe fn tree_sitter_freemarker() -> *const ();
25}
26
27/// The tree-sitter [`LanguageFn`] for this grammar.
28pub const LANGUAGE: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_freemarker) };
29
30/// The content of the [`node-types.json`] file for this grammar.
31///
32/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers/6-static-node-types
33pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
34
35#[cfg(with_highlights_query)]
36/// The syntax highlighting query for this grammar.
37pub const HIGHLIGHTS_QUERY: &str = include_str!("../../queries/highlights.scm");
38
39#[cfg(test)]
40mod tests {
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 FreeMarker parser");
47 }
48
49 #[cfg(with_highlights_query)]
50 #[test]
51 fn highlights_query_is_valid() {
52 let language = super::LANGUAGE.into();
53 tree_sitter::Query::new(&language, super::HIGHLIGHTS_QUERY)
54 .expect("highlights query should be valid");
55 }
56}