term-rustdoc 0.2.0

A TUI for Rust docs.
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

use super::region::SelectedRegion;
use crate::{
    color::HEAD,
    ui::scrollable::{
        generics::{render_line, render_line_fill_gap, LineState},
        Scroll,
    },
};
use ratatui::prelude::Buffer;
use term_rustdoc::{tree::Text, util::XString};
use unicode_width::UnicodeWidthStr;

pub type ScrollHeading = Scroll<Headings>;

#[derive(Debug)]
pub struct Heading {
    line: Text,
    jump: SelectedRegion,
}

impl Heading {
    fn new(text: XString, jump: SelectedRegion) -> Self {
        Self {
            line: Text {
                text,
                style: Default::default(),
            },
            jump,
        }
    }

    pub fn as_str(&self) -> &str {
        &self.line.text
    }

    pub fn jump_row_start(&self) -> usize {
        self.jump.row_start()
    }
}

impl LineState for Heading {
    type State = XString;

    fn state(&self) -> Self::State {
        self.line.text.clone()
    }

    fn is_identical(&self, state: &Self::State) -> bool {
        self.as_str() == *state
    }
}

#[derive(Default)]
pub struct Headings {
    lines: Vec<Heading>,
}

impl std::ops::Deref for Headings {
    type Target = [Heading];

    fn deref(&self) -> &Self::Target {
        &self.lines
    }
}

impl Headings {
    pub fn with_capacity(cap: usize) -> Self {
        Headings {
            lines: Vec::with_capacity(cap),
        }
    }

    pub fn push(&mut self, text: XString, region: SelectedRegion) {
        self.lines.push(Heading::new(text, region));
    }
}

impl ScrollHeading {
    pub fn update_headings(&mut self, headings: Headings) {
        // NOTE: max_width is the real maximum width of all lines,
        // and the display width can be smaller then max_width to truncate heading lines.
        let max_width = headings
            .iter()
            .map(|h| h.as_str().width() as u16)
            .max()
            .unwrap_or(0);
        self.lines = headings;
        self.max_width = max_width;
    }

    pub fn render(&self, buf: &mut Buffer, content_start: usize, content_end: usize) {
        let width = self.area.width;
        if width == 0 {
            return;
        }
        let (x, mut y, width) = (self.area.x, self.area.y, width as usize);
        let mut gap_str = XString::new_inline("");
        let lines = &self.lines.lines;
        for (idx, line) in lines.iter().enumerate() {
            let text = &line.as_str();
            let text = text.get(..width.min(text.len())).unwrap_or("");
            let row_start = line.jump.row_start();
            // highlight the heading when the heading line is in visual range or
            // only the contents after the heading is in visual range
            if (content_start <= row_start && content_end > row_start)
                || (content_start > row_start
                    && lines
                        .get(idx + 1)
                        .map(|l| content_end < l.jump.row_start())
                        .unwrap_or(true))
            {
                render_line_fill_gap(Some(text), HEAD, buf, x, y, width, &mut gap_str);
            } else {
                let style = line.line.style;
                render_line(Some((text, style)), buf, x, y, width);
            }
            y += 1;
        }
    }
}