tree_sitter_hcl/lib.rs
1//! This crate provides HCL 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//! example "test" {
9//! foo = "bar"
10//! }
11//! "#;
12//! let mut parser = tree_sitter::Parser::new();
13//! let language = tree_sitter_hcl::LANGUAGE;
14//! parser
15//! .set_language(&language.into())
16//! .expect("Error loading HCL parser");
17//! let tree = parser.parse(code, None).unwrap();
18//! assert!(!tree.root_node().has_error());
19//! ```
20//!
21//! [`Parser`]: https://docs.rs/tree-sitter/0.25.3/tree_sitter/struct.Parser.html
22//! [tree-sitter]: https://tree-sitter.github.io/
23
24use tree_sitter_language::LanguageFn;
25
26extern "C" {
27 fn tree_sitter_hcl() -> *const ();
28}
29
30/// The tree-sitter [`LanguageFn`] for this grammar.
31pub const LANGUAGE: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_hcl) };
32
33/// The content of the [`node-types.json`] file for this grammar.
34///
35/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers/6-static-node-types
36pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
37
38#[cfg(test)]
39mod tests {
40 #[test]
41 fn test_can_load_grammar() {
42 let mut parser = tree_sitter::Parser::new();
43 parser
44 .set_language(&super::LANGUAGE.into())
45 .expect("Error loading HCL parser");
46 }
47}