tree_sitter_qmljs/lib.rs
1//! This crate provides QML language support for the [tree-sitter][] parsing library.
2//!
3//! Typically, you will use the [LANGUAGE][] constant 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//! import QtQuick
9//!
10//! Item {}
11//! "#;
12//! let mut parser = tree_sitter::Parser::new();
13//! let language = tree_sitter_qmljs::LANGUAGE;
14//! parser
15//! .set_language(&language.into())
16//! .expect("Error loading QML parser");
17//! let tree = parser.parse(code, None).unwrap();
18//! assert!(!tree.root_node().has_error());
19//! ```
20//!
21//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
22//! [tree-sitter]: https://tree-sitter.github.io/
23
24use tree_sitter_language::LanguageFn;
25
26extern "C" {
27 fn tree_sitter_qmljs() -> *const ();
28}
29
30/// The tree-sitter [`LanguageFn`][LanguageFn] for this grammar.
31///
32/// [LanguageFn]: https://docs.rs/tree-sitter-language/*/tree_sitter_language/struct.LanguageFn.html
33pub const LANGUAGE: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_qmljs) };
34
35/// The content of the [`node-types.json`][] file for this grammar.
36///
37/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
38pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
39
40// NOTE: uncomment these to include any queries that this grammar contains:
41
42pub const HIGHLIGHTS_QUERY: &str = include_str!("../../queries/highlights.scm");
43// pub const INJECTIONS_QUERY: &str = include_str!("../../queries/injections.scm");
44pub const LOCALS_QUERY: &str = include_str!("../../queries/locals.scm");
45// pub const TAGS_QUERY: &str = include_str!("../../queries/tags.scm");
46
47#[cfg(test)]
48mod tests {
49 #[test]
50 fn test_can_load_grammar() {
51 let mut parser = tree_sitter::Parser::new();
52 parser
53 .set_language(&super::LANGUAGE.into())
54 .expect("Error loading QML parser");
55 }
56}