on master help sign in
ui: wip: Markdown doc renderer.
commit1d42b959159751078b3bbc159a45cebe51d924fa authorBlaž Hrastnik <blaz@mxxn.io> dateFri 5 Mar 2021, 16:07 (6 years ago) parenta5c4314
7 files changed+165−4
Cargo.lock+21 helix-term/Cargo.toml+2 helix-term/src/commands.rs+1−1 helix-term/src/ui/markdown.rs+137 helix-term/src/ui/mod.rs+2 helix-term/src/ui/popup.rs+2−2 helix-term/src/ui/text.rs−1
Cargo.lock+21
@@ -552,6 +552,7 @@ dependencies = [
552552 "log",
553553 "num_cpus",
554554 "once_cell",
555+ "pulldown-cmark",
555556 "smol",
556557 "smol-timeout",
557558 "tui",
@@ -903,6 +904,17 @@ dependencies = [
903904 "unicode-xid",
904905]
905906
907+[[package]]
908+name = "pulldown-cmark"
909+version = "0.8.0"
910+source = "registry+https://github.com/rust-lang/crates.io-index"
911+checksum = "ffade02495f22453cd593159ea2f59827aae7f53fa8323f756799b670881dcf8"
912+dependencies = [
913+ "bitflags",
914+ "memchr",
915+ "unicase",
916+]
917+
906918[[package]]
907919name = "quote"
908920version = "1.0.9"
@@ -1226,6 +1238,15 @@ dependencies = [
12261238 "unicode-width",
12271239]
12281240
1241+[[package]]
1242+name = "unicase"
1243+version = "2.6.0"
1244+source = "registry+https://github.com/rust-lang/crates.io-index"
1245+checksum = "50f37be617794602aabbeee0be4f259dc1778fabe05e2d67ee8f79326d5cb4f6"
1246+dependencies = [
1247+ "version_check",
1248+]
1249+
12291250[[package]]
12301251name = "unicode-bidi"
12311252version = "0.3.4"
helix-term/Cargo.toml+2
@@ -39,3 +39,5 @@ fuzzy-matcher = "0.3"
3939ignore = "0.4"
4040# shellexpand = "2.1"
4141dirs-next = "2.0"
42+# markdown doc rendering
43+pulldown-cmark = { version = "0.8", default-features = false }
helix-term/src/commands.rs+1−1
@@ -1179,7 +1179,7 @@ pub fn hover(cx: &mut Context) {
11791179
11801180 // skip if contents empty
11811181
1182− let contents = ui::Text::new(contents);
1182+ let contents = ui::Markdown::new(contents);
11831183 let mut popup = Popup::new(Box::new(contents));
11841184 cx.push_layer(Box::new(popup));
11851185 }
helix-term/src/ui/markdown.rsnew file+137
@@ -0,0 +1,137 @@
1+use crate::compositor::{Component, Compositor, Context, EventResult};
2+use crossterm::event::{Event, KeyCode, KeyEvent, KeyModifiers};
3+use tui::buffer::Buffer as Surface;
4+use tui::{
5+ layout::Rect,
6+ style::{Color, Style},
7+ text::Text,
8+};
9+
10+use std::borrow::Cow;
11+
12+use helix_core::Position;
13+use helix_view::Editor;
14+
15+pub struct Markdown {
16+ contents: String,
17+}
18+
19+impl Markdown {
20+ pub fn new(contents: String) -> Self {
21+ Self { contents }
22+ }
23+}
24+impl Component for Markdown {
25+ fn render(&self, area: Rect, surface: &mut Surface, cx: &mut Context) {
26+ use tui::widgets::{Paragraph, Widget, Wrap};
27+
28+ use pulldown_cmark::{CodeBlockKind, CowStr, Event, Options, Parser, Tag};
29+ use tui::text::{Span, Spans, Text};
30+
31+ // also 2021-03-04T16:33:58.553 helix_lsp::transport [INFO] <- {"contents":{"kind":"markdown","value":"\n```rust\ncore::num\n```\n\n```rust\npub const fn saturating_sub(self, rhs:Self) ->Self\n```\n\n---\n\n```rust\n```"},"range":{"end":{"character":61,"line":101},"start":{"character":47,"line":101}}}
32+ let text = "\n```rust\ncore::iter::traits::iterator::Iterator\n```\n\n```rust\nfn collect<B: FromIterator<Self::Item>>(self) -> B\nwhere\n Self: Sized,\n```\n\n---\n\nTransforms an iterator into a collection.\n\n`collect()` can take anything iterable, and turn it into a relevant\ncollection. This is one of the more powerful methods in the standard\nlibrary, used in a variety of contexts.\n\nThe most basic pattern in which `collect()` is used is to turn one\ncollection into another. You take a collection, call [`iter`](https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html) on it,\ndo a bunch of transformations, and then `collect()` at the end.\n\n`collect()` can also create instances of types that are not typical\ncollections. For example, a [`String`](https://doc.rust-lang.org/nightly/core/iter/std/string/struct.String.html) can be built from [`char`](type@char)s,\nand an iterator of [`Result<T, E>`](https://doc.rust-lang.org/nightly/core/result/enum.Result.html) items can be collected\ninto `Result<Collection<T>, E>`. See the examples below for more.\n\nBecause `collect()` is so general, it can cause problems with type\ninference. As such, `collect()` is one of the few times you'll see\nthe syntax affectionately known as the 'turbofish': `::<>`. This\nhelps the inference algorithm understand specifically which collection\nyou're trying to collect into.\n\n# Examples\n\nBasic usage:\n\n```rust\nlet a = [1, 2, 3];\n\nlet doubled: Vec<i32> = a.iter()\n .map(|&x| x * 2)\n .collect();\n\nassert_eq!(vec![2, 4, 6], doubled);\n```\n\nNote that we needed the `: Vec<i32>` on the left-hand side. This is because\nwe could collect into, for example, a [`VecDeque<T>`](https://doc.rust-lang.org/nightly/core/iter/std/collections/struct.VecDeque.html) instead:\n\n```rust\nuse std::collections::VecDeque;\n\nlet a = [1, 2, 3];\n\nlet doubled: VecDeque<i32> = a.iter().map(|&x| x * 2).collect();\n\nassert_eq!(2, doubled[0]);\nassert_eq!(4, doubled[1]);\nassert_eq!(6, doubled[2]);\n```\n\nUsing the 'turbofish' instead of annotating `doubled`:\n\n```rust\nlet a = [1, 2, 3];\n\nlet doubled = a.iter().map(|x| x * 2).collect::<Vec<i32>>();\n\nassert_eq!(vec![2, 4, 6], doubled);\n```\n\nBecause `collect()` only cares about what you're collecting into, you can\nstill use a partial type hint, `_`, with the turbofish:\n\n```rust\nlet a = [1, 2, 3];\n\nlet doubled = a.iter().map(|x| x * 2).collect::<Vec<_>>();\n\nassert_eq!(vec![2, 4, 6], doubled);\n```\n\nUsing `collect()` to make a [`String`](https://doc.rust-lang.org/nightly/core/iter/std/string/struct.String.html):\n\n```rust\nlet chars = ['g', 'd', 'k', 'k', 'n'];\n\nlet hello: String = chars.iter()\n .map(|&x| x as u8)\n .map(|x| (x + 1) as char)\n .collect();\n\nassert_eq!(\"hello\", hello);\n```\n\nIf you have a list of [`Result<T, E>`](https://doc.rust-lang.org/nightly/core/result/enum.Result.html)s, you can use `collect()` to\nsee if any of them failed:\n\n```rust\nlet results = [Ok(1), Err(\"nope\"), Ok(3), Err(\"bad\")];\n\nlet result: Result<Vec<_>, &str> = results.iter().cloned().collect();\n\n// gives us the first error\nassert_eq!(Err(\"nope\"), result);\n\nlet results = [Ok(1), Ok(3)];\n\nlet result: Result<Vec<_>, &str> = results.iter().cloned().collect();\n\n// gives us the list of answers\nassert_eq!(Ok(vec![1, 3]), result);\n```";
33+
34+ let mut options = Options::empty();
35+ options.insert(Options::ENABLE_STRIKETHROUGH);
36+ let parser = Parser::new_ext(&self.contents, options);
37+
38+ // TODO: if possible, render links as terminal hyperlinks: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
39+ let mut tags = Vec::new();
40+ let mut spans = Vec::new();
41+ let mut lines = Vec::new();
42+
43+ fn to_span(text: pulldown_cmark::CowStr) -> Span {
44+ use std::ops::Deref;
45+ Span::raw::<std::borrow::Cow<_>>(match text {
46+ CowStr::Borrowed(s) => s.into(),
47+ CowStr::Boxed(s) => s.to_string().into(),
48+ CowStr::Inlined(s) => s.deref().to_owned().into(),
49+ })
50+ }
51+
52+ let text_style = Style::default().fg(Color::Rgb(164, 160, 232)); // lavender
53+ let code_style = Style::default().fg(Color::Rgb(255, 255, 255)); // white
54+ let heading_style = Style::default().fg(Color::Rgb(219, 191, 239)); // lilac
55+
56+ for event in parser {
57+ match event {
58+ Event::Start(tag) => tags.push(tag),
59+ Event::End(tag) => {
60+ tags.pop();
61+ match tag {
62+ Tag::Heading(_) | Tag::Paragraph => {
63+ // whenever paragraph closes, new line
64+ let spans = std::mem::replace(&mut spans, Vec::new());
65+ lines.push(Spans::from(spans));
66+ lines.push(Spans::default());
67+ }
68+ Tag::CodeBlock(CodeBlockKind::Fenced(_)) => {
69+ let spans = std::mem::replace(&mut spans, Vec::new());
70+ lines.push(Spans::from(spans));
71+ }
72+ _ => (),
73+ }
74+ }
75+ Event::Text(text) => {
76+ if let Some(Tag::CodeBlock(CodeBlockKind::Fenced(_))) = tags.last() {
77+ for line in text.lines() {
78+ let mut span = Span::styled(line.to_string(), code_style);
79+ lines.push(Spans::from(span));
80+ }
81+ } else if let Some(Tag::Heading(_)) = tags.last() {
82+ let mut span = to_span(text);
83+ span.style = heading_style;
84+ spans.push(span);
85+ } else {
86+ let mut span = to_span(text);
87+ span.style = text_style;
88+ spans.push(span);
89+ }
90+ }
91+ Event::Code(text) | Event::Html(text) => {
92+ let mut span = to_span(text);
93+ span.style = code_style;
94+ spans.push(span);
95+ }
96+ Event::SoftBreak | Event::HardBreak => {
97+ // let spans = std::mem::replace(&mut spans, Vec::new());
98+ // lines.push(Spans::from(spans));
99+ spans.push(Span::raw(" "));
100+ }
101+ Event::Rule => {
102+ lines.push(Spans::from("---"));
103+ lines.push(Spans::default());
104+ }
105+ // TaskListMarker(bool) true if checked
106+ _ => (),
107+ }
108+ // build up a vec of Paragraph tui widgets
109+ }
110+
111+ if !spans.is_empty() {
112+ lines.push(Spans::from(spans));
113+ }
114+
115+ let contents = Text::from(lines);
116+
117+ let par = Paragraph::new(contents).wrap(Wrap { trim: false });
118+ // .scroll(x, y) offsets
119+
120+ // padding on all sides
121+ let area = Rect::new(area.x + 1, area.y + 1, area.width - 2, area.height - 2);
122+ par.render(area, surface);
123+ }
124+
125+ fn size_hint(&self, area: Rect) -> Option<(usize, usize)> {
126+ let contents = tui::text::Text::from(self.contents.clone());
127+ Some((contents.width(), contents.height()))
128+ }
129+}
130+
131+#[cfg(test)]
132+mod test {
133+ use super::*;
134+
135+ #[test]
136+ fn it_works() {}
137+}
helix-term/src/ui/mod.rs+2
@@ -1,4 +1,5 @@
11mod editor;
2+mod markdown;
23mod menu;
34mod picker;
45mod popup;
@@ -6,6 +7,7 @@ mod prompt;
67mod text;
78
89pub use editor::EditorView;
10+pub use markdown::Markdown;
911pub use menu::Menu;
1012pub use picker::Picker;
1113pub use popup::Popup;
helix-term/src/ui/popup.rs+2−2
@@ -82,8 +82,8 @@ impl Component for Popup {
8282 .size_hint(viewport)
8383 .expect("Component needs size_hint implemented in order to be embedded in a popup");
8484
85− let width = width.min(150) as u16;
86− let height = height.min(13) as u16;
85+ let width = width.min(120) as u16;
86+ let height = height.min(26) as u16;
8787
8888 // -- make sure frame doesn't stick out of bounds
8989 let mut rel_x = position.col as u16;
helix-term/src/ui/text.rs−1
@@ -4,7 +4,6 @@ use tui::buffer::Buffer as Surface;
44use tui::{
55 layout::Rect,
66 style::{Color, Style},
7− widgets::{Block, Borders},
87};
98
109use std::borrow::Cow;