tree_sitter_ygg/lib.rs
1//! This crate provides a Rust grammar for the [tree-sitter][] parsing library.
2//!
3//! Typically, you will use the [language][language func] function to add this grammar 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//! fn double(x: i32) -> i32 {
11//! x * 2
12//! }
13//! "#;
14//! let mut parser = Parser::new();
15//! parser.set_language(tree_sitter_ygg::language()).expect("Error loading Rust grammar");
16//! let parsed = parser.parse(code, None);
17//! # let parsed = parsed.unwrap();
18//! # let root = parsed.root_node();
19//! # assert!(!root.has_error());
20//! ```
21//!
22//! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
23//! [language func]: fn.language.html
24//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
25//! [tree-sitter]: https://tree-sitter.github.io/
26
27use tree_sitter::Language;
28
29extern "C" {
30 fn tree_sitter_ygg() -> Language;
31}
32
33/// Returns the tree-sitter [Language][] for this grammar.
34///
35/// [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
36pub fn language() -> Language {
37 unsafe { tree_sitter_ygg() }
38}
39
40/// The syntax highlighting query for this language.
41pub const HIGHLIGHT_QUERY: &str = include_str!("../queries/highlights.scm");
42
43/// The content of the [`node-types.json`][] file for this grammar.
44///
45/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
46pub const NODE_TYPES: &str = include_str!("tree_sitter/node-types.json");