editor/

slash.rs

//! The slash menu: `/` at an empty block, then the rows the app installed with
//! [`crate::AppExt::set_slash_items`], or [`defaults`] until it does.
//!
//! The editor keeps focus while the menu is open and the query is the text
//! typed after the `/`, which is how Notion does it and why there is no second
//! field to hand focus to.

use std::rc::Rc;

use gpui::{App, Global, SharedString, WeakEntity, Window};
use ui::{
    icons::{Icon, glyph},
    menu::{self, Item},
    popover::filter_indices,
};

use markdown::{Align, BlockKind, Cursor, QuoteKind, Text};

/// Every block a block can be turned into, and what each is called.
///
/// A bookmark is deliberately absent: it needs a URL, and a card with none is a
/// blank the reader cannot fill. A pasted URL is where a bookmark comes from.
/// An image is here because it *can* wait — with no URL it paints the row that
/// asks for one.
pub fn items() -> Vec<(SharedString, BlockKind)> {
    let text = Text::default;
    vec![
        ("Text".into(), BlockKind::Paragraph(text())),
        (
            "Heading 1".into(),
            BlockKind::Heading {
                level: 1,
                text: text(),
            },
        ),
        (
            "Heading 2".into(),
            BlockKind::Heading {
                level: 2,
                text: text(),
            },
        ),
        (
            "Heading 3".into(),
            BlockKind::Heading {
                level: 3,
                text: text(),
            },
        ),
        ("Bullet".into(), BlockKind::Bullet(text())),
        (
            "Numbered".into(),
            BlockKind::Ordered {
                number: 1,
                text: text(),
            },
        ),
        (
            "Task".into(),
            BlockKind::Task {
                checked: false,
                text: text(),
            },
        ),
        (
            "Code".into(),
            BlockKind::Code {
                language: None,
                code: text(),
                height: None,
            },
        ),
        (
            "Table".into(),
            BlockKind::Table {
                align: vec![Align::Left; 2],
                header: vec![text(), text()],
                rows: vec![vec![text(), text()]],
            },
        ),
        (
            "Image".into(),
            BlockKind::Image {
                url: String::new(),
                alt: text(),
                width: None,
            },
        ),
        ("Divider".into(), BlockKind::Rule),
    ]
}

/// Every quote a block can be put in, and what each is called.
pub fn quotes() -> Vec<(SharedString, Option<QuoteKind>)> {
    vec![
        ("Quote".into(), None),
        ("Note".into(), Some(QuoteKind::Note)),
        ("Tip".into(), Some(QuoteKind::Tip)),
        ("Important".into(), Some(QuoteKind::Important)),
        ("Warning".into(), Some(QuoteKind::Warning)),
        ("Caution".into(), Some(QuoteKind::Caution)),
    ]
}

/// What a [`SlashAction::Run`] row calls.
pub type SlashRun = Rc<dyn Fn(SlashAt, &mut Window, &mut App)>;

/// What picking a slash or block menu row does.
#[derive(Clone)]
pub enum SlashAction {
    /// Turn the block the row was picked for into this one.
    Block(BlockKind),
    /// Put the block in a quote with this alert — see
    /// [`markdown::Doc::toggle_quote`].
    Quote(Option<QuoteKind>),
    /// Hand the block to the app, after the menu's own update ends. From the
    /// slash menu the `/query` is gone from the block by then; what the block
    /// becomes, and where the caret goes, is the app's.
    Run(SlashRun),
}

/// The block a [`SlashAction::Run`] row was picked for.
#[derive(Clone)]
pub struct SlashAt {
    pub editor: WeakEntity<crate::Editor>,
    pub block: usize,
}

/// One row of the slash menu.
#[derive(Clone)]
pub struct SlashRow {
    pub label: SharedString,
    pub icon: Option<Icon>,
    pub action: SlashAction,
}

