tree_sitter_surrealql/
lib.rs

1//! This crate provides surrealql 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_surrealql::language()).expect("Error loading surrealql 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_surrealql() -> Language;
22}
23
24/// Get 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_surrealql() }
29}
30
31/// The content of the [`node-types.json`][] file for this grammar.
32///
33/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
34pub const NODE_TYPES: &'static str = include_str!("../../src/node-types.json");
35
36// Query files for this grammar
37
38pub const HIGHLIGHTS_QUERY: &'static str = include_str!("../../queries/highlights.scm");
39pub const FOLDS_QUERY: &'static str = include_str!("../../queries/folds.scm");
40pub const INDENTS_QUERY: &'static str = include_str!("../../queries/indents.scm");
41
42#[cfg(test)]
43mod tests {
44    #[test]
45    fn test_can_load_grammar() {
46        let mut parser = tree_sitter::Parser::new();
47        parser
48            .set_language(&super::language())
49            .expect(&"Error loading surrealql language");
50    }
51}