tree_sitter_regex/
lib.rs

1//! This crate provides Regex 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//! [a-z]+
9//! "#;
10//! let mut parser = tree_sitter::Parser::new();
11//! let language = tree_sitter_regex::LANGUAGE;
12//! parser
13//!     .set_language(&language.into())
14//!     .expect("Error loading Regex parser");
15//! let tree = parser.parse(code, None).unwrap();
16//! assert!(!tree.root_node().has_error());
17//! ```
18//!
19//! [`Parser`]: https://docs.rs/tree-sitter/0.25.9/tree_sitter/struct.Parser.html
20//! [tree-sitter]: https://tree-sitter.github.io/
21
22use tree_sitter_language::LanguageFn;
23
24extern "C" {
25    fn tree_sitter_regex() -> *const ();
26}
27
28/// The tree-sitter [`LanguageFn`] for this grammar.
29pub const LANGUAGE: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_regex) };
30
31/// The content of the [`node-types.json`] file for this grammar.
32///
33/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers/6-static-node-types
34pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
35
36/// The syntax highlighting query for this grammar.
37pub const HIGHLIGHTS_QUERY: &str = include_str!("../../queries/highlights.scm");
38
39#[cfg(test)]
40mod tests {
41    #[test]
42    fn test_can_load_grammar() {
43        let mut parser = tree_sitter::Parser::new();
44        parser
45            .set_language(&super::LANGUAGE.into())
46            .expect("Error loading Regex parser");
47    }
48}