on master help sign in
ui: Use parsed markdown contents to determine sizing.
commit80eca5c32f2a9f3345a2449c8620f86423061d33 authorBlaž Hrastnik <blaz@mxxn.io> dateMon 15 Mar 2021, 17:55 (6 years ago) parentf9b9bc0
1 file changed+82−79
helix-term/src/ui/markdown.rs+82−79
helix-term/src/ui/markdown.rs+82−79
@@ -21,98 +21,101 @@ impl Markdown {
2121 Self { contents }
2222 }
2323}
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− }
24+fn parse(contents: &str) -> tui::text::Text {
25+ use pulldown_cmark::{CodeBlockKind, CowStr, Event, Options, Parser, Tag};
26+ use tui::text::{Span, Spans, Text};
27+
28+ // 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}}}
29+ 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```";
30+
31+ let mut options = Options::empty();
32+ options.insert(Options::ENABLE_STRIKETHROUGH);
33+ let parser = Parser::new_ext(contents, options);
34+
35+ // TODO: if possible, render links as terminal hyperlinks: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
36+ let mut tags = Vec::new();
37+ let mut spans = Vec::new();
38+ let mut lines = Vec::new();
39+
40+ fn to_span(text: pulldown_cmark::CowStr) -> Span {
41+ use std::ops::Deref;
42+ Span::raw::<std::borrow::Cow<_>>(match text {
43+ CowStr::Borrowed(s) => s.to_string().into(), // could retain borrow
44+ CowStr::Boxed(s) => s.to_string().into(),
45+ CowStr::Inlined(s) => s.deref().to_owned().into(),
46+ })
47+ }
5148
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(_)
63− | Tag::Paragraph
64− | Tag::CodeBlock(CodeBlockKind::Fenced(_)) => {
65− // whenever code block or paragraph closes, new line
66− let spans = std::mem::replace(&mut spans, Vec::new());
49+ let text_style = Style::default().fg(Color::Rgb(164, 160, 232)); // lavender
50+ let code_style = Style::default().fg(Color::Rgb(255, 255, 255)); // white
51+ let heading_style = Style::default().fg(Color::Rgb(219, 191, 239)); // lilac
52+
53+ for event in parser {
54+ match event {
55+ Event::Start(tag) => tags.push(tag),
56+ Event::End(tag) => {
57+ tags.pop();
58+ match tag {
59+ Tag::Heading(_) | Tag::Paragraph | Tag::CodeBlock(CodeBlockKind::Fenced(_)) => {
60+ // whenever code block or paragraph closes, new line
61+ let spans = std::mem::replace(&mut spans, Vec::new());
62+ if !spans.is_empty() {
6763 lines.push(Spans::from(spans));
68− lines.push(Spans::default());
6964 }
70− _ => (),
65+ lines.push(Spans::default());
7166 }
67+ _ => (),
7268 }
73− Event::Text(text) => {
74− if let Some(Tag::CodeBlock(CodeBlockKind::Fenced(_))) = tags.last() {
75− for line in text.lines() {
76− let mut span = Span::styled(line.to_string(), code_style);
77− lines.push(Spans::from(span));
78− }
79− } else if let Some(Tag::Heading(_)) = tags.last() {
80− let mut span = to_span(text);
81− span.style = heading_style;
82− spans.push(span);
83− } else {
84− let mut span = to_span(text);
85− span.style = text_style;
86− spans.push(span);
69+ }
70+ Event::Text(text) => {
71+ if let Some(Tag::CodeBlock(CodeBlockKind::Fenced(_))) = tags.last() {
72+ for line in text.lines() {
73+ let mut span = Span::styled(line.to_string(), code_style);
74+ lines.push(Spans::from(span));
8775 }
88− }
89− Event::Code(text) | Event::Html(text) => {
76+ } else if let Some(Tag::Heading(_)) = tags.last() {
9077 let mut span = to_span(text);
91− span.style = code_style;
78+ span.style = heading_style;
79+ spans.push(span);
80+ } else {
81+ let mut span = to_span(text);
82+ span.style = text_style;
9283 spans.push(span);
9384 }
94− Event::SoftBreak | Event::HardBreak => {
95− // let spans = std::mem::replace(&mut spans, Vec::new());
96− // lines.push(Spans::from(spans));
97− spans.push(Span::raw(" "));
98− }
99− Event::Rule => {
100− lines.push(Spans::from("---"));
101− lines.push(Spans::default());
102− }
103− // TaskListMarker(bool) true if checked
104− _ => (),
10585 }
106− // build up a vec of Paragraph tui widgets
86+ Event::Code(text) | Event::Html(text) => {
87+ let mut span = to_span(text);
88+ span.style = code_style;
89+ spans.push(span);
90+ }
91+ Event::SoftBreak | Event::HardBreak => {
92+ // let spans = std::mem::replace(&mut spans, Vec::new());
93+ // lines.push(Spans::from(spans));
94+ spans.push(Span::raw(" "));
95+ }
96+ Event::Rule => {
97+ lines.push(Spans::from("---"));
98+ lines.push(Spans::default());
99+ }
100+ // TaskListMarker(bool) true if checked
101+ _ => (),
107102 }
103+ // build up a vec of Paragraph tui widgets
104+ }
108105
109− if !spans.is_empty() {
110− lines.push(Spans::from(spans));
111− }
106+ if !spans.is_empty() {
107+ lines.push(Spans::from(spans));
108+ }
109+
110+ Text::from(lines)
111+}
112+impl Component for Markdown {
113+ fn render(&self, area: Rect, surface: &mut Surface, cx: &mut Context) {
114+ use tui::widgets::{Paragraph, Widget, Wrap};
112115
113− let contents = Text::from(lines);
116+ let text = parse(&self.contents);
114117
115− let par = Paragraph::new(contents)
118+ let par = Paragraph::new(text)
116119 .wrap(Wrap { trim: false })
117120 .scroll((cx.scroll.unwrap_or_default() as u16, 0));
118121
@@ -121,7 +124,7 @@ impl Component for Markdown {
121124 }
122125
123126 fn required_size(&mut self, viewport: (u16, u16)) -> Option<(u16, u16)> {
124− let contents = tui::text::Text::from(self.contents.clone());
127+ let contents = parse(&self.contents);
125128 let padding = 2;
126129 let width = std::cmp::min(contents.width() as u16 + padding, viewport.0);
127130 let height = std::cmp::min(contents.height() as u16 + padding, viewport.1);