Unnamed repository; edit this file 'description' to name the repository.
Diffstat (limited to 'helix-term/src/ui/markdown.rs')
| -rw-r--r-- | helix-term/src/ui/markdown.rs | 303 |
1 files changed, 101 insertions, 202 deletions
diff --git a/helix-term/src/ui/markdown.rs b/helix-term/src/ui/markdown.rs index 6bef59d1..5f78c3cc 100644 --- a/helix-term/src/ui/markdown.rs +++ b/helix-term/src/ui/markdown.rs @@ -1,5 +1,4 @@ use crate::compositor::{Component, Context}; -use arc_swap::ArcSwap; use tui::{ buffer::Buffer as Surface, text::{Span, Spans, Text}, @@ -7,19 +6,18 @@ use tui::{ use std::sync::Arc; -use pulldown_cmark::{CodeBlockKind, Event, HeadingLevel, Options, Parser, Tag, TagEnd}; +use pulldown_cmark::{CodeBlockKind, Event, HeadingLevel, Options, Parser, Tag}; use helix_core::{ - syntax::{self, HighlightEvent, OverlayHighlights}, - RopeSlice, Syntax, + syntax::{self, HighlightEvent, Syntax}, + Rope, }; use helix_view::{ graphics::{Margin, Rect, Style}, - theme::Modifier, Theme, }; -fn styled_multiline_text<'a>(text: &str, style: Style) -> Text<'a> { +fn styled_multiline_text<'a>(text: String, style: Style) -> Text<'a> { let spans: Vec<_> = text .lines() .map(|line| Span::styled(line.to_string(), style)) @@ -29,15 +27,11 @@ fn styled_multiline_text<'a>(text: &str, style: Style) -> Text<'a> { } pub fn highlighted_code_block<'a>( - text: &str, + text: String, language: &str, theme: Option<&Theme>, - loader: &syntax::Loader, - // Optional overlay highlights to mix in with the syntax highlights. - // - // Note that `OverlayHighlights` is typically used with char indexing but the only caller - // which passes this parameter currently passes **byte indices** instead. - additional_highlight_spans: Option<OverlayHighlights>, + config_loader: Arc<syntax::Loader>, + additional_highlight_spans: Option<Vec<(usize, std::ops::Range<usize>)>>, ) -> Text<'a> { let mut spans = Vec::new(); let mut lines = Vec::new(); @@ -51,81 +45,65 @@ pub fn highlighted_code_block<'a>( None => return styled_multiline_text(text, code_style), }; - let ropeslice = RopeSlice::from(text); - let Some(syntax) = loader - .language_for_match(RopeSlice::from(language)) - .and_then(|lang| Syntax::new(ropeslice, lang, loader).ok()) - else { - return styled_multiline_text(text, code_style); + let rope = Rope::from(text.as_ref()); + let syntax = config_loader + .language_configuration_for_injection_string(language) + .and_then(|config| config.highlight_config(theme.scopes())) + .map(|config| Syntax::new(&rope, config, Arc::clone(&config_loader))); + + let syntax = match syntax { + Some(s) => s, + None => return styled_multiline_text(text, code_style), }; - let mut syntax_highlighter = syntax.highlighter(ropeslice, loader, ..); - let mut syntax_highlight_stack = Vec::new(); - let mut overlay_highlight_stack = Vec::new(); - let mut overlay_highlighter = syntax::OverlayHighlighter::new(additional_highlight_spans); - let mut pos = 0; - - while pos < ropeslice.len_bytes() as u32 { - if pos == syntax_highlighter.next_event_offset() { - let (event, new_highlights) = syntax_highlighter.advance(); - if event == HighlightEvent::Refresh { - syntax_highlight_stack.clear(); + let highlight_iter = syntax + .highlight_iter(rope.slice(..), None, None) + .map(|e| e.unwrap()); + let highlight_iter: Box<dyn Iterator<Item = HighlightEvent>> = + if let Some(spans) = additional_highlight_spans { + Box::new(helix_core::syntax::merge(highlight_iter, spans)) + } else { + Box::new(highlight_iter) + }; + + let mut highlights = Vec::new(); + for event in highlight_iter { + match event { + HighlightEvent::HighlightStart(span) => { + highlights.push(span); } - syntax_highlight_stack.extend(new_highlights); - } else if pos == overlay_highlighter.next_event_offset() as u32 { - let (event, new_highlights) = overlay_highlighter.advance(); - if event == HighlightEvent::Refresh { - overlay_highlight_stack.clear(); + HighlightEvent::HighlightEnd => { + highlights.pop(); } - overlay_highlight_stack.extend(new_highlights) - } - - let start = pos; - pos = syntax_highlighter - .next_event_offset() - .min(overlay_highlighter.next_event_offset() as u32); - if pos == u32::MAX { - pos = ropeslice.len_bytes() as u32; - } - if pos == start { - continue; - } - // The highlighter should always move forward. - // If the highlighter malfunctions, bail on syntax highlighting and log an error. - debug_assert!(pos > start); - if pos < start { - log::error!("Failed to highlight '{language}': {text:?}"); - return styled_multiline_text(text, code_style); - } - - let style = syntax_highlight_stack - .iter() - .chain(overlay_highlight_stack.iter()) - .fold(text_style, |acc, highlight| { - acc.patch(theme.highlight(*highlight)) - }); - - let mut slice = &text[start as usize..pos as usize]; - // TODO: do we need to handle all unicode line endings - // here, or is just '\n' okay? - while let Some(end) = slice.find('\n') { - // emit span up to newline - let text = &slice[..end]; - let text = text.replace('\t', " "); // replace tabs - let span = Span::styled(text, style); - spans.push(span); - - // truncate slice to after newline - slice = &slice[end + 1..]; - - // make a new line - let spans = std::mem::take(&mut spans); - lines.push(Spans::from(spans)); - } + HighlightEvent::Source { start, end } => { + let style = highlights + .iter() + .fold(text_style, |acc, span| acc.patch(theme.highlight(span.0))); + + let mut slice = &text[start..end]; + // TODO: do we need to handle all unicode line endings + // here, or is just '\n' okay? + while let Some(end) = slice.find('\n') { + // emit span up to newline + let text = &slice[..end]; + let text = text.replace('\t', " "); // replace tabs + let span = Span::styled(text, style); + spans.push(span); + + // truncate slice to after newline + slice = &slice[end + 1..]; + + // make a new line + let spans = std::mem::take(&mut spans); + lines.push(Spans::from(spans)); + } - if !slice.is_empty() { - let span = Span::styled(slice.replace('\t', " "), style); - spans.push(span); + // if there's anything left, emit it too + if !slice.is_empty() { + let span = Span::styled(slice.replace('\t', " "), style); + spans.push(span); + } + } } } @@ -140,7 +118,7 @@ pub fn highlighted_code_block<'a>( pub struct Markdown { contents: String, - config_loader: Arc<ArcSwap<syntax::Loader>>, + config_loader: Arc<syntax::Loader>, } // TODO: pre-render and self reference via Pin @@ -149,9 +127,6 @@ pub struct Markdown { impl Markdown { const TEXT_STYLE: &'static str = "ui.text"; const BLOCK_STYLE: &'static str = "markup.raw.inline"; - const RULE_STYLE: &'static str = "punctuation.special"; - const UNNUMBERED_LIST_STYLE: &'static str = "markup.list.unnumbered"; - const NUMBERED_LIST_STYLE: &'static str = "markup.list.numbered"; const HEADING_STYLES: [&'static str; 6] = [ "markup.heading.1", "markup.heading.2", @@ -160,22 +135,17 @@ impl Markdown { "markup.heading.5", "markup.heading.6", ]; - const INDENT: &'static str = " "; - pub fn new(contents: String, config_loader: Arc<ArcSwap<syntax::Loader>>) -> Self { + pub fn new(contents: String, config_loader: Arc<syntax::Loader>) -> Self { Self { contents, config_loader, } } - pub fn parse(&self, theme: Option<&Theme>) -> tui::text::Text<'_> { - fn push_line<'a>(spans: &mut Vec<Span<'a>>, lines: &mut Vec<Spans<'a>>) { - let spans = std::mem::take(spans); - if !spans.is_empty() { - lines.push(Spans::from(spans)); - } - } + fn parse(&self, theme: Option<&Theme>) -> tui::text::Text<'_> { + // // 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}}} + // 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```"; let mut options = Options::empty(); options.insert(Options::ENABLE_STRIKETHROUGH); @@ -185,144 +155,70 @@ impl Markdown { let mut tags = Vec::new(); let mut spans = Vec::new(); let mut lines = Vec::new(); - let mut list_stack = Vec::new(); - - let get_indent = |level: usize| { - if level < 1 { - String::new() - } else { - Self::INDENT.repeat(level - 1) - } - }; let get_theme = |key: &str| -> Style { theme.map(|t| t.get(key)).unwrap_or_default() }; let text_style = get_theme(Self::TEXT_STYLE); let code_style = get_theme(Self::BLOCK_STYLE); - let numbered_list_style = get_theme(Self::NUMBERED_LIST_STYLE); - let unnumbered_list_style = get_theme(Self::UNNUMBERED_LIST_STYLE); - let rule_style = get_theme(Self::RULE_STYLE); let heading_styles: Vec<Style> = Self::HEADING_STYLES .iter() .map(|key| get_theme(key)) .collect(); - // Transform text in `<code>` blocks into `Event::Code` - let mut in_code = false; - let parser = parser.filter_map(|event| match event { - Event::Html(tag) - if tag.starts_with("<code") && matches!(tag.chars().nth(5), Some(' ' | '>')) => - { - in_code = true; - None - } - Event::Html(tag) if *tag == *"</code>" => { - in_code = false; - None - } - Event::Text(text) if in_code => Some(Event::Code(text)), - _ => Some(event), - }); + let mut list_stack = Vec::new(); for event in parser { match event { - Event::Start(Tag::List(list)) => { - // if the list stack is not empty this is a sub list, in that - // case we need to push the current line before proceeding - if !list_stack.is_empty() { - push_line(&mut spans, &mut lines); - } - - list_stack.push(list); - } - Event::End(TagEnd::List(_)) => { + Event::Start(Tag::List(list)) => list_stack.push(list), + Event::End(Tag::List(_)) => { list_stack.pop(); - - // whenever top-level list closes, empty line - if list_stack.is_empty() { - lines.push(Spans::default()); - } } Event::Start(Tag::Item) => { - if list_stack.is_empty() { - log::warn!("markdown parsing error, list item without list"); - } - tags.push(Tag::Item); - - // get the appropriate bullet for the current list - let (bullet, bullet_style) = list_stack - .last() - .unwrap_or(&None) // use the '- ' bullet in case the list stack would be empty - .map_or((String::from("• "), unnumbered_list_style), |number| { - (format!("{}. ", number), numbered_list_style) - }); - - // increment the current list number if there is one - if let Some(v) = list_stack.last_mut().unwrap_or(&mut None).as_mut() { - *v += 1; - } - - let prefix = get_indent(list_stack.len()) + bullet.as_str(); - spans.push(Span::styled(prefix, bullet_style)); + spans.push(Span::from("- ")); } Event::Start(tag) => { tags.push(tag); - if spans.is_empty() && !list_stack.is_empty() { - // TODO: could push indent + 2 or 3 spaces to align with - // the rest of the list. - spans.push(Span::from(get_indent(list_stack.len()))); - } } Event::End(tag) => { tags.pop(); match tag { - TagEnd::Heading(_) - | TagEnd::Paragraph - | TagEnd::CodeBlock - | TagEnd::Item => { - push_line(&mut spans, &mut lines); - } - _ => (), - } - - // whenever heading, code block or paragraph closes, empty line - match tag { - TagEnd::Heading(_) | TagEnd::Paragraph | TagEnd::CodeBlock => { + Tag::Heading(_, _, _) + | Tag::Paragraph + | Tag::CodeBlock(CodeBlockKind::Fenced(_)) + | Tag::Item => { + // whenever code block or paragraph closes, new line + let spans = std::mem::take(&mut spans); + if !spans.is_empty() { + lines.push(Spans::from(spans)); + } lines.push(Spans::default()); } _ => (), } } Event::Text(text) => { - if let Some(Tag::CodeBlock(kind)) = tags.last() { - let language = match kind { - CodeBlockKind::Fenced(language) => language, - CodeBlockKind::Indented => "", - }; + // TODO: temp workaround + if let Some(Tag::CodeBlock(CodeBlockKind::Fenced(language))) = tags.last() { let tui_text = highlighted_code_block( - &text, + text.to_string(), language, theme, - &self.config_loader.load(), + Arc::clone(&self.config_loader), None, ); lines.extend(tui_text.lines.into_iter()); } else { - let style = match tags.last() { - Some(Tag::Heading { level, .. }) => match level { + let style = if let Some(Tag::Heading(level, ..)) = tags.last() { + match level { HeadingLevel::H1 => heading_styles[0], HeadingLevel::H2 => heading_styles[1], HeadingLevel::H3 => heading_styles[2], HeadingLevel::H4 => heading_styles[3], HeadingLevel::H5 => heading_styles[4], HeadingLevel::H6 => heading_styles[5], - }, - Some(Tag::Emphasis) => text_style.add_modifier(Modifier::ITALIC), - Some(Tag::Strong) => text_style.add_modifier(Modifier::BOLD), - Some(Tag::Strikethrough) => { - text_style.add_modifier(Modifier::CROSSED_OUT) } - _ => text_style, + } else { + text_style }; spans.push(Span::styled(text, style)); } @@ -331,15 +227,12 @@ impl Markdown { spans.push(Span::styled(text, code_style)); } Event::SoftBreak | Event::HardBreak => { - push_line(&mut spans, &mut lines); - if !list_stack.is_empty() { - // TODO: could push indent + 2 or 3 spaces to align with - // the rest of the list. - spans.push(Span::from(get_indent(list_stack.len()))); - } + // let spans = std::mem::replace(&mut spans, Vec::new()); + // lines.push(Spans::from(spans)); + spans.push(Span::raw(" ")); } Event::Rule => { - lines.push(Spans::from(Span::styled("───", rule_style))); + lines.push(Spans::from(Span::styled("---", code_style))); lines.push(Spans::default()); } // TaskListMarker(bool) true if checked @@ -371,20 +264,26 @@ impl Component for Markdown { let text = self.parse(Some(&cx.editor.theme)); - let par = Paragraph::new(&text) + let par = Paragraph::new(text) .wrap(Wrap { trim: false }) .scroll((cx.scroll.unwrap_or_default() as u16, 0)); - let margin = Margin::all(1); - par.render(area.inner(margin), surface); + let margin = Margin { + vertical: 1, + horizontal: 1, + }; + par.render(area.inner(&margin), surface); } fn required_size(&mut self, viewport: (u16, u16)) -> Option<(u16, u16)> { let padding = 2; + if padding >= viewport.1 || padding >= viewport.0 { + return None; + } let contents = self.parse(None); // TODO: account for tab width - let max_text_width = (viewport.0.saturating_sub(padding)).min(120); + let max_text_width = (viewport.0 - padding).min(120); let (width, height) = crate::ui::text::required_size(&contents, max_text_width); Some((width + padding, height + padding)) |