Skip to main content

devgen_tree_sitter_toml/
lib.rs

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