termi 0.1.5

A modal terminal code editor written in Rust
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

//! # File tree
//!
//! **Purpose:** the side panel listing the project's files.
//!
//! **Responsibility:** draw a flattened [`Tree`](crate::filesystem::tree::Tree)
//! with indentation, folder markers and a selection highlight, scrolled so the
//! selected row stays visible. The tree itself decides what is expanded; this
//! widget only draws it.
//!
//! **Public API:** [`FileTree`].

use ratatui::buffer::Buffer as Surface;
use ratatui::layout::Rect;
use ratatui::text::{Line, Span};
use ratatui::widgets::{Block, BorderType, Borders, Widget};

use crate::filesystem::tree::Entry;
use crate::theme::Theme;

/// The file browser panel.
pub struct FileTree<'a> {
    /// Rows to draw, already flattened.
    pub entries: &'a [Entry],
    /// Index of the highlighted row.
    pub selected: usize,
    /// Whether the panel has keyboard focus.
    pub focused: bool,
    /// Title shown on the border, usually the root directory's name.
    pub title: &'a str,
    /// Colours.
    pub theme: &'a Theme,
}

impl FileTree<'_> {
    /// First row to draw so `selected` is visible in a panel `height` tall.
    fn scroll_offset(&self, height: usize) -> usize {
        if height == 0 || self.selected < height {
            return 0;
        }
        self.selected - height + 1
    }

    /// Indentation, folder marker and name for one row.
    fn label(entry: &Entry) -> String {
        let marker = if entry.is_dir {
            if entry.is_open { "▾ " } else { "▸ " }
        } else {
            "  "
        };
        format!("{}{marker}{}", "  ".repeat(entry.depth), entry.name)
    }
}

impl Widget for FileTree<'_> {
    fn render(self, area: Rect, surface: &mut Surface) {
        if area.is_empty() {
            return;
        }
        let border_style = if self.focused {
            self.theme.popup_border
        } else {
            self.theme.gutter
        };
        let block = Block::default()
            .borders(Borders::RIGHT)
            .border_type(BorderType::Plain)
            .border_style(border_style)
            .title(Span::styled(self.title, self.theme.tree_directory));

        let inner = block.inner(area);
        surface.set_style(area, self.theme.text);
        block.render(area, surface);

        let height = inner.height as usize;
        let offset = self.scroll_offset(height);

        for (row, entry) in self.entries.iter().skip(offset).take(height).enumerate() {
            let index = offset + row;
            let mut style = if entry.is_dir {
                self.theme.tree_directory
            } else {
                self.theme.tree_file
            };
            if index == self.selected {
                style = style.patch(if self.focused {
                    self.theme.selection
                } else {
                    self.theme.cursor_line
                });
            }

            let y = inner.y + u16::try_from(row).unwrap_or(u16::MAX);
            let line = Rect {
                y,
                height: 1,
                ..inner
            };
            // Painting the row first makes the selection span the full width
            // rather than stopping at the end of the name.
            surface.set_style(line, style);
            Line::from(Span::styled(Self::label(entry), style)).render(line, surface);
        }
    }
}