vim: Add Multi Replace mode in Vim (#8469)

For #4440, I've only added support for normal, if it's visual mode,
would we like this to delete the current selection row and enter insert
mode?

---------

Co-authored-by: Conrad Irwin <conrad.irwin@gmail.com>
This commit is contained in:
Hans 2024-03-15 10:31:53 +08:00 committed by GitHub
parent 72d36d0213
commit e836a979a2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
12 changed files with 584 additions and 16 deletions

352
crates/vim/src/replace.rs Normal file
View file

@ -0,0 +1,352 @@
use crate::{
motion::{self},
state::Mode,
Vim,
};
use editor::{display_map::ToDisplayPoint, Bias, ToPoint};
use gpui::{actions, ViewContext, WindowContext};
use language::{AutoindentMode, Point};
use std::ops::Range;
use std::sync::Arc;
use workspace::Workspace;
actions!(vim, [ToggleReplace, UndoReplace]);
pub fn register(workspace: &mut Workspace, _: &mut ViewContext<Workspace>) {
workspace.register_action(|_, _: &ToggleReplace, cx: &mut ViewContext<Workspace>| {
Vim::update(cx, |vim, cx| {
vim.update_state(|state| state.replacements = vec![]);
vim.switch_mode(Mode::Replace, false, cx);
});
});
workspace.register_action(|_, _: &UndoReplace, cx: &mut ViewContext<Workspace>| {
Vim::update(cx, |vim, cx| {
if vim.state().mode != Mode::Replace {
return;
}
let count = vim.take_count(cx);
undo_replace(vim, count, cx)
});
});
}
pub(crate) fn multi_replace(text: Arc<str>, cx: &mut WindowContext) {
Vim::update(cx, |vim, cx| {
vim.update_active_editor(cx, |vim, editor, cx| {
editor.transact(cx, |editor, cx| {
editor.set_clip_at_line_ends(false, cx);
let map = editor.snapshot(cx);
let display_selections = editor.selections.all::<Point>(cx);
// Handles all string that require manipulation, including inserts and replaces
let edits = display_selections
.into_iter()
.map(|selection| {
let is_new_line = text.as_ref() == "\n";
let mut range = selection.range();
// "\n" need to be handled separately, because when a "\n" is typing,
// we don't do a replace, we need insert a "\n"
if !is_new_line {
range.end.column += 1;
range.end = map.buffer_snapshot.clip_point(range.end, Bias::Right);
}
let replace_range = map.buffer_snapshot.anchor_before(range.start)
..map.buffer_snapshot.anchor_after(range.end);
let current_text = map
.buffer_snapshot
.text_for_range(replace_range.clone())
.collect();
vim.update_state(|state| {
state
.replacements
.push((replace_range.clone(), current_text))
});
(replace_range, text.clone())
})
.collect::<Vec<_>>();
editor.buffer().update(cx, |buffer, cx| {
buffer.edit(
edits.clone(),
Some(AutoindentMode::Block {
original_indent_columns: Vec::new(),
}),
cx,
);
});
editor.change_selections(None, cx, |s| {
s.select_anchor_ranges(edits.iter().map(|(range, _)| range.end..range.end));
});
editor.set_clip_at_line_ends(true, cx);
});
});
});
}
fn undo_replace(vim: &mut Vim, maybe_times: Option<usize>, cx: &mut WindowContext) {
vim.update_active_editor(cx, |vim, editor, cx| {
editor.transact(cx, |editor, cx| {
editor.set_clip_at_line_ends(false, cx);
let map = editor.snapshot(cx);
let selections = editor.selections.all::<Point>(cx);
let mut new_selections = vec![];
let edits: Vec<(Range<Point>, String)> = selections
.into_iter()
.filter_map(|selection| {
let end = selection.head();
let start = motion::backspace(
&map,
end.to_display_point(&map),
maybe_times.unwrap_or(1),
)
.to_point(&map);
new_selections.push(
map.buffer_snapshot.anchor_before(start)
..map.buffer_snapshot.anchor_before(start),
);
let mut undo = None;
let edit_range = start..end;
for (i, (range, inverse)) in vim.state().replacements.iter().rev().enumerate() {
if range.start.to_point(&map.buffer_snapshot) <= edit_range.start
&& range.end.to_point(&map.buffer_snapshot) >= edit_range.end
{
undo = Some(inverse.clone());
vim.update_state(|state| {
state.replacements.remove(state.replacements.len() - i - 1);
});
break;
}
}
Some((edit_range, undo?))
})
.collect::<Vec<_>>();
editor.buffer().update(cx, |buffer, cx| {
buffer.edit(edits, None, cx);
});
editor.change_selections(None, cx, |s| {
s.select_ranges(new_selections);
});
editor.set_clip_at_line_ends(true, cx);
});
});
}
#[cfg(test)]
mod test {
use indoc::indoc;
use crate::{
state::Mode,
test::{NeovimBackedTestContext, VimTestContext},
};
#[gpui::test]
async fn test_enter_and_exit_replace_mode(cx: &mut gpui::TestAppContext) {
let mut cx = VimTestContext::new(cx, true).await;
cx.simulate_keystroke("shift-r");
assert_eq!(cx.mode(), Mode::Replace);
cx.simulate_keystroke("escape");
assert_eq!(cx.mode(), Mode::Normal);
}
#[gpui::test]
async fn test_replace_mode(cx: &mut gpui::TestAppContext) {
let mut cx: NeovimBackedTestContext = NeovimBackedTestContext::new(cx).await;
// test normal replace
cx.set_shared_state(indoc! {"
ˇThe quick brown
fox jumps over
the lazy dog."})
.await;
cx.simulate_shared_keystrokes(["shift-r", "O", "n", "e"])
.await;
cx.assert_shared_state(indoc! {"
Oneˇ quick brown
fox jumps over
the lazy dog."})
.await;
assert_eq!(Mode::Replace, cx.neovim_mode().await);
// test replace with line ending
cx.set_shared_state(indoc! {"
The quick browˇn
fox jumps over
the lazy dog."})
.await;
cx.simulate_shared_keystrokes(["shift-r", "O", "n", "e"])
.await;
cx.assert_shared_state(indoc! {"
The quick browOneˇ
fox jumps over
the lazy dog."})
.await;
// test replace with blank line
cx.set_shared_state(indoc! {"
The quick brown
ˇ
fox jumps over
the lazy dog."})
.await;
cx.simulate_shared_keystrokes(["shift-r", "O", "n", "e"])
.await;
cx.assert_shared_state(indoc! {"
The quick brown
Oneˇ
fox jumps over
the lazy dog."})
.await;
// test replace with multi cursor
cx.set_shared_state(indoc! {"
ˇThe quick brown
fox jumps over
the lazy ˇdog."})
.await;
cx.simulate_shared_keystrokes(["shift-r", "O", "n", "e"])
.await;
cx.assert_shared_state(indoc! {"
Oneˇ quick brown
fox jumps over
the lazy Oneˇ."})
.await;
// test replace with newline
cx.set_shared_state(indoc! {"
The quˇick brown
fox jumps over
the lazy dog."})
.await;
cx.simulate_shared_keystrokes(["shift-r", "enter", "O", "n", "e"])
.await;
cx.assert_shared_state(indoc! {"
The qu
Oneˇ brown
fox jumps over
the lazy dog."})
.await;
// test replace with multi cursor and newline
cx.set_shared_state(indoc! {"
ˇThe quick brown
fox jumps over
the lazy ˇdog."})
.await;
cx.simulate_shared_keystrokes(["shift-r", "O", "n", "e"])
.await;
cx.assert_shared_state(indoc! {"
Oneˇ quick brown
fox jumps over
the lazy Oneˇ."})
.await;
cx.simulate_shared_keystrokes(["enter", "T", "w", "o"])
.await;
cx.assert_shared_state(indoc! {"
One
Twoˇck brown
fox jumps over
the lazy One
Twoˇ"})
.await;
}
#[gpui::test]
async fn test_replace_mode_undo(cx: &mut gpui::TestAppContext) {
let mut cx: NeovimBackedTestContext = NeovimBackedTestContext::new(cx).await;
const UNDO_REPLACE_EXAMPLES: &[&'static str] = &[
// replace undo with single line
"ˇThe quick brown fox jumps over the lazy dog.",
// replace undo with ending line
indoc! {"
The quick browˇn
fox jumps over
the lazy dog."
},
// replace undo with empty line
indoc! {"
The quick brown
ˇ
fox jumps over
the lazy dog."
},
// replace undo with multi cursor
indoc! {"
The quick browˇn
fox jumps over
the lazy ˇdog."
},
];
for example in UNDO_REPLACE_EXAMPLES {
// normal undo
cx.assert_binding_matches(
[
"shift-r",
"O",
"n",
"e",
"backspace",
"backspace",
"backspace",
],
example,
)
.await;
// undo with new line
cx.assert_binding_matches(
[
"shift-r",
"O",
"enter",
"e",
"backspace",
"backspace",
"backspace",
],
example,
)
.await;
cx.assert_binding_matches(
[
"shift-r",
"O",
"enter",
"n",
"enter",
"e",
"backspace",
"backspace",
"backspace",
"backspace",
"backspace",
],
example,
)
.await;
}
}
#[gpui::test]
async fn test_replace_multicursor(cx: &mut gpui::TestAppContext) {
let mut cx = VimTestContext::new(cx, true).await;
cx.set_state("ˇabcˇabcabc", Mode::Normal);
cx.simulate_keystrokes(["shift-r", "1", "2", "3", "4"]);
cx.assert_state("1234ˇ234ˇbc", Mode::Replace);
assert_eq!(cx.mode(), Mode::Replace);
cx.simulate_keystrokes([
"backspace",
"backspace",
"backspace",
"backspace",
"backspace",
]);
cx.assert_state("ˇabˇcabcabc", Mode::Replace);
}
}