/// An item of the slash or block menu.
#[derive(Clone)]
pub enum SlashItem {
    /// A section's name over the items after it, shown while the query is
    /// empty.
    Heading(SharedString),
    Row(SlashRow),
    /// Rows behind a submenu. A query matches them as `Group (row)`; several
    /// matches stay behind the submenu, and a lone one stands as its own row.
    Group {
        label: SharedString,
        icon: Option<Icon>,
        rows: Vec<SlashRow>,
    },
}

/// The editor's blocks as slash items, each under its glyph, the quotes and
/// callouts behind one `Quote` group.
pub fn defaults() -> Vec<SlashItem> {
    let mut defaults = Vec::new();
    for (label, kind) in items() {
        // The quotes follow the lists.
        let lists_end = matches!(kind, BlockKind::Code { .. });
        if lists_end {
            defaults.push(SlashItem::Group {
                label: "Quote".into(),
                icon: Some(glyph::TextQuote.into()),
                rows: quotes()
                    .into_iter()
                    .map(|(label, alert)| SlashRow {
                        label,
                        icon: Some(quote_glyph(alert)),
                        action: SlashAction::Quote(alert),
                    })
                    .collect(),
            });
        }
        defaults.push(SlashItem::Row(SlashRow {
            label,
            icon: Some(glyph_of(&kind)),
            action: SlashAction::Block(kind),
        }));
    }
    defaults
}

/// The glyph a block's slash row carries.
fn glyph_of(kind: &BlockKind) -> Icon {
    match kind {
        BlockKind::Paragraph(_) => glyph::Pilcrow.into(),
        BlockKind::Heading { level: 1, .. } => glyph::Heading1.into(),
        BlockKind::Heading { level: 2, .. } => glyph::Heading2.into(),
        BlockKind::Heading { .. } => glyph::Heading3.into(),
        BlockKind::Bullet(_) => glyph::List.into(),
        BlockKind::Ordered { .. } => glyph::ListOrdered.into(),
        BlockKind::Task { .. } => glyph::ListTodo.into(),
        BlockKind::Code { .. } => glyph::SquareCode.into(),
        BlockKind::Table { .. } => glyph::Table.into(),
        BlockKind::Image { .. } => glyph::Image.into(),
        _ => glyph::SeparatorHorizontal.into(),
    }
}

/// The glyph a quote's slash row carries.
fn quote_glyph(alert: Option<QuoteKind>) -> Icon {
    match alert {
        None => glyph::TextQuote.into(),
        Some(QuoteKind::Note) => glyph::Info.into(),
        Some(QuoteKind::Tip) => glyph::Lightbulb.into(),
        Some(QuoteKind::Important) => glyph::MessageSquareWarning.into(),
        Some(QuoteKind::Warning) => glyph::TriangleAlert.into(),
        Some(QuoteKind::Caution) => glyph::OctagonAlert.into(),
    }
}

/// What the app installed.
pub(crate) struct Installed(pub Vec<SlashItem>);

impl Global for Installed {}

/// The items the app installed, or [`defaults`].
pub(crate) fn installed(cx: &App) -> Vec<SlashItem> {
    cx.try_global::<Installed>()
        .map_or_else(defaults, |Installed(items)| items.clone())
}

/// One row the open menu can offer: what a query matches, what a submenu
/// shows, the section and group it sits in, that group's glyph, and what
/// picking it does.
#[derive(Clone)]
struct Entry {
    label: SharedString,
    short: SharedString,
    /// The heading above it, numbered so two sections of one name stay apart.
    section: Option<(usize, SharedString)>,
    group: Option<(SharedString, Option<Icon>)>,
    icon: Option<Icon>,
    action: SlashAction,
}

/// The installed items, flattened.
fn entries(items: Vec<SlashItem>) -> Vec<Entry> {
    let mut entries = Vec::new();
    let mut section = None;
    for (ix, item) in items.into_iter().enumerate() {
        match item {
            SlashItem::Heading(label) => section = Some((ix, label)),
            SlashItem::Row(row) => entries.push(Entry {
                label: row.label.clone(),
                short: row.label,
                section: section.clone(),
                group: None,
                icon: row.icon,
                action: row.action,
            }),
            SlashItem::Group { label, icon, rows } => {
                entries.extend(rows.into_iter().map(|row| Entry {
                    label: match row.label == label {
                        true => label.clone(),
                        false => format!("{label} ({})", row.label).into(),
                    },
                    short: row.label,
                    section: section.clone(),
                    group: Some((label.clone(), icon.clone())),
                    icon: row.icon,
                    action: row.action,
                }))
            }
        }
    }
    entries
}

