bmux_scene_protocol_render 0.0.1-alpha.1

Terminal-ANSI renderer for bmux scene-protocol paint commands and glyph helpers
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

//! Capability predicates for scene-protocol rendering.

use bmux_scene_protocol::scene_protocol::{TerminalCapability, TerminalCapabilityQuery};

/// Per-attached-terminal capabilities relevant to scene rendering.
#[allow(clippy::struct_excessive_bools)] // Independent terminal feature flags.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct SceneRenderCapabilities {
    pub truecolor: bool,
    pub unicode_box_drawing: bool,
    pub unicode_block_elements: bool,
    pub graphics_kitty: bool,
    pub graphics_sixel: bool,
    pub graphics_iterm2: bool,
    pub graphics_alpha: bool,
    pub cell_pixels: bool,
}

impl Default for SceneRenderCapabilities {
    fn default() -> Self {
        Self {
            truecolor: true,
            unicode_box_drawing: true,
            unicode_block_elements: true,
            graphics_kitty: false,
            graphics_sixel: false,
            graphics_iterm2: false,
            graphics_alpha: false,
            cell_pixels: false,
        }
    }
}

impl SceneRenderCapabilities {
    #[must_use]
    pub const fn supports(self, capability: TerminalCapability) -> bool {
        match capability {
            TerminalCapability::Truecolor => self.truecolor,
            TerminalCapability::UnicodeBoxDrawing => self.unicode_box_drawing,
            TerminalCapability::UnicodeBlockElements => self.unicode_block_elements,
            TerminalCapability::GraphicsKitty => self.graphics_kitty,
            TerminalCapability::GraphicsSixel => self.graphics_sixel,
            TerminalCapability::GraphicsIterm2 => self.graphics_iterm2,
            TerminalCapability::GraphicsAlpha => self.graphics_alpha,
            TerminalCapability::CellPixels => self.cell_pixels,
        }
    }
}

#[must_use]
pub fn capability_query_matches(
    query: Option<&TerminalCapabilityQuery>,
    capabilities: SceneRenderCapabilities,
) -> bool {
    let Some(query) = query else {
        return true;
    };
    query
        .all
        .iter()
        .all(|capability| capabilities.supports(*capability))
        && (query.any.is_empty()
            || query
                .any
                .iter()
                .any(|capability| capabilities.supports(*capability)))
        && query
            .none
            .iter()
            .all(|capability| !capabilities.supports(*capability))
}

#[cfg(test)]
mod tests {
    use super::{SceneRenderCapabilities, capability_query_matches};
    use bmux_scene_protocol::scene_protocol::{TerminalCapability, TerminalCapabilityQuery};

    #[test]
    fn capability_query_matches_all_any_and_none() {
        let caps = SceneRenderCapabilities {
            graphics_kitty: true,
            graphics_alpha: true,
            cell_pixels: true,
            ..SceneRenderCapabilities::default()
        };
        let query = TerminalCapabilityQuery {
            all: vec![TerminalCapability::GraphicsKitty],
            any: vec![
                TerminalCapability::GraphicsSixel,
                TerminalCapability::GraphicsAlpha,
            ],
            none: vec![TerminalCapability::GraphicsIterm2],
        };
        assert!(capability_query_matches(Some(&query), caps));
    }

    #[test]
    fn capability_query_rejects_forbidden_capability() {
        let caps = SceneRenderCapabilities {
            graphics_kitty: true,
            ..SceneRenderCapabilities::default()
        };
        let query = TerminalCapabilityQuery {
            all: Vec::new(),
            any: Vec::new(),
            none: vec![TerminalCapability::GraphicsKitty],
        };
        assert!(!capability_query_matches(Some(&query), caps));
    }
}