zed/crates/command_palette/src/command_palette.rs

use fuzzy::{StringMatch, StringMatchCandidate};
use gpui::{
    actions,
    elements::{ChildView, Flex, Label, ParentElement},
    keymap::Keystroke,
    Action, Element, Entity, MutableAppContext, View, ViewContext, ViewHandle,
};
use selector::{SelectorModal, SelectorModalDelegate};
use settings::Settings;
use std::cmp;
use workspace::Workspace;

mod selector;

pub fn init(cx: &mut MutableAppContext) {
    cx.add_action(CommandPalette::toggle);
    selector::init::<CommandPalette>(cx);
}

actions!(command_palette, [Toggle]);

pub struct CommandPalette {
    selector: ViewHandle<SelectorModal<Self>>,
    actions: Vec<Command>,
    matches: Vec<StringMatch>,
    selected_ix: usize,
    focused_view_id: usize,
}

pub enum Event {
    Dismissed,
}

struct Command {
    name: &'static str,
    action: Box<dyn Action>,
    keystrokes: Vec<Keystroke>,
    has_multiple_bindings: bool,
}

impl CommandPalette {
    pub fn new(focused_view_id: usize, cx: &mut ViewContext<Self>) -> Self {
        let this = cx.weak_handle();
        let actions = cx
            .available_actions(cx.window_id(), focused_view_id)
            .map(|(name, action, bindings)| Command {
                name,
                action,
                keystrokes: bindings
                    .last()
                    .map_or(Vec::new(), |binding| binding.keystrokes().to_vec()),
                has_multiple_bindings: bindings.len() > 1,
            })
            .collect();
        let selector = cx.add_view(|cx| SelectorModal::new(this, cx));
        Self {
            selector,
            actions,
            matches: vec![],
            selected_ix: 0,
            focused_view_id,
        }
    }

    fn toggle(_: &mut Workspace, _: &Toggle, cx: &mut ViewContext<Workspace>) {
        let workspace = cx.handle();
        let window_id = cx.window_id();
        let focused_view_id = cx.focused_view_id(window_id).unwrap_or(workspace.id());

        cx.as_mut().defer(move |cx| {
            let this = cx.add_view(window_id, |cx| Self::new(focused_view_id, cx));
            workspace.update(cx, |workspace, cx| {
                workspace.toggle_modal(cx, |cx, _| {
                    cx.subscribe(&this, Self::on_event).detach();
                    this
                });
            });
        });
    }

    fn on_event(
        workspace: &mut Workspace,
        _: ViewHandle<Self>,
        event: &Event,
        cx: &mut ViewContext<Workspace>,
    ) {
        match event {
            Event::Dismissed => {
                workspace.dismiss_modal(cx);
            }
        }
    }
}

impl Entity for CommandPalette {
    type Event = Event;
}

impl View for CommandPalette {
    fn ui_name() -> &'static str {
        "CommandPalette"
    }

    fn render(&mut self, _: &mut gpui::RenderContext<'_, Self>) -> gpui::ElementBox {
        ChildView::new(self.selector.clone()).boxed()
    }

    fn on_focus(&mut self, cx: &mut ViewContext<Self>) {
        cx.focus(&self.selector);
    }
}

impl SelectorModalDelegate for CommandPalette {
    fn match_count(&self) -> usize {
        self.matches.len()
    }

    fn selected_index(&self) -> usize {
        self.selected_ix
    }

    fn set_selected_index(&mut self, ix: usize) {
        self.selected_ix = ix;
    }

    fn update_matches(
        &mut self,
        query: String,
        cx: &mut gpui::ViewContext<Self>,
    ) -> gpui::Task<()> {
        let candidates = self
            .actions
            .iter()
            .enumerate()
            .map(|(ix, command)| StringMatchCandidate {
                id: ix,
                string: command.name.to_string(),
                char_bag: command.name.chars().collect(),
            })
            .collect::<Vec<_>>();
        cx.spawn(move |this, mut cx| async move {
            let matches = fuzzy::match_strings(
                &candidates,
                &query,
                true,
                10000,
                &Default::default(),
                cx.background(),
            )
            .await;
            this.update(&mut cx, |this, _| {
                this.matches = matches;
                if this.matches.is_empty() {
                    this.selected_ix = 0;
                } else {
                    this.selected_ix = cmp::min(this.selected_ix, this.matches.len() - 1);
                }
            });
        })
    }

    fn dismiss(&mut self, cx: &mut ViewContext<Self>) {
        cx.emit(Event::Dismissed);
    }

    fn confirm(&mut self, cx: &mut ViewContext<Self>) {
        if !self.matches.is_empty() {
            let window_id = cx.window_id();
            let action_ix = self.matches[self.selected_ix].candidate_id;
            cx.dispatch_action_at(
                window_id,
                self.focused_view_id,
                self.actions[action_ix].action.as_ref(),
            )
        }
        cx.emit(Event::Dismissed);
    }

    fn render_match(&self, ix: usize, selected: bool, cx: &gpui::AppContext) -> gpui::ElementBox {
        let mat = &self.matches[ix];
        let command = &self.actions[mat.candidate_id];
        let settings = cx.global::<Settings>();
        let theme = &settings.theme.selector;
        let style = if selected {
            &theme.active_item
        } else {
            &theme.item
        };

        Flex::row()
            .with_child(Label::new(mat.string.clone(), style.label.clone()).boxed())
            .with_children(command.keystrokes.iter().map(|keystroke| {
                Flex::row()
                    .with_children(
                        [
                            (keystroke.ctrl, "^"),
                            (keystroke.alt, "⎇"),
                            (keystroke.cmd, "⌘"),
                            (keystroke.shift, "⇧"),
                        ]
                        .into_iter()
                        .filter_map(|(modifier, label)| {
                            if modifier {
                                Some(Label::new(label.into(), style.label.clone()).boxed())
                            } else {
                                None
                            }
                        }),
                    )
                    .with_child(Label::new(keystroke.key.clone(), style.label.clone()).boxed())
                    .contained()
                    .with_margin_left(5.0)
                    .flex_float()
                    .boxed()
            }))
            .with_children(if command.has_multiple_bindings {
                Some(Label::new("+".into(), style.label.clone()).boxed())
            } else {
                None
            })
            .contained()
            .with_style(style.container)
            .boxed()
    }
}

impl std::fmt::Debug for Command {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Command")
            .field("name", &self.name)
            .field("keystrokes", &self.keystrokes)
            .finish()
    }
}