/// The [`SlashAction::Block`] and [`SlashAction::Quote`] rows of `items`,
/// groups kept, without headings.
pub(crate) fn turns(items: Vec<SlashItem>) -> Vec<SlashItem> {
    let turns =
        |row: &SlashRow| matches!(row.action, SlashAction::Block(_) | SlashAction::Quote(_));
    items
        .into_iter()
        .filter_map(|item| match item {
            SlashItem::Row(row) => turns(&row).then_some(SlashItem::Row(row)),
            SlashItem::Group { label, icon, rows } => {
                let rows: Vec<SlashRow> = rows.into_iter().filter(turns).collect();
                (!rows.is_empty()).then_some(SlashItem::Group { label, icon, rows })
            }
            SlashItem::Heading(_) => None,
        })
        .collect()
}

/// What [`items`] calls this block, and `None` for one the menu does not offer
/// — a bookmark, which needs a URL nobody can type into a menu row.
///
/// Matched on the kind alone: a row spells a heading's level and nothing else,
/// so a numbered list at 7, a fence tagged `rs` and a table of any size are all
/// the row they came from.
pub fn label(kind: &BlockKind) -> Option<SharedString> {
    items()
        .into_iter()
        .find(|(_, row)| same(row, kind))
        .map(|(label, _)| label)
}

fn same(row: &BlockKind, kind: &BlockKind) -> bool {
    match (row, kind) {
        (BlockKind::Heading { level: a, .. }, BlockKind::Heading { level: b, .. }) => a == b,
        (row, kind) => std::mem::discriminant(row) == std::mem::discriminant(kind),
    }
}

/// A row of the open menu: a heading, one entry, or a group of them behind a
/// submenu. Indices are into the menu's entries.
enum Row {
    Heading(SharedString),
    Block(usize),
    Group(SharedString, Option<Icon>, Vec<usize>),
}

/// Installed items as the rows of an open menu.
pub struct Rows {
    rows: Vec<Row>,
    /// Read once at open.
    entries: Vec<Entry>,
}

impl Rows {
    pub fn new(items: Vec<SlashItem>) -> Self {
        let mut rows = Self {
            rows: Vec::new(),
            entries: entries(items),
        };
        rows.refilter("");
        rows
    }

    /// A group sits behind one row where its first entry is. A query ranks
    /// the entries, and a group's row stands where its best match does,
    /// holding the matches in rank order — or, holding one, is that row.
    /// Headings stand only over an unranked menu.
    pub fn refilter(&mut self, query: &str) {
        let order: Vec<usize> = if query.is_empty() {
            (0..self.entries.len()).collect()
        } else {
            let labels: Vec<SharedString> = self
                .entries
                .iter()
                .map(|entry| entry.label.clone())
                .collect();
            filter_indices(query, &labels)
        };
        let mut rows: Vec<Row> = Vec::new();
        let mut section = None;
        for ix in order {
            let entry = &self.entries[ix];
            if query.is_empty() && entry.section.as_ref().map(|(at, _)| *at) != section {
                section = entry.section.as_ref().map(|(at, _)| *at);
                if let Some((_, label)) = &entry.section {
                    rows.push(Row::Heading(label.clone()));
                }
            }
            let Some((group, icon)) = &entry.group else {
                rows.push(Row::Block(ix));
                continue;
            };
            match rows
                .iter_mut()
                .find(|row| matches!(row, Row::Group(label, ..) if label == group))
            {
                Some(Row::Group(_, _, held)) => held.push(ix),
                _ => rows.push(Row::Group(group.clone(), icon.clone(), vec![ix])),
            }
        }
        self.rows = rows
            .into_iter()
            .map(|row| match row {
                Row::Group(_, _, held) if !query.is_empty() && held.len() == 1 => {
                    Row::Block(held[0])
                }
                row => row,
            })
            .collect();
    }

