tree_sitter_vimdoc/
lib.rs

1//! This crate provides vimdoc 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 = r#"
8//!   {lines}   |readfile()|-style
9//!   {type}    behavior:
10//!             • "b" |blockwise-visual|
11//!             • "c" |charwise|
12//!             • "l" |linewise|
13//!             • "listitem"
14//!   {consumes} adjacent
15//! "#;
16//! let mut parser = tree_sitter::Parser::new();
17//! parser.set_language(&tree_sitter_vimdoc::language()).expect("Error loading vimdoc grammar");
18//! let tree = parser.parse(code, None).unwrap();
19//! ```
20//!
21//! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
22//! [language func]: fn.language.html
23//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
24//! [tree-sitter]: https://tree-sitter.github.io/
25
26use tree_sitter::Language;
27
28extern "C" {
29    fn tree_sitter_vimdoc() -> Language;
30}
31
32/// Get the tree-sitter [Language][] for this grammar.
33///
34/// [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
35pub fn language() -> Language {
36    unsafe { tree_sitter_vimdoc() }
37}
38
39/// The content of the [`node-types.json`][] file for this grammar.
40///
41/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
42pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
43
44pub const HIGHLIGHTS_QUERY: &str = include_str!("../../queries/vimdoc/highlights.scm");
45
46pub const INJECTIONS_QUERY: &str = include_str!("../../queries/vimdoc/injections.scm");
47
48#[cfg(test)]
49mod tests {
50    #[test]
51    fn test_can_load_grammar() {
52        let mut parser = tree_sitter::Parser::new();
53        parser
54            .set_language(&super::language())
55            .expect("Error loading Vimdoc language");
56    }
57}
tree_sitter_vimdoc/lib.rs

tree_sitter_vimdoc/
lib.rs
