Files
oak-gpui/crates/vim/src/digraph.rs
T
Conrad Irwin 36d51fe4a5 vim: Improve lifecycle (#16477)
Closes #13579

A major painpoint in the Vim crate has been life-cycle management. We
used to have one global Vim instance that tried to track per-editor
state; this led to a number of subtle issues (e.g. #13579, the mode
indicator being global, and quick toggling between windows letting vim
mode's notion of the active editor get out of sync).

This PR changes the internal structure of the code so that there is now
one `Vim` instance per `Editor` (stored as an `Addon`); and the global
stuff is separated out. This fixes the above problems, and tidies up a
bunch of the mess in the codebase.

Release Notes:

* vim: Fixed accidental visual mode in project search and go to
references
([#13579](https://github.com/zed-industries/zed/issues/13579)).
2024-08-20 20:48:50 -06:00

158 lines
5.2 KiB
Rust

use std::sync::Arc;
use collections::HashMap;
use gpui::AppContext;
use settings::Settings;
use std::sync::LazyLock;
use ui::ViewContext;
use crate::{Vim, VimSettings};
mod default;
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: &AppContext) -> 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,
cx: &mut ViewContext<Self>,
) {
let text = lookup_digraph(first_char, second_char, &cx);
self.pop_operator(cx);
if self.editor_input_enabled() {
self.update_editor(cx, |_, editor, cx| editor.insert(&text, cx));
} else {
self.input_ignored(text, cx);
}
}
}
#[cfg(test)]
mod test {
use collections::HashMap;
use settings::SettingsStore;
use crate::{
state::Mode,
test::{NeovimBackedTestContext, VimTestContext},
VimSettings,
};
#[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ˇş");
}
}