Skip to main content

tree_sitter_objectscript/
lib.rs

1//! This crate provides Objectscript language support for the [tree-sitter][] parsing library.
2//!
3//! Typically, you will use the [LANGUAGE_OBJECTSCRIPT_UDL] 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//! Class Demo.Test
9//! {
10//!   ClassMethod Main()
11//!   {
12//!     set x = 42
13//!   }
14//! }
15//! "#;
16//! let mut parser = tree_sitter::Parser::new();
17//! let language = tree_sitter_objectscript::LANGUAGE_OBJECTSCRIPT_UDL;
18//! parser
19//!     .set_language(&language.into())
20//!     .expect("Error loading Objectscript parser");
21//! let tree = parser.parse(code, None).unwrap();
22//! assert!(!tree.root_node().has_error());
23//! ```
24//!
25//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
26//! [tree-sitter]: https://tree-sitter.github.io/
27
28use tree_sitter_language::LanguageFn;
29
30extern "C" {
31    fn tree_sitter_objectscript() -> *const ();
32    fn tree_sitter_objectscript_udl() -> *const ();
33}
34
35/// The tree-sitter [`LanguageFn`] for ObjectScript Playground.
36///
37/// [LanguageFn]: https://docs.rs/tree-sitter-language/*/tree_sitter_language/struct.LanguageFn.html
38pub const LANGUAGE_OBJECTSCRIPT_PLAYGROUND: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_objectscript) };
39/// The tree-sitter [`LanguageFn`] for ObjectScript UDL.
40///
41/// [LanguageFn]: https://docs.rs/tree-sitter-language/*/tree_sitter_language/struct.LanguageFn.html
42pub const LANGUAGE_OBJECTSCRIPT_UDL: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_objectscript_udl) };
43/// The content of the [`node-types.json`][] file for ObjectScript.
44///
45/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
46pub const OBJECTSCRIPT_UDL_NODE_TYPES: &str = include_str!("../../udl/src/node-types.json");
47/// The content of the [`node-types.json`][] file for ObjectScript Playground.
48///
49/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
50pub const OBJECTSCRIPT_PLAYGROUND_NODE_TYPES: &str = include_str!("../../objectscript/src/node-types.json");
51/// The content of the [`node-types.json`][] file for ObjectScript Core (routines).
52///
53
54/// The syntax highlighting query for ObjectScript.
55pub const OBJECTSCRIPT_HIGHLIGHTS_QUERY: &str = concat!(
56include_str!("../../expr/queries/highlights.scm"), "\n",
57include_str!("../../core/queries/highlights.scm"), "\n",
58include_str!("../../udl/queries/highlights.scm"),
59);
60
61/// The injections query for ObjectScript.
62pub const OBJECTSCRIPT_INJECTIONS_QUERY: &str = concat!(
63include_str!("../../core/queries/injections.scm"), "\n",
64include_str!("../../udl/queries/injections.scm"),
65);
66
67/// The indents query for ObjectScript.
68pub const OBJECTSCRIPT_INDENTS_QUERY: &str =
69    include_str!("../../core/queries/indents.scm");
70
71
72#[cfg(test)]
73mod tests {
74    #[test]
75    fn test_can_load_objectscript_grammar() {
76        let mut parser = tree_sitter::Parser::new();
77        parser
78            .set_language(&super::LANGUAGE_OBJECTSCRIPT_PLAYGROUND.into())
79            .expect("Error loading Objectscript parser");
80    }
81
82    #[test]
83    fn test_can_load_objectscript_udl_grammar() {
84        let mut parser = tree_sitter::Parser::new();
85        parser
86            .set_language(&super::LANGUAGE_OBJECTSCRIPT_UDL.into())
87            .expect("Error loading Objectscript UDL parser");
88    }
89
90    #[test]
91    fn test_indents_query_is_loaded() {
92        assert!(super::OBJECTSCRIPT_INDENTS_QUERY.contains("indent"));
93    }
94
95    #[test]
96    fn test_injections_query_is_loaded() {
97        assert!(super::OBJECTSCRIPT_INJECTIONS_QUERY.contains("injection"));
98    }
99
100    #[test]
101    fn test_highlights_query_is_loaded() {
102        assert!(super::OBJECTSCRIPT_HIGHLIGHTS_QUERY.contains("@keyword"));
103    }
104}