urushi 0.1.1

Composable styling, components, and terminal rendering for Rust CLIs
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
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
//! A finite-viewport position and its selectable terminal presentation.

use crate::{
    BlockStyle, Canvas, CanvasContext, CanvasItem, CellContribution, Composition, Grapheme, Length,
    Position, PositionedCell, PrintableText, ScrollbarRole, TextStyle, View,
};

/// The axis along which a [`Scrollbar`] describes a viewport.
///
/// Orientation does not choose an edge. A parent `View` places a vertical
/// scrollbar on the left or right, or a horizontal scrollbar above or below
/// its content.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash)]
pub enum ScrollbarOrientation {
    /// The viewport moves through rows.
    #[default]
    Vertical,
    /// The viewport moves through columns.
    Horizontal,
}

/// How a [`ScrollbarPresentation`] represents the visible viewport on its track.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash)]
pub enum ScrollbarThumbSizing {
    /// Size the thumb in proportion to the visible share of the content.
    #[default]
    Proportional,
    /// Draw one cell that represents position without representing viewport size.
    Marker,
}

/// Immutable semantic input for one finite-viewport position indicator.
///
/// Lengths and positions use caller-defined content units. They may be rows,
/// columns, items, or another uniform unit, provided all three values use the
/// same unit. Rendering clamps `position` to the last origin at which the
/// viewport remains within the content.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct Scrollbar {
    orientation: ScrollbarOrientation,
    content_length: usize,
    viewport_length: usize,
    position: usize,
}

impl Scrollbar {
    /// Creates a scrollbar at the beginning of its content.
    pub const fn new(
        orientation: ScrollbarOrientation,
        content_length: usize,
        viewport_length: usize,
    ) -> Self {
        Self {
            orientation,
            content_length,
            viewport_length,
            position: 0,
        }
    }

    /// Replaces the requested viewport origin.
    ///
    /// The presentation clamps an out-of-range value after accounting for the
    /// current content and viewport lengths.
    #[must_use]
    pub const fn position(mut self, position: usize) -> Self {
        self.position = position;
        self
    }

    pub const fn orientation(&self) -> ScrollbarOrientation {
        self.orientation
    }

    pub const fn content_length(&self) -> usize {
        self.content_length
    }

    pub const fn viewport_length(&self) -> usize {
        self.viewport_length
    }

    pub const fn get_position(&self) -> usize {
        self.position
    }
}

/// The four glyphs used along one scrollbar orientation.
///
/// The thumb is required. Track and endpoint glyphs are optional, allowing a
/// presentation to range from a conventional arrowed rail to a thumb-only
/// indicator. Every present glyph must be exactly one printable, one-cell
/// grapheme.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ScrollbarGlyphs {
    thumb: String,
    track: Option<String>,
    begin: Option<String>,
    end: Option<String>,
}

impl ScrollbarGlyphs {
    /// Creates a thumb-only glyph set.
    ///
    /// # Panics
    ///
    /// Panics unless `thumb` is exactly one printable, one-cell grapheme.
    pub fn new(thumb: impl Into<String>) -> Self {
        Self {
            thumb: checked_glyph(thumb),
            track: None,
            begin: None,
            end: None,
        }
    }

    /// Replaces or removes the track glyph.
    ///
    /// # Panics
    ///
    /// Panics unless a present glyph is exactly one printable, one-cell
    /// grapheme.
    #[must_use]
    pub fn track(mut self, track: Option<&str>) -> Self {
        self.track = track.map(checked_glyph);
        self
    }

    /// Replaces or removes the beginning glyph.
    ///
    /// # Panics
    ///
    /// Panics unless a present glyph is exactly one printable, one-cell
    /// grapheme.
    #[must_use]
    pub fn begin(mut self, begin: Option<&str>) -> Self {
        self.begin = begin.map(checked_glyph);
        self
    }

    /// Replaces or removes the ending glyph.
    ///
    /// # Panics
    ///
    /// Panics unless a present glyph is exactly one printable, one-cell
    /// grapheme.
    #[must_use]
    pub fn end(mut self, end: Option<&str>) -> Self {
        self.end = end.map(checked_glyph);
        self
    }

    pub fn get_thumb(&self) -> &str {
        &self.thumb
    }

    pub fn get_track(&self) -> Option<&str> {
        self.track.as_deref()
    }

    pub fn get_begin(&self) -> Option<&str> {
        self.begin.as_deref()
    }

    pub fn get_end(&self) -> Option<&str> {
        self.end.as_deref()
    }
}

