sipha 3.0.0

PEG parser, syntax trees, and code generation
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

//! Formatter options and helpers for sipha syntax trees.
//!
//! Re-exports sipha's emit API and adds presets for common formatting choices
//! (e.g. semantic-only output, or full round-trip with trivia).

use crate::tree::red::SyntaxNode;

pub use crate::tree::emit::{EmitOptions, syntax_root_to_string};

/// Format the tree to string, including all tokens and trivia (lossless round-trip).
#[inline]
#[must_use]
pub fn format_full(root: &SyntaxNode) -> String {
    crate::tree::emit::syntax_root_to_string(root, &EmitOptions::full())
}

/// Format the tree to string, semantic tokens only (no trivia).
#[inline]
#[must_use]
pub fn format_semantic_only(root: &SyntaxNode) -> String {
    crate::tree::emit::syntax_root_to_string(root, &EmitOptions::semantic_only())
}

/// Format the tree, optionally skipping a sentinel token kind (e.g. EOF).
#[inline]
#[must_use]
pub fn format_with_skip(root: &SyntaxNode, include_trivia: bool, skip_kind: u16) -> String {
    crate::tree::emit::syntax_root_to_string(
        root,
        &EmitOptions {
            include_trivia,
            skip_kind: Some(skip_kind),
        },
    )
}