tui-term 0.3.4

A pseudoterminal widget for ratatui
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

use ratatui_core::{buffer::Buffer, layout::Rect};

use crate::widget::{Cell, CursorShape, PseudoTerminal, Screen};

/// Draw the [`Screen`] to the [`Buffer`],
/// area is the designated area that the consumer provides
pub fn handle<S: Screen>(term: &PseudoTerminal<S>, area: Rect, buf: &mut Buffer) {
    let cols = area.width;
    let rows = area.height;
    let col_start = area.x;
    let row_start = area.y;
    let area_cols = area.width + area.x;
    let area_rows = area.height + area.y;
    let screen = term.screen();

    // The [`Screen`] is made out of rows of cells
    for row in 0..rows {
        for col in 0..cols {
            let buf_col = col + col_start;
            let buf_row = row + row_start;

            if buf_row > area_rows || buf_col > area_cols {
                // Skip writing outside the area
                continue;
            }

            if let Some(screen_cell) = screen.cell(row, col) {
                let cell = &mut buf[(buf_col, buf_row)];
                screen_cell.apply(cell);
            }
        }
    }

    if !screen.hide_cursor() && term.cursor.show {
        let (c_row, c_col) = screen.cursor_position();
        if c_row.saturating_add(row_start) < area_rows
            && c_col.saturating_add(col_start) < area_cols
        {
            let c_cell = &mut buf[(c_col + col_start, c_row + row_start)];
            if let Some(cell) = screen.cell(c_row, c_col) {
                if cell.has_contents() {
                    let style = term.cursor.overlay_style;
                    c_cell.set_style(style);
                } else {
                    let shape = screen.cursor_shape();
                    let symbol = match shape {
                        CursorShape::Default => &term.cursor.symbol,
                        CursorShape::BlinkingBlock | CursorShape::SteadyBlock => "█",
                        CursorShape::BlinkingUnderline | CursorShape::SteadyUnderline => "▁",
                        CursorShape::BlinkingBar | CursorShape::SteadyBar => "▏",
                    };
                    let style = term.cursor.style;
                    c_cell.set_symbol(symbol);
                    c_cell.set_style(style);
                }
            }
        }
    }
}