fn checked_glyph(glyph: impl Into<String>) -> String {
    let glyph = glyph.into();
    assert!(
        !glyph.chars().any(char::is_control),
        "a scrollbar glyph must not contain control characters: {glyph:?}"
    );
    let mut graphemes = PrintableText::new(&glyph).graphemes();
    let first = graphemes.next();
    assert!(
        first.is_some() && graphemes.next().is_none(),
        "a scrollbar glyph must be exactly one grapheme: {glyph:?}"
    );
    assert_eq!(
        first.map(Grapheme::width),
        Some(1),
        "a scrollbar glyph must occupy exactly one terminal cell: {glyph:?}"
    );
    drop(graphemes);
    glyph
}

/// Selectable visual and geometric policy for a [`Scrollbar`].
///
/// The presentation stores separate glyph sets for both orientations so the
/// same value can compose vertical and horizontal semantic scrollbars. A
/// caller can clone a Theme-owned presentation and replace either set or any
/// logical part style without changing the semantic value.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ScrollbarPresentation {
    vertical_glyphs: ScrollbarGlyphs,
    horizontal_glyphs: ScrollbarGlyphs,
    styles: [TextStyle; 4],
    thumb_sizing: ScrollbarThumbSizing,
}

impl ScrollbarPresentation {
    /// Creates a proportional presentation with conventional thin rails.
    pub fn new(thumb_style: TextStyle, track_style: TextStyle) -> Self {
        Self {
            vertical_glyphs: ScrollbarGlyphs::new("█")
                .track(Some("│"))
                .begin(Some("↑"))
                .end(Some("↓")),
            horizontal_glyphs: ScrollbarGlyphs::new("█")
                .track(Some("─"))
                .begin(Some("←"))
                .end(Some("→")),
            styles: [
                thumb_style,
                track_style.clone(),
                track_style.clone(),
                track_style,
            ],
            thumb_sizing: ScrollbarThumbSizing::Proportional,
        }
    }

    pub fn get_glyphs(&self, orientation: ScrollbarOrientation) -> &ScrollbarGlyphs {
        match orientation {
            ScrollbarOrientation::Vertical => &self.vertical_glyphs,
            ScrollbarOrientation::Horizontal => &self.horizontal_glyphs,
        }
    }

    /// Replaces the glyph set for one orientation.
    #[must_use]
    pub fn glyphs(mut self, orientation: ScrollbarOrientation, glyphs: ScrollbarGlyphs) -> Self {
        match orientation {
            ScrollbarOrientation::Vertical => self.vertical_glyphs = glyphs,
            ScrollbarOrientation::Horizontal => self.horizontal_glyphs = glyphs,
        }
        self
    }

    pub const fn get_thumb_sizing(&self) -> ScrollbarThumbSizing {
        self.thumb_sizing
    }

    /// Replaces the policy that maps viewport state onto the track.
    #[must_use]
    pub const fn thumb_sizing(mut self, thumb_sizing: ScrollbarThumbSizing) -> Self {
        self.thumb_sizing = thumb_sizing;
        self
    }

    pub fn get_style(&self, role: ScrollbarRole) -> &TextStyle {
        &self.styles[role.index()]
    }

    /// Replaces one complete logical part style.
    #[must_use]
    pub fn style(mut self, role: ScrollbarRole, style: TextStyle) -> Self {
        self.styles[role.index()] = style;
        self
    }

    #[must_use]
    pub fn thumb_style(self, style: TextStyle) -> Self {
        self.style(ScrollbarRole::Thumb, style)
    }

    #[must_use]
    pub fn track_style(self, style: TextStyle) -> Self {
        self.style(ScrollbarRole::Track, style)
    }

    #[must_use]
    pub fn begin_style(self, style: TextStyle) -> Self {
        self.style(ScrollbarRole::Begin, style)
    }

    #[must_use]
    pub fn end_style(self, style: TextStyle) -> Self {
        self.style(ScrollbarRole::End, style)
    }