    /// The rows as [`ui::menu::card`] paints them.
    pub fn menu(&self) -> Vec<Item> {
        self.rows
            .iter()
            .map(|row| match row {
                Row::Heading(label) => Item::Heading(label.clone()),
                Row::Block(ix) => self.item(*ix, &self.entries[*ix].label),
                Row::Group(label, icon, group) => {
                    let submenu = Item::submenu(
                        label.clone(),
                        group
                            .iter()
                            .map(|ix| self.item(*ix, &self.entries[*ix].short))
                            .collect(),
                    );
                    match icon.clone() {
                        Some(icon) => submenu.with_icon(icon),
                        None => submenu,
                    }
                }
            })
            .collect()
    }

    fn item(&self, ix: usize, label: &SharedString) -> Item {
        let item = Item::action(label.clone());
        match self.entries[ix].icon.clone() {
            Some(icon) => item.with_icon(icon),
            None => item,
        }
    }

    /// Whether the row at `path` is a group, which Enter opens rather than
    /// picks.
    fn is_group(&self, path: &[usize]) -> bool {
        matches!(
            (path.first().and_then(|row| self.rows.get(*row)), path.len()),
            (Some(Row::Group(..)), 1)
        )
    }

    /// What the row at `path` does, and `None` for a heading or a group.
    pub fn action_at(&self, path: &[usize]) -> Option<SlashAction> {
        let ix = match (self.rows.get(*path.first()?)?, path.get(1)) {
            (Row::Block(ix), None) => *ix,
            (Row::Group(_, _, group), Some(row)) => *group.get(*row)?,
            _ => return None,
        };
        self.entries.get(ix).map(|entry| entry.action.clone())
    }
}

/// An open menu: where the `/` sits, and the rows under it.
pub struct Slash {
    /// The `/` itself. Everything between it and the caret is the query, and
    /// backspacing onto it closes the menu.
    pub at: Cursor,
    rows: Rows,
    pub cursor: menu::Cursor,
}

impl Slash {
    pub fn open(at: Cursor, items: Vec<SlashItem>) -> Self {
        let mut slash = Self {
            at,
            rows: Rows::new(items),
            cursor: menu::Cursor::default(),
        };
        slash.refilter("");
        slash
    }

    pub fn refilter(&mut self, query: &str) {
        self.rows.refilter(query);
        self.cursor.clear();
        self.cursor.step(&self.menu(), 1);
    }

    pub fn menu(&self) -> Vec<Item> {
        self.rows.menu()
    }

    /// Walk the rows of the innermost open panel.
    pub fn step(&mut self, delta: isize) {
        let menu = self.menu();
        self.cursor.step(&menu, delta);
    }

    /// Open the group under the live row. `false` when it is not one.
    pub fn descend(&mut self) -> bool {
        let menu = self.menu();
        self.cursor.descend(&menu)
    }

    /// Whether the live row is a group, which Enter opens rather than picks.
    pub fn on_group(&self) -> bool {
        self.cursor
            .path()
            .is_some_and(|path| self.rows.is_group(&path))
    }

    pub fn action_at(&self, path: &[usize]) -> Option<SlashAction> {
        self.rows.action_at(path)
    }

    /// What has been typed since the `/`, or `None` when the caret has left
    /// the run entirely — which is what closes the menu.
    pub fn query(&self, caret: Cursor, text: &str) -> Option<String> {
        if caret.block != self.at.block || caret.part != self.at.part {
            return None;
        }
        let start = self.at.offset + 1;
        if caret.offset < start {
            return None;
        }
        let query = text.get(start..caret.offset)?;
        // A space ends it: `/ ` is a stray slash, not a command.
        (!query.contains(char::is_whitespace)).then(|| query.to_string())
    }
}