katui-rt 0.0.4

The katui runtime: the tty transport, terminal lifecycle and loops
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

//! The capability card `katui-info` prints: one line per fact, the
//! graphics backend first, chosen through the same selection every other
//! consumer uses.

use katui_present::select::select;
use katui_proto::probe::{Capabilities, ProbeSource};

/// What to tell someone whose terminal gave us no graphics, naming the
/// fix when we know it.
#[must_use]
pub fn no_graphics_advice(caps: &Capabilities) -> String {
    match caps.identity.as_ref().filter(|_| caps.multiplexed()) {
        Some(identity) if identity.name == "rmux" => {
            "rmux is not passing graphics through. Run `rmux set -g allow-passthrough on`, \
             then start this again."
                .to_owned()
        }
        Some(identity) if identity.name == "tmux" => {
            "tmux is not passing graphics through. Update to tmux 3.8 or newer, then start \
             this again."
                .to_owned()
        }
        Some(identity) => format!("{} is not passing graphics through.", identity.name),
        None => "This needs a terminal with the kitty graphics protocol.".to_owned(),
    }
}

/// Render the card for `caps`.
#[must_use]
pub fn card(caps: &Capabilities) -> String {
    let graphics = select(caps).name();
    let identity = caps
        .identity
        .as_ref()
        .map_or_else(|| "unknown".to_owned(), ToString::to_string);
    let cell = match caps.cell {
        Some(cell) => format!("{}x{} px", cell.width, cell.height),
        None => "unknown".to_owned(),
    };
    let source = match caps.trust {
        ProbeSource::Probed => "probed",
        ProbeSource::Sniffed => "sniffed",
        ProbeSource::Declared => "declared",
    };
    format!(
        "graphics: {graphics}\nidentity: {identity}\ntruecolor: {}\nanimation: {}\nlocal files: {}\ncell: {cell}\nsource: {source}\n",
        if caps.truecolor { "yes" } else { "no" },
        if caps.animation { "yes" } else { "no" },
        if caps.local_files { "yes" } else { "no" }
    )
}

#[cfg(test)]
mod tests {
    use super::card;
    use katui_proto::probe::{Capabilities, CellPixels, Identity, ProbeSource};

    #[test]
    fn the_advice_names_the_fix_for_each_multiplexer() {
        let behind = |name: &str| Capabilities {
            identity: Some(Identity {
                name: name.to_owned(),
                version: None,
            }),
            ..Capabilities::default()
        };
        assert!(super::no_graphics_advice(&behind("rmux")).contains("allow-passthrough"));
        assert!(super::no_graphics_advice(&behind("tmux")).contains("3.8"));
        assert!(
            super::no_graphics_advice(&Capabilities::default()).contains("kitty graphics protocol")
        );
    }

    #[test]
    fn a_probed_kitty_session_prints_every_fact() {
        let caps = Capabilities {
            kitty: true,
            animation: false,
            sixel: false,
            truecolor: true,
            identity: Some(Identity {
                name: "kitty".to_owned(),
                version: Some("0.29.0".to_owned()),
            }),
            cell: Some(CellPixels {
                width: 7,
                height: 14,
            }),
            text_area: None,
            relative_placements: false,
            local_files: false,
            id_space: katui_proto::kitty::IdSpace::default(),
            trust: ProbeSource::Probed,
        };
        assert_eq!(
            card(&caps),
            "graphics: kitty\nidentity: kitty 0.29.0\ntruecolor: yes\nanimation: no\nlocal files: no\ncell: 7x14 px\nsource: probed\n"
        );
    }

    #[test]
    fn a_silent_terminal_falls_back_to_the_floor() {
        let caps = Capabilities {
            trust: ProbeSource::Sniffed,
            ..Capabilities::default()
        };
        assert_eq!(
            card(&caps),
            "graphics: blocks\nidentity: unknown\ntruecolor: no\nanimation: no\nlocal files: no\ncell: unknown\nsource: sniffed\n"
        );
    }
}