    /// Composes the semantic viewport state into a one-cell-cross-axis View.
    ///
    /// The main axis remains area-dependent. Resolving a vertical scrollbar
    /// therefore requires a finite height, and resolving a horizontal one
    /// requires a finite width.
    pub fn compose(&self, scrollbar: &Scrollbar) -> View {
        let item = ScrollbarItem {
            scrollbar: *scrollbar,
            glyphs: self.get_glyphs(scrollbar.orientation).clone(),
            styles: self.styles.clone(),
            thumb_sizing: self.thumb_sizing,
        };
        let canvas = View::canvas(Canvas::new().item(item));
        let style = match scrollbar.orientation {
            ScrollbarOrientation::Vertical => BlockStyle::new()
                .width(Length::Cells(1))
                .height(Length::fill(1)),
            ScrollbarOrientation::Horizontal => BlockStyle::new()
                .width(Length::fill(1))
                .height(Length::Cells(1)),
        };
        View::block(style, canvas)
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
struct ScrollbarItem {
    scrollbar: Scrollbar,
    glyphs: ScrollbarGlyphs,
    styles: [TextStyle; 4],
    thumb_sizing: ScrollbarThumbSizing,
}

impl CanvasItem for ScrollbarItem {
    fn draw(&self, context: &mut CanvasContext) {
        if self.scrollbar.content_length == 0 {
            return;
        }
        let extent = match self.scrollbar.orientation {
            ScrollbarOrientation::Vertical => context.size().height(),
            ScrollbarOrientation::Horizontal => context.size().width(),
        };
        if extent == 0 {
            return;
        }

        let endpoint_count = usize::from(self.glyphs.begin.is_some())
            .saturating_add(usize::from(self.glyphs.end.is_some()));
        let show_endpoints = extent >= endpoint_count.saturating_add(1);
        let begin = show_endpoints
            .then_some(self.glyphs.begin.as_deref())
            .flatten();
        let end = show_endpoints
            .then_some(self.glyphs.end.as_deref())
            .flatten();
        let track_origin = usize::from(begin.is_some());
        let track_length = extent
            .saturating_sub(track_origin)
            .saturating_sub(usize::from(end.is_some()));
        if track_length == 0 {
            return;
        }

        if let Some(begin) = begin {
            self.draw_part(context, 0, begin, ScrollbarRole::Begin);
        }
        if let Some(track) = self.glyphs.track.as_deref() {
            let cells = (0..track_length).map(|offset| {
                self.cell(
                    track_origin.saturating_add(offset),
                    track,
                    ScrollbarRole::Track,
                )
            });
            context.cells_with(cells, Composition::Replace);
        }
        if let Some(end) = end {
            self.draw_part(
                context,
                track_origin.saturating_add(track_length),
                end,
                ScrollbarRole::End,
            );
        }

        let (thumb_start, thumb_length) = self.thumb_geometry(track_length);
        let cells = (0..thumb_length).map(|offset| {
            self.cell(
                track_origin
                    .saturating_add(thumb_start)
                    .saturating_add(offset),
                &self.glyphs.thumb,
                ScrollbarRole::Thumb,
            )
        });
        context.cells_with(cells, Composition::Replace);
    }
}

impl ScrollbarItem {
    fn thumb_geometry(&self, track_length: usize) -> (usize, usize) {
        let content = self.scrollbar.content_length;
        let viewport = self.scrollbar.viewport_length.min(content);
        let maximum = content.saturating_sub(viewport);
        let position = self.scrollbar.position.min(maximum);

        match self.thumb_sizing {
            ScrollbarThumbSizing::Proportional => {
                if maximum == 0 {
                    return (0, track_length);
                }
                let length = scale_round(viewport, track_length, content).clamp(1, track_length);
                let travel = track_length.saturating_sub(length);
                (scale_round(position, travel, maximum), length)
            }
            ScrollbarThumbSizing::Marker => {
                let travel = track_length.saturating_sub(1);
                let start = if maximum == 0 {
                    0
                } else {
                    scale_round(position, travel, maximum)
                };
                (start, 1)
            }
        }
    }

    fn draw_part(
        &self,
        context: &mut CanvasContext,
        offset: usize,
        glyph: &str,
        role: ScrollbarRole,
    ) {
        context.cells_with([self.cell(offset, glyph, role)], Composition::Replace);
    }

    fn cell(&self, offset: usize, glyph: &str, role: ScrollbarRole) -> PositionedCell {
        let position = match self.scrollbar.orientation {
            ScrollbarOrientation::Vertical => Position::new(0, coordinate(offset)),
            ScrollbarOrientation::Horizontal => Position::new(coordinate(offset), 0),
        };
        PositionedCell::new(
            position,
            CellContribution::new()
                .symbol(Grapheme::new(glyph))
                .style(self.styles[role.index()].clone()),
        )
    }
}

fn scale_round(value: usize, scale: usize, denominator: usize) -> usize {
    debug_assert!(denominator > 0);
    let numerator = (value as u128).saturating_mul(scale as u128);
    let rounded = numerator.saturating_add((denominator / 2) as u128) / denominator as u128;
    usize::try_from(rounded).unwrap_or(usize::MAX)
}

fn coordinate(value: usize) -> i64 {
    i64::try_from(value).unwrap_or(i64::MAX)
}