blizz-ui 3.0.0-dev.8

Self-rendering terminal UI components for the blizz wizard
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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
use std::io::Write;

use crossterm::{
  cursor::MoveTo,
  queue,
  style::{Attribute, Color, Print, ResetColor, SetAttribute, SetForegroundColor},
};
use rand::Rng;

use crate::decode;
use crate::layout::centered_column;
use crate::prompt::text_entry;
use crate::select_option::SelectOption;

const PREFIX_ACTIVE: &str = "\u{25b8} ";
const PREFIX_INACTIVE: &str = "  ";
const ARROW_UP: char = '\u{25b2}';
const ARROW_DOWN: char = '\u{25bc}';
const ELLIPSIS: &str = " \u{00b7}\u{00b7}\u{00b7} ";
const BORDER_VERTICAL: &str = "\u{2502}";
const BORDER_HORIZONTAL: &str = "\u{2500}";
const CORNER_TOP_LEFT: &str = "\u{256d}";
const CORNER_TOP_RIGHT: &str = "\u{256e}";
const CORNER_BOTTOM_LEFT: &str = "\u{2570}";
const CORNER_BOTTOM_RIGHT: &str = "\u{256f}";
const BORDER_TOP_OFFSET: u16 = 1;

const MAX_VISIBLE_OPTIONS: usize = 8;

/// Select list with scroll, open/reveal animation progress, and bordered layout.
#[derive(Debug, Clone)]
pub struct SelectorComponent {
  pub options: Vec<SelectOption>,
  pub selected: usize,
  pub scroll_offset: usize,
  pub visible: bool,
  pub open: f64,
  pub reveal: f64,
}

impl SelectorComponent {
  pub fn hidden() -> Self {
    Self {
      options: Vec::new(),
      selected: 0,
      scroll_offset: 0,
      visible: false,
      open: 0.0,
      reveal: 0.0,
    }
  }

  pub fn from_options(options: Vec<SelectOption>, default_index: usize) -> Self {
    Self {
      options,
      selected: default_index,
      scroll_offset: 0,
      visible: true,
      open: 0.0,
      reveal: 0.0,
    }
  }

  pub fn is_fully_open(&self) -> bool {
    self.open >= 1.0
  }

  pub fn is_fully_closed(&self) -> bool {
    self.open <= 0.0
  }

  pub fn is_fully_revealed(&self) -> bool {
    self.reveal >= 1.0
  }

  pub fn is_fully_hidden(&self) -> bool {
    self.reveal <= 0.0
  }

  /// How many option rows are visible for a list of this length (same cap as [`SelectorComponent::render`]).
  pub fn viewport_row_count(option_count: usize) -> usize {
    option_count.min(MAX_VISIBLE_OPTIONS)
  }

  #[cfg(not(tarpaulin_include))]
  pub fn render<W: Write, R: Rng>(
    &self,
    writer: &mut W,
    tw: u16,
    start_row: u16,
    rng: &mut R,
  ) -> std::io::Result<usize> {
    if self.options.is_empty() {
      return Ok(0);
    }

    let layout = SelectorLayout::compute(self, tw);

    if self.open < 1.0 {
      return render_partial_border(writer, self.open, &layout, start_row);
    }

    let scroll_offset = self.scroll_offset;
    let has_scroll_up = scroll_offset > 0;
    let has_scroll_down = scroll_offset + layout.max_visible < self.options.len();

    let mut row = start_row;

    let top = selector_border(layout.inner_width, has_scroll_up, true);
    queue!(
      writer,
      MoveTo(layout.col, row),
      SetForegroundColor(Color::DarkGrey),
      Print(&top),
      ResetColor
    )?;
    row += 1;

    render_selector_items(
      writer,
      self,
      &layout,
      row,
      has_scroll_up,
      has_scroll_down,
      rng,
    )?;
    row += layout.max_visible as u16;

    let bottom = selector_border(layout.inner_width, has_scroll_down, false);
    queue!(
      writer,
      MoveTo(layout.col, row),
      SetForegroundColor(Color::DarkGrey),
      Print(&bottom),
      ResetColor
    )?;

    Ok(layout.max_visible + 2)
  }
}

struct SelectorLayout {
  tw: u16,
  inner_width: u16,
  col: u16,
  max_visible: usize,
}

impl SelectorLayout {
  fn compute(sel: &SelectorComponent, tw: u16) -> Self {
    let total = sel.options.len();
    let max_visible = total.min(MAX_VISIBLE_OPTIONS);
    let inner_width = selector_inner_width(sel, tw);
    let outer_width = inner_width + 4;
    let col = centered_column(tw, outer_width);
    Self {
      tw,
      inner_width,
      col,
      max_visible,
    }
  }
}

fn selector_inner_width(sel: &SelectorComponent, tw: u16) -> u16 {
  let max_label = sel
    .options
    .iter()
    .map(|o| o.label.chars().count())
    .max()
    .unwrap_or(0);
  let prefix_width = PREFIX_ACTIVE.chars().count();
  let content_min = (prefix_width + max_label + 2) as u16;
  let entry_width = text_entry("", "", tw).inner_width;
  content_min.max(entry_width)
}

fn selector_border(inner_width: u16, has_overflow: bool, top: bool) -> String {
  let fill_total = inner_width as usize + 2;
  let (left_corner, right_corner) = if top {
    (CORNER_TOP_LEFT, CORNER_TOP_RIGHT)
  } else {
    (CORNER_BOTTOM_LEFT, CORNER_BOTTOM_RIGHT)
  };

  if !has_overflow {
    let fill: String = BORDER_HORIZONTAL.repeat(fill_total);
    return format!("{left_corner}{fill}{right_corner}");
  }

  let text_col = PREFIX_ACTIVE.chars().count() + 1;
  let leading_space = ELLIPSIS.chars().take_while(|c| *c == ' ').count();
  let prefix_offset = text_col.saturating_sub(leading_space);
  let ellipsis_len = ELLIPSIS.chars().count();
  let right_fill = fill_total.saturating_sub(prefix_offset + ellipsis_len);
  format!(
    "{}{}{}{}{}",
    left_corner,
    BORDER_HORIZONTAL.repeat(prefix_offset),
    ELLIPSIS,
    BORDER_HORIZONTAL.repeat(right_fill),
    right_corner,
  )
}

#[cfg(not(tarpaulin_include))]
fn render_partial_border<W: Write>(
  writer: &mut W,
  open_progress: f64,
  layout: &SelectorLayout,
  start_row: u16,
) -> std::io::Result<usize> {
  let raw = ((layout.inner_width as f64) * open_progress).round() as u16;
  let even = (raw / 2) * 2;
  let current_width = if even == 0 && raw > 0 {
    2
  } else {
    even.min(layout.inner_width)
  };

  if current_width == 0 {
    return Ok(0);
  }

  let col = centered_column(layout.tw, current_width + 4);

  let top = selector_border(current_width, false, true);
  let bottom = selector_border(current_width, false, false);
  let empty_inner: String = " ".repeat(current_width as usize + 2);

  queue!(
    writer,
    MoveTo(col, start_row),
    SetForegroundColor(Color::DarkGrey),
    Print(&top),
    ResetColor
  )?;

  for i in 0..layout.max_visible {
    let row = start_row + BORDER_TOP_OFFSET + i as u16;
    queue!(
      writer,
      MoveTo(col, row),
      SetForegroundColor(Color::DarkGrey),
      Print(BORDER_VERTICAL),
      Print(&empty_inner),
      Print(BORDER_VERTICAL),
      ResetColor
    )?;
  }

  let bottom_row = start_row + BORDER_TOP_OFFSET + layout.max_visible as u16;
  queue!(
    writer,
    MoveTo(col, bottom_row),
    SetForegroundColor(Color::DarkGrey),
    Print(&bottom),
    ResetColor
  )?;

  Ok(layout.max_visible + 2)
}

struct SelectorRowPaint<'a> {
  layout: &'a SelectorLayout,
  row: u16,
  opt_idx: usize,
  max_label_width: usize,
  pad_width: usize,
  arrow_char: char,
}

#[cfg(not(tarpaulin_include))]
fn render_selector_items<W: Write, R: Rng>(
  writer: &mut W,
  sel: &SelectorComponent,
  layout: &SelectorLayout,
  start_row: u16,
  has_scroll_up: bool,
  has_scroll_down: bool,
  rng: &mut R,
) -> std::io::Result<()> {
  let max_label_width = sel
    .options
    .iter()
    .map(|o| o.label.chars().count())
    .max()
    .unwrap_or(0);
  let pad_width = (layout.inner_width as usize)
    .saturating_sub(PREFIX_ACTIVE.chars().count() + max_label_width + 2);

  for i in 0..layout.max_visible {
    let opt_idx = sel.scroll_offset + i;
    if opt_idx >= sel.options.len() {
      break;
    }
    render_selector_item(
      writer,
      sel,
      SelectorRowPaint {
        layout,
        row: start_row + i as u16,
        opt_idx,
        max_label_width,
        pad_width,
        arrow_char: scroll_arrow_for(i, layout.max_visible, has_scroll_up, has_scroll_down),
      },
      rng,
    )?;
  }

  Ok(())
}

