#![allow(missing_docs)] use crate::PlatformStyle; use crate::{h_flex, prelude::*, Icon, IconName, IconSize}; use gpui::{ relative, Action, AnyElement, App, FocusHandle, IntoElement, Keystroke, Modifiers, Window, }; #[derive(Debug, IntoElement, Clone)] pub struct KeyBinding { /// A keybinding consists of a key and a set of modifier keys. /// More then one keybinding produces a chord. /// /// This should always contain at least one element. key_binding: gpui::KeyBinding, /// The [`PlatformStyle`] to use when displaying this keybinding. platform_style: PlatformStyle, } impl KeyBinding { /// Returns the highest precedence keybinding for an action. This is the last binding added to /// the keymap. User bindings are added after built-in bindings so that they take precedence. pub fn for_action(action: &dyn Action, window: &mut Window) -> Option { let key_binding = window .bindings_for_action(action) .into_iter() .rev() .next()?; Some(Self::new(key_binding)) } /// Like `for_action`, but lets you specify the context from which keybindings are matched. pub fn for_action_in( action: &dyn Action, focus: &FocusHandle, window: &mut Window, ) -> Option { let key_binding = window .bindings_for_action_in(action, focus) .into_iter() .rev() .next()?; Some(Self::new(key_binding)) } pub fn new(key_binding: gpui::KeyBinding) -> Self { Self { key_binding, platform_style: PlatformStyle::platform(), } } /// Sets the [`PlatformStyle`] for this [`KeyBinding`]. pub fn platform_style(mut self, platform_style: PlatformStyle) -> Self { self.platform_style = platform_style; self } } impl RenderOnce for KeyBinding { fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement { h_flex() .debug_selector(|| { format!( "KEY_BINDING-{}", self.key_binding .keystrokes() .iter() .map(|k| k.key.to_string()) .collect::>() .join(" ") ) }) .gap(DynamicSpacing::Base04.rems(cx)) .flex_none() .children(self.key_binding.keystrokes().iter().map(|keystroke| { h_flex() .flex_none() .py_0p5() .rounded_sm() .text_color(cx.theme().colors().text_muted) .children(render_modifiers( &keystroke.modifiers, self.platform_style, None, false, )) .map(|el| el.child(render_key(&keystroke, self.platform_style, None))) })) } } pub fn render_key( keystroke: &Keystroke, platform_style: PlatformStyle, color: Option, ) -> AnyElement { let key_icon = icon_for_key(keystroke, platform_style); match key_icon { Some(icon) => KeyIcon::new(icon, color).into_any_element(), None => Key::new(capitalize(&keystroke.key), color).into_any_element(), } } fn icon_for_key(keystroke: &Keystroke, platform_style: PlatformStyle) -> Option { match keystroke.key.as_str() { "left" => Some(IconName::ArrowLeft), "right" => Some(IconName::ArrowRight), "up" => Some(IconName::ArrowUp), "down" => Some(IconName::ArrowDown), "backspace" => Some(IconName::Backspace), "delete" => Some(IconName::Delete), "return" => Some(IconName::Return), "enter" => Some(IconName::Return), "tab" => Some(IconName::Tab), "space" => Some(IconName::Space), "escape" => Some(IconName::Escape), "pagedown" => Some(IconName::PageDown), "pageup" => Some(IconName::PageUp), "shift" if platform_style == PlatformStyle::Mac => Some(IconName::Shift), "control" if platform_style == PlatformStyle::Mac => Some(IconName::Control), "platform" if platform_style == PlatformStyle::Mac => Some(IconName::Command), "function" if platform_style == PlatformStyle::Mac => Some(IconName::Control), "alt" if platform_style == PlatformStyle::Mac => Some(IconName::Option), _ => None, } } pub fn render_modifiers( modifiers: &Modifiers, platform_style: PlatformStyle, color: Option, standalone: bool, ) -> impl Iterator { enum KeyOrIcon { Key(&'static str), Icon(IconName), } struct Modifier { enabled: bool, mac: KeyOrIcon, linux: KeyOrIcon, windows: KeyOrIcon, } let table = { use KeyOrIcon::*; [ Modifier { enabled: modifiers.function, mac: Icon(IconName::Control), linux: Key("Fn"), windows: Key("Fn"), }, Modifier { enabled: modifiers.control, mac: Icon(IconName::Control), linux: Key("Ctrl"), windows: Key("Ctrl"), }, Modifier { enabled: modifiers.alt, mac: Icon(IconName::Option), linux: Key("Alt"), windows: Key("Alt"), }, Modifier { enabled: modifiers.platform, mac: Icon(IconName::Command), linux: Key("Super"), windows: Key("Win"), }, Modifier { enabled: modifiers.shift, mac: Icon(IconName::Shift), linux: Key("Shift"), windows: Key("Shift"), }, ] }; let filtered = table .into_iter() .filter(|modifier| modifier.enabled) .collect::>(); let last_ix = filtered.len().saturating_sub(1); filtered .into_iter() .enumerate() .flat_map(move |(ix, modifier)| match platform_style { PlatformStyle::Mac => vec![modifier.mac], PlatformStyle::Linux if standalone && ix == last_ix => vec![modifier.linux], PlatformStyle::Linux => vec![modifier.linux, KeyOrIcon::Key("+")], PlatformStyle::Windows if standalone && ix == last_ix => { vec![modifier.windows] } PlatformStyle::Windows => vec![modifier.windows, KeyOrIcon::Key("+")], }) .map(move |key_or_icon| match key_or_icon { KeyOrIcon::Key(key) => Key::new(key, color).into_any_element(), KeyOrIcon::Icon(icon) => KeyIcon::new(icon, color).into_any_element(), }) } #[derive(IntoElement)] pub struct Key { key: SharedString, color: Option, } impl RenderOnce for Key { fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement { let single_char = self.key.len() == 1; div() .py_0() .map(|this| { if single_char { this.w(rems_from_px(14.)) .flex() .flex_none() .justify_center() } else { this.px_0p5() } }) .h(rems_from_px(14.)) .text_ui(cx) .line_height(relative(1.)) .text_color(self.color.unwrap_or(Color::Muted).color(cx)) .child(self.key.clone()) } } impl Key { pub fn new(key: impl Into, color: Option) -> Self { Self { key: key.into(), color, } } } #[derive(IntoElement)] pub struct KeyIcon { icon: IconName, color: Option, } impl RenderOnce for KeyIcon { fn render(self, _window: &mut Window, _cx: &mut App) -> impl IntoElement { Icon::new(self.icon) .size(IconSize::XSmall) .color(self.color.unwrap_or(Color::Muted)) } } impl KeyIcon { pub fn new(icon: IconName, color: Option) -> Self { Self { icon, color } } } /// Returns a textual representation of the key binding for the given [`Action`]. pub fn text_for_action(action: &dyn Action, window: &Window) -> Option { let bindings = window.bindings_for_action(action); let key_binding = bindings.last()?; Some(text_for_key_binding(key_binding, PlatformStyle::platform())) } /// Returns a textual representation of the key binding for the given [`Action`] /// as if the provided [`FocusHandle`] was focused. pub fn text_for_action_in( action: &dyn Action, focus: &FocusHandle, window: &mut Window, ) -> Option { let bindings = window.bindings_for_action_in(action, focus); let key_binding = bindings.last()?; Some(text_for_key_binding(key_binding, PlatformStyle::platform())) } /// Returns a textual representation of the given key binding for the specified platform. pub fn text_for_key_binding( key_binding: &gpui::KeyBinding, platform_style: PlatformStyle, ) -> String { key_binding .keystrokes() .iter() .map(|keystroke| text_for_keystroke(keystroke, platform_style)) .collect::>() .join(" ") } /// Returns a textual representation of the given [`Keystroke`]. pub fn text_for_keystroke(keystroke: &Keystroke, platform_style: PlatformStyle) -> String { let mut text = String::new(); let delimiter = match platform_style { PlatformStyle::Mac => '-', PlatformStyle::Linux | PlatformStyle::Windows => '+', }; if keystroke.modifiers.function { match platform_style { PlatformStyle::Mac => text.push_str("fn"), PlatformStyle::Linux | PlatformStyle::Windows => text.push_str("Fn"), } text.push(delimiter); } if keystroke.modifiers.control { match platform_style { PlatformStyle::Mac => text.push_str("Control"), PlatformStyle::Linux | PlatformStyle::Windows => text.push_str("Ctrl"), } text.push(delimiter); } if keystroke.modifiers.alt { match platform_style { PlatformStyle::Mac => text.push_str("Option"), PlatformStyle::Linux | PlatformStyle::Windows => text.push_str("Alt"), } text.push(delimiter); } if keystroke.modifiers.platform { match platform_style { PlatformStyle::Mac => text.push_str("Command"), PlatformStyle::Linux => text.push_str("Super"), PlatformStyle::Windows => text.push_str("Win"), } text.push(delimiter); } if keystroke.modifiers.shift { match platform_style { PlatformStyle::Mac | PlatformStyle::Linux | PlatformStyle::Windows => { text.push_str("Shift") } } text.push(delimiter); } let key = match keystroke.key.as_str() { "pageup" => "PageUp", "pagedown" => "PageDown", key => &capitalize(key), }; text.push_str(key); text } fn capitalize(str: &str) -> String { let mut chars = str.chars(); match chars.next() { None => String::new(), Some(first_char) => first_char.to_uppercase().collect::() + chars.as_str(), } } #[cfg(test)] mod tests { use super::*; #[test] fn test_text_for_keystroke() { assert_eq!( text_for_keystroke(&Keystroke::parse("cmd-c").unwrap(), PlatformStyle::Mac), "Command-C".to_string() ); assert_eq!( text_for_keystroke(&Keystroke::parse("cmd-c").unwrap(), PlatformStyle::Linux), "Super+C".to_string() ); assert_eq!( text_for_keystroke(&Keystroke::parse("cmd-c").unwrap(), PlatformStyle::Windows), "Win+C".to_string() ); assert_eq!( text_for_keystroke( &Keystroke::parse("ctrl-alt-delete").unwrap(), PlatformStyle::Mac ), "Control-Option-Delete".to_string() ); assert_eq!( text_for_keystroke( &Keystroke::parse("ctrl-alt-delete").unwrap(), PlatformStyle::Linux ), "Ctrl+Alt+Delete".to_string() ); assert_eq!( text_for_keystroke( &Keystroke::parse("ctrl-alt-delete").unwrap(), PlatformStyle::Windows ), "Ctrl+Alt+Delete".to_string() ); assert_eq!( text_for_keystroke( &Keystroke::parse("shift-pageup").unwrap(), PlatformStyle::Mac ), "Shift-PageUp".to_string() ); assert_eq!( text_for_keystroke( &Keystroke::parse("shift-pageup").unwrap(), PlatformStyle::Linux ), "Shift+PageUp".to_string() ); assert_eq!( text_for_keystroke( &Keystroke::parse("shift-pageup").unwrap(), PlatformStyle::Windows ), "Shift+PageUp".to_string() ); } }