use crate::md::theme;
use pulldown_cmark::{Alignment, Event, Options, Parser, Tag, TagEnd};
use ratatui::style::{Modifier, Style};
use ratatui::text::{Line, Span};
#[derive(Clone, Debug, PartialEq)]
pub struct PCell {
pub ch: char,
pub style: Style,
pub link: Option<usize>,
pub src: Option<(usize, usize)>,
}
#[derive(Clone, Debug, PartialEq)]
pub struct ImageSpec {
pub alt: String,
pub url: String,
}
#[derive(Clone, Debug, Default)]
pub struct PLine {
pub cells: Vec<PCell>,
pub checkbox: Option<usize>,
pub image: Option<usize>,
pub src_line: Option<usize>,
}
pub fn to_line(cells: &[PCell]) -> Line<'static> {
let mut spans: Vec<Span<'static>> = Vec::new();
let mut text = String::new();
let mut current: Option<Style> = None;
for cell in cells {
if current != Some(cell.style) {
if let Some(s) = current {
spans.push(Span::styled(std::mem::take(&mut text), s));
}
current = Some(cell.style);
}
text.push(cell.ch);
}
if let Some(s) = current {
spans.push(Span::styled(text, s));
}
Line::from(spans)
}
impl PLine {
#[cfg(test)]
pub fn text(&self) -> String {
self.cells.iter().map(|c| c.ch).collect()
}
}
#[derive(Clone, Debug, Default)]
pub struct Rendered {
pub lines: Vec<PLine>,
pub urls: Vec<String>,
pub images: Vec<ImageSpec>,
}
impl Rendered {
pub fn url(&self, i: usize) -> Option<&str> {
self.urls.get(i).map(String::as_str)
}
}
fn options() -> Options {
Options::ENABLE_STRIKETHROUGH | Options::ENABLE_TASKLISTS | Options::ENABLE_TABLES
}
pub fn render(markdown: &str) -> Rendered {
let mut r = Ren::new(markdown);
r.run(markdown);
r.finish()
}
enum Sink {
Page,
Table,
}
#[derive(Default)]
struct Table {
aligns: Vec<Alignment>,
rows: Vec<Vec<Vec<PCell>>>,
in_head: bool,
row: Vec<Vec<PCell>>,
}
struct Ren {
src: String,
out: Rendered,
cells: Vec<PCell>,
cell_buf: Vec<PCell>,
sink: Sink,
styles: Vec<Style>,
link: Option<usize>,
prefix: String,
list_depth: usize,
in_code_block: bool,
table: Option<Table>,
line_starts: Vec<usize>,
src_line: Option<usize>,
pending_checkbox: Option<usize>,
done_item: bool,
image_alt: Option<(String, String)>,
}
impl Ren {
fn new(markdown: &str) -> Ren {
let mut line_starts = vec![0usize];
for (i, b) in markdown.bytes().enumerate() {
if b == b'\n' {
line_starts.push(i + 1);
}
}
Ren {
src: markdown.to_string(),
out: Rendered::default(),
cells: Vec::new(),
cell_buf: Vec::new(),
sink: Sink::Page,
styles: vec![Style::default()],
link: None,
prefix: String::new(),
list_depth: 0,
in_code_block: false,
table: None,
line_starts,
src_line: None,
pending_checkbox: None,
done_item: false,
image_alt: None,
}
}
fn style(&self) -> Style {
*self.styles.last().unwrap()
}
fn buf(&mut self) -> &mut Vec<PCell> {
match self.sink {
Sink::Page => &mut self.cells,
Sink::Table => &mut self.cell_buf,
}
}
fn push(&mut self, text: &str, style: Style, link: Option<usize>) {
self.push_at(text, style, link, None);
}
fn push_at(&mut self, text: &str, style: Style, link: Option<usize>, off: Option<usize>) {
let mut off = off;
let mut cells: Vec<PCell> = Vec::with_capacity(text.len());
for ch in text.chars() {
cells.push(PCell {
ch,
style,
link,
src: off.map(|o| self.pos_of(o)),
});
if let Some(o) = off.as_mut() {
*o += ch.len_utf8();
}
}
self.buf().extend(cells);
}
fn line_of(&self, offset: usize) -> usize {
match self.line_starts.binary_search(&offset) {
Ok(i) => i,
Err(i) => i.saturating_sub(1),
}
}
fn pos_of(&self, offset: usize) -> (usize, usize) {
let line = self.line_of(offset);
let start = self.line_starts.get(line).copied().unwrap_or(0);
let offset = offset.min(self.src.len());
let col = self.src.get(start..offset).map_or(0, |s| s.chars().count());
(line, col)
}
fn flush(&mut self) {
if self.cells.is_empty() {
return;
}
let cells = std::mem::take(&mut self.cells);
self.out.lines.push(PLine {
cells,
checkbox: self.pending_checkbox.take(),
image: None,
src_line: self.src_line,
});
}
fn blank(&mut self) {
self.flush();
if !self
.out
.lines
.last()
.map(|l| l.cells.is_empty())
.unwrap_or(true)
{
self.out.lines.push(PLine::default());
}
}
fn line_prefix(&mut self) {
if self.prefix.is_empty() || !matches!(self.sink, Sink::Page) || !self.cells.is_empty() {
return;
}
let p = self.prefix.clone();
self.push(&p, theme::MARKER, None);
}
fn indent(&self) -> String {
format!(
"{}{}",
self.prefix,
" ".repeat(self.list_depth.saturating_sub(1))
)
}
fn emit_text(&mut self, text: &str, off: Option<usize>) {
let base = self.style();
let link = self.link;
let chars: Vec<char> = text.chars().collect();
let mut byte_at: Vec<usize> = Vec::with_capacity(chars.len() + 1);
let mut b = 0;
for ch in &chars {
byte_at.push(b);
b += ch.len_utf8();
}
byte_at.push(b);
let at = |i: usize| off.map(|o| o + byte_at[i]);
let mut i = 0;
let mut run = String::new();
let mut run_start = 0usize;
while i < chars.len() {
if chars[i] == '=' && chars.get(i + 1) == Some(&'=') {
if let Some(end) = find_pair(&chars, i + 2) {
self.push_at(&std::mem::take(&mut run), base, link, at(run_start));
let body: String = chars[i + 2..end].iter().collect();
self.push_at(&body, base.patch(theme::HIGHLIGHT), link, at(i + 2));
i = end + 2;
run_start = i;
continue;
}
}
if link.is_none() && starts_url(&chars, i) {
let mut end = i;
while end < chars.len() && !chars[end].is_whitespace() {
end += 1;
}
while end > i && matches!(chars[end - 1], '.' | ',' | ')' | ']' | '!' | '?') {
end -= 1;
}
let url: String = chars[i..end].iter().collect();
self.push_at(&std::mem::take(&mut run), base, None, at(run_start));
let idx = self.out.urls.len();
self.out.urls.push(url.clone());
self.push_at(&url, base.patch(theme::LINK), Some(idx), at(i));
i = end;
run_start = i;
continue;
}
if run.is_empty() {
run_start = i;
}
run.push(chars[i]);
i += 1;
}
self.push_at(&run, base, link, at(run_start));
}
fn run(&mut self, markdown: &str) {
for (event, range) in Parser::new_ext(markdown, options()).into_offset_iter() {
let src_line = self.line_of(range.start);
if self.cells.is_empty() && matches!(self.sink, Sink::Page) {
self.src_line = Some(src_line);
}
self.event(event, src_line, range);
}
self.flush();
}
fn event(&mut self, event: Event<'_>, src_line: usize, range: std::ops::Range<usize>) {
match event {
Event::Start(Tag::Heading { level, .. }) => {
self.blank();
self.src_line = Some(src_line);
self.line_prefix();
self.styles.push(theme::heading(level as usize));
}
Event::End(TagEnd::Heading(_)) => {
self.styles.pop();
self.flush();
}
Event::Start(Tag::Paragraph) => {
if self.list_depth == 0 && self.table.is_none() {
self.blank();
self.src_line = Some(src_line);
}
self.line_prefix();
}
Event::End(TagEnd::Paragraph) => self.flush(),
Event::Start(Tag::BlockQuote(_)) => {
self.blank();
self.prefix.push_str("▌ ");
self.styles.push(theme::QUOTE);
}
Event::End(TagEnd::BlockQuote(_)) => {
self.styles.pop();
let n = self.prefix.len().saturating_sub("▌ ".len());
self.prefix.truncate(n);
self.flush();
}
Event::Start(Tag::List(_)) => {
if self.list_depth == 0 {
self.blank();
}
self.list_depth += 1;
}
Event::End(TagEnd::List(_)) => {
self.list_depth = self.list_depth.saturating_sub(1);
self.flush();
}
Event::Start(Tag::Item) => {
self.flush();
self.src_line = Some(src_line);
let text = format!("{}{} ", self.indent(), theme::BULLET);
self.push(&text, theme::MARKER, None);
}
Event::End(TagEnd::Item) => {
if self.done_item {
self.styles.pop();
self.done_item = false;
}
self.flush()
}
Event::TaskListMarker(done) => {
self.cells.clear();
let (mark, style) = if done {
(theme::CHECKED, theme::DONE)
} else {
(theme::UNCHECKED, theme::MARKER)
};
let text = format!("{}{mark} ", self.indent());
self.push(&text, style, None);
self.pending_checkbox = Some(src_line);
if done {
self.styles.push(self.style().patch(theme::DONE_TEXT));
self.done_item = true;
}
}
Event::Start(Tag::CodeBlock(_)) => {
self.blank();
self.src_line = Some(src_line);
self.in_code_block = true;
}
Event::End(TagEnd::CodeBlock) => {
self.in_code_block = false;
self.flush();
}
Event::Start(Tag::Emphasis) => self
.styles
.push(self.style().add_modifier(Modifier::ITALIC)),
Event::Start(Tag::Strong) => {
self.styles.push(self.style().add_modifier(Modifier::BOLD))
}
Event::Start(Tag::Strikethrough) => self
.styles
.push(self.style().add_modifier(Modifier::CROSSED_OUT)),
Event::End(TagEnd::Emphasis)
| Event::End(TagEnd::Strong)
| Event::End(TagEnd::Strikethrough) => {
self.styles.pop();
}
Event::Start(Tag::Link { dest_url, .. }) => {
let idx = self.out.urls.len();
self.out.urls.push(dest_url.into_string());
self.link = Some(idx);
self.styles.push(self.style().patch(theme::LINK));
}
Event::End(TagEnd::Link) => {
self.styles.pop();
self.link = None;
}
Event::Start(Tag::Image { dest_url, .. }) => {
self.image_alt = Some((String::new(), dest_url.into_string()));
}
Event::End(TagEnd::Image) => {
if let Some((alt, url)) = self.image_alt.take() {
self.flush();
let idx = self.out.images.len();
self.out.images.push(ImageSpec {
alt: alt.clone(),
url: url.clone(),
});
let label = if alt.is_empty() {
format!("🖼 {url}")
} else {
format!("🖼 {alt} ({url})")
};
self.push(&label, theme::MARKER, None);
let cells = std::mem::take(&mut self.cells);
self.out.lines.push(PLine {
cells,
checkbox: None,
image: Some(idx),
src_line: self.src_line,
});
}
}
Event::Start(Tag::Table(aligns)) => {
self.blank();
self.src_line = Some(src_line);
self.table = Some(Table {
aligns,
..Table::default()
});
}
Event::End(TagEnd::Table) => self.emit_table(),
Event::Start(Tag::TableHead) => {
if let Some(t) = self.table.as_mut() {
t.in_head = true;
}
}
Event::End(TagEnd::TableHead) | Event::End(TagEnd::TableRow) => {
if let Some(t) = self.table.as_mut() {
let row = std::mem::take(&mut t.row);
t.rows.push(row);
t.in_head = false;
}
}
Event::Start(Tag::TableRow) => {}
Event::Start(Tag::TableCell) => {
self.cell_buf.clear();
self.sink = Sink::Table;
if self.table.as_ref().is_some_and(|t| t.in_head) {
self.styles.push(self.style().add_modifier(Modifier::BOLD));
}
}
Event::End(TagEnd::TableCell) => {
if self.table.as_ref().is_some_and(|t| t.in_head) {
self.styles.pop();
}
self.sink = Sink::Page;
let cell = std::mem::take(&mut self.cell_buf);
if let Some(t) = self.table.as_mut() {
t.row.push(cell);
}
}
Event::Code(code) => {
let style = self.style().patch(theme::CODE);
let link = self.link;
let ticks = self.src[range.clone()]
.chars()
.take_while(|c| *c == '`')
.count();
self.push_at(&code.into_string(), style, link, Some(range.start + ticks));
}
Event::Text(text) => {
if let Some((alt, _)) = self.image_alt.as_mut() {
alt.push_str(&text);
} else if self.in_code_block {
let mut off = range.start;
for raw in text.split_inclusive('\n') {
let l = raw.trim_end_matches('\n').trim_end_matches('\r');
self.push(" ", theme::CODE, None);
self.push_at(l, theme::CODE, None, Some(off));
off += raw.len();
let cells = std::mem::take(&mut self.cells);
self.out.lines.push(PLine {
cells,
checkbox: None,
image: None,
src_line: self.src_line,
});
}
} else {
self.emit_text(&text, Some(range.start));
}
}
Event::SoftBreak => {
if matches!(self.sink, Sink::Table) {
self.push(" ", self.style(), self.link);
} else {
self.flush();
self.src_line = Some(src_line);
if !self.prefix.is_empty() {
let p = self.prefix.clone();
self.push(&p, theme::MARKER, None);
}
}
}
Event::HardBreak => self.flush(),
Event::Rule => {
self.blank();
self.push(&"─".repeat(40), theme::MARKER, None);
self.flush();
}
_ => {}
}
}
fn emit_table(&mut self) {
let Some(t) = self.table.take() else { return };
if t.rows.is_empty() {
return;
}
let cols = t.rows.iter().map(|r| r.len()).max().unwrap_or(0);
let measured: Vec<Vec<usize>> = t
.rows
.iter()
.map(|r| r.iter().map(|c| cells_width(c)).collect())
.collect();
let widths = crate::md::column_widths(&measured, cols);
let src_line = self.src_line;
for (ri, row) in t.rows.iter().enumerate() {
let mut cells: Vec<PCell> = Vec::new();
for (ci, w) in widths.iter().enumerate().take(cols) {
if ci > 0 {
cells.extend(str_cells(crate::md::COL_SEP, theme::MARKER));
}
let empty: Vec<PCell> = Vec::new();
let cell = row.get(ci).unwrap_or(&empty);
let align = align_of(t.aligns.get(ci).copied().unwrap_or(Alignment::None));
let (left, right) = crate::md::pad_for(cells_width(cell), *w, align);
cells.extend(str_cells(&" ".repeat(left), theme::PLAIN));
cells.extend(cell.iter().cloned());
cells.extend(str_cells(&" ".repeat(right), theme::PLAIN));
}
self.out.lines.push(PLine {
cells,
checkbox: None,
image: None,
src_line,
});
if ri == 0 {
let rule = crate::md::table_rule(&widths);
self.out.lines.push(PLine {
cells: str_cells(&rule, theme::MARKER),
checkbox: None,
image: None,
src_line,
});
}
}
}
fn finish(mut self) -> Rendered {
self.flush();
self.out
}
}
fn align_of(a: Alignment) -> crate::md::Align {
match a {
Alignment::Right => crate::md::Align::Right,
Alignment::Center => crate::md::Align::Center,
_ => crate::md::Align::Left,
}
}
fn str_cells(s: &str, style: Style) -> Vec<PCell> {
s.chars()
.map(|ch| PCell {
ch,
style,
link: None,
src: None,
})
.collect()
}
pub fn cells_width(cells: &[PCell]) -> usize {
cells.iter().map(|c| crate::md::char_width(c.ch)).sum()
}
fn starts_url(chars: &[char], i: usize) -> bool {
let rest: String = chars[i..].iter().take(8).collect();
(rest.starts_with("http://") || rest.starts_with("https://"))
&& (i == 0 || !chars[i - 1].is_alphanumeric())
}
fn find_pair(chars: &[char], from: usize) -> Option<usize> {
(from..chars.len().saturating_sub(1)).find(|&k| chars[k] == '=' && chars[k + 1] == '=')
}
#[cfg(test)]
mod tests {
use super::*;
fn flat(r: &Rendered) -> String {
r.lines
.iter()
.map(|l| l.text())
.collect::<Vec<_>>()
.join("\n")
}
#[test]
fn renders_without_panic() {
let md = "# Title\n\nSome **bold** and *italic* and `code`.\n\n- one\n- [ ] task\n- [x] done\n\n> quote\n\n```\nlet x = 1;\n```\n\n---\n";
let r = render(md);
assert!(r.lines.len() > 5);
let flat = flat(&r);
assert!(flat.contains("Title"));
assert!(flat.contains("bold"));
assert!(flat.contains("let x = 1;"));
}
#[test]
fn code_block_offsets_survive_crlf() {
for md in [
"# T\n\n```\nlet x = 1;\nlet y = 2;\n```\n\ntail\n",
"# T\r\n\r\n```\r\nlet x = 1;\r\nlet y = 2;\r\n```\r\n\r\ntail\r\n",
] {
let src_lines: Vec<&str> = md.lines().collect();
for line in &render(md).lines {
for c in &line.cells {
if let Some((l, col)) = c.src {
let at = src_lines[l].chars().nth(col);
assert_eq!(at, Some(c.ch), "{md:?} at ({l},{col})");
}
}
}
}
}
#[test]
fn tables_get_aligned_columns_and_a_head_rule() {
let md = "| a | bbbb |\n| --- | ---: |\n| 1 | 2 |\n";
let r = render(md);
let rows: Vec<String> = r
.lines
.iter()
.map(|l| l.text())
.filter(|t| !t.trim().is_empty())
.collect();
assert_eq!(rows[0], "a │ bbbb");
assert_eq!(rows[1], "──┼─────");
assert_eq!(rows[2], "1 │ 2"); assert!(r.lines[0].cells[0]
.style
.add_modifier
.contains(Modifier::BOLD));
}
#[test]
fn table_columns_are_measured_in_display_columns() {
let r = render("| 漢字 | b |\n| --- | --- |\n| x | y |\n");
let rows: Vec<&PLine> = r
.lines
.iter()
.filter(|l| !l.text().trim().is_empty())
.collect();
let widths: Vec<usize> = rows.iter().map(|l| cells_width(&l.cells)).collect();
assert!(widths.windows(2).all(|w| w[0] == w[1]), "{widths:?}");
}
#[test]
fn every_quoted_line_gets_its_bar() {
let r = render("> first line\n> second line\n\nafter\n");
let quoted: Vec<String> = r
.lines
.iter()
.map(|l| l.text())
.filter(|t| t.contains("line"))
.collect();
assert_eq!(quoted, vec!["▌ first line", "▌ second line"]);
assert!(r.lines.iter().any(|l| l.text() == "after"));
}
#[test]
fn highlight_gets_the_highlight_style() {
let r = render("a ==wow== b");
let line = r.lines.iter().find(|l| l.text().contains("wow")).unwrap();
assert_eq!(line.text(), "a wow b");
let cell = line.cells.iter().find(|c| c.ch == 'w').unwrap();
assert_eq!(cell.style.bg, theme::HIGHLIGHT.bg);
}
#[test]
fn checkboxes_render_and_remember_their_source_line() {
let r = render("# t\n\n- [ ] todo\n- [x] done\n");
let todo = r.lines.iter().find(|l| l.text().contains("todo")).unwrap();
assert_eq!(todo.text(), "☐ todo");
assert_eq!(todo.checkbox, Some(2));
let done = r.lines.iter().find(|l| l.text().contains("done")).unwrap();
assert_eq!(done.text(), "✓ done");
assert_eq!(done.checkbox, Some(3));
assert!(done.cells[0].style.fg == theme::DONE.fg);
}
#[test]
fn links_and_bare_urls_are_recorded() {
let r = render("see [docs](http://x.y) and https://z.example/p now");
let line = r.lines.iter().find(|l| l.text().contains("docs")).unwrap();
let docs = line.cells.iter().find(|c| c.ch == 'd').unwrap();
assert_eq!(r.url(docs.link.unwrap()), Some("http://x.y"));
let bare = line
.cells
.iter()
.find(|c| c.link.map(|i| r.urls[i].starts_with("https://z")) == Some(true))
.unwrap();
assert_eq!(r.url(bare.link.unwrap()), Some("https://z.example/p"));
assert!(line.text().contains("https://z.example/p"));
}
#[test]
fn images_become_their_own_line() {
let r = render("\n");
let line = r.lines.iter().find(|l| l.image.is_some()).unwrap();
assert_eq!(line.text(), "🖼 a cat (cat.png)");
assert_eq!(
r.images[line.image.unwrap()],
ImageSpec {
alt: "a cat".into(),
url: "cat.png".into()
}
);
}
}