tree_sitter_ruby/
lib.rs

1//! This crate provides Ruby 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 = "def hello(name)\n  puts \"Hello, #{name}!\"\nend\n";
8//! let mut parser = tree_sitter::Parser::new();
9//! let language = tree_sitter_ruby::LANGUAGE;
10//! parser
11//!     .set_language(&language.into())
12//!     .expect("Error loading Ruby parser");
13//! let tree = parser.parse(code, None).unwrap();
14//! assert!(!tree.root_node().has_error());
15//! ```
16//!
17//! The parser carries the ABI number of the WillBooster fork of tree-sitter (`0x57420001`), so it loads only with
18//! the `willbooster-tree-sitter` runtime, version 2.0.0 or later; upstream's `tree-sitter` runtime rejects it.
19//!
20//! [`Parser`]: https://docs.rs/willbooster-tree-sitter/2/tree_sitter/struct.Parser.html
21//! [tree-sitter]: https://tree-sitter.github.io/
22
23use tree_sitter_language::LanguageFn;
24
25unsafe extern "C" {
26    fn tree_sitter_ruby() -> *const ();
27}
28
29/// The tree-sitter [`LanguageFn`] for this grammar.
30pub const LANGUAGE: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_ruby) };
31
32/// The content of the [`node-types.json`] file for this grammar.
33///
34/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers/6-static-node-types
35pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
36
37#[cfg(test)]
38mod tests {
39    #[test]
40    fn test_can_load_grammar() {
41        let mut parser = tree_sitter::Parser::new();
42        parser
43            .set_language(&super::LANGUAGE.into())
44            .expect("Error loading Ruby parser");
45    }
46}
tree_sitter_ruby/lib.rs

tree_sitter_ruby/
lib.rs
