bendns' repos / helix
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.rs202
1 files changed, 83 insertions, 119 deletions
diff --git a/helix-term/src/ui/markdown.rs b/helix-term/src/ui/markdown.rs
index 6bef59d1..923dd73a 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",
@@ -162,7 +137,7 @@ impl Markdown {
];
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,
@@ -198,9 +173,6 @@ impl Markdown {
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))
@@ -209,9 +181,7 @@ impl Markdown {
// 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(' ' | '>')) =>
- {
+ Event::Html(tag) if *tag == *"<code>" => {
in_code = true;
None
}
@@ -234,7 +204,7 @@ impl Markdown {
list_stack.push(list);
}
- Event::End(TagEnd::List(_)) => {
+ Event::End(Tag::List(_)) => {
list_stack.pop();
// whenever top-level list closes, empty line
@@ -250,12 +220,10 @@ impl Markdown {
tags.push(Tag::Item);
// get the appropriate bullet for the current list
- let (bullet, bullet_style) = list_stack
+ let bullet = 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)
- });
+ .map_or(String::from("- "), |number| format!("{}. ", number));
// increment the current list number if there is one
if let Some(v) = list_stack.last_mut().unwrap_or(&mut None).as_mut() {
@@ -263,7 +231,7 @@ impl Markdown {
}
let prefix = get_indent(list_stack.len()) + bullet.as_str();
- spans.push(Span::styled(prefix, bullet_style));
+ spans.push(Span::from(prefix));
}
Event::Start(tag) => {
tags.push(tag);
@@ -276,10 +244,7 @@ impl Markdown {
Event::End(tag) => {
tags.pop();
match tag {
- TagEnd::Heading(_)
- | TagEnd::Paragraph
- | TagEnd::CodeBlock
- | TagEnd::Item => {
+ Tag::Heading(_, _, _) | Tag::Paragraph | Tag::CodeBlock(_) | Tag::Item => {
push_line(&mut spans, &mut lines);
}
_ => (),
@@ -287,7 +252,7 @@ impl Markdown {
// whenever heading, code block or paragraph closes, empty line
match tag {
- TagEnd::Heading(_) | TagEnd::Paragraph | TagEnd::CodeBlock => {
+ Tag::Heading(_, _, _) | Tag::Paragraph | Tag::CodeBlock(_) => {
lines.push(Spans::default());
}
_ => (),
@@ -300,29 +265,25 @@ impl Markdown {
CodeBlockKind::Indented => "",
};
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));
}
@@ -339,7 +300,7 @@ impl Markdown {
}
}
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 +332,23 @@ 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);
+ 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))