//! Provides hooks for customizing the behavior of the command palette. #![deny(missing_docs)] use std::{any::TypeId, rc::Rc}; use collections::HashSet; use derive_more::{Deref, DerefMut}; use gpui::{Action, App, BorrowAppContext, Global, Task, WeakEntity}; use workspace::Workspace; /// Initializes the command palette hooks. pub fn init(cx: &mut App) { cx.set_global(GlobalCommandPaletteFilter::default()); } /// A filter for the command palette. #[derive(Default)] pub struct CommandPaletteFilter { hidden_namespaces: HashSet<&'static str>, hidden_action_types: HashSet, /// Actions that have explicitly been shown. These should be shown even if /// they are in a hidden namespace. shown_action_types: HashSet, } #[derive(Deref, DerefMut, Default)] struct GlobalCommandPaletteFilter(CommandPaletteFilter); impl Global for GlobalCommandPaletteFilter {} impl CommandPaletteFilter { /// Returns the global [`CommandPaletteFilter`], if one is set. pub fn try_global(cx: &App) -> Option<&CommandPaletteFilter> { cx.try_global::() .map(|filter| &filter.0) } /// Returns a mutable reference to the global [`CommandPaletteFilter`]. pub fn global_mut(cx: &mut App) -> &mut Self { cx.global_mut::() } /// Updates the global [`CommandPaletteFilter`] using the given closure. pub fn update_global(cx: &mut App, update: F) where F: FnOnce(&mut Self, &mut App), { if cx.has_global::() { cx.update_global(|this: &mut GlobalCommandPaletteFilter, cx| update(&mut this.0, cx)) } } /// Returns whether the given [`Action`] is hidden by the filter. pub fn is_hidden(&self, action: &dyn Action) -> bool { let name = action.name(); let namespace = name.split("::").next().unwrap_or("malformed action name"); // If this action has specifically been shown then it should be visible. if self.shown_action_types.contains(&action.type_id()) { return false; } self.hidden_namespaces.contains(namespace) || self.hidden_action_types.contains(&action.type_id()) } /// Hides all actions in the given namespace. pub fn hide_namespace(&mut self, namespace: &'static str) { self.hidden_namespaces.insert(namespace); } /// Shows all actions in the given namespace. pub fn show_namespace(&mut self, namespace: &'static str) { self.hidden_namespaces.remove(namespace); } /// Hides all actions with the given types. pub fn hide_action_types<'a>(&mut self, action_types: impl IntoIterator) { for action_type in action_types { self.hidden_action_types.insert(*action_type); self.shown_action_types.remove(action_type); } } /// Shows all actions with the given types. pub fn show_action_types<'a>(&mut self, action_types: impl IntoIterator) { for action_type in action_types { self.shown_action_types.insert(*action_type); self.hidden_action_types.remove(action_type); } } } /// The result of intercepting a command palette command. #[derive(Debug)] pub struct CommandInterceptItem { /// The action produced as a result of the interception. pub action: Box, /// The display string to show in the command palette for this result. pub string: String, /// The character positions in the string that match the query. /// Used for highlighting matched characters in the command palette UI. pub positions: Vec, } /// The result of intercepting a command palette command. #[derive(Default, Debug)] pub struct CommandInterceptResult { /// The items pub results: Vec, /// Whether or not to continue to show the normal matches pub exclusive: bool, } /// An interceptor for the command palette. #[derive(Clone)] pub struct GlobalCommandPaletteInterceptor( Rc, &mut App) -> Task>, ); impl Global for GlobalCommandPaletteInterceptor {} impl GlobalCommandPaletteInterceptor { /// Sets the global interceptor. /// /// This will override the previous interceptor, if it exists. pub fn set( cx: &mut App, interceptor: impl Fn(&str, WeakEntity, &mut App) -> Task + 'static, ) { cx.set_global(Self(Rc::new(interceptor))); } /// Clears the global interceptor. pub fn clear(cx: &mut App) { if cx.has_global::() { cx.remove_global::(); } } /// Intercepts the given query from the command palette. pub fn intercept( query: &str, workspace: WeakEntity, cx: &mut App, ) -> Option> { let interceptor = cx.try_global::()?; let handler = interceptor.0.clone(); Some(handler(query, workspace, cx)) } }