tree_sitter_palm/lib.rs
1//! This crate provides palm language support for the [tree-sitter][] parsing library.
2//!
3//! Typically, you will use the [language][language func] function to add this language to a
4//! tree-sitter [Parser][], and then use the parser to parse some code:
5//!
6//! ```
7//! let code = "";
8//! let mut parser = tree_sitter::Parser::new();
9//! parser.set_language(tree_sitter_palm::language()).expect("Error loading palm grammar");
10//! let tree = parser.parse(code, None).unwrap();
11//! ```
12//!
13//! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
14//! [language func]: fn.language.html
15//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
16//! [tree-sitter]: https://tree-sitter.github.io/
17
18use tree_sitter::Language;
19
20extern "C" {
21 fn tree_sitter_palm() -> Language;
22}
23
24/// Returns the tree-sitter [Language][] for this grammar.
25///
26/// [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
27pub fn language() -> Language {
28 unsafe { tree_sitter_palm() }
29}
30
31/// The source of the palm tree-sitter grammar description.
32pub const GRAMMAR: &'static str = include_str!("../../grammar.js");
33
34/// The syntax highlighting query for this language.
35pub const HIGHLIGHT_QUERY: &'static str = include_str!("../../queries/highlights.scm");
36
37/// The content of the [`node-types.json`][] file for this grammar.
38///
39/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
40pub const NODE_TYPES: &'static str = include_str!("../../src/node-types.json");
41
42/// The symbol tagging query for this language.
43pub const TAGGING_QUERY: &'static str = include_str!("../../queries/tags.scm");
44
45#[cfg(test)]
46mod tests {
47 #[test]
48 fn can_load_grammar() {
49 let mut parser = tree_sitter::Parser::new();
50 parser
51 .set_language(super::language())
52 .expect("Error loading palm grammar");
53 }
54}