bmux_scene_protocol 0.0.1-alpha.1

Typed scene-decoration protocol shared by bmux core and any decoration plugin
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

//! Shared helpers for turning a [`crate::scene_protocol::BorderGlyphs`]
//! choice into the six concrete runes required to paint a 1-cell
//! border.
//!
//! Both the attach renderer and the decoration plugin consume this
//! table. Keeping it in the scene-protocol crate (adjacent to the
//! generated [`crate::scene_protocol::BorderGlyphs`] variant) ensures
//! they stay in lock-step when new preset variants are added.

use crate::scene_protocol::BorderGlyphs;

/// Six-rune border glyph set used when painting a 1-cell border.
///
/// String slices point at either compile-time static literals (for
/// the built-in presets) or at the owned strings carried by a
/// [`BorderGlyphs::Custom`] variant. The lifetime parameter captures
/// whichever is appropriate for the caller.
#[derive(Clone, Copy, Debug)]
pub struct BorderGlyphSet<'a> {
    pub top_left: &'a str,
    pub top_right: &'a str,
    pub bottom_left: &'a str,
    pub bottom_right: &'a str,
    pub horizontal: &'a str,
    pub vertical: &'a str,
}

/// Expand a [`BorderGlyphs`] preset into its six runes.
///
/// Returns `None` for [`BorderGlyphs::None`] (explicit no-border) and
/// [`BorderGlyphs::Custom`] (callers must look at the variant's owned
/// strings directly; use [`border_glyphs_corners_or_custom`] when you
/// want both cases handled with one call).
#[must_use]
#[allow(clippy::ref_option)] // Match arms borrow the `&BorderGlyphs` input directly.
pub const fn border_glyphs_corners(choice: &BorderGlyphs) -> Option<BorderGlyphSet<'static>> {
    let set = match choice {
        BorderGlyphs::None | BorderGlyphs::Custom { .. } => return None,
        BorderGlyphs::Ascii => BorderGlyphSet {
            top_left: "+",
            top_right: "+",
            bottom_left: "+",
            bottom_right: "+",
            horizontal: "-",
            vertical: "|",
        },
        BorderGlyphs::AsciiFocused => BorderGlyphSet {
            top_left: "+",
            top_right: "+",
            bottom_left: "+",
            bottom_right: "+",
            horizontal: "=",
            vertical: "|",
        },
        BorderGlyphs::AsciiZoomed => BorderGlyphSet {
            top_left: "#",
            top_right: "#",
            bottom_left: "#",
            bottom_right: "#",
            horizontal: "=",
            vertical: "\u{2551}",
        },
        BorderGlyphs::SingleLine => BorderGlyphSet {
            top_left: "\u{250c}",
            top_right: "\u{2510}",
            bottom_left: "\u{2514}",
            bottom_right: "\u{2518}",
            horizontal: "\u{2500}",
            vertical: "\u{2502}",
        },
        BorderGlyphs::DoubleLine => BorderGlyphSet {
            top_left: "\u{2554}",
            top_right: "\u{2557}",
            bottom_left: "\u{255a}",
            bottom_right: "\u{255d}",
            horizontal: "\u{2550}",
            vertical: "\u{2551}",
        },
        BorderGlyphs::Rounded => BorderGlyphSet {
            top_left: "\u{256d}",
            top_right: "\u{256e}",
            bottom_left: "\u{2570}",
            bottom_right: "\u{256f}",
            horizontal: "\u{2500}",
            vertical: "\u{2502}",
        },
        BorderGlyphs::Thick => BorderGlyphSet {
            top_left: "\u{250f}",
            top_right: "\u{2513}",
            bottom_left: "\u{2517}",
            bottom_right: "\u{251b}",
            horizontal: "\u{2501}",
            vertical: "\u{2503}",
        },
        BorderGlyphs::HeavyDouble => BorderGlyphSet {
            top_left: "\u{250f}",
            top_right: "\u{2513}",
            bottom_left: "\u{2517}",
            bottom_right: "\u{251b}",
            horizontal: "\u{2550}",
            vertical: "\u{2551}",
        },
        BorderGlyphs::Dashed => BorderGlyphSet {
            top_left: "\u{250c}",
            top_right: "\u{2510}",
            bottom_left: "\u{2514}",
            bottom_right: "\u{2518}",
            horizontal: "\u{254c}",
            vertical: "\u{254e}",
        },
        BorderGlyphs::Dotted => BorderGlyphSet {
            top_left: "\u{250c}",
            top_right: "\u{2510}",
            bottom_left: "\u{2514}",
            bottom_right: "\u{2518}",
            horizontal: "\u{2508}",
            vertical: "\u{250a}",
        },
        BorderGlyphs::NerdPowerline => BorderGlyphSet {
            top_left: "\u{e0b6}",
            top_right: "\u{e0b4}",
            bottom_left: "\u{e0b6}",
            bottom_right: "\u{e0b4}",
            horizontal: " ",
            vertical: " ",
        },
    };
    Some(set)
}

/// Expand a [`BorderGlyphs`] into its six runes, handling
/// [`BorderGlyphs::Custom`] by borrowing the variant's owned strings.
/// Returns `None` only for [`BorderGlyphs::None`].
#[must_use]
pub fn border_glyphs_corners_or_custom(choice: &BorderGlyphs) -> Option<BorderGlyphSet<'_>> {
    match choice {
        BorderGlyphs::None => None,
        BorderGlyphs::Custom {
            top_left,
            top_right,
            bottom_left,
            bottom_right,
            horizontal,
            vertical,
        } => Some(BorderGlyphSet {
            top_left,
            top_right,
            bottom_left,
            bottom_right,
            horizontal,
            vertical,
        }),
        other => border_glyphs_corners(other),
    }
}