reovim-client-driver 0.14.4

Platform-agnostic trait contracts for Reovim client modules
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
113
114
115
116
117
118
119
120
121

//! Bounded rendering surface that clips and offsets coordinates.
//!
//! `ScopedSurface` wraps any `&mut dyn RenderSurface` with a `Rect` bounds.
//! All drawing operations are automatically offset to the bounds origin and
//! clipped to the bounds dimensions. Modules use this to render into their
//! allocated chrome region without manual coordinate arithmetic.
//!
//! # Example
//!
//! ```ignore
//! let mut scoped = ScopedSurface::new(&mut surface, bounds);
//! // (0, 0) in scoped == (bounds.x, bounds.y) in the inner surface
//! scoped.write_styled(0, 0, "hello", style);
//! ```

use crate::{Rect, RenderSurface, Style, types::Color};

/// A rendering surface that clips and offsets all operations to a bounded region.
///
/// Created via `ScopedSurface::new()` (standalone constructor, not a trait method,
/// to preserve `RenderSurface` object safety).
pub struct ScopedSurface<'a> {
    inner: &'a mut dyn RenderSurface,
    bounds: Rect,
}

impl<'a> ScopedSurface<'a> {
    /// Create a scoped surface that renders within the given bounds.
    ///
    /// All coordinates passed to `RenderSurface` methods are relative to the
    /// bounds origin (`bounds.x`, `bounds.y`). Operations outside the bounds
    /// are silently clipped.
    #[must_use]
    pub fn new(inner: &'a mut dyn RenderSurface, bounds: Rect) -> Self {
        Self { inner, bounds }
    }
}

impl RenderSurface for ScopedSurface<'_> {
    fn write_styled(&mut self, x: u16, y: u16, text: &str, style: Style) -> u16 {
        if y >= self.bounds.height || x >= self.bounds.width {
            return 0;
        }
        let abs_x = self.bounds.x.saturating_add(x);
        let abs_y = self.bounds.y.saturating_add(y);
        let max_cols = self.bounds.width.saturating_sub(x);
        // Truncate text to fit within bounds
        let truncated = truncate_to_cols(text, max_cols);
        if truncated.is_empty() {
            return 0;
        }
        self.inner.write_styled(abs_x, abs_y, truncated, style)
    }

    fn apply_style(&mut self, x: u16, y: u16, style: Style) {
        if y >= self.bounds.height || x >= self.bounds.width {
            return;
        }
        let abs_x = self.bounds.x.saturating_add(x);
        let abs_y = self.bounds.y.saturating_add(y);
        self.inner.apply_style(abs_x, abs_y, style);
    }

    fn overlay_bg(&mut self, x: u16, y: u16, bg: Color) {
        if y >= self.bounds.height || x >= self.bounds.width {
            return;
        }
        let abs_x = self.bounds.x.saturating_add(x);
        let abs_y = self.bounds.y.saturating_add(y);
        self.inner.overlay_bg(abs_x, abs_y, bg);
    }

    fn fill(&mut self, rect: Rect, ch: char, style: Style) {
        if let Some(clipped) =
            self.bounds
                .intersect(&offset_rect(rect, self.bounds.x, self.bounds.y))
        {
            self.inner.fill(clipped, ch, style);
        }
    }

    fn clear(&mut self, rect: Rect) {
        if let Some(clipped) =
            self.bounds
                .intersect(&offset_rect(rect, self.bounds.x, self.bounds.y))
        {
            self.inner.clear(clipped);
        }
    }

    fn size(&self) -> (u16, u16) {
        (self.bounds.width, self.bounds.height)
    }
}

/// Offset a rect's origin by (dx, dy) using saturating addition.
const fn offset_rect(rect: Rect, dx: u16, dy: u16) -> Rect {
    Rect::new(rect.x.saturating_add(dx), rect.y.saturating_add(dy), rect.width, rect.height)
}

/// Truncate a string to fit within `max_cols` columns.
fn truncate_to_cols(text: &str, max_cols: u16) -> &str {
    use unicode_width::UnicodeWidthChar;

    let max = max_cols as usize;
    let mut cols = 0;
    let mut byte_end = 0;
    for ch in text.chars() {
        let w = ch.width().unwrap_or(0);
        if cols + w > max {
            break;
        }
        cols += w;
        byte_end += ch.len_utf8();
    }
    &text[..byte_end]
}

#[cfg(test)]
#[path = "scoped_surface_tests.rs"]
mod tests;