r3bl_tui 0.7.7

TUI library to build modern apps inspired by React, Elm, with Flexbox, CSS, editor component, emoji support, and more
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

// Copyright (c) 2022-2025 R3BL LLC. Licensed under Apache License, Version 2.0.

use crate::{RenderOpCommon,
            RenderOpCommon::{ApplyColors, ClearCurrentLine, ClearScreen,
                             ClearToEndOfLine, ClearToStartOfLine,
                             DisableBracketedPaste, DisableMouseTracking,
                             EnableBracketedPaste, EnableMouseTracking,
                             EnterAlternateScreen, EnterRawMode, ExitAlternateScreen,
                             ExitRawMode, HideCursor, MoveCursorPositionAbs,
                             MoveCursorPositionRelTo, MoveCursorToColumn,
                             MoveCursorToNextLine, MoveCursorToPreviousLine, Noop,
                             PrintStyledText, ResetColor, RestoreCursorPosition,
                             SaveCursorPosition, SetBgColor, SetFgColor, ShowCursor},
            RenderOpDebugFormat, TuiStyle};
use std::fmt::{Formatter, Result};

#[derive(Debug)]
pub struct CrosstermDebugFormatRenderOp;

impl RenderOpDebugFormat for CrosstermDebugFormatRenderOp {
    fn fmt_debug(&self, this: &RenderOpCommon, f: &mut Formatter<'_>) -> Result {
        match this {
            Noop => f.write_str("Noop"),
            EnterRawMode => f.write_str("EnterRawMode"),
            ExitRawMode => f.write_str("ExitRawMode"),
            ClearScreen => f.write_str("ClearScreen"),
            ResetColor => f.write_str("ResetColor"),
            SetFgColor(fg_color) => {
                write!(f, "SetFgColor({fg_color:?})")
            }
            SetBgColor(bg_color) => {
                write!(f, "SetBgColor({bg_color:?})")
            }
            ApplyColors(maybe_style) => match maybe_style {
                Some(style) => write!(f, "ApplyColors({style:?})"),
                None => f.write_str("ApplyColors(None)"),
            },
            MoveCursorPositionAbs(pos) => {
                write!(f, "MoveCursorPositionAbs({pos:?})")
            }
            MoveCursorPositionRelTo(box_origin_pos, content_rel_pos) => write!(
                f,
                "MoveCursorPositionRelTo({box_origin_pos:?}, {content_rel_pos:?})"
            ),
            PrintStyledText(text) => {
                write!(f, "PrintStyledText({} bytes)", text.len())
            }
            // ===== Incremental Rendering Operations (Phase 1) =====
            MoveCursorToColumn(col_index) => {
                write!(f, "MoveCursorToColumn({col_index:?})")
            }
            MoveCursorToNextLine(row_height) => {
                write!(f, "MoveCursorToNextLine({row_height:?})")
            }
            MoveCursorToPreviousLine(row_height) => {
                write!(f, "MoveCursorToPreviousLine({row_height:?})")
            }
            ClearCurrentLine => f.write_str("ClearCurrentLine"),
            ClearToEndOfLine => f.write_str("ClearToEndOfLine"),
            ClearToStartOfLine => f.write_str("ClearToStartOfLine"),
            ShowCursor => f.write_str("ShowCursor"),
            HideCursor => f.write_str("HideCursor"),
            SaveCursorPosition => f.write_str("SaveCursorPosition"),
            RestoreCursorPosition => f.write_str("RestoreCursorPosition"),
            // ===== Terminal Mode Operations =====
            EnterAlternateScreen => f.write_str("EnterAlternateScreen"),
            ExitAlternateScreen => f.write_str("ExitAlternateScreen"),
            EnableMouseTracking => f.write_str("EnableMouseTracking"),
            DisableMouseTracking => f.write_str("DisableMouseTracking"),
            EnableBracketedPaste => f.write_str("EnableBracketedPaste"),
            DisableBracketedPaste => f.write_str("DisableBracketedPaste"),
        }
    }
}

/// Helper for formatting styled text output from the compositor.
///
/// This function formats text content with optional styling information
/// for display in the terminal backend.
///
/// # Errors
///
/// Returns a formatting error if writing to the formatter fails.
pub fn format_output_paint_text(
    f: &mut Formatter<'_>,
    text: &str,
    maybe_style: Option<TuiStyle>,
) -> Result {
    f.write_str("Compositor..PrintText...")?;
    f.write_str("(")?;
    write!(f, "{}", text.len())?;
    f.write_str(" bytes, ")?;
    match maybe_style {
        Some(style) => write!(f, "{style:?})"),
        None => f.write_str("None)"),
    }
}