tree_sitter_arduino/
lib.rs

1//! This crate provides Arduino 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//! void setup() {
9//!   pinMode(LED_BUILTIN, OUTPUT);
10//! }
11//!
12//! void loop() {
13//!   digitalWrite(LED_BUILTIN, HIGH);
14//!   delay(1000);
15//!   digitalWrite(LED_BUILTIN, LOW);
16//!   delay(1000);
17//! }
18//! "#;
19//! let mut parser = tree_sitter::Parser::new();
20//! let language = tree_sitter_arduino::LANGUAGE;
21//! parser
22//!     .set_language(&language.into())
23//!     .expect("Error loading Arduino parser");
24//! let tree = parser.parse(code, None).unwrap();
25//! assert!(!tree.root_node().has_error());
26//! ```
27//!
28//! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
29//! [language func]: fn.language.html
30//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
31//! [tree-sitter]: https://tree-sitter.github.io/
32
33use tree_sitter_language::LanguageFn;
34
35extern "C" {
36    fn tree_sitter_arduino() -> *const ();
37}
38
39/// The tree-sitter [`LanguageFn`] for this grammar.
40pub const LANGUAGE: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_arduino) };
41
42/// The content of the [`node-types.json`][] file for this grammar.
43///
44/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
45pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
46
47/// The syntax highlighting queries.
48pub const HIGHLIGHTS_QUERY: &str = include_str!("../../queries/highlights.scm");
49
50/// The tags queries used for code navigation.
51pub const TAGS_QUERY: &str = include_str!("../../queries/tags.scm");
52
53#[cfg(test)]
54mod tests {
55    #[test]
56    fn test_can_load_grammar() {
57        let mut parser = tree_sitter::Parser::new();
58        parser
59            .set_language(&super::LANGUAGE.into())
60            .expect("Error loading Arduino parser");
61    }
62}
tree_sitter_arduino/lib.rs

tree_sitter_arduino/
lib.rs
