leekscript-tooling 0.1.0

LeekScript tooling: formatter, visitor, tree display, transform
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

//! Utilities to display the parser's syntax tree in a readable ASCII/Unicode tree format.
//!
//! Delegates to sipha's grammar-agnostic [`format_syntax_tree`](sipha::tree_display::format_syntax_tree)
//! with a kind-name callback for `LeekScript` syntax kinds.

use sipha::red::SyntaxNode;
use sipha::tree_display::format_syntax_tree as sipha_format_syntax_tree;

use leekscript_core::syntax;

/// Options for formatting the syntax tree (re-exported from sipha).
pub use sipha::tree_display::TreeDisplayOptions;

/// Format a syntax tree starting at `root` as a multi-line string.
///
/// Uses `LeekScript` kind names for node and token labels.
#[must_use]
pub fn format_syntax_tree(root: &SyntaxNode, options: &TreeDisplayOptions) -> String {
    sipha_format_syntax_tree(root, options, |k| syntax::kind_name(k).to_string())
}

/// Print the syntax tree to stdout.
pub fn print_syntax_tree(root: &SyntaxNode, options: &TreeDisplayOptions) {
    println!("{}", format_syntax_tree(root, options));
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn options_default() {
        let opts = TreeDisplayOptions::default();
        assert!(opts.show_tokens);
        assert!(!opts.show_trivia);
    }

    #[test]
    fn options_structure_only() {
        let opts = TreeDisplayOptions::structure_only();
        assert!(!opts.show_tokens);
    }

    #[test]
    fn options_full() {
        let opts = TreeDisplayOptions::full();
        assert!(opts.show_trivia);
    }
}