rat-ftable 2.2.0

ratatui table widget for large data
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
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
use crate::event::TableOutcome;
use crate::{TableSelection, TableState};
use rat_event::{HandleEvent, MouseOnly, Regular, ct_event, flow};
use rat_focus::HasFocus;
use rat_scrolled::ScrollAreaState;
use rat_scrolled::event::ScrollOutcome;
use ratatui_crossterm::crossterm::event::{Event, KeyModifiers};
use std::cmp::{max, min};
use std::collections::HashSet;
use std::mem;

/// Allows selection an active range of rows.
///
/// The current range can be retired to a set of selected rows,
/// and a new range be started. This allows multiple interval
/// selection and deselection of certain rows.
///
/// This one only supports row-selection.
#[derive(Debug, Default, Clone)]
pub struct RowSetSelection {
    /// Start of the active selection.
    pub anchor_row: Option<usize>,
    /// Current end of the active selection.
    pub lead_row: Option<usize>,
    /// Retired rows. This doesn't contain the rows
    /// between anchor and lead.
    ///
    /// You can call [RowSetSelection::retire_selection] to
    /// add the anchor-lead range. This resets anchor and lead though.
    /// Or iterate the complete range and call [RowSetSelection::is_selected_row].
    pub selected: HashSet<usize>,
}

impl TableSelection for RowSetSelection {
    fn count(&self) -> usize {
        let n = if let Some(anchor) = self.anchor_row {
            if let Some(lead) = self.lead_row {
                lead.abs_diff(anchor) + 1
            } else {
                0
            }
        } else {
            0
        };

        n + self.selected.len()
    }

    #[allow(clippy::collapsible_else_if)]
    #[allow(clippy::collapsible_if)]
    fn is_selected_row(&self, row: usize) -> bool {
        if let Some(mut anchor) = self.anchor_row {
            if let Some(mut lead) = self.lead_row {
                if lead < anchor {
                    mem::swap(&mut lead, &mut anchor);
                }
                if row >= anchor && row <= lead {
                    return true;
                }
            }
        } else {
            if let Some(lead) = self.lead_row {
                if row == lead {
                    return true;
                }
            }
        }

        self.selected.contains(&row)
    }

    fn is_selected_column(&self, _column: usize) -> bool {
        false
    }

    fn is_selected_cell(&self, _column: usize, _row: usize) -> bool {
        false
    }

    fn lead_selection(&self) -> Option<(usize, usize)> {
        self.lead_row.map(|srow| (0, srow))
    }

    fn validate_rows(&mut self, rows: usize) {
        if let Some(lead_row) = self.lead_row {
            if rows == 0 {
                self.lead_row = None;
            } else if lead_row >= rows {
                self.lead_row = Some(rows - 1);
            }
        }
        if let Some(anchor_row) = self.anchor_row {
            if rows == 0 {
                self.anchor_row = None;
            } else if anchor_row >= rows {
                self.anchor_row = Some(rows - 1);
            }
        }
        self.selected.retain(|v| *v < rows);
    }

    fn validate_cols(&mut self, _cols: usize) {}

    fn items_added(&mut self, pos: usize, n: usize) {
        if let Some(lead_row) = self.lead_row {
            if lead_row > pos {
                self.lead_row = Some(lead_row + n);
            }
        }
        if let Some(anchor_row) = self.anchor_row {
            if anchor_row > pos {
                self.anchor_row = Some(anchor_row + n);
            }
        }
        let corr = self.selected.extract_if(|v| *v > pos).collect::<Vec<_>>();
        for v in corr {
            self.selected.insert(v + n);
        }
    }

    fn items_removed(&mut self, pos: usize, n: usize, rows: usize) {
        if let Some(lead_row) = self.lead_row {
            if rows == 0 {
                self.lead_row = None;
            } else if lead_row == pos && lead_row + n >= rows {
                self.lead_row = Some(rows.saturating_sub(1))
            } else if lead_row > pos {
                self.lead_row = Some(lead_row.saturating_sub(n).min(pos));
            }
        }
        if let Some(anchor_row) = self.anchor_row {
            if rows == 0 {
                self.anchor_row = None;
            } else if anchor_row == pos && anchor_row + n >= rows {
                self.anchor_row = Some(rows.saturating_sub(1))
            } else if anchor_row > pos {
                self.anchor_row = Some(anchor_row.saturating_sub(n).min(pos));
            }
        }
        let corr = self.selected.extract_if(|v| *v > pos).collect::<Vec<_>>();
        for v in corr {
            if rows == 0 {
                // removed
            } else if v == pos && v + n >= rows {
                self.selected.insert(rows.saturating_sub(1));
            } else if v > pos {
                self.selected.insert(v.saturating_sub(n).min(pos));
            }
        }
    }
}

impl RowSetSelection {
    /// New selection.
    pub fn new() -> RowSetSelection {
        RowSetSelection {
            anchor_row: None,
            lead_row: None,
            selected: HashSet::new(),
        }
    }

    /// Clear the selection.
    pub fn clear(&mut self) {
        self.anchor_row = None;
        self.lead_row = None;
        self.selected.clear();
    }

    /// Current lead.
    pub fn lead(&self) -> Option<usize> {
        self.lead_row
    }

    /// Current anchor.
    pub fn anchor(&self) -> Option<usize> {
        self.anchor_row
    }

    /// Set of all selected rows. Clones the retired set and adds the current anchor..lead range.
    pub fn selected(&self) -> HashSet<usize> {
        let mut selected = self.selected.clone();
        Self::fill(self.anchor_row, self.lead_row, &mut selected);
        selected
    }

    /// Has some selection.
    pub fn has_selection(&self) -> bool {
        self.lead_row.is_some() || !self.selected.is_empty()
    }

    /// Set a new lead. Maybe extend the range.
    pub fn set_lead(&mut self, lead: Option<usize>, extend: bool) -> bool {
        let old_selection = (self.anchor_row, self.lead_row);
        self.extend(extend);
        self.lead_row = lead;
        old_selection != (self.anchor_row, self.lead_row)
    }

    /// Transfers the range anchor to lead to the selection set and reset both.
    pub fn retire_selection(&mut self) {
        Self::fill(self.anchor_row, self.lead_row, &mut self.selected);
        self.anchor_row = None;
        self.lead_row = None;
    }

    /// Add to selection. Only works for retired selections, not for the
    /// active anchor-lead range.
    pub fn add(&mut self, idx: usize) {
        self.selected.insert(idx);
    }

    /// Remove from selection. Only works for retired selections, not for the
    /// active anchor-lead range.
    pub fn remove(&mut self, idx: usize) {
        self.selected.remove(&idx);
    }

    /// Set a new lead, at the same time limit the lead to max.
    pub fn move_to(&mut self, lead: usize, max: usize, extend: bool) -> bool {
        let old_selection = (self.anchor_row, self.lead_row);
        self.extend(extend);
        if lead <= max {
            self.lead_row = Some(lead);
        } else {
            self.lead_row = Some(max);
        }
        old_selection != (self.anchor_row, self.lead_row)
    }

    /// Select next. Maybe extend the range.
    pub fn move_down(&mut self, n: usize, maximum: usize, extend: bool) -> bool {
        let old_selection = (self.anchor_row, self.lead_row);
        self.extend(extend);
        self.lead_row = Some(self.lead_row.map_or(0, |v| min(v + n, maximum)));
        old_selection != (self.anchor_row, self.lead_row)
    }

    /// Select next. Maybe extend the range.
    pub fn move_up(&mut self, n: usize, maximum: usize, extend: bool) -> bool {
        let old_selection = (self.anchor_row, self.lead_row);
        self.extend(extend);
        self.lead_row = Some(self.lead_row.map_or(maximum, |v| v.saturating_sub(n)));
        old_selection != (self.anchor_row, self.lead_row)
    }

    fn extend(&mut self, extend: bool) {
        if extend {
            if self.anchor_row.is_none() {
                self.anchor_row = self.lead_row;
            }
        } else {
            self.anchor_row = None;
            self.selected.clear();
        }
    }

    #[allow(clippy::collapsible_else_if)]
    fn fill(anchor: Option<usize>, lead: Option<usize>, selection: &mut HashSet<usize>) {
        if let Some(mut anchor) = anchor {
            if let Some(mut lead) = lead {
                if lead < anchor {
                    mem::swap(&mut lead, &mut anchor);
                }

                for n in anchor..=lead {
                    selection.insert(n);
                }
            }
        } else {
            if let Some(lead) = lead {
                selection.insert(lead);
            }
        }
    }
}

impl HandleEvent<Event, Regular, TableOutcome> for TableState<RowSetSelection> {
    fn handle(&mut self, event: &Event, _: Regular) -> TableOutcome {
        let res = if self.is_focused() {
            match event {
                ct_event!(keycode press Up) => {
                    if self.move_up(1, false) {
                        TableOutcome::Selected
                    } else {
                        TableOutcome::Unchanged
                    }
                }
                ct_event!(keycode press Down) => {
                    if self.move_down(1, false) {
                        TableOutcome::Selected
                    } else {
                        TableOutcome::Unchanged
                    }
                }
                ct_event!(keycode press CONTROL-Up)
                | ct_event!(keycode press CONTROL-Home)
                | ct_event!(keycode press Home) => {
                    if self.move_to(0, false) {
                        TableOutcome::Selected
                    } else {
                        TableOutcome::Unchanged
                    }
                }
                ct_event!(keycode press CONTROL-Down)
                | ct_event!(keycode press CONTROL-End)
                | ct_event!(keycode press End) => {
                    if self.move_to(self.rows.saturating_sub(1), false) {
                        TableOutcome::Selected
                    } else {
                        TableOutcome::Unchanged
                    }
                }
                ct_event!(keycode press PageUp) => {
                    if self.move_up(max(1, self.page_len().saturating_sub(1)), false) {
                        TableOutcome::Selected
                    } else {
                        TableOutcome::Unchanged
                    }
                }
                ct_event!(keycode press PageDown) => {
                    if self.move_down(max(1, self.page_len().saturating_sub(1)), false) {
                        TableOutcome::Selected
                    } else {
                        TableOutcome::Unchanged
                    }
                }
                ct_event!(keycode press SHIFT-Up) => {
                    if self.move_up(1, true) {
                        TableOutcome::Selected
                    } else {
                        TableOutcome::Unchanged
                    }
                }
                ct_event!(keycode press SHIFT-Down) => {
                    if self.move_down(1, true) {
                        TableOutcome::Selected
                    } else {
                        TableOutcome::Unchanged
                    }
                }
                ct_event!(keycode press CONTROL_SHIFT-Up)
                | ct_event!(keycode press CONTROL_SHIFT-Home)
                | ct_event!(keycode press SHIFT-Home) => {
                    if self.move_to(0, true) {
                        TableOutcome::Selected
                    } else {
                        TableOutcome::Unchanged
                    }
                }
                ct_event!(keycode press CONTROL_SHIFT-Down)
                | ct_event!(keycode press CONTROL_SHIFT-End)
                | ct_event!(keycode press SHIFT-End) => {
                    if self.move_to(self.rows.saturating_sub(1), true) {
                        TableOutcome::Selected
                    } else {
                        TableOutcome::Unchanged
                    }
                }
                ct_event!(keycode press SHIFT-PageUp) => {
                    if self.move_up(max(1, self.page_len().saturating_sub(1)), true) {
                        TableOutcome::Selected
                    } else {
                        TableOutcome::Unchanged
                    }
                }
                ct_event!(keycode press SHIFT-PageDown) => {
                    if self.move_down(max(1, self.page_len().saturating_sub(1)), true) {
                        TableOutcome::Selected
                    } else {
                        TableOutcome::Unchanged
                    }
                }
                ct_event!(keycode press Left) => {
                    if self.scroll_left(1) {
                        TableOutcome::Changed
                    } else {
                        TableOutcome::Unchanged
                    }
                }
                ct_event!(keycode press Right) => {
                    if self.scroll_right(1) {
                        TableOutcome::Changed
                    } else {
                        TableOutcome::Unchanged
                    }
                }
                ct_event!(keycode press CONTROL-Left) => {
                    if self.scroll_to_x(0) {
                        TableOutcome::Changed
                    } else {
                        TableOutcome::Unchanged
                    }
                }
                ct_event!(keycode press CONTROL-Right) => {
                    if self.scroll_to_x(self.x_max_offset()) {
                        TableOutcome::Changed
                    } else {
                        TableOutcome::Unchanged
                    }
                }
                _ => TableOutcome::Continue,
            }
        } else {
            TableOutcome::Continue
        };

        if res == TableOutcome::Continue {
            self.handle(event, MouseOnly)
        } else {
            res
        }
    }
}

impl HandleEvent<Event, MouseOnly, TableOutcome> for TableState<RowSetSelection> {
    fn handle(&mut self, event: &Event, _: MouseOnly) -> TableOutcome {
        if !self.has_mouse_focus() {
            return TableOutcome::Continue;
        }

        flow!(match event {
            ct_event!(mouse any for m) | ct_event!(mouse any CONTROL for m)
                if self.mouse.drag(self.table_area, m)
                    || self.mouse.drag2(self.table_area, m, KeyModifiers::CONTROL) =>
            {
                if self.move_to(self.row_at_drag((m.column, m.row)), true) {
                    TableOutcome::Selected
                } else {
                    TableOutcome::Unchanged
                }
            }
            ct_event!(mouse down Left for column, row) => {
                let pos = (*column, *row);
                if self.table_area.contains(pos.into()) {
                    if let Some(new_row) = self.row_at_clicked(pos) {
                        if self.move_to(new_row, false) {
                            TableOutcome::Selected
                        } else {
                            TableOutcome::Unchanged
                        }
                    } else {
                        TableOutcome::Continue
                    }
                } else {
                    TableOutcome::Continue
                }
            }
            ct_event!(mouse down ALT-Left for column, row) => {
                let pos = (*column, *row);
                if self.area.contains(pos.into()) {
                    if let Some(new_row) = self.row_at_clicked(pos) {
                        if self.move_to(new_row, true) {
                            TableOutcome::Selected
                        } else {
                            TableOutcome::Unchanged
                        }
                    } else {
                        TableOutcome::Continue
                    }
                } else {
                    TableOutcome::Continue
                }
            }
            ct_event!(mouse down CONTROL-Left for column, row) => {
                let pos = (*column, *row);
                if self.area.contains(pos.into()) {
                    if let Some(new_row) = self.row_at_clicked(pos) {
                        self.retire_selection();
                        if self.selection.is_selected_row(new_row) {
                            self.selection.remove(new_row);
                        } else {
                            self.move_to(new_row, true);
                        }
                        TableOutcome::Selected
                    } else {
                        TableOutcome::Continue
                    }
                } else {
                    TableOutcome::Continue
                }
            }
            _ => TableOutcome::Continue,
        });

        let mut sas = ScrollAreaState::new()
            .area(self.inner)
            .h_scroll(&mut self.hscroll)
            .v_scroll(&mut self.vscroll);

        match sas.handle(event, MouseOnly) {
            ScrollOutcome::Up(v) => {
                if self.scroll_up(v) {
                    TableOutcome::Changed
                } else {
                    TableOutcome::Unchanged
                }
            }
            ScrollOutcome::Down(v) => {
                if self.scroll_down(v) {
                    TableOutcome::Changed
                } else {
                    TableOutcome::Unchanged
                }
            }
            ScrollOutcome::VPos(v) => {
                if self.set_row_offset(self.vscroll.limited_offset(v)) {
                    TableOutcome::Changed
                } else {
                    TableOutcome::Unchanged
                }
            }
            ScrollOutcome::Left(v) => {
                if self.scroll_left(v) {
                    TableOutcome::Changed
                } else {
                    TableOutcome::Unchanged
                }
            }
            ScrollOutcome::Right(v) => {
                if self.scroll_right(v) {
                    TableOutcome::Changed
                } else {
                    TableOutcome::Unchanged
                }
            }
            ScrollOutcome::HPos(v) => {
                if self.set_x_offset(self.hscroll.limited_offset(v)) {
                    TableOutcome::Changed
                } else {
                    TableOutcome::Unchanged
                }
            }

            ScrollOutcome::Continue => TableOutcome::Continue,
            ScrollOutcome::Unchanged => TableOutcome::Unchanged,
            ScrollOutcome::Changed => TableOutcome::Changed,
        }
    }
}

/// Handle all events.
/// Table events are only processed if focus is true.
/// Mouse events are processed if they are in range.
pub fn handle_events(
    state: &mut TableState<RowSetSelection>,
    focus: bool,
    event: &Event,
) -> TableOutcome {
    state.focus.set(focus);
    state.handle(event, Regular)
}

/// Handle only mouse-events.
pub fn handle_mouse_events(state: &mut TableState<RowSetSelection>, event: &Event) -> TableOutcome {
    state.handle(event, MouseOnly)
}