mirror of
https://github.com/alacritty/alacritty.git
synced 2026-11-20 21:23:23 +03:00
1 parent
542147067d
commit
bbb2cbf947
3 files changed
+130
-33
No files matched your search
@@ -22,6 +22,7 @@ Notable changes to the `alacritty_terminal` crate are documented in its
|
||||
- Off-by-one in vi mode ParagraphUp action
|
||||
- Unbounded per-cell memory usage for zero-width cells
|
||||
- Unbounded Kitty keyboard mode stack size
|
||||
- Keyboard and mouse bindings missing from `alacritty msg get-config` output
|
||||
|
||||
## 0.17.0
|
||||
|
||||
|
||||
@@ -1,23 +1,26 @@
|
||||
use serde::{Deserialize, Deserializer, Serialize};
|
||||
use serde::{Deserialize, Deserializer, Serialize, Serializer};
|
||||
|
||||
use alacritty_config_derive::{ConfigDeserialize, SerdeReplace};
|
||||
|
||||
use crate::config::bindings::{self, MouseBinding};
|
||||
use crate::config::ui_config;
|
||||
|
||||
#[derive(ConfigDeserialize, Serialize, Default, Clone, Debug, PartialEq, Eq)]
|
||||
#[derive(ConfigDeserialize, Serialize, Default, Clone, Debug, PartialEq)]
|
||||
pub struct Mouse {
|
||||
pub hide_when_typing: bool,
|
||||
#[serde(skip_serializing)]
|
||||
pub bindings: MouseBindings,
|
||||
}
|
||||
|
||||
#[derive(SerdeReplace, Clone, Debug, PartialEq, Eq)]
|
||||
pub struct MouseBindings(pub Vec<MouseBinding>);
|
||||
/// Active mouse bindings and the user's binding entries they were created from.
|
||||
#[derive(SerdeReplace, Clone, Debug, PartialEq)]
|
||||
pub struct MouseBindings {
|
||||
pub bindings: Vec<MouseBinding>,
|
||||
user_bindings: Vec<toml::Value>,
|
||||
}
|
||||
|
||||
impl Default for MouseBindings {
|
||||
fn default() -> Self {
|
||||
Self(bindings::default_mouse_bindings())
|
||||
Self { bindings: bindings::default_mouse_bindings(), user_bindings: Vec::new() }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -26,6 +29,18 @@ impl<'de> Deserialize<'de> for MouseBindings {
|
||||
where
|
||||
D: Deserializer<'de>,
|
||||
{
|
||||
Ok(Self(ui_config::deserialize_bindings(deserializer, Self::default().0)?))
|
||||
let mut user_bindings = Vec::<toml::Value>::deserialize(deserializer)?;
|
||||
let bindings =
|
||||
ui_config::deserialize_bindings(&mut user_bindings, bindings::default_mouse_bindings());
|
||||
Ok(Self { bindings, user_bindings })
|
||||
}
|
||||
}
|
||||
|
||||
impl Serialize for MouseBindings {
|
||||
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
|
||||
where
|
||||
S: Serializer,
|
||||
{
|
||||
self.user_bindings.serialize(serializer)
|
||||
}
|
||||
}
|
||||
@@ -7,7 +7,7 @@ use std::path::PathBuf;
|
||||
use std::rc::Rc;
|
||||
|
||||
use log::{error, warn};
|
||||
use serde::de::{Error as SerdeError, MapAccess, Visitor};
|
||||
use serde::de::{DeserializeOwned, Error as SerdeError, MapAccess, Visitor};
|
||||
use serde::{Deserialize, Deserializer, Serialize, Serializer};
|
||||
use unicode_width::UnicodeWidthChar;
|
||||
use winit::keyboard::{Key, ModifiersState};
|
||||
@@ -154,7 +154,7 @@ impl UiConfig {
|
||||
|
||||
#[inline]
|
||||
pub fn mouse_bindings(&self) -> &[MouseBinding] {
|
||||
&self.mouse.bindings.0
|
||||
&self.mouse.bindings.bindings
|
||||
}
|
||||
|
||||
#[inline]
|
||||
@@ -173,16 +173,16 @@ impl UiConfig {
|
||||
#[derive(ConfigDeserialize, Serialize, Default, Clone, Debug, PartialEq)]
|
||||
struct Keyboard {
|
||||
/// Keybindings.
|
||||
#[serde(skip_serializing)]
|
||||
bindings: KeyBindings,
|
||||
}
|
||||
|
||||
#[derive(SerdeReplace, Clone, Debug, PartialEq, Eq)]
|
||||
struct KeyBindings(Vec<KeyBinding>);
|
||||
/// Active keybindings and the user's binding entries they were created from.
|
||||
#[derive(SerdeReplace, Clone, Debug, PartialEq)]
|
||||
struct KeyBindings(Vec<KeyBinding>, Vec<toml::Value>);
|
||||
|
||||
impl Default for KeyBindings {
|
||||
fn default() -> Self {
|
||||
Self(bindings::default_key_bindings())
|
||||
Self(bindings::default_key_bindings(), Vec::new())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -191,31 +191,44 @@ impl<'de> Deserialize<'de> for KeyBindings {
|
||||
where
|
||||
D: Deserializer<'de>,
|
||||
{
|
||||
Ok(Self(deserialize_bindings(deserializer, Self::default().0)?))
|
||||
let mut user_bindings = Vec::<toml::Value>::deserialize(deserializer)?;
|
||||
let bindings = deserialize_bindings(&mut user_bindings, bindings::default_key_bindings());
|
||||
Ok(Self(bindings, user_bindings))
|
||||
}
|
||||
}
|
||||
|
||||
pub fn deserialize_bindings<'a, D, T>(
|
||||
deserializer: D,
|
||||
mut default: Vec<Binding<T>>,
|
||||
) -> Result<Vec<Binding<T>>, D::Error>
|
||||
where
|
||||
D: Deserializer<'a>,
|
||||
T: Clone + Eq,
|
||||
Binding<T>: Deserialize<'a>,
|
||||
{
|
||||
let values = Vec::<toml::Value>::deserialize(deserializer)?;
|
||||
impl Serialize for KeyBindings {
|
||||
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
|
||||
where
|
||||
S: Serializer,
|
||||
{
|
||||
self.1.serialize(serializer)
|
||||
}
|
||||
}
|
||||
|
||||
/// Deserialize the user's bindings and merge them with the defaults.
|
||||
///
|
||||
/// Invalid bindings are logged and removed from `values`.
|
||||
pub fn deserialize_bindings<T>(
|
||||
values: &mut Vec<toml::Value>,
|
||||
mut default: Vec<Binding<T>>,
|
||||
) -> Vec<Binding<T>>
|
||||
where
|
||||
T: Clone + Eq,
|
||||
Binding<T>: DeserializeOwned,
|
||||
{
|
||||
// Skip all invalid values.
|
||||
let mut bindings = Vec::with_capacity(values.len());
|
||||
for value in values {
|
||||
match Binding::<T>::deserialize(value) {
|
||||
Ok(binding) => bindings.push(binding),
|
||||
Err(err) => {
|
||||
error!(target: LOG_TARGET_CONFIG, "Config error: {err}; ignoring binding");
|
||||
},
|
||||
}
|
||||
}
|
||||
values.retain(|value| match Binding::<T>::deserialize(value.clone()) {
|
||||
Ok(binding) => {
|
||||
bindings.push(binding);
|
||||
true
|
||||
},
|
||||
Err(err) => {
|
||||
error!(target: LOG_TARGET_CONFIG, "Config error: {err}; ignoring binding");
|
||||
false
|
||||
},
|
||||
});
|
||||
|
||||
// Remove matching default bindings.
|
||||
for binding in bindings.iter() {
|
||||
@@ -224,7 +237,7 @@ where
|
||||
|
||||
bindings.extend(default);
|
||||
|
||||
Ok(bindings)
|
||||
bindings
|
||||
}
|
||||
|
||||
/// A delta for a point in a 2 dimensional plane.
|
||||
@@ -734,4 +747,72 @@ mod tests {
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn serialize_user_bindings() {
|
||||
let config: UiConfig = toml::from_str(
|
||||
r#"
|
||||
[keyboard]
|
||||
bindings = [
|
||||
{ key = "N", mods = "Control|Shift", action = "SpawnNewInstance" },
|
||||
]
|
||||
|
||||
[mouse]
|
||||
bindings = [{ mouse = "Middle", mode = "~Vi", action = "Copy" }]
|
||||
"#,
|
||||
)
|
||||
.unwrap();
|
||||
|
||||
let serialized = serde_json::to_value(&config).unwrap();
|
||||
assert_eq!(
|
||||
serialized["keyboard"]["bindings"],
|
||||
serde_json::json!([
|
||||
{ "key": "N", "mods": "Control|Shift", "action": "SpawnNewInstance" },
|
||||
])
|
||||
);
|
||||
assert_eq!(
|
||||
serialized["mouse"]["bindings"],
|
||||
serde_json::json!([{ "mouse": "Middle", "mode": "~Vi", "action": "Copy" }])
|
||||
);
|
||||
|
||||
let reloaded: UiConfig = serde_json::from_value(serde_json::json!({
|
||||
"keyboard": serialized["keyboard"],
|
||||
"mouse": serialized["mouse"],
|
||||
}))
|
||||
.unwrap();
|
||||
assert_eq!(reloaded.key_bindings(), config.key_bindings());
|
||||
assert_eq!(reloaded.mouse_bindings(), config.mouse_bindings());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn serialize_skips_invalid_bindings() {
|
||||
let config: UiConfig = toml::from_str(
|
||||
r#"
|
||||
[keyboard]
|
||||
bindings = [
|
||||
{ key = "N", mods = "Control|Shift", action = "SpawnNewInstance" },
|
||||
{ key = "Invalid", action = "SpawnNewInstance" },
|
||||
]
|
||||
|
||||
[mouse]
|
||||
bindings = [
|
||||
{ mouse = "Middle", mode = "~Vi", action = "Copy" },
|
||||
{ mouse = "Middle", action = "Invalid" },
|
||||
]
|
||||
"#,
|
||||
)
|
||||
.unwrap();
|
||||
|
||||
let serialized = serde_json::to_value(&config).unwrap();
|
||||
assert_eq!(
|
||||
serialized["keyboard"]["bindings"],
|
||||
serde_json::json!([
|
||||
{ "key": "N", "mods": "Control|Shift", "action": "SpawnNewInstance" },
|
||||
])
|
||||
);
|
||||
assert_eq!(
|
||||
serialized["mouse"]["bindings"],
|
||||
serde_json::json!([{ "mouse": "Middle", "mode": "~Vi", "action": "Copy" }])
|
||||
);
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user