ZIm/crates/vim/src/digraph.rs
2025-08-11 16:10:06 -06:00

363 lines
12 KiB
Rust

use std::sync::Arc;
use collections::HashMap;
use editor::Editor;
use gpui::{Action, App, Context, Keystroke, KeystrokeEvent, Window};
use schemars::JsonSchema;
use serde::Deserialize;
use settings::Settings;
use std::sync::LazyLock;
use crate::{Vim, VimSettings, state::Operator};
mod default;
#[derive(Debug, Clone, Deserialize, JsonSchema, PartialEq, Action)]
#[action(namespace = vim)]
struct Literal(String, char);
pub(crate) fn register(editor: &mut Editor, cx: &mut Context<Vim>) {
Vim::action(editor, cx, Vim::literal)
}
static DEFAULT_DIGRAPHS_MAP: LazyLock<HashMap<String, Arc<str>>> = LazyLock::new(|| {
let mut map = HashMap::default();
for &(a, b, c) in default::DEFAULT_DIGRAPHS {
let key = format!("{a}{b}");
let value = char::from_u32(c).unwrap().to_string().into();
map.insert(key, value);
}
map
});
fn lookup_digraph(a: char, b: char, cx: &App) -> Arc<str> {
let custom_digraphs = &VimSettings::get_global(cx).custom_digraphs;
let input = format!("{a}{b}");
let reversed = format!("{b}{a}");
custom_digraphs
.get(&input)
.or_else(|| DEFAULT_DIGRAPHS_MAP.get(&input))
.or_else(|| custom_digraphs.get(&reversed))
.or_else(|| DEFAULT_DIGRAPHS_MAP.get(&reversed))
.cloned()
.unwrap_or_else(|| b.to_string().into())
}
impl Vim {
pub fn insert_digraph(
&mut self,
first_char: char,
second_char: char,
window: &mut Window,
cx: &mut Context<Self>,
) {
let text = lookup_digraph(first_char, second_char, cx);
self.pop_operator(window, cx);
if self.editor_input_enabled() {
self.update_editor(cx, |_, editor, cx| editor.insert(&text, window, cx));
} else {
self.input_ignored(text, window, cx);
}
}
fn literal(&mut self, action: &Literal, window: &mut Window, cx: &mut Context<Self>) {
if let Some(Operator::Literal { prefix }) = self.active_operator() {
if let Some(prefix) = prefix {
if let Some(keystroke) = Keystroke::parse(&action.0).ok() {
window.defer(cx, |window, cx| {
window.dispatch_keystroke(keystroke, cx);
});
}
return self.handle_literal_input(prefix, "", window, cx);
}
}
self.insert_literal(Some(action.1), "", window, cx);
}
pub fn handle_literal_keystroke(
&mut self,
keystroke_event: &KeystrokeEvent,
prefix: String,
window: &mut Window,
cx: &mut Context<Self>,
) {
// handled by handle_literal_input
if keystroke_event.keystroke.key_char.is_some() {
return;
};
if prefix.len() > 0 {
self.handle_literal_input(prefix, "", window, cx);
} else {
self.pop_operator(window, cx);
}
// give another chance to handle the binding outside
// of waiting mode.
if keystroke_event.action.is_none() {
let keystroke = keystroke_event.keystroke.clone();
window.defer(cx, |window, cx| {
window.dispatch_keystroke(keystroke, cx);
});
}
return;
}
pub fn handle_literal_input(
&mut self,
mut prefix: String,
text: &str,
window: &mut Window,
cx: &mut Context<Self>,
) {
let first = prefix.chars().next();
let next = text.chars().next().unwrap_or(' ');
match first {
Some('o' | 'O') => {
if next.is_digit(8) {
prefix.push(next);
if prefix.len() == 4 {
let ch: char = u8::from_str_radix(&prefix[1..], 8).unwrap_or(255).into();
return self.insert_literal(Some(ch), "", window, cx);
}
} else {
let ch = if prefix.len() > 1 {
Some(u8::from_str_radix(&prefix[1..], 8).unwrap_or(255).into())
} else {
None
};
return self.insert_literal(ch, text, window, cx);
}
}
Some('x' | 'X' | 'u' | 'U') => {
let max_len = match first.unwrap() {
'x' => 3,
'X' => 3,
'u' => 5,
'U' => 9,
_ => unreachable!(),
};
if next.is_ascii_hexdigit() {
prefix.push(next);
if prefix.len() == max_len {
let ch: char = u32::from_str_radix(&prefix[1..], 16)
.ok()
.and_then(|n| n.try_into().ok())
.unwrap_or('\u{FFFD}');
return self.insert_literal(Some(ch), "", window, cx);
}
} else {
let ch = if prefix.len() > 1 {
Some(
u32::from_str_radix(&prefix[1..], 16)
.ok()
.and_then(|n| n.try_into().ok())
.unwrap_or('\u{FFFD}'),
)
} else {
None
};
return self.insert_literal(ch, text, window, cx);
}
}
Some('0'..='9') => {
if next.is_ascii_hexdigit() {
prefix.push(next);
if prefix.len() == 3 {
let ch: char = u8::from_str_radix(&prefix, 10).unwrap_or(255).into();
return self.insert_literal(Some(ch), "", window, cx);
}
} else {
let ch: char = u8::from_str_radix(&prefix, 10).unwrap_or(255).into();
return self.insert_literal(Some(ch), "", window, cx);
}
}
None if matches!(next, 'o' | 'O' | 'x' | 'X' | 'u' | 'U' | '0'..='9') => {
prefix.push(next)
}
_ => {
return self.insert_literal(None, text, window, cx);
}
};
self.pop_operator(window, cx);
self.push_operator(
Operator::Literal {
prefix: Some(prefix),
},
window,
cx,
);
}
fn insert_literal(
&mut self,
ch: Option<char>,
suffix: &str,
window: &mut Window,
cx: &mut Context<Self>,
) {
self.pop_operator(window, cx);
let mut text = String::new();
if let Some(c) = ch {
if c == '\n' {
text.push('\x00')
} else {
text.push(c)
}
}
text.push_str(suffix);
if self.editor_input_enabled() {
self.update_editor(cx, |_, editor, cx| editor.insert(&text, window, cx));
} else {
self.input_ignored(text.into(), window, cx);
}
}
}
#[cfg(test)]
mod test {
use collections::HashMap;
use settings::SettingsStore;
use crate::{
VimSettings,
state::Mode,
test::{NeovimBackedTestContext, VimTestContext},
};
#[gpui::test]
async fn test_digraph_insert_mode(cx: &mut gpui::TestAppContext) {
let mut cx: NeovimBackedTestContext = NeovimBackedTestContext::new(cx).await;
cx.set_shared_state("Hellˇo").await;
cx.simulate_shared_keystrokes("a ctrl-k o : escape").await;
cx.shared_state().await.assert_eq("Helloˇö");
cx.set_shared_state("Hellˇo").await;
cx.simulate_shared_keystrokes("a ctrl-k : o escape").await;
cx.shared_state().await.assert_eq("Helloˇö");
cx.set_shared_state("Hellˇo").await;
cx.simulate_shared_keystrokes("i ctrl-k o : escape").await;
cx.shared_state().await.assert_eq("Hellˇöo");
}
#[gpui::test]
async fn test_digraph_insert_multicursor(cx: &mut gpui::TestAppContext) {
let mut cx: VimTestContext = VimTestContext::new(cx, true).await;
cx.set_state("Hellˇo wˇorld", Mode::Normal);
cx.simulate_keystrokes("a ctrl-k o : escape");
cx.assert_state("Helloˇö woˇörld", Mode::Normal);
}
#[gpui::test]
async fn test_digraph_replace(cx: &mut gpui::TestAppContext) {
let mut cx: NeovimBackedTestContext = NeovimBackedTestContext::new(cx).await;
cx.set_shared_state("Hellˇo").await;
cx.simulate_shared_keystrokes("r ctrl-k o :").await;
cx.shared_state().await.assert_eq("Hellˇö");
}
#[gpui::test]
async fn test_digraph_find(cx: &mut gpui::TestAppContext) {
let mut cx: NeovimBackedTestContext = NeovimBackedTestContext::new(cx).await;
cx.set_shared_state("ˇHellö world").await;
cx.simulate_shared_keystrokes("f ctrl-k o :").await;
cx.shared_state().await.assert_eq("Hellˇö world");
cx.set_shared_state("ˇHellö world").await;
cx.simulate_shared_keystrokes("t ctrl-k o :").await;
cx.shared_state().await.assert_eq("Helˇlö world");
}
#[gpui::test]
async fn test_digraph_replace_mode(cx: &mut gpui::TestAppContext) {
let mut cx: NeovimBackedTestContext = NeovimBackedTestContext::new(cx).await;
cx.set_shared_state("ˇHello").await;
cx.simulate_shared_keystrokes(
"shift-r ctrl-k a ' ctrl-k e ` ctrl-k i : ctrl-k o ~ ctrl-k u - escape",
)
.await;
cx.shared_state().await.assert_eq("áèïõˇū");
}
#[gpui::test]
async fn test_digraph_custom(cx: &mut gpui::TestAppContext) {
let mut cx: VimTestContext = VimTestContext::new(cx, true).await;
cx.update_global(|store: &mut SettingsStore, cx| {
store.update_user_settings::<VimSettings>(cx, |s| {
let mut custom_digraphs = HashMap::default();
custom_digraphs.insert("|-".into(), "".into());
custom_digraphs.insert(":)".into(), "👨‍💻".into());
s.custom_digraphs = Some(custom_digraphs);
});
});
cx.set_state("ˇ", Mode::Normal);
cx.simulate_keystrokes("a ctrl-k | - escape");
cx.assert_state("ˇ⊢", Mode::Normal);
// Test support for multi-codepoint mappings
cx.set_state("ˇ", Mode::Normal);
cx.simulate_keystrokes("a ctrl-k : ) escape");
cx.assert_state("ˇ👨‍💻", Mode::Normal);
}
#[gpui::test]
async fn test_digraph_keymap_conflict(cx: &mut gpui::TestAppContext) {
let mut cx: NeovimBackedTestContext = NeovimBackedTestContext::new(cx).await;
cx.set_shared_state("Hellˇo").await;
cx.simulate_shared_keystrokes("a ctrl-k s , escape").await;
cx.shared_state().await.assert_eq("Helloˇş");
}
#[gpui::test]
async fn test_ctrl_v(cx: &mut gpui::TestAppContext) {
let mut cx: NeovimBackedTestContext = NeovimBackedTestContext::new(cx).await;
cx.set_shared_state("ˇ").await;
cx.simulate_shared_keystrokes("i ctrl-v 0 0 0").await;
cx.shared_state().await.assert_eq("\x00ˇ");
cx.simulate_shared_keystrokes("ctrl-v j").await;
cx.shared_state().await.assert_eq("\x00");
cx.simulate_shared_keystrokes("ctrl-v x 6 5").await;
cx.shared_state().await.assert_eq("\x00jeˇ");
cx.simulate_shared_keystrokes("ctrl-v U 1 F 6 4 0 space")
.await;
cx.shared_state().await.assert_eq("\x00je🙀 ˇ");
}
#[gpui::test]
async fn test_ctrl_v_escape(cx: &mut gpui::TestAppContext) {
let mut cx: NeovimBackedTestContext = NeovimBackedTestContext::new(cx).await;
cx.set_shared_state("ˇ").await;
cx.simulate_shared_keystrokes("i ctrl-v 9 escape").await;
cx.shared_state().await.assert_eq("ˇ\t");
cx.simulate_shared_keystrokes("i ctrl-v escape").await;
cx.shared_state().await.assert_eq("\x1bˇ\t");
}
#[gpui::test]
async fn test_ctrl_v_control(cx: &mut gpui::TestAppContext) {
let mut cx: NeovimBackedTestContext = NeovimBackedTestContext::new(cx).await;
cx.set_shared_state("ˇ").await;
cx.simulate_shared_keystrokes("i ctrl-v ctrl-d").await;
cx.shared_state().await.assert_eq("\x04ˇ");
cx.simulate_shared_keystrokes("ctrl-v ctrl-j").await;
cx.shared_state().await.assert_eq("\x04\x00ˇ");
cx.simulate_shared_keystrokes("ctrl-v tab").await;
cx.shared_state().await.assert_eq("\x04\x00\x09ˇ");
}
}