From b7820ee6689af1e7615f21084258e986f40cb67e Mon Sep 17 00:00:00 2001
From: Michael Davis <mcarsondavis@gmail.com>
Date: Tue, 13 Feb 2024 18:11:57 -0500
Subject: [PATCH] Disallow macro keybindings within command sequences
This is a temporary limitation because of the way that command sequences
are executed. Each command is currently executed back-to-back
synchronously, but macros are by design queued up for the compositor.
So macros mixed into a command sequence will behave undesirably: they
will be executed after the rest of the static and/or typable commands
in the sequence.
This is pending a larger refactor of how we handle commands.
<https://redirect.github.com/helix-editor/helix/issues/5555> has
further details and <https://redirect.github.com/helix-editor/helix/issues/4508>
discusses a similar problem faced by the command palette.
---
helix-term/src/keymap.rs | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/helix-term/src/keymap.rs b/helix-term/src/keymap.rs
index 4d8d13d6..020ecaf4 100644
--- a/helix-term/src/keymap.rs
+++ b/helix-term/src/keymap.rs
@@ -177,6 +177,19 @@ impl<'de> serde::de::Visitor<'de> for KeyTrieVisitor {
.map_err(serde::de::Error::custom)?,
)
}
+
+ // Prevent macro keybindings from being used in command sequences.
+ // This is meant to be a temporary restriction pending a larger
+ // refactor of how command sequences are executed.
+ if commands
+ .iter()
+ .any(|cmd| matches!(cmd, MappableCommand::Macro { .. }))
+ {
+ return Err(serde::de::Error::custom(
+ "macro keybindings may not be used in command sequences",
+ ));
+ }
+
Ok(KeyTrie::Sequence(commands))
}