tree_sitter_macaulay2/
lib.rs

1//! This crate provides Macaulay2 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 = "";
8//! let mut parser = tree_sitter::Parser::new();
9//! parser.set_language(&tree_sitter_macaulay2::language()).expect("Error loading Macaulay2 grammar");
10//! let tree = parser.parse(code, None).unwrap();
11//! ```
12//!
13//! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
14//! [language func]: fn.language.html
15//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
16//! [tree-sitter]: https://tree-sitter.github.io/
17
18use tree_sitter::Language;
19
20extern "C" {
21    fn tree_sitter_macaulay2() -> Language;
22}
23
24/// Get the tree-sitter [Language][] for this grammar.
25///
26/// [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
27pub fn language() -> Language {
28    unsafe { tree_sitter_macaulay2() }
29}
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#static-node-types
34pub const NODE_TYPES: &str = include_str!("../../src/node-types.json");
35
36/// The syntax-highlighting query for this language.
37pub const HIGHLIGHTS_QUERY: &str = include_str!("../../queries/highlights.scm");
38
39/// The language-injection query for this language.
40pub const INJECTIONS_QUERY: &str = include_str!("../../queries/injections.scm");
41
42/// The symbol-tagging query for this language.
43pub const TAGS_QUERY: &str = include_str!("../../queries/tags.scm");
44
45/// The indentation query for this language.
46pub const INDENTS_QUERY: &str = include_str!("../../queries/indents.scm");
47
48/// The folding query for this language.
49pub const FOLDS_QUERY: &str = include_str!("../../queries/folds.scm");
50
51#[cfg(test)]
52mod tests {
53    use tree_sitter::{InputEdit, Parser, Point};
54
55    #[test]
56    fn test_can_load_grammar() {
57        let mut parser = Parser::new();
58        parser
59            .set_language(&super::language())
60            .expect("Error loading Macaulay2 language");
61    }
62
63    #[test]
64    fn exports_every_configured_query() {
65        for query in [
66            super::HIGHLIGHTS_QUERY,
67            super::INJECTIONS_QUERY,
68            super::TAGS_QUERY,
69            super::INDENTS_QUERY,
70            super::FOLDS_QUERY,
71        ] {
72            assert!(!query.is_empty());
73        }
74    }
75
76    #[test]
77    fn incremental_edit_removes_zero_width_empty_components() {
78        fn empty_component_ranges(tree: &tree_sitter::Tree) -> Vec<std::ops::Range<usize>> {
79            let mut cursor = tree.walk();
80            let mut ranges = Vec::new();
81
82            loop {
83                let node = cursor.node();
84                if node.kind() == "empty_component" {
85                    ranges.push(node.byte_range());
86                }
87
88                if cursor.goto_first_child() {
89                    continue;
90                }
91                while !cursor.goto_next_sibling() {
92                    if !cursor.goto_parent() {
93                        return ranges;
94                    }
95                }
96            }
97        }
98
99        let mut parser = Parser::new();
100        parser
101            .set_language(&super::language())
102            .expect("Error loading Macaulay2 language");
103
104        let mut tree = parser.parse("2,,\n", None).expect("initial parse failed");
105        assert!(!tree.root_node().has_error());
106        let ranges = empty_component_ranges(&tree);
107        assert_eq!(ranges.len(), 2);
108        assert!(ranges.iter().all(|range| range.is_empty()));
109
110        tree.edit(&InputEdit {
111            start_byte: 2,
112            old_end_byte: 3,
113            new_end_byte: 3,
114            start_position: Point::new(0, 2),
115            old_end_position: Point::new(0, 3),
116            new_end_position: Point::new(0, 3),
117        });
118
119        let tree = parser
120            .parse("2,3\n", Some(&tree))
121            .expect("incremental parse failed");
122        assert!(!tree.root_node().has_error());
123        assert!(empty_component_ranges(&tree).is_empty());
124    }
125}
tree_sitter_macaulay2/lib.rs

tree_sitter_macaulay2/
lib.rs
