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

use crate::ui::{MarkdownAndHeading, ScrollMarkdown, Surround};
use ratatui::{
    layout::Alignment,
    prelude::{Buffer, Rect},
    text::Line,
    widgets::{Block, Borders},
};

use super::centered_rect;

pub struct Help {
    md: HelpMarkdown,
    /// full screen area
    full: Rect,
}

impl Help {
    pub fn new(full: Rect) -> Help {
        let outer = split_surround(full);
        Help {
            md: HelpMarkdown::new(outer),
            full,
        }
    }

    pub fn update_area(&mut self, full: Rect) {
        if self.full == full {
            return;
        }
        self.full = full;
        let outer = split_surround(full);
        self.md = HelpMarkdown::new(outer);
    }

    pub fn render(&self, buf: &mut Buffer) {
        self.md.border.render(buf);
        self.md.inner.render(buf);
    }

    pub fn scroll_text(&mut self) -> &mut ScrollMarkdown {
        self.md.inner.scroll_text()
    }

    pub fn heading_jump(&mut self, position: (u16, u16)) -> bool {
        // position: (x, y)
        if self.md.inner.heading().area.contains(position.into()) {
            return self.md.inner.heading_jump(position.1);
        }
        false
    }

    pub fn contains(&self, position: (u16, u16)) -> bool {
        self.md.border.area().contains(position.into())
    }
}

fn split_surround(full: Rect) -> Surround {
    let outer = centered_rect(full, 80, 80);
    let title = Line::from(" Press F1 to toggle this Help ").alignment(Alignment::Right);
    Surround::new(
        Block::new()
            .title(" Help ")
            .title_bottom(title)
            .borders(Borders::ALL),
        outer,
    )
}

struct HelpMarkdown {
    inner: MarkdownAndHeading,
    border: Surround,
}

impl HelpMarkdown {
    fn new(border: Surround) -> Self {
        let inner = MarkdownAndHeading::new(Self::HELP, border.inner());
        HelpMarkdown { inner, border }
    }

    const HELP: &'static str = include_str!("help.md");
}