@@ -21,6 +21,10 @@ pub struct Markdown {
21 contents: String,
21 contents: String,
23 config_loader: Arc<syntax::Loader>,
23 config_loader: Arc<syntax::Loader>,
27+ heading_style: String,
26// TODO: pre-render and self reference via Pin
30// TODO: pre-render and self reference via Pin
@@ -31,121 +35,139 @@ impl Markdown {
33 config_loader,
37 config_loader,
38+ text_style: "markup.normal".into(),
39+ block_style: "markup.raw.inline".into(),
40+ heading_style: "markup.heading".into(),
38−fn parse<'a>(
44+ pub fn style_group(mut self, suffix: &str) -> Self {
39− contents: &'a str,
45+ self.text_style = format!("markup.normal.{}", suffix);
40− theme: Option<&Theme>,
46+ self.block_style = format!("markup.raw.inline.{}", suffix);
41− loader: Arc<syntax::Loader>,
47+ self.heading_style = format!("markup.heading.{}", suffix);
42−) -> tui::text::Text<'a> {
48+ self
43− // // 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}}}
44− // 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```";
46− let mut options = Options::empty();
47− options.insert(Options::ENABLE_STRIKETHROUGH);
48− let parser = Parser::new_ext(contents, options);
50− // TODO: if possible, render links as terminal hyperlinks: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
51− let mut tags = Vec::new();
52− let mut spans = Vec::new();
53− let mut lines = Vec::new();
55− fn to_span(text: pulldown_cmark::CowStr) -> Span {
57− Span::raw::<std::borrow::Cow<_>>(match text {
58− CowStr::Borrowed(s) => s.into(),
59− CowStr::Boxed(s) => s.to_string().into(),
60− CowStr::Inlined(s) => s.deref().to_owned().into(),
64− let text_style = theme.map(|theme| theme.get("ui.text")).unwrap_or_default();
51+ fn parse(&self, theme: Option<&Theme>) -> tui::text::Text<'_> {
65−
52+ // // 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}}}
66− // TODO: use better scopes for these, `markup.raw.block`, `markup.heading`
53+ // 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```";
55+ let mut options = Options::empty();
56+ options.insert(Options::ENABLE_STRIKETHROUGH);
57+ let parser = Parser::new_ext(&self.contents, options);
59+ // TODO: if possible, render links as terminal hyperlinks: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
60+ let mut tags = Vec::new();
61+ let mut spans = Vec::new();
62+ let mut lines = Vec::new();
64+ fn to_span(text: pulldown_cmark::CowStr) -> Span {
66+ Span::raw::<std::borrow::Cow<_>>(match text {
67+ CowStr::Borrowed(s) => s.into(),
68+ CowStr::Boxed(s) => s.to_string().into(),
69+ CowStr::Inlined(s) => s.deref().to_owned().into(),
73+ macro_rules! get_theme {
76+ .map(|theme| theme.try_get($s1.as_str()))
81+ let text_style = get_theme!(self.text_style);
67− let code_style = theme
82+ let code_style = get_theme!(self.block_style);
68− .map(|theme| theme.get("ui.text.focus"))
69− .unwrap_or_default(); // white
70− let heading_style = theme
83+ let heading_style = get_theme!(self.heading_style);
71− .map(|theme| theme.get("ui.linenr.selected"))
84+
72− .unwrap_or_default(); // lilac
74− for event in parser {
85+ for event in parser {
75− match event {
86+ match event {
76− Event::Start(tag) => tags.push(tag),
87+ Event::Start(tag) => tags.push(tag),
77− Event::End(tag) => {
88+ Event::End(tag) => {
78− tags.pop();
89+ tags.pop();
79− match tag {
90+ match tag {
80− Tag::Heading(_, _, _)
91+ Tag::Heading(_, _, _)
81− | Tag::Paragraph
92+ | Tag::Paragraph
82− | Tag::CodeBlock(CodeBlockKind::Fenced(_)) => {
93+ | Tag::CodeBlock(CodeBlockKind::Fenced(_)) => {
83− // whenever code block or paragraph closes, new line
94+ // whenever code block or paragraph closes, new line
84− let spans = std::mem::take(&mut spans);
95+ let spans = std::mem::take(&mut spans);
85− if !spans.is_empty() {
96+ if !spans.is_empty() {
86− lines.push(Spans::from(spans));
97+ lines.push(Spans::from(spans));
99+ lines.push(Spans::default());
88− lines.push(Spans::default());
101+ _ => (),
93− Event::Text(text) => {
104+ Event::Text(text) => {
94− // TODO: temp workaround
105+ // TODO: temp workaround
95− if let Some(Tag::CodeBlock(CodeBlockKind::Fenced(language))) = tags.last() {
106+ if let Some(Tag::CodeBlock(CodeBlockKind::Fenced(language))) = tags.last() {
96− if let Some(theme) = theme {
107+ if let Some(theme) = theme {
97− let rope = Rope::from(text.as_ref());
108+ let rope = Rope::from(text.as_ref());
98− let syntax = loader
109+ let syntax = self
99− .language_configuration_for_injection_string(language)
111+ .language_configuration_for_injection_string(language)
100− .and_then(|config| config.highlight_config(theme.scopes()))
112+ .and_then(|config| config.highlight_config(theme.scopes()))
101− .map(|config| Syntax::new(&rope, config, loader.clone()));
114+ Syntax::new(&rope, config, self.config_loader.clone())
103− if let Some(syntax) = syntax {
117+ if let Some(syntax) = syntax {
104− // if we have a syntax available, highlight_iter and generate spans
118+ // if we have a syntax available, highlight_iter and generate spans
105− let mut highlights = Vec::new();
119+ let mut highlights = Vec::new();
107− for event in syntax.highlight_iter(rope.slice(..), None, None) {
121+ for event in syntax.highlight_iter(rope.slice(..), None, None) {
108− match event.unwrap() {
122+ match event.unwrap() {
109− HighlightEvent::HighlightStart(span) => {
123+ HighlightEvent::HighlightStart(span) => {
110− highlights.push(span);
112− HighlightEvent::HighlightEnd => {
115− HighlightEvent::Source { start, end } => {
116− let style = match highlights.first() {
117− Some(span) => theme.get(&theme.scopes()[span.0]),
121− // TODO: replace tabs with indentation
123− let mut slice = &text[start..end];
124− // TODO: do we need to handle all unicode line endings
125− // here, or is just '\n' okay?
126− while let Some(end) = slice.find('\n') {
127− // emit span up to newline
128− let text = &slice[..end];
129− let text = text.replace('\t', " "); // replace tabs
130− let span = Span::styled(text, style);
131− spans.push(span);
124+ highlights.push(span);
133− // truncate slice to after newline
134− slice = &slice[end + 1..];
137− let spans = std::mem::take(&mut spans);
138− lines.push(Spans::from(spans));
126+ HighlightEvent::HighlightEnd => {
129+ HighlightEvent::Source { start, end } => {
130+ let style = match highlights.first() {
131+ Some(span) => theme.get(&theme.scopes()[span.0]),
135+ // TODO: replace tabs with indentation
137+ let mut slice = &text[start..end];
138+ // TODO: do we need to handle all unicode line endings
139+ // here, or is just '\n' okay?
140+ while let Some(end) = slice.find('\n') {
141+ // emit span up to newline
142+ let text = &slice[..end];
143+ let text = text.replace('\t', " "); // replace tabs
144+ let span = Span::styled(text, style);
147+ // truncate slice to after newline
148+ slice = &slice[end + 1..];
151+ let spans = std::mem::take(&mut spans);
152+ lines.push(Spans::from(spans));
141− // if there's anything left, emit it too
155+ // if there's anything left, emit it too
142− if !slice.is_empty() {
156+ if !slice.is_empty() {
143− let span =
157+ let span = Span::styled(
144− Span::styled(slice.replace('\t', " "), style);
158+ slice.replace('\t', " "),
145− spans.push(span);
161+ spans.push(span);
167+ for line in text.lines() {
168+ let span = Span::styled(line.to_string(), code_style);
169+ lines.push(Spans::from(span));
151 for line in text.lines() {
173 for line in text.lines() {
@@ -153,68 +175,60 @@ fn parse<'a>(
153 lines.push(Spans::from(span));
175 lines.push(Spans::from(span));
178+ } else if let Some(Tag::Heading(_, _, _)) = tags.last() {
179+ let mut span = to_span(text);
180+ span.style = heading_style;
157− for line in text.lines() {
183+ let mut span = to_span(text);
158− let span = Span::styled(line.to_string(), code_style);
184+ span.style = text_style;
159− lines.push(Spans::from(span));
185+ spans.push(span);
162− } else if let Some(Tag::Heading(_, _, _)) = tags.last() {
187+ }
163− let mut span = to_span(text);
188+ Event::Code(text) | Event::Html(text) => {
164− span.style = heading_style;
167 let mut span = to_span(text);
189 let mut span = to_span(text);
168− span.style = text_style;
190+ span.style = code_style;
169 spans.push(span);
191 spans.push(span);
193+ Event::SoftBreak | Event::HardBreak => {
194+ // let spans = std::mem::replace(&mut spans, Vec::new());
195+ // lines.push(Spans::from(spans));
196+ spans.push(Span::raw(" "));
199+ let mut span = Span::raw("---");
200+ span.style = code_style;
201+ lines.push(Spans::from(span));
202+ lines.push(Spans::default());
204+ // TaskListMarker(bool) true if checked
206+ log::warn!("unhandled markdown event {:?}", event);
172− Event::Code(text) | Event::Html(text) => {
209+ // build up a vec of Paragraph tui widgets
173− let mut span = to_span(text);
174− span.style = code_style;
177− Event::SoftBreak | Event::HardBreak => {
178− // let spans = std::mem::replace(&mut spans, Vec::new());
179− // lines.push(Spans::from(spans));
180− spans.push(Span::raw(" "));
183− let mut span = Span::raw("---");
184− span.style = code_style;
185− lines.push(Spans::from(span));
186− lines.push(Spans::default());
188− // TaskListMarker(bool) true if checked
190− log::warn!("unhandled markdown event {:?}", event);
193− // build up a vec of Paragraph tui widgets
196− if !spans.is_empty() {
212+ if !spans.is_empty() {
197− lines.push(Spans::from(spans));
213+ lines.push(Spans::from(spans));
200− // if last line is empty, remove it
216+ // if last line is empty, remove it
201− if let Some(line) = lines.last() {
217+ if let Some(line) = lines.last() {
202− if line.0.is_empty() {
218+ if line.0.is_empty() {
203− lines.pop();
219+ lines.pop();
207− Text::from(lines)
223+ Text::from(lines)
209impl Component for Markdown {
227impl Component for Markdown {
210 fn render(&mut self, area: Rect, surface: &mut Surface, cx: &mut Context) {
228 fn render(&mut self, area: Rect, surface: &mut Surface, cx: &mut Context) {
211 use tui::widgets::{Paragraph, Widget, Wrap};
229 use tui::widgets::{Paragraph, Widget, Wrap};
215− Some(&cx.editor.theme),
231+ let text = self.parse(Some(&cx.editor.theme));
216− self.config_loader.clone(),
219 let par = Paragraph::new(text)
233 let par = Paragraph::new(text)
220 .wrap(Wrap { trim: false })
234 .wrap(Wrap { trim: false })
@@ -232,7 +246,8 @@ impl Component for Markdown {
232 if padding >= viewport.1 || padding >= viewport.0 {
246 if padding >= viewport.1 || padding >= viewport.0 {
233 return None;
247 return None;
235− let contents = parse(&self.contents, None, self.config_loader.clone());
249+ let contents = self.parse(None);
236 // TODO: account for tab width
251 // TODO: account for tab width
237 let max_text_width = (viewport.0 - padding).min(120);
252 let max_text_width = (viewport.0 - padding).min(120);
238 let mut text_width = 0;
253 let mut text_width = 0;