tree_sitter_cue/
lib.rs

1// ------------------------------------------------------------------------------------------------
2// Copyright © 2023, Jean-Philippe Braun <eon@patapon.info>, Amaan Qureshi <amaanq12@gmail.com>
3// See the LICENSE file in this repo for license details.
4// ------------------------------------------------------------------------------------------------
5
6//! This crate provides Cue language support for the [tree-sitter][] parsing library.
7//!
8//! Typically, you will use the [language][language func] function to add this language to a
9//! tree-sitter [Parser][], and then use the parser to parse some code:
10//!
11//! ```
12//! let code = "";
13//! let mut parser = tree_sitter::Parser::new();
14//! parser.set_language(tree_sitter_cue::language()).expect("Error loading Cue grammar");
15//! let tree = parser.parse(code, None).unwrap();
16//! ```
17//!
18//! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
19//! [language func]: fn.language.html
20//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
21//! [tree-sitter]: https://tree-sitter.github.io/
22
23use tree_sitter::Language;
24
25extern "C" {
26    fn tree_sitter_cue() -> Language;
27}
28
29/// Get the tree-sitter [Language][] for this grammar.
30///
31/// [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
32pub fn language() -> Language {
33    unsafe { tree_sitter_cue() }
34}
35
36/// The source of the Rust tree-sitter grammar description.
37pub const GRAMMAR: &str = include_str!("../../grammar.js");
38
39/// The folds query for this language.
40pub const FOLDS_QUERY: &str = include_str!("../../queries/folds.scm");
41
42/// The syntax highlighting query for this language.
43pub const HIGHLIGHTS_QUERY: &str = include_str!("../../queries/highlights.scm");
44
45/// The indents query for this language.
46pub const INDENTS_QUERY: &str = include_str!("../../queries/indents.scm");
47
48/// The injection query for this language.
49pub const INJECTIONS_QUERY: &str = include_str!("../../queries/injections.scm");
50
51/// The symbol tagging query for this language.
52pub const LOCALS_QUERY: &str = include_str!("../../queries/locals.scm");
53
54/// The content of the [`node-types.json`][] file for this grammar.
55///
56/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
57pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
58
59#[cfg(test)]
60mod tests {
61    #[test]
62    fn test_can_load_grammar() {
63        let mut parser = tree_sitter::Parser::new();
64        parser
65            .set_language(super::language())
66            .expect("Error loading Cue grammar");
67    }
68}
tree_sitter_cue/lib.rs

tree_sitter_cue/
lib.rs