#[cfg(not(tarpaulin_include))]
fn render_selector_item<W: Write, R: Rng>(
  writer: &mut W,
  sel: &SelectorComponent,
  paint: SelectorRowPaint<'_>,
  rng: &mut R,
) -> std::io::Result<()> {
  let SelectorRowPaint {
    layout,
    row,
    opt_idx,
    max_label_width,
    pad_width,
    arrow_char,
  } = paint;

  let opt = &sel.options[opt_idx];
  let is_selected = opt_idx == sel.selected;

  let label = if sel.reveal < 1.0 {
    let revealed = (opt.label.chars().count() as f64 * sel.reveal).round() as usize;
    decode::decode_frame(&opt.label, revealed, rng)
  } else {
    opt.label.clone()
  };

  let prefix = if is_selected {
    PREFIX_ACTIVE
  } else {
    PREFIX_INACTIVE
  };

  let padded_label = format!("{:<width$}", label, width = max_label_width);

  queue!(
    writer,
    MoveTo(layout.col, row),
    SetForegroundColor(Color::DarkGrey),
    Print(BORDER_VERTICAL),
    Print(" "),
  )?;

  if is_selected {
    queue!(
      writer,
      SetForegroundColor(Color::White),
      SetAttribute(Attribute::Bold),
      Print(prefix),
      Print(&padded_label),
      SetAttribute(Attribute::Reset),
    )?;
  } else {
    queue!(
      writer,
      SetForegroundColor(Color::DarkGrey),
      Print(prefix),
      Print(&padded_label),
    )?;
  }

  let gap: String = " ".repeat(pad_width + 1);
  queue!(
    writer,
    SetForegroundColor(Color::DarkGrey),
    Print(format!("{gap}{arrow_char}")),
    Print(format!(" {BORDER_VERTICAL}")),
    ResetColor
  )
}

fn scroll_arrow_for(
  i: usize,
  max_visible: usize,
  has_scroll_up: bool,
  has_scroll_down: bool,
) -> char {
  if i == 0 && has_scroll_up {
    ARROW_UP
  } else if i == max_visible - 1 && has_scroll_down {
    ARROW_DOWN
  } else {
    ' '
  }
}

#[cfg(test)]
mod tests {
  use super::*;

  fn option(label: &str, value: &str) -> SelectOption {
    SelectOption {
      label: label.to_string(),
      value: value.to_string(),
    }
  }

  #[test]
  fn viewport_row_count_matches_render_cap() {
    assert_eq!(SelectorComponent::viewport_row_count(0), 0);
    assert_eq!(SelectorComponent::viewport_row_count(5), 5);
    assert_eq!(SelectorComponent::viewport_row_count(8), 8);
    assert_eq!(
      SelectorComponent::viewport_row_count(200),
      MAX_VISIBLE_OPTIONS
    );
  }

  #[test]
  fn is_fully_thresholds() {
    let mut s = SelectorComponent::from_options(vec![option("a", "a")], 0);
    s.open = 1.0;
    assert!(s.is_fully_open());
    s.open = 0.999;
    assert!(!s.is_fully_open());
    s.open = 0.0;
    assert!(s.is_fully_closed());
    s.open = -0.1;
    assert!(s.is_fully_closed());

    s.reveal = 1.0;
    assert!(s.is_fully_revealed());
    s.reveal = 0.999;
    assert!(!s.is_fully_revealed());
    s.reveal = 0.0;
    assert!(s.is_fully_hidden());
    s.reveal = 0.01;
    assert!(!s.is_fully_hidden());
  }

  #[test]
  fn scroll_arrow_for_branches() {
    assert_eq!(scroll_arrow_for(0, 4, true, false), ARROW_UP);
    assert_eq!(scroll_arrow_for(3, 4, false, true), ARROW_DOWN);
    assert_eq!(scroll_arrow_for(1, 4, true, true), ' ');
    assert_eq!(scroll_arrow_for(3, 4, true, false), ' ');
  }

  #[test]
  fn selector_layout_compute_places_column() {
    let sel = SelectorComponent::from_options(
      vec![option("short", "s"), option("much longer label", "m")],
      0,
    );
    let layout = SelectorLayout::compute(&sel, 120);
    assert_eq!(layout.max_visible, 2);
    assert_eq!(layout.tw, 120);
    assert!(layout.inner_width > 0);
    assert!(layout.col < 120);

    let empty = SelectorComponent::hidden();
    let layout_empty = SelectorLayout::compute(&empty, 80);
    assert_eq!(layout_empty.max_visible, 0);
  }

  #[test]
  fn selector_inner_width_tracks_longest_label() {
    let sel = SelectorComponent::from_options(vec![option("ab", "a"), option("abcdef", "b")], 0);
    let w = selector_inner_width(&sel, 200);
    assert!(w >= 6);

    let sel_empty = SelectorComponent::hidden();
    let w0 = selector_inner_width(&sel_empty, 80);
    assert!(w0 > 0);
  }

  #[test]
  fn selector_border_plain_and_overflow() {
    let plain_top = selector_border(10, false, true);
    assert!(plain_top.starts_with(CORNER_TOP_LEFT));
    assert!(plain_top.ends_with(CORNER_TOP_RIGHT));

    let plain_bot = selector_border(10, false, false);
    assert!(plain_bot.starts_with(CORNER_BOTTOM_LEFT));

    let overflow_top = selector_border(20, true, true);
    assert!(overflow_top.contains('\u{00b7}'));
  }
}