559 lines
18 KiB
Rust
559 lines
18 KiB
Rust
// SPDX-License-Identifier: GPL-3.0-only
|
|
|
|
use cosmic::widget::menu::key_bind::{KeyBind, Modifier};
|
|
use cosmic::{
|
|
iced::core::keyboard::key::Named,
|
|
iced::keyboard::{Key, Modifiers},
|
|
};
|
|
use serde::{Deserialize, Serialize};
|
|
use std::collections::{BTreeMap, HashMap};
|
|
|
|
use crate::{Action, fl};
|
|
|
|
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
|
|
pub enum ModifierName {
|
|
Ctrl,
|
|
Shift,
|
|
Alt,
|
|
Super,
|
|
}
|
|
|
|
impl ModifierName {
|
|
fn to_modifier(self) -> Modifier {
|
|
match self {
|
|
Self::Ctrl => Modifier::Ctrl,
|
|
Self::Shift => Modifier::Shift,
|
|
Self::Alt => Modifier::Alt,
|
|
Self::Super => Modifier::Super,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Clone, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
|
|
pub struct Binding {
|
|
pub modifiers: Vec<ModifierName>,
|
|
pub key: String,
|
|
}
|
|
|
|
impl Binding {
|
|
fn to_key_bind(&self) -> Option<KeyBind> {
|
|
let key = key_from_string(&self.key)?;
|
|
let mut modifiers = Vec::new();
|
|
for modifier in [
|
|
ModifierName::Ctrl,
|
|
ModifierName::Shift,
|
|
ModifierName::Alt,
|
|
ModifierName::Super,
|
|
] {
|
|
if self.modifiers.contains(&modifier) {
|
|
modifiers.push(modifier.to_modifier());
|
|
}
|
|
}
|
|
|
|
Some(KeyBind { modifiers, key })
|
|
}
|
|
}
|
|
|
|
#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
|
|
pub enum KeyBindAction {
|
|
Disable,
|
|
ClearScrollback,
|
|
Copy,
|
|
CopyOrSigint,
|
|
Find,
|
|
PaneFocusDown,
|
|
PaneFocusLeft,
|
|
PaneFocusRight,
|
|
PaneFocusUp,
|
|
PaneSplitHorizontal,
|
|
PaneSplitVertical,
|
|
PaneToggleMaximized,
|
|
Paste,
|
|
PastePrimary,
|
|
#[cfg_attr(not(feature = "password_manager"), allow(dead_code))]
|
|
PasswordManager,
|
|
SelectAll,
|
|
Settings,
|
|
TabActivate0,
|
|
TabActivate1,
|
|
TabActivate2,
|
|
TabActivate3,
|
|
TabActivate4,
|
|
TabActivate5,
|
|
TabActivate6,
|
|
TabActivate7,
|
|
TabActivate8,
|
|
TabClose,
|
|
TabNew,
|
|
TabNext,
|
|
TabPrev,
|
|
ToggleFullscreen,
|
|
WindowClose,
|
|
WindowNew,
|
|
ZoomIn,
|
|
ZoomOut,
|
|
ZoomReset,
|
|
}
|
|
|
|
impl KeyBindAction {
|
|
fn to_action(self) -> Option<Action> {
|
|
match self {
|
|
Self::Disable => None,
|
|
Self::ClearScrollback => Some(Action::ClearScrollback),
|
|
Self::Copy => Some(Action::Copy),
|
|
Self::CopyOrSigint => Some(Action::CopyOrSigint),
|
|
Self::Find => Some(Action::Find),
|
|
Self::PaneFocusDown => Some(Action::PaneFocusDown),
|
|
Self::PaneFocusLeft => Some(Action::PaneFocusLeft),
|
|
Self::PaneFocusRight => Some(Action::PaneFocusRight),
|
|
Self::PaneFocusUp => Some(Action::PaneFocusUp),
|
|
Self::PaneSplitHorizontal => Some(Action::PaneSplitHorizontal),
|
|
Self::PaneSplitVertical => Some(Action::PaneSplitVertical),
|
|
Self::PaneToggleMaximized => Some(Action::PaneToggleMaximized),
|
|
Self::Paste => Some(Action::Paste),
|
|
Self::PastePrimary => Some(Action::PastePrimary),
|
|
Self::SelectAll => Some(Action::SelectAll),
|
|
Self::Settings => Some(Action::Settings),
|
|
Self::TabActivate0 => Some(Action::TabActivate0),
|
|
Self::TabActivate1 => Some(Action::TabActivate1),
|
|
Self::TabActivate2 => Some(Action::TabActivate2),
|
|
Self::TabActivate3 => Some(Action::TabActivate3),
|
|
Self::TabActivate4 => Some(Action::TabActivate4),
|
|
Self::TabActivate5 => Some(Action::TabActivate5),
|
|
Self::TabActivate6 => Some(Action::TabActivate6),
|
|
Self::TabActivate7 => Some(Action::TabActivate7),
|
|
Self::TabActivate8 => Some(Action::TabActivate8),
|
|
Self::TabClose => Some(Action::TabClose),
|
|
Self::TabNew => Some(Action::TabNew),
|
|
Self::TabNext => Some(Action::TabNext),
|
|
Self::TabPrev => Some(Action::TabPrev),
|
|
Self::ToggleFullscreen => Some(Action::ToggleFullscreen),
|
|
Self::WindowClose => Some(Action::WindowClose),
|
|
Self::WindowNew => Some(Action::WindowNew),
|
|
Self::ZoomIn => Some(Action::ZoomIn),
|
|
Self::ZoomOut => Some(Action::ZoomOut),
|
|
Self::ZoomReset => Some(Action::ZoomReset),
|
|
Self::PasswordManager => {
|
|
#[cfg(feature = "password_manager")]
|
|
{
|
|
Some(Action::PasswordManager)
|
|
}
|
|
#[cfg(not(feature = "password_manager"))]
|
|
{
|
|
None
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
|
|
#[serde(transparent)]
|
|
pub struct Shortcuts(pub BTreeMap<Binding, KeyBindAction>);
|
|
|
|
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
|
|
pub enum BindingSource {
|
|
Default,
|
|
Custom,
|
|
}
|
|
|
|
#[derive(Clone, Debug, Eq, PartialEq)]
|
|
pub struct ResolvedBinding {
|
|
pub binding: Binding,
|
|
pub source: BindingSource,
|
|
}
|
|
|
|
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
|
|
pub struct ShortcutsConfig {
|
|
defaults: Shortcuts,
|
|
pub custom: Shortcuts,
|
|
}
|
|
|
|
impl ShortcutsConfig {
|
|
pub fn new(custom: Shortcuts) -> Self {
|
|
Self {
|
|
defaults: fallback_shortcuts(),
|
|
custom,
|
|
}
|
|
}
|
|
|
|
pub fn key_binds(&self) -> HashMap<KeyBind, Action> {
|
|
let mut binds = HashMap::new();
|
|
insert_shortcuts(&self.defaults, &mut binds, false);
|
|
insert_shortcuts(&self.custom, &mut binds, true);
|
|
binds
|
|
}
|
|
|
|
pub fn bindings_for_action(&self, action: KeyBindAction) -> (Vec<ResolvedBinding>, bool) {
|
|
let mut bindings = Vec::new();
|
|
|
|
let mut changed = false;
|
|
for (binding, default_action) in &self.defaults.0 {
|
|
if *default_action != action {
|
|
continue;
|
|
}
|
|
|
|
match self.custom.0.get(binding) {
|
|
Some(KeyBindAction::Disable) => {
|
|
changed = true;
|
|
}
|
|
Some(custom_action) => {
|
|
if *custom_action == action {
|
|
bindings.push(ResolvedBinding {
|
|
binding: binding.clone(),
|
|
source: BindingSource::Custom,
|
|
});
|
|
changed = true;
|
|
}
|
|
}
|
|
None => bindings.push(ResolvedBinding {
|
|
binding: binding.clone(),
|
|
source: BindingSource::Default,
|
|
}),
|
|
}
|
|
}
|
|
|
|
for (binding, custom_action) in &self.custom.0 {
|
|
if *custom_action == action
|
|
&& !bindings.iter().any(|resolved| resolved.binding == *binding)
|
|
{
|
|
bindings.push(ResolvedBinding {
|
|
binding: binding.clone(),
|
|
source: BindingSource::Custom,
|
|
});
|
|
changed = true;
|
|
}
|
|
}
|
|
|
|
(bindings, changed)
|
|
}
|
|
|
|
pub fn action_for_binding(&self, binding: &Binding) -> Option<KeyBindAction> {
|
|
if let Some(action) = self.custom.0.get(binding) {
|
|
if *action == KeyBindAction::Disable {
|
|
return None;
|
|
}
|
|
return Some(*action);
|
|
}
|
|
|
|
self.defaults.0.get(binding).copied()
|
|
}
|
|
|
|
pub fn reset_action(&mut self, reset_action: KeyBindAction) {
|
|
self.custom.0.retain(|binding, action| {
|
|
if *action == reset_action {
|
|
// Remove any matching bindings
|
|
return false;
|
|
}
|
|
if let Some(default_action) = self.defaults.0.get(binding)
|
|
&& *default_action == reset_action
|
|
{
|
|
// Remove binding that overrode a default
|
|
return false;
|
|
}
|
|
true
|
|
});
|
|
}
|
|
}
|
|
|
|
pub fn action_label(action: KeyBindAction) -> String {
|
|
match action {
|
|
KeyBindAction::Disable => fl!("disable"),
|
|
KeyBindAction::ClearScrollback => fl!("clear-scrollback"),
|
|
KeyBindAction::Copy => fl!("copy"),
|
|
KeyBindAction::CopyOrSigint => fl!("copy-or-sigint"),
|
|
KeyBindAction::Find => fl!("find"),
|
|
KeyBindAction::PaneFocusDown => fl!("focus-pane-down"),
|
|
KeyBindAction::PaneFocusLeft => fl!("focus-pane-left"),
|
|
KeyBindAction::PaneFocusRight => fl!("focus-pane-right"),
|
|
KeyBindAction::PaneFocusUp => fl!("focus-pane-up"),
|
|
KeyBindAction::PaneSplitHorizontal => fl!("split-horizontal"),
|
|
KeyBindAction::PaneSplitVertical => fl!("split-vertical"),
|
|
KeyBindAction::PaneToggleMaximized => fl!("pane-toggle-maximize"),
|
|
KeyBindAction::Paste => fl!("paste"),
|
|
KeyBindAction::PastePrimary => fl!("paste-primary"),
|
|
KeyBindAction::PasswordManager => fl!("password-manager"),
|
|
KeyBindAction::SelectAll => fl!("select-all"),
|
|
KeyBindAction::Settings => fl!("settings"),
|
|
KeyBindAction::TabActivate0 => fl!("tab-activate", number = 1),
|
|
KeyBindAction::TabActivate1 => fl!("tab-activate", number = 2),
|
|
KeyBindAction::TabActivate2 => fl!("tab-activate", number = 3),
|
|
KeyBindAction::TabActivate3 => fl!("tab-activate", number = 4),
|
|
KeyBindAction::TabActivate4 => fl!("tab-activate", number = 5),
|
|
KeyBindAction::TabActivate5 => fl!("tab-activate", number = 6),
|
|
KeyBindAction::TabActivate6 => fl!("tab-activate", number = 7),
|
|
KeyBindAction::TabActivate7 => fl!("tab-activate", number = 8),
|
|
KeyBindAction::TabActivate8 => fl!("tab-activate", number = 9),
|
|
KeyBindAction::TabClose => fl!("close-tab"),
|
|
KeyBindAction::TabNew => fl!("new-tab"),
|
|
KeyBindAction::TabNext => fl!("next-tab"),
|
|
KeyBindAction::TabPrev => fl!("previous-tab"),
|
|
KeyBindAction::ToggleFullscreen => fl!("toggle-fullscreen"),
|
|
KeyBindAction::WindowClose => fl!("close-window"),
|
|
KeyBindAction::WindowNew => fl!("new-window"),
|
|
KeyBindAction::ZoomIn => fl!("zoom-in"),
|
|
KeyBindAction::ZoomOut => fl!("zoom-out"),
|
|
KeyBindAction::ZoomReset => fl!("zoom-reset"),
|
|
}
|
|
}
|
|
|
|
pub struct ShortcutGroup {
|
|
pub title: String,
|
|
pub actions: Vec<KeyBindAction>,
|
|
}
|
|
|
|
pub fn shortcut_groups() -> Vec<ShortcutGroup> {
|
|
let mut groups = Vec::new();
|
|
groups.push(ShortcutGroup {
|
|
title: fl!("shortcut-group-clipboard"),
|
|
actions: vec![
|
|
KeyBindAction::SelectAll,
|
|
KeyBindAction::Copy,
|
|
KeyBindAction::CopyOrSigint,
|
|
KeyBindAction::Paste,
|
|
KeyBindAction::PastePrimary,
|
|
KeyBindAction::Find,
|
|
],
|
|
});
|
|
groups.push(ShortcutGroup {
|
|
title: fl!("shortcut-group-tabs"),
|
|
actions: vec![
|
|
KeyBindAction::TabNew,
|
|
KeyBindAction::TabClose,
|
|
KeyBindAction::TabNext,
|
|
KeyBindAction::TabPrev,
|
|
KeyBindAction::TabActivate0,
|
|
KeyBindAction::TabActivate1,
|
|
KeyBindAction::TabActivate2,
|
|
KeyBindAction::TabActivate3,
|
|
KeyBindAction::TabActivate4,
|
|
KeyBindAction::TabActivate5,
|
|
KeyBindAction::TabActivate6,
|
|
KeyBindAction::TabActivate7,
|
|
KeyBindAction::TabActivate8,
|
|
],
|
|
});
|
|
groups.push(ShortcutGroup {
|
|
title: fl!("splits"),
|
|
actions: vec![
|
|
KeyBindAction::PaneSplitHorizontal,
|
|
KeyBindAction::PaneSplitVertical,
|
|
KeyBindAction::PaneToggleMaximized,
|
|
KeyBindAction::PaneFocusLeft,
|
|
KeyBindAction::PaneFocusRight,
|
|
KeyBindAction::PaneFocusUp,
|
|
KeyBindAction::PaneFocusDown,
|
|
],
|
|
});
|
|
groups.push(ShortcutGroup {
|
|
title: fl!("shortcut-group-window"),
|
|
actions: vec![
|
|
KeyBindAction::WindowNew,
|
|
KeyBindAction::WindowClose,
|
|
KeyBindAction::ToggleFullscreen,
|
|
KeyBindAction::Settings,
|
|
],
|
|
});
|
|
groups.push(ShortcutGroup {
|
|
title: fl!("shortcut-group-zoom"),
|
|
actions: vec![
|
|
KeyBindAction::ZoomIn,
|
|
KeyBindAction::ZoomOut,
|
|
KeyBindAction::ZoomReset,
|
|
],
|
|
});
|
|
let mut other_actions = vec![KeyBindAction::ClearScrollback];
|
|
#[cfg(feature = "password_manager")]
|
|
other_actions.push(KeyBindAction::PasswordManager);
|
|
groups.push(ShortcutGroup {
|
|
title: fl!("shortcut-group-other"),
|
|
actions: other_actions,
|
|
});
|
|
groups
|
|
}
|
|
|
|
pub fn binding_display(binding: &Binding) -> String {
|
|
binding
|
|
.to_key_bind()
|
|
.map(|key_bind| key_bind.to_string())
|
|
.unwrap_or_else(|| binding.key.clone())
|
|
}
|
|
|
|
pub fn binding_from_key(modifiers: Modifiers, key: Key) -> Option<Binding> {
|
|
if is_modifier_only_key(&key) {
|
|
return None;
|
|
}
|
|
let key = key_to_string(&key)?;
|
|
let mut binding_modifiers = Vec::new();
|
|
if modifiers.control() {
|
|
binding_modifiers.push(ModifierName::Ctrl);
|
|
}
|
|
if modifiers.shift() {
|
|
binding_modifiers.push(ModifierName::Shift);
|
|
}
|
|
if modifiers.alt() {
|
|
binding_modifiers.push(ModifierName::Alt);
|
|
}
|
|
if modifiers.logo() {
|
|
binding_modifiers.push(ModifierName::Super);
|
|
}
|
|
Some(Binding {
|
|
modifiers: binding_modifiers,
|
|
key,
|
|
})
|
|
}
|
|
|
|
fn insert_shortcuts(
|
|
shortcuts: &Shortcuts,
|
|
binds: &mut HashMap<KeyBind, Action>,
|
|
allow_disable: bool,
|
|
) {
|
|
for (binding, action) in &shortcuts.0 {
|
|
let key_bind = match binding.to_key_bind() {
|
|
Some(key_bind) => key_bind,
|
|
None => {
|
|
log::warn!("invalid key binding: {:?}", binding);
|
|
continue;
|
|
}
|
|
};
|
|
if allow_disable && *action == KeyBindAction::Disable {
|
|
binds.remove(&key_bind);
|
|
continue;
|
|
}
|
|
let Some(action) = action.to_action() else {
|
|
log::warn!("unsupported shortcut action: {:?}", action);
|
|
continue;
|
|
};
|
|
binds.insert(key_bind, action);
|
|
}
|
|
}
|
|
|
|
fn fallback_shortcuts() -> Shortcuts {
|
|
let mut shortcuts = BTreeMap::new();
|
|
|
|
macro_rules! bind {
|
|
([$($modifier:ident),* $(,)?], $key:expr, $action:ident) => {{
|
|
shortcuts.insert(
|
|
Binding {
|
|
modifiers: vec![$(ModifierName::$modifier),*],
|
|
key: $key.to_string(),
|
|
},
|
|
KeyBindAction::$action,
|
|
);
|
|
}};
|
|
}
|
|
|
|
// Standard key bindings
|
|
bind!([Ctrl, Shift], "A", SelectAll);
|
|
bind!([Ctrl, Shift], "C", Copy);
|
|
bind!([Ctrl], "c", CopyOrSigint);
|
|
bind!([Ctrl, Shift], "F", Find);
|
|
bind!([Ctrl, Shift], "N", WindowNew);
|
|
bind!([Ctrl, Shift], "Q", WindowClose);
|
|
bind!([Ctrl, Shift], "T", TabNew);
|
|
bind!([Ctrl, Shift], "V", Paste);
|
|
bind!([Shift], "Insert", PastePrimary);
|
|
bind!([Ctrl, Shift], "W", TabClose);
|
|
bind!([Ctrl], ",", Settings);
|
|
bind!([], "F11", ToggleFullscreen);
|
|
|
|
// Ctrl+Alt+D splits horizontally, Ctrl+Alt+R splits vertically, Ctrl+Shift+X maximizes split
|
|
//TODO: Adjust bindings as desired by UX
|
|
bind!([Ctrl, Alt], "d", PaneSplitHorizontal);
|
|
bind!([Ctrl, Alt], "r", PaneSplitVertical);
|
|
bind!([Ctrl, Shift], "X", PaneToggleMaximized);
|
|
#[cfg(feature = "password_manager")]
|
|
bind!([Ctrl, Alt], "p", PasswordManager);
|
|
|
|
// Ctrl+Tab and Ctrl+Shift+Tab cycle through tabs
|
|
// Ctrl+Tab is not a special key for terminals and is free to use
|
|
bind!([Ctrl], "Tab", TabNext);
|
|
bind!([Ctrl, Shift], "Tab", TabPrev);
|
|
|
|
// Ctrl+Shift+# activates tabs by index
|
|
bind!([Ctrl, Shift], "1", TabActivate0);
|
|
bind!([Ctrl, Shift], "2", TabActivate1);
|
|
bind!([Ctrl, Shift], "3", TabActivate2);
|
|
bind!([Ctrl, Shift], "4", TabActivate3);
|
|
bind!([Ctrl, Shift], "5", TabActivate4);
|
|
bind!([Ctrl, Shift], "6", TabActivate5);
|
|
bind!([Ctrl, Shift], "7", TabActivate6);
|
|
bind!([Ctrl, Shift], "8", TabActivate7);
|
|
bind!([Ctrl, Shift], "9", TabActivate8);
|
|
|
|
// Ctrl+0, Ctrl+-, and Ctrl+= are not special keys for terminals and are free to use
|
|
bind!([Ctrl], "0", ZoomReset);
|
|
bind!([Ctrl], "-", ZoomOut);
|
|
bind!([Ctrl], "=", ZoomIn);
|
|
bind!([Ctrl], "+", ZoomIn);
|
|
|
|
// Ctrl+Arrows and Ctrl+HJKL move between splits
|
|
bind!([Ctrl, Shift], "ArrowLeft", PaneFocusLeft);
|
|
bind!([Ctrl, Shift], "H", PaneFocusLeft);
|
|
bind!([Ctrl, Shift], "ArrowDown", PaneFocusDown);
|
|
bind!([Ctrl, Shift], "J", PaneFocusDown);
|
|
bind!([Ctrl, Shift], "ArrowUp", PaneFocusUp);
|
|
bind!([Ctrl, Shift], "K", PaneFocusUp);
|
|
bind!([Ctrl, Shift], "ArrowRight", PaneFocusRight);
|
|
bind!([Ctrl, Shift], "L", PaneFocusRight);
|
|
|
|
// CTRL+Alt+L clears the scrollback.
|
|
bind!([Ctrl, Alt], "L", ClearScrollback);
|
|
|
|
Shortcuts(shortcuts)
|
|
}
|
|
|
|
fn key_from_string(value: &str) -> Option<Key> {
|
|
match value {
|
|
"Insert" => Some(Key::Named(Named::Insert)),
|
|
"Tab" => Some(Key::Named(Named::Tab)),
|
|
"F11" => Some(Key::Named(Named::F11)),
|
|
"ArrowLeft" | "Left" => Some(Key::Named(Named::ArrowLeft)),
|
|
"ArrowRight" | "Right" => Some(Key::Named(Named::ArrowRight)),
|
|
"ArrowUp" | "Up" => Some(Key::Named(Named::ArrowUp)),
|
|
"ArrowDown" | "Down" => Some(Key::Named(Named::ArrowDown)),
|
|
"PageUp" => Some(Key::Named(Named::PageUp)),
|
|
"PageDown" => Some(Key::Named(Named::PageDown)),
|
|
"Space" | "space" => Some(Key::Character(" ".into())),
|
|
_ if !value.is_empty() => Some(Key::Character(value.into())),
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
fn key_to_string(key: &Key) -> Option<String> {
|
|
match key {
|
|
Key::Character(c) => {
|
|
if c == " " {
|
|
Some("Space".to_string())
|
|
} else if c.len() == 1 && c.chars().all(|ch| ch.is_ascii_alphabetic()) {
|
|
Some(c.to_uppercase())
|
|
} else {
|
|
Some(c.to_string())
|
|
}
|
|
}
|
|
Key::Named(named) => Some(format!("{named:?}")),
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
fn is_modifier_only_key(key: &Key) -> bool {
|
|
matches!(
|
|
key,
|
|
Key::Named(
|
|
Named::Alt
|
|
| Named::AltGraph
|
|
| Named::CapsLock
|
|
| Named::Control
|
|
| Named::Fn
|
|
| Named::FnLock
|
|
| Named::NumLock
|
|
| Named::ScrollLock
|
|
| Named::Shift
|
|
| Named::Symbol
|
|
| Named::SymbolLock
|
|
| Named::Meta
|
|
| Named::Hyper
|
|
| Named::Super
|
|
)
|
|
)
|
|
}
|