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
121
122
123
124
125
126
127

use crate::{
    color::DECLARATION_BORDER,
    ui::{
        scrollable::{Headings, MarkdownArea, ScrollText},
        Surround,
    },
};
use ratatui::{
    prelude::*,
    widgets::{Block, BorderType, Borders},
};
use term_rustdoc::{
    decl::item_str,
    tree::{CrateDoc, IDMap},
};

#[derive(Default)]
pub(super) struct ContentInner {
    decl: Declaration,
    md: ScrollText,
}

impl std::fmt::Debug for ContentInner {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "ContentInner")
    }
}

impl ContentInner {
    pub fn new(doc: &CrateDoc) -> Self {
        let md = ScrollText::new_text(doc.clone()).unwrap_or_default();
        ContentInner {
            md,
            decl: Declaration::default(),
        }
    }

    pub fn update_decl(&mut self, id: &str, outer: Rect) {
        if let Some(map) = self.md.doc_ref() {
            // exclude border width
            let width = outer.width.saturating_sub(4);
            self.decl.update_decl(id, map, width);
        }
        self.update_area(outer);
    }

    pub fn update_area(&mut self, outer: Rect) {
        let md = self.decl.update_area(outer);
        self.md.area = md;
        self.md.start = 0;
        // self.md.max_width = md.width;
    }

    pub fn render(&self, buf: &mut Buffer) {
        if !self.decl.display.scroll_text_ref().is_empty() {
            self.decl.border.render(buf);
            self.decl.display.render(buf);
        }
        self.md.render(buf);
    }

    pub fn content(&mut self) -> &mut ScrollText {
        &mut self.md
    }

    pub fn md_ref(&self) -> &ScrollText {
        &self.md
    }

    pub fn update_doc(&mut self, id: &str, outer: Rect) -> Option<Headings> {
        self.update_decl(id, outer);
        self.md.update_doc(id)
    }

    pub fn reset_doc(&mut self) {
        self.md.lines.reset_doc();
    }
}

struct Declaration {
    display: MarkdownArea,
    border: Surround,
}

impl Default for Declaration {
    fn default() -> Self {
        Declaration {
            display: MarkdownArea::default(),
            border: Surround::new(
                Block::new()
                    .borders(Borders::ALL)
                    .border_type(BorderType::QuadrantOutside)
                    .border_style(DECLARATION_BORDER),
                Rect::default(),
            ),
        }
    }
}

impl Declaration {
    fn update_decl(&mut self, id: &str, map: &IDMap, width: u16) {
        let code = item_str(id, map);
        if code.is_empty() {
            self.display.scroll_text().lines = Default::default();
        } else {
            self.display.rust_code(&code, width);
        }
    }

    /// Reserve space for item and returns the rest area for showing markdown content.
    fn update_area(&mut self, outer: Rect) -> Rect {
        let scroll_text = self.display.scroll_text();
        let total_len = scroll_text.total_len() as u16;
        if total_len == 0 {
            return outer;
        }
        let height = total_len + 1;
        let [decl, md] = Layout::vertical([Constraint::Length(height), Constraint::Min(0)])
            .spacing(1)
            .areas(outer);
        if let Some(inner) = self.border.update_area(decl) {
            scroll_text.area = inner;
            // scroll_text.max_width = decl.width;
        }
        md
    }
}