tree_sitter_gleam/
lib.rs

1//! This crate provides Gleam 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//! use tree_sitter::Parser;
8//!
9//! let code = r#"
10//! import gleam/io
11//!
12//! pub fn main() {
13//!     io.println("hello, friend!")
14//! }
15//! "#;
16//! let mut parser = Parser::new();
17//! let language = tree_sitter_gleam::LANGUAGE;
18//! parser
19//!     .set_language(&language.into())
20//!     .expect("Error loading Gleam parser");
21//! let tree = parser.parse(code, None).unwrap();
22//! assert!(!tree.root_node().has_error());
23//! ```
24//!
25//! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
26//! [language func]: fn.language.html
27//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
28//! [tree-sitter]: https://tree-sitter.github.io/
29
30use tree_sitter_language::LanguageFn;
31
32extern "C" {
33    fn tree_sitter_gleam() -> *const ();
34}
35
36/// The tree-sitter [`LanguageFn`] for this grammar.
37pub const LANGUAGE: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_gleam) };
38
39/// The content of the [`node-types.json`][] file for this grammar.
40///
41/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
42pub const NODE_TYPES: &'static str = include_str!("../../src/node-types.json");
43
44/// The syntax highlighting query for this language.
45pub const HIGHLIGHT_QUERY: &'static str = include_str!("../../queries/highlights.scm");
46
47// The locals tagging query for this language.
48pub const LOCALS_QUERY: &'static str = include_str!("../../queries/locals.scm");
49
50/// The symbol tagging query for this language.
51pub const TAGS_QUERY: &'static 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 Gleam parser");
61    }
62}
tree_sitter_gleam/lib.rs

tree_sitter_gleam/
lib.rs
