markdown_renderer.rs

   1use crate::markdown_elements::{
   2    HeadingLevel, Image, Link, MarkdownParagraph, MarkdownParagraphChunk, ParsedMarkdown,
   3    ParsedMarkdownBlockQuote, ParsedMarkdownCodeBlock, ParsedMarkdownElement,
   4    ParsedMarkdownHeading, ParsedMarkdownListItem, ParsedMarkdownListItemType, ParsedMarkdownTable,
   5    ParsedMarkdownTableAlignment, ParsedMarkdownTableRow,
   6};
   7use fs::normalize_path;
   8use gpui::{
   9    AbsoluteLength, AnyElement, App, AppContext as _, ClipboardItem, Context, Div, Element,
  10    ElementId, Entity, HighlightStyle, Hsla, ImageSource, InteractiveText, IntoElement, Keystroke,
  11    Modifiers, ParentElement, Render, Resource, SharedString, Styled, StyledText, TextStyle,
  12    WeakEntity, Window, div, img, rems,
  13};
  14use settings::Settings;
  15use std::{
  16    ops::{Mul, Range},
  17    sync::Arc,
  18    vec,
  19};
  20use theme::{ActiveTheme, SyntaxTheme, ThemeSettings};
  21use ui::{
  22    ButtonCommon, Clickable, Color, FluentBuilder, IconButton, IconName, IconSize,
  23    InteractiveElement, Label, LabelCommon, LabelSize, LinkPreview, Pixels, Rems,
  24    StatefulInteractiveElement, StyledExt, StyledImage, ToggleState, Tooltip, VisibleOnHover,
  25    h_flex, tooltip_container, v_flex,
  26};
  27use workspace::{OpenOptions, OpenVisible, Workspace};
  28
  29pub struct CheckboxClickedEvent {
  30    pub checked: bool,
  31    pub source_range: Range<usize>,
  32}
  33
  34impl CheckboxClickedEvent {
  35    pub fn source_range(&self) -> Range<usize> {
  36        self.source_range.clone()
  37    }
  38
  39    pub fn checked(&self) -> bool {
  40        self.checked
  41    }
  42}
  43
  44type CheckboxClickedCallback = Arc<Box<dyn Fn(&CheckboxClickedEvent, &mut Window, &mut App)>>;
  45
  46#[derive(Clone)]
  47pub struct RenderContext {
  48    workspace: Option<WeakEntity<Workspace>>,
  49    next_id: usize,
  50    buffer_font_family: SharedString,
  51    buffer_text_style: TextStyle,
  52    text_style: TextStyle,
  53    border_color: Hsla,
  54    title_bar_background_color: Hsla,
  55    panel_background_color: Hsla,
  56    text_color: Hsla,
  57    link_color: Hsla,
  58    window_rem_size: Pixels,
  59    text_muted_color: Hsla,
  60    code_block_background_color: Hsla,
  61    code_span_background_color: Hsla,
  62    syntax_theme: Arc<SyntaxTheme>,
  63    indent: usize,
  64    checkbox_clicked_callback: Option<CheckboxClickedCallback>,
  65    is_last_child: bool,
  66}
  67
  68impl RenderContext {
  69    pub fn new(
  70        workspace: Option<WeakEntity<Workspace>>,
  71        window: &mut Window,
  72        cx: &mut App,
  73    ) -> RenderContext {
  74        let theme = cx.theme().clone();
  75
  76        let settings = ThemeSettings::get_global(cx);
  77        let buffer_font_family = settings.buffer_font.family.clone();
  78        let mut buffer_text_style = window.text_style();
  79        buffer_text_style.font_family = buffer_font_family.clone();
  80        buffer_text_style.font_size = AbsoluteLength::from(settings.buffer_font_size(cx));
  81
  82        RenderContext {
  83            workspace,
  84            next_id: 0,
  85            indent: 0,
  86            buffer_font_family,
  87            buffer_text_style,
  88            text_style: window.text_style(),
  89            syntax_theme: theme.syntax().clone(),
  90            border_color: theme.colors().border,
  91            title_bar_background_color: theme.colors().title_bar_background,
  92            panel_background_color: theme.colors().panel_background,
  93            text_color: theme.colors().text,
  94            link_color: theme.colors().text_accent,
  95            window_rem_size: window.rem_size(),
  96            text_muted_color: theme.colors().text_muted,
  97            code_block_background_color: theme.colors().surface_background,
  98            code_span_background_color: theme.colors().editor_document_highlight_read_background,
  99            checkbox_clicked_callback: None,
 100            is_last_child: false,
 101        }
 102    }
 103
 104    pub fn with_checkbox_clicked_callback(
 105        mut self,
 106        callback: impl Fn(&CheckboxClickedEvent, &mut Window, &mut App) + 'static,
 107    ) -> Self {
 108        self.checkbox_clicked_callback = Some(Arc::new(Box::new(callback)));
 109        self
 110    }
 111
 112    fn next_id(&mut self, span: &Range<usize>) -> ElementId {
 113        let id = format!("markdown-{}-{}-{}", self.next_id, span.start, span.end);
 114        self.next_id += 1;
 115        ElementId::from(SharedString::from(id))
 116    }
 117
 118    /// HACK: used to have rems relative to buffer font size, so that things scale appropriately as
 119    /// buffer font size changes. The callees of this function should be reimplemented to use real
 120    /// relative sizing once that is implemented in GPUI
 121    pub fn scaled_rems(&self, rems: f32) -> Rems {
 122        self.buffer_text_style
 123            .font_size
 124            .to_rems(self.window_rem_size)
 125            .mul(rems)
 126    }
 127
 128    /// This ensures that children inside of block quotes
 129    /// have padding between them.
 130    ///
 131    /// For example, for this markdown:
 132    ///
 133    /// ```markdown
 134    /// > This is a block quote.
 135    /// >
 136    /// > And this is the next paragraph.
 137    /// ```
 138    ///
 139    /// We give padding between "This is a block quote."
 140    /// and "And this is the next paragraph."
 141    fn with_common_p(&self, element: Div) -> Div {
 142        if self.indent > 0 && !self.is_last_child {
 143            element.pb(self.scaled_rems(0.75))
 144        } else {
 145            element
 146        }
 147    }
 148
 149    /// The is used to indicate that the current element is the last child or not of its parent.
 150    ///
 151    /// Then we can avoid adding padding to the bottom of the last child.
 152    fn with_last_child<R>(&mut self, is_last: bool, render: R) -> AnyElement
 153    where
 154        R: FnOnce(&mut Self) -> AnyElement,
 155    {
 156        self.is_last_child = is_last;
 157        let element = render(self);
 158        self.is_last_child = false;
 159        element
 160    }
 161}
 162
 163pub fn render_parsed_markdown(
 164    parsed: &ParsedMarkdown,
 165    workspace: Option<WeakEntity<Workspace>>,
 166    window: &mut Window,
 167    cx: &mut App,
 168) -> Div {
 169    let mut cx = RenderContext::new(workspace, window, cx);
 170
 171    v_flex().gap_3().children(
 172        parsed
 173            .children
 174            .iter()
 175            .map(|block| render_markdown_block(block, &mut cx)),
 176    )
 177}
 178pub fn render_markdown_block(block: &ParsedMarkdownElement, cx: &mut RenderContext) -> AnyElement {
 179    use ParsedMarkdownElement::*;
 180    match block {
 181        Paragraph(text) => render_markdown_paragraph(text, cx),
 182        Heading(heading) => render_markdown_heading(heading, cx),
 183        ListItem(list_item) => render_markdown_list_item(list_item, cx),
 184        Table(table) => render_markdown_table(table, cx),
 185        BlockQuote(block_quote) => render_markdown_block_quote(block_quote, cx),
 186        CodeBlock(code_block) => render_markdown_code_block(code_block, cx),
 187        HorizontalRule(_) => render_markdown_rule(cx),
 188        Image(image) => render_markdown_image(image, cx),
 189    }
 190}
 191
 192fn render_markdown_heading(parsed: &ParsedMarkdownHeading, cx: &mut RenderContext) -> AnyElement {
 193    let size = match parsed.level {
 194        HeadingLevel::H1 => 2.,
 195        HeadingLevel::H2 => 1.5,
 196        HeadingLevel::H3 => 1.25,
 197        HeadingLevel::H4 => 1.,
 198        HeadingLevel::H5 => 0.875,
 199        HeadingLevel::H6 => 0.85,
 200    };
 201
 202    let text_size = cx.scaled_rems(size);
 203
 204    // was `DefiniteLength::from(text_size.mul(1.25))`
 205    // let line_height = DefiniteLength::from(text_size.mul(1.25));
 206    let line_height = text_size * 1.25;
 207
 208    // was `rems(0.15)`
 209    // let padding_top = cx.scaled_rems(0.15);
 210    let padding_top = rems(0.15);
 211
 212    // was `.pb_1()` = `rems(0.25)`
 213    // let padding_bottom = cx.scaled_rems(0.25);
 214    let padding_bottom = rems(0.25);
 215
 216    let color = match parsed.level {
 217        HeadingLevel::H6 => cx.text_muted_color,
 218        _ => cx.text_color,
 219    };
 220    div()
 221        .line_height(line_height)
 222        .text_size(text_size)
 223        .text_color(color)
 224        .pt(padding_top)
 225        .pb(padding_bottom)
 226        .children(render_markdown_text(&parsed.contents, cx))
 227        .whitespace_normal()
 228        .into_any()
 229}
 230
 231fn render_markdown_list_item(
 232    parsed: &ParsedMarkdownListItem,
 233    cx: &mut RenderContext,
 234) -> AnyElement {
 235    use ParsedMarkdownListItemType::*;
 236    let depth = parsed.depth.saturating_sub(1) as usize;
 237
 238    let bullet = match &parsed.item_type {
 239        Ordered(order) => list_item_prefix(*order as usize, true, depth).into_any_element(),
 240        Unordered => list_item_prefix(1, false, depth).into_any_element(),
 241        Task(checked, range) => div()
 242            .id(cx.next_id(range))
 243            .mt(cx.scaled_rems(3.0 / 16.0))
 244            .child(
 245                MarkdownCheckbox::new(
 246                    "checkbox",
 247                    if *checked {
 248                        ToggleState::Selected
 249                    } else {
 250                        ToggleState::Unselected
 251                    },
 252                    cx.clone(),
 253                )
 254                .when_some(
 255                    cx.checkbox_clicked_callback.clone(),
 256                    |this, callback| {
 257                        this.on_click({
 258                            let range = range.clone();
 259                            move |selection, window, cx| {
 260                                let checked = match selection {
 261                                    ToggleState::Selected => true,
 262                                    ToggleState::Unselected => false,
 263                                    _ => return,
 264                                };
 265
 266                                if window.modifiers().secondary() {
 267                                    callback(
 268                                        &CheckboxClickedEvent {
 269                                            checked,
 270                                            source_range: range.clone(),
 271                                        },
 272                                        window,
 273                                        cx,
 274                                    );
 275                                }
 276                            }
 277                        })
 278                    },
 279                ),
 280            )
 281            .hover(|s| s.cursor_pointer())
 282            .tooltip(|_, cx| {
 283                InteractiveMarkdownElementTooltip::new(None, "toggle checkbox", cx).into()
 284            })
 285            .into_any_element(),
 286    };
 287    let bullet = div().mr(cx.scaled_rems(0.5)).child(bullet);
 288
 289    let contents: Vec<AnyElement> = parsed
 290        .content
 291        .iter()
 292        .map(|c| render_markdown_block(c, cx))
 293        .collect();
 294
 295    let item = h_flex()
 296        .when(!parsed.nested, |this| this.pl(cx.scaled_rems(depth as f32)))
 297        .when(parsed.nested && depth > 0, |this| this.ml_neg_1p5())
 298        .items_start()
 299        .children(vec![
 300            bullet,
 301            v_flex()
 302                .children(contents)
 303                .when(!parsed.nested, |this| this.gap(cx.scaled_rems(1.0)))
 304                .pr(cx.scaled_rems(1.0))
 305                .w_full(),
 306        ]);
 307
 308    cx.with_common_p(item).into_any()
 309}
 310
 311/// # MarkdownCheckbox ///
 312/// HACK: Copied from `ui/src/components/toggle.rs` to deal with scaling issues in markdown preview
 313/// changes should be integrated into `Checkbox` in `toggle.rs` while making sure checkboxes elsewhere in the
 314/// app are not visually affected
 315#[derive(gpui::IntoElement)]
 316struct MarkdownCheckbox {
 317    id: ElementId,
 318    toggle_state: ToggleState,
 319    disabled: bool,
 320    placeholder: bool,
 321    on_click: Option<Box<dyn Fn(&ToggleState, &mut Window, &mut App) + 'static>>,
 322    filled: bool,
 323    style: ui::ToggleStyle,
 324    tooltip: Option<Box<dyn Fn(&mut Window, &mut App) -> gpui::AnyView>>,
 325    label: Option<SharedString>,
 326    render_cx: RenderContext,
 327}
 328
 329impl MarkdownCheckbox {
 330    /// Creates a new [`Checkbox`].
 331    fn new(id: impl Into<ElementId>, checked: ToggleState, render_cx: RenderContext) -> Self {
 332        Self {
 333            id: id.into(),
 334            toggle_state: checked,
 335            disabled: false,
 336            on_click: None,
 337            filled: false,
 338            style: ui::ToggleStyle::default(),
 339            tooltip: None,
 340            label: None,
 341            placeholder: false,
 342            render_cx,
 343        }
 344    }
 345
 346    /// Binds a handler to the [`Checkbox`] that will be called when clicked.
 347    fn on_click(mut self, handler: impl Fn(&ToggleState, &mut Window, &mut App) + 'static) -> Self {
 348        self.on_click = Some(Box::new(handler));
 349        self
 350    }
 351
 352    fn bg_color(&self, cx: &App) -> Hsla {
 353        let style = self.style.clone();
 354        match (style, self.filled) {
 355            (ui::ToggleStyle::Ghost, false) => cx.theme().colors().ghost_element_background,
 356            (ui::ToggleStyle::Ghost, true) => cx.theme().colors().element_background,
 357            (ui::ToggleStyle::ElevationBased(_), false) => gpui::transparent_black(),
 358            (ui::ToggleStyle::ElevationBased(elevation), true) => elevation.darker_bg(cx),
 359            (ui::ToggleStyle::Custom(_), false) => gpui::transparent_black(),
 360            (ui::ToggleStyle::Custom(color), true) => color.opacity(0.2),
 361        }
 362    }
 363
 364    fn border_color(&self, cx: &App) -> Hsla {
 365        if self.disabled {
 366            return cx.theme().colors().border_variant;
 367        }
 368
 369        match self.style.clone() {
 370            ui::ToggleStyle::Ghost => cx.theme().colors().border,
 371            ui::ToggleStyle::ElevationBased(_) => cx.theme().colors().border,
 372            ui::ToggleStyle::Custom(color) => color.opacity(0.3),
 373        }
 374    }
 375}
 376
 377impl gpui::RenderOnce for MarkdownCheckbox {
 378    fn render(self, _: &mut Window, cx: &mut App) -> impl IntoElement {
 379        let group_id = format!("checkbox_group_{:?}", self.id);
 380        let color = if self.disabled {
 381            Color::Disabled
 382        } else {
 383            Color::Selected
 384        };
 385        let icon_size_small = IconSize::Custom(self.render_cx.scaled_rems(14. / 16.)); // was IconSize::Small
 386        let icon = match self.toggle_state {
 387            ToggleState::Selected => {
 388                if self.placeholder {
 389                    None
 390                } else {
 391                    Some(
 392                        ui::Icon::new(IconName::Check)
 393                            .size(icon_size_small)
 394                            .color(color),
 395                    )
 396                }
 397            }
 398            ToggleState::Indeterminate => Some(
 399                ui::Icon::new(IconName::Dash)
 400                    .size(icon_size_small)
 401                    .color(color),
 402            ),
 403            ToggleState::Unselected => None,
 404        };
 405
 406        let bg_color = self.bg_color(cx);
 407        let border_color = self.border_color(cx);
 408        let hover_border_color = border_color.alpha(0.7);
 409
 410        let size = self.render_cx.scaled_rems(1.25); // was Self::container_size(); (20px)
 411
 412        let checkbox = h_flex()
 413            .id(self.id.clone())
 414            .justify_center()
 415            .items_center()
 416            .size(size)
 417            .group(group_id.clone())
 418            .child(
 419                div()
 420                    .flex()
 421                    .flex_none()
 422                    .justify_center()
 423                    .items_center()
 424                    .m(self.render_cx.scaled_rems(0.25)) // was .m_1
 425                    .size(self.render_cx.scaled_rems(1.0)) // was .size_4
 426                    .rounded(self.render_cx.scaled_rems(0.125)) // was .rounded_xs
 427                    .border_1()
 428                    .bg(bg_color)
 429                    .border_color(border_color)
 430                    .when(self.disabled, |this| this.cursor_not_allowed())
 431                    .when(self.disabled, |this| {
 432                        this.bg(cx.theme().colors().element_disabled.opacity(0.6))
 433                    })
 434                    .when(!self.disabled, |this| {
 435                        this.group_hover(group_id.clone(), |el| el.border_color(hover_border_color))
 436                    })
 437                    .when(self.placeholder, |this| {
 438                        this.child(
 439                            div()
 440                                .flex_none()
 441                                .rounded_full()
 442                                .bg(color.color(cx).alpha(0.5))
 443                                .size(self.render_cx.scaled_rems(0.25)), // was .size_1
 444                        )
 445                    })
 446                    .children(icon),
 447            );
 448
 449        h_flex()
 450            .id(self.id)
 451            .gap(ui::DynamicSpacing::Base06.rems(cx))
 452            .child(checkbox)
 453            .when_some(
 454                self.on_click.filter(|_| !self.disabled),
 455                |this, on_click| {
 456                    this.on_click(move |_, window, cx| {
 457                        on_click(&self.toggle_state.inverse(), window, cx)
 458                    })
 459                },
 460            )
 461            // TODO: Allow label size to be different from default.
 462            // TODO: Allow label color to be different from muted.
 463            .when_some(self.label, |this, label| {
 464                this.child(Label::new(label).color(Color::Muted))
 465            })
 466            .when_some(self.tooltip, |this, tooltip| {
 467                this.tooltip(move |window, cx| tooltip(window, cx))
 468            })
 469    }
 470}
 471
 472fn calculate_table_columns_count(rows: &Vec<ParsedMarkdownTableRow>) -> usize {
 473    let mut actual_column_count = 0;
 474    for row in rows {
 475        actual_column_count = actual_column_count.max(
 476            row.columns
 477                .iter()
 478                .map(|column| column.col_span)
 479                .sum::<usize>(),
 480        );
 481    }
 482    actual_column_count
 483}
 484
 485fn render_markdown_table(parsed: &ParsedMarkdownTable, cx: &mut RenderContext) -> AnyElement {
 486    let actual_header_column_count = calculate_table_columns_count(&parsed.header);
 487    let actual_body_column_count = calculate_table_columns_count(&parsed.body);
 488    let max_column_count = std::cmp::max(actual_header_column_count, actual_body_column_count);
 489
 490    let total_rows = parsed.header.len() + parsed.body.len();
 491
 492    // Track which grid cells are occupied by spanning cells
 493    let mut grid_occupied = vec![vec![false; max_column_count]; total_rows];
 494
 495    let mut cells = Vec::with_capacity(total_rows * max_column_count);
 496
 497    for (row_idx, row) in parsed.header.iter().chain(parsed.body.iter()).enumerate() {
 498        let mut col_idx = 0;
 499
 500        for cell in row.columns.iter() {
 501            // Skip columns occupied by row-spanning cells from previous rows
 502            while col_idx < max_column_count && grid_occupied[row_idx][col_idx] {
 503                col_idx += 1;
 504            }
 505
 506            if col_idx >= max_column_count {
 507                break;
 508            }
 509
 510            let container = match cell.alignment {
 511                ParsedMarkdownTableAlignment::Left | ParsedMarkdownTableAlignment::None => div(),
 512                ParsedMarkdownTableAlignment::Center => v_flex().items_center(),
 513                ParsedMarkdownTableAlignment::Right => v_flex().items_end(),
 514            };
 515
 516            let cell_element = container
 517                .col_span(cell.col_span.min(max_column_count - col_idx) as u16)
 518                .row_span(cell.row_span.min(total_rows - row_idx) as u16)
 519                .children(render_markdown_text(&cell.children, cx))
 520                .px_2()
 521                .py_1()
 522                .border_1()
 523                .size_full()
 524                .border_color(cx.border_color)
 525                .when(cell.is_header, |this| {
 526                    this.bg(cx.title_bar_background_color)
 527                })
 528                .when(cell.row_span > 1, |this| this.justify_center())
 529                .when(row_idx % 2 == 1, |this| this.bg(cx.panel_background_color));
 530
 531            cells.push(cell_element);
 532
 533            // Mark grid positions as occupied for row-spanning cells
 534            for r in 0..cell.row_span {
 535                for c in 0..cell.col_span {
 536                    if row_idx + r < total_rows && col_idx + c < max_column_count {
 537                        grid_occupied[row_idx + r][col_idx + c] = true;
 538                    }
 539                }
 540            }
 541
 542            col_idx += cell.col_span;
 543        }
 544
 545        // Fill remaining columns with empty cells if needed
 546        while col_idx < max_column_count {
 547            if grid_occupied[row_idx][col_idx] {
 548                col_idx += 1;
 549                continue;
 550            }
 551
 552            let empty_cell = div()
 553                .border_1()
 554                .size_full()
 555                .border_color(cx.border_color)
 556                .when(row_idx % 2 == 1, |this| this.bg(cx.panel_background_color));
 557
 558            cells.push(empty_cell);
 559            col_idx += 1;
 560        }
 561    }
 562
 563    cx.with_common_p(div())
 564        .grid()
 565        .size_full()
 566        .grid_cols(max_column_count as u16)
 567        .border_1()
 568        .border_color(cx.border_color)
 569        .children(cells)
 570        .into_any()
 571}
 572
 573fn render_markdown_block_quote(
 574    parsed: &ParsedMarkdownBlockQuote,
 575    cx: &mut RenderContext,
 576) -> AnyElement {
 577    cx.indent += 1;
 578
 579    let children: Vec<AnyElement> = parsed
 580        .children
 581        .iter()
 582        .enumerate()
 583        .map(|(ix, child)| {
 584            cx.with_last_child(ix + 1 == parsed.children.len(), |cx| {
 585                render_markdown_block(child, cx)
 586            })
 587        })
 588        .collect();
 589
 590    cx.indent -= 1;
 591
 592    cx.with_common_p(div())
 593        .child(
 594            div()
 595                .border_l_4()
 596                .border_color(cx.border_color)
 597                .pl_3()
 598                .children(children),
 599        )
 600        .into_any()
 601}
 602
 603fn render_markdown_code_block(
 604    parsed: &ParsedMarkdownCodeBlock,
 605    cx: &mut RenderContext,
 606) -> AnyElement {
 607    let body = if let Some(highlights) = parsed.highlights.as_ref() {
 608        StyledText::new(parsed.contents.clone()).with_default_highlights(
 609            &cx.buffer_text_style,
 610            highlights.iter().filter_map(|(range, highlight_id)| {
 611                highlight_id
 612                    .style(cx.syntax_theme.as_ref())
 613                    .map(|style| (range.clone(), style))
 614            }),
 615        )
 616    } else {
 617        StyledText::new(parsed.contents.clone())
 618    };
 619
 620    let copy_block_button = IconButton::new("copy-code", IconName::Copy)
 621        .icon_size(IconSize::Small)
 622        .on_click({
 623            let contents = parsed.contents.clone();
 624            move |_, _window, cx| {
 625                cx.write_to_clipboard(ClipboardItem::new_string(contents.to_string()));
 626            }
 627        })
 628        .tooltip(Tooltip::text("Copy code block"))
 629        .visible_on_hover("markdown-block");
 630
 631    cx.with_common_p(div())
 632        .font_family(cx.buffer_font_family.clone())
 633        .px_3()
 634        .py_3()
 635        .bg(cx.code_block_background_color)
 636        .rounded_sm()
 637        .child(body)
 638        .child(
 639            div()
 640                .h_flex()
 641                .absolute()
 642                .right_1()
 643                .top_1()
 644                .child(copy_block_button),
 645        )
 646        .into_any()
 647}
 648
 649fn render_markdown_paragraph(parsed: &MarkdownParagraph, cx: &mut RenderContext) -> AnyElement {
 650    cx.with_common_p(div())
 651        .children(render_markdown_text(parsed, cx))
 652        .flex()
 653        .flex_col()
 654        .into_any_element()
 655}
 656
 657fn render_markdown_text(parsed_new: &MarkdownParagraph, cx: &mut RenderContext) -> Vec<AnyElement> {
 658    let mut any_element = Vec::with_capacity(parsed_new.len());
 659    // these values are cloned in-order satisfy borrow checker
 660    let syntax_theme = cx.syntax_theme.clone();
 661    let workspace_clone = cx.workspace.clone();
 662    let code_span_bg_color = cx.code_span_background_color;
 663    let text_style = cx.text_style.clone();
 664    let link_color = cx.link_color;
 665
 666    for parsed_region in parsed_new {
 667        match parsed_region {
 668            MarkdownParagraphChunk::Text(parsed) => {
 669                let element_id = cx.next_id(&parsed.source_range);
 670
 671                let highlights = gpui::combine_highlights(
 672                    parsed.highlights.iter().filter_map(|(range, highlight)| {
 673                        highlight
 674                            .to_highlight_style(&syntax_theme)
 675                            .map(|style| (range.clone(), style))
 676                    }),
 677                    parsed.regions.iter().zip(&parsed.region_ranges).filter_map(
 678                        |(region, range)| {
 679                            if region.code {
 680                                Some((
 681                                    range.clone(),
 682                                    HighlightStyle {
 683                                        background_color: Some(code_span_bg_color),
 684                                        ..Default::default()
 685                                    },
 686                                ))
 687                            } else if region.link.is_some() {
 688                                Some((
 689                                    range.clone(),
 690                                    HighlightStyle {
 691                                        color: Some(link_color),
 692                                        ..Default::default()
 693                                    },
 694                                ))
 695                            } else {
 696                                None
 697                            }
 698                        },
 699                    ),
 700                );
 701                let mut links = Vec::new();
 702                let mut link_ranges = Vec::new();
 703                for (range, region) in parsed.region_ranges.iter().zip(&parsed.regions) {
 704                    if let Some(link) = region.link.clone() {
 705                        links.push(link);
 706                        link_ranges.push(range.clone());
 707                    }
 708                }
 709                let workspace = workspace_clone.clone();
 710                let element = div()
 711                    .child(
 712                        InteractiveText::new(
 713                            element_id,
 714                            StyledText::new(parsed.contents.clone())
 715                                .with_default_highlights(&text_style, highlights),
 716                        )
 717                        .tooltip({
 718                            let links = links.clone();
 719                            let link_ranges = link_ranges.clone();
 720                            move |idx, _, cx| {
 721                                for (ix, range) in link_ranges.iter().enumerate() {
 722                                    if range.contains(&idx) {
 723                                        return Some(LinkPreview::new(&links[ix].to_string(), cx));
 724                                    }
 725                                }
 726                                None
 727                            }
 728                        })
 729                        .on_click(
 730                            link_ranges,
 731                            move |clicked_range_ix, window, cx| match &links[clicked_range_ix] {
 732                                Link::Web { url } => cx.open_url(url),
 733                                Link::Path { path, .. } => {
 734                                    if let Some(workspace) = &workspace {
 735                                        _ = workspace.update(cx, |workspace, cx| {
 736                                            workspace
 737                                                .open_abs_path(
 738                                                    normalize_path(path.clone().as_path()),
 739                                                    OpenOptions {
 740                                                        visible: Some(OpenVisible::None),
 741                                                        ..Default::default()
 742                                                    },
 743                                                    window,
 744                                                    cx,
 745                                                )
 746                                                .detach();
 747                                        });
 748                                    }
 749                                }
 750                            },
 751                        ),
 752                    )
 753                    .into_any();
 754                any_element.push(element);
 755            }
 756
 757            MarkdownParagraphChunk::Image(image) => {
 758                any_element.push(render_markdown_image(image, cx));
 759            }
 760        }
 761    }
 762
 763    any_element
 764}
 765
 766fn render_markdown_rule(cx: &mut RenderContext) -> AnyElement {
 767    let rule = div().w_full().h(cx.scaled_rems(0.125)).bg(cx.border_color);
 768    div().py(cx.scaled_rems(0.5)).child(rule).into_any()
 769}
 770
 771fn render_markdown_image(image: &Image, cx: &mut RenderContext) -> AnyElement {
 772    let image_resource = match image.link.clone() {
 773        Link::Web { url } => Resource::Uri(url.into()),
 774        Link::Path { path, .. } => Resource::Path(Arc::from(path)),
 775    };
 776
 777    let element_id = cx.next_id(&image.source_range);
 778    let workspace = cx.workspace.clone();
 779
 780    div()
 781        .id(element_id)
 782        .cursor_pointer()
 783        .child(
 784            img(ImageSource::Resource(image_resource))
 785                .max_w_full()
 786                .with_fallback({
 787                    let alt_text = image.alt_text.clone();
 788                    move || div().children(alt_text.clone()).into_any_element()
 789                })
 790                .when_some(image.height, |this, height| this.h(height))
 791                .when_some(image.width, |this, width| this.w(width)),
 792        )
 793        .tooltip({
 794            let link = image.link.clone();
 795            let alt_text = image.alt_text.clone();
 796            move |_, cx| {
 797                InteractiveMarkdownElementTooltip::new(
 798                    Some(alt_text.clone().unwrap_or(link.to_string().into())),
 799                    "open image",
 800                    cx,
 801                )
 802                .into()
 803            }
 804        })
 805        .on_click({
 806            let link = image.link.clone();
 807            move |_, window, cx| {
 808                if window.modifiers().secondary() {
 809                    match &link {
 810                        Link::Web { url } => cx.open_url(url),
 811                        Link::Path { path, .. } => {
 812                            if let Some(workspace) = &workspace {
 813                                _ = workspace.update(cx, |workspace, cx| {
 814                                    workspace
 815                                        .open_abs_path(
 816                                            path.clone(),
 817                                            OpenOptions {
 818                                                visible: Some(OpenVisible::None),
 819                                                ..Default::default()
 820                                            },
 821                                            window,
 822                                            cx,
 823                                        )
 824                                        .detach();
 825                                });
 826                            }
 827                        }
 828                    }
 829                }
 830            }
 831        })
 832        .into_any()
 833}
 834
 835struct InteractiveMarkdownElementTooltip {
 836    tooltip_text: Option<SharedString>,
 837    action_text: SharedString,
 838}
 839
 840impl InteractiveMarkdownElementTooltip {
 841    pub fn new(
 842        tooltip_text: Option<SharedString>,
 843        action_text: impl Into<SharedString>,
 844        cx: &mut App,
 845    ) -> Entity<Self> {
 846        let tooltip_text = tooltip_text.map(|t| util::truncate_and_trailoff(&t, 50).into());
 847
 848        cx.new(|_cx| Self {
 849            tooltip_text,
 850            action_text: action_text.into(),
 851        })
 852    }
 853}
 854
 855impl Render for InteractiveMarkdownElementTooltip {
 856    fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
 857        tooltip_container(cx, |el, _| {
 858            let secondary_modifier = Keystroke {
 859                modifiers: Modifiers::secondary_key(),
 860                ..Default::default()
 861            };
 862
 863            el.child(
 864                v_flex()
 865                    .gap_1()
 866                    .when_some(self.tooltip_text.clone(), |this, text| {
 867                        this.child(Label::new(text).size(LabelSize::Small))
 868                    })
 869                    .child(
 870                        Label::new(format!(
 871                            "{}-click to {}",
 872                            secondary_modifier, self.action_text
 873                        ))
 874                        .size(LabelSize::Small)
 875                        .color(Color::Muted),
 876                    ),
 877            )
 878        })
 879    }
 880}
 881
 882/// Returns the prefix for a list item.
 883fn list_item_prefix(order: usize, ordered: bool, depth: usize) -> String {
 884    let ix = order.saturating_sub(1);
 885    const NUMBERED_PREFIXES_1: &str = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
 886    const NUMBERED_PREFIXES_2: &str = "abcdefghijklmnopqrstuvwxyz";
 887    const BULLETS: [&str; 5] = ["", "", "", "", ""];
 888
 889    if ordered {
 890        match depth {
 891            0 => format!("{}. ", order),
 892            1 => format!(
 893                "{}. ",
 894                NUMBERED_PREFIXES_1
 895                    .chars()
 896                    .nth(ix % NUMBERED_PREFIXES_1.len())
 897                    .unwrap()
 898            ),
 899            _ => format!(
 900                "{}. ",
 901                NUMBERED_PREFIXES_2
 902                    .chars()
 903                    .nth(ix % NUMBERED_PREFIXES_2.len())
 904                    .unwrap()
 905            ),
 906        }
 907    } else {
 908        let depth = depth.min(BULLETS.len() - 1);
 909        let bullet = BULLETS[depth];
 910        return format!("{} ", bullet);
 911    }
 912}
 913
 914#[cfg(test)]
 915mod tests {
 916    use super::*;
 917    use crate::markdown_elements::ParsedMarkdownTableColumn;
 918    use crate::markdown_elements::ParsedMarkdownText;
 919
 920    fn text(text: &str) -> MarkdownParagraphChunk {
 921        MarkdownParagraphChunk::Text(ParsedMarkdownText {
 922            source_range: 0..text.len(),
 923            contents: SharedString::new(text),
 924            highlights: Default::default(),
 925            region_ranges: Default::default(),
 926            regions: Default::default(),
 927        })
 928    }
 929
 930    fn column(
 931        col_span: usize,
 932        row_span: usize,
 933        children: Vec<MarkdownParagraphChunk>,
 934    ) -> ParsedMarkdownTableColumn {
 935        ParsedMarkdownTableColumn {
 936            col_span,
 937            row_span,
 938            is_header: false,
 939            children,
 940            alignment: ParsedMarkdownTableAlignment::None,
 941        }
 942    }
 943
 944    fn column_with_row_span(
 945        col_span: usize,
 946        row_span: usize,
 947        children: Vec<MarkdownParagraphChunk>,
 948    ) -> ParsedMarkdownTableColumn {
 949        ParsedMarkdownTableColumn {
 950            col_span,
 951            row_span,
 952            is_header: false,
 953            children,
 954            alignment: ParsedMarkdownTableAlignment::None,
 955        }
 956    }
 957
 958    #[test]
 959    fn test_calculate_table_columns_count() {
 960        assert_eq!(0, calculate_table_columns_count(&vec![]));
 961
 962        assert_eq!(
 963            1,
 964            calculate_table_columns_count(&vec![ParsedMarkdownTableRow::with_columns(vec![
 965                column(1, 1, vec![text("column1")])
 966            ])])
 967        );
 968
 969        assert_eq!(
 970            2,
 971            calculate_table_columns_count(&vec![ParsedMarkdownTableRow::with_columns(vec![
 972                column(1, 1, vec![text("column1")]),
 973                column(1, 1, vec![text("column2")]),
 974            ])])
 975        );
 976
 977        assert_eq!(
 978            2,
 979            calculate_table_columns_count(&vec![ParsedMarkdownTableRow::with_columns(vec![
 980                column(2, 1, vec![text("column1")])
 981            ])])
 982        );
 983
 984        assert_eq!(
 985            3,
 986            calculate_table_columns_count(&vec![ParsedMarkdownTableRow::with_columns(vec![
 987                column(1, 1, vec![text("column1")]),
 988                column(2, 1, vec![text("column2")]),
 989            ])])
 990        );
 991
 992        assert_eq!(
 993            2,
 994            calculate_table_columns_count(&vec![
 995                ParsedMarkdownTableRow::with_columns(vec![
 996                    column(1, 1, vec![text("column1")]),
 997                    column(1, 1, vec![text("column2")]),
 998                ]),
 999                ParsedMarkdownTableRow::with_columns(vec![column(1, 1, vec![text("column1")]),])
1000            ])
1001        );
1002
1003        assert_eq!(
1004            3,
1005            calculate_table_columns_count(&vec![
1006                ParsedMarkdownTableRow::with_columns(vec![
1007                    column(1, 1, vec![text("column1")]),
1008                    column(1, 1, vec![text("column2")]),
1009                ]),
1010                ParsedMarkdownTableRow::with_columns(vec![column(3, 3, vec![text("column1")]),])
1011            ])
1012        );
1013    }
1014
1015    #[test]
1016    fn test_row_span_support() {
1017        assert_eq!(
1018            3,
1019            calculate_table_columns_count(&vec![
1020                ParsedMarkdownTableRow::with_columns(vec![
1021                    column_with_row_span(1, 2, vec![text("spans 2 rows")]),
1022                    column(1, 1, vec![text("column2")]),
1023                    column(1, 1, vec![text("column3")]),
1024                ]),
1025                ParsedMarkdownTableRow::with_columns(vec![
1026                    // First column is covered by row span from above
1027                    column(1, 1, vec![text("column2 row2")]),
1028                    column(1, 1, vec![text("column3 row2")]),
1029                ])
1030            ])
1031        );
1032
1033        assert_eq!(
1034            4,
1035            calculate_table_columns_count(&vec![
1036                ParsedMarkdownTableRow::with_columns(vec![
1037                    column_with_row_span(1, 3, vec![text("spans 3 rows")]),
1038                    column_with_row_span(2, 1, vec![text("spans 2 cols")]),
1039                    column(1, 1, vec![text("column4")]),
1040                ]),
1041                ParsedMarkdownTableRow::with_columns(vec![
1042                    // First column covered by row span
1043                    column(1, 1, vec![text("column2")]),
1044                    column(1, 1, vec![text("column3")]),
1045                    column(1, 1, vec![text("column4")]),
1046                ]),
1047                ParsedMarkdownTableRow::with_columns(vec![
1048                    // First column still covered by row span
1049                    column(3, 1, vec![text("spans 3 cols")]),
1050                ])
1051            ])
1052        );
1053    }
1054
1055    #[test]
1056    fn test_list_item_prefix() {
1057        assert_eq!(list_item_prefix(1, true, 0), "1. ");
1058        assert_eq!(list_item_prefix(2, true, 0), "2. ");
1059        assert_eq!(list_item_prefix(3, true, 0), "3. ");
1060        assert_eq!(list_item_prefix(11, true, 0), "11. ");
1061        assert_eq!(list_item_prefix(1, true, 1), "A. ");
1062        assert_eq!(list_item_prefix(2, true, 1), "B. ");
1063        assert_eq!(list_item_prefix(3, true, 1), "C. ");
1064        assert_eq!(list_item_prefix(1, true, 2), "a. ");
1065        assert_eq!(list_item_prefix(2, true, 2), "b. ");
1066        assert_eq!(list_item_prefix(7, true, 2), "g. ");
1067        assert_eq!(list_item_prefix(1, true, 1), "A. ");
1068        assert_eq!(list_item_prefix(1, true, 2), "a. ");
1069        assert_eq!(list_item_prefix(1, false, 0), "");
1070        assert_eq!(list_item_prefix(1, false, 1), "");
1071        assert_eq!(list_item_prefix(1, false, 2), "");
1072        assert_eq!(list_item_prefix(1, false, 3), "");
1073        assert_eq!(list_item_prefix(1, false, 4), "");
1074    }
1075}