tuika 0.5.0

A composable terminal UI toolkit — flexbox layout, overlays, focus, and safe ratatui interoperability.
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

//! The width-independent intermediate form both passes speak.
//!
//! Parsing produces these; flattening consumes them. Keeping the two passes
//! apart is what makes streaming affordable: a settled block is parsed once and
//! only re-flattened when the render width changes.

use pulldown_cmark::Alignment;
use ratatui_core::style::Style;
use ratatui_core::text::{Line, Span};

use crate::term::image::ImageData;

/// Columns of indentation added per level of list / block-quote nesting.
pub(super) const INDENT: u16 = 2;

/// A parsed, width-independent markdown block. Wrapping and table layout happen
/// later, at [`flatten`] time, against a concrete width.
pub(super) enum MdItem {
    /// Word-wrappable prose (a paragraph line, heading, list item, quote line).
    Prose { spans: Vec<RichSpan>, indent: u16 },
    /// A fenced or indented code block. The source stays width-independent so a
    /// [`FencedBlockRenderer`](super::FencedBlockRenderer) can lay it out for
    /// the current viewport; the ordinary themed presentation is the fallback.
    CodeBlock {
        language: String,
        source: String,
        fallback: Vec<Line<'static>>,
        indent: u16,
    },
    /// A GFM table, laid out to the available width when flattened.
    Table { table: TableData, indent: u16 },
    /// A resolved block image: reserves rows at flatten time and is painted by an
    /// [`Image`](crate::components::Image) overlay in the view (see [`ImageResolver`]).
    Image {
        data: ImageData,
        alt: String,
        indent: u16,
    },
    /// A blank spacer row separating blocks.
    Blank,
}

/// An inline run that may carry an OSC 8 hyperlink target.
///
/// ratatui's [`Span`] has no href field, so markdown keeps the destination here
/// through wrapping; [`flatten_linked`] turns contiguous href runs into
/// [`BufferLink`]s the host (or [`Markdown`](super::Markdown) view) applies with
/// [`apply_buffer_links`](crate::term::hyperlink::apply_buffer_links).
#[derive(Clone, Debug)]
pub(super) struct RichSpan {
    pub(super) content: String,
    pub(super) style: Style,
    /// When set, this run is a hyperlink to `href` (the visible label may differ).
    pub(super) href: Option<String>,
}

impl RichSpan {
    pub(super) fn styled(content: impl Into<String>, style: Style, href: Option<String>) -> Self {
        Self {
            content: content.into(),
            style,
            href,
        }
    }

    pub(super) fn to_span(&self) -> Span<'static> {
        Span::styled(self.content.clone(), self.style)
    }
}

/// Table contents captured during parsing: each cell is a run of pre-styled
/// inline spans (bold, links, inline code, emoji), boxed and width-fitted at
/// render time by [`render_table`].
pub(super) struct TableData {
    pub(super) aligns: Vec<Alignment>,
    pub(super) header: Vec<Cell>,
    pub(super) rows: Vec<Vec<Cell>>,
}

/// One table cell's inline content, already styled by the shared inline
/// machinery so cells carry the same markup as prose.
pub(super) type Cell = Vec<RichSpan>;