#![allow(clippy::doc_markdown)]
use {
reovim_driver_input::{
KeyCode, KeyEvent, KeyLookupState, KeySequence, KeymapQuery, ModeKeyResolver, ModeState,
Modifiers, ResolveInput, ResolveResult,
},
reovim_kernel::api::v1::ModeId,
};
use {
super::super::insert::*,
crate::{VimSessionState, modes::VimMode},
};
fn key(c: char) -> KeyEvent {
KeyEvent::new(KeyCode::Char(c))
}
fn key_with_mod(c: char, modifiers: Modifiers) -> KeyEvent {
KeyEvent::with_modifiers(KeyCode::Char(c), modifiers)
}
fn test_state() -> ModeState {
ModeState::new(VimMode::INSERT_ID)
}
struct NotFoundKeymap;
#[cfg_attr(coverage_nightly, coverage(off))]
impl KeymapQuery for NotFoundKeymap {
fn query(&self, _mode: &ModeId, _keys: &KeySequence) -> KeyLookupState {
KeyLookupState::NotFound
}
}
fn resolve_input(keymap: &impl KeymapQuery) -> ResolveInput<'_> {
static EMPTY_KEYS: KeySequence = KeySequence::new();
static MODE: ModeId = VimMode::INSERT_ID;
ResolveInput::new(&EMPTY_KEYS, &MODE, keymap)
}
#[test]
fn test_new_resolver() {
let resolver = VimInsertResolver::new();
assert_eq!(resolver.mode_id(), &VimMode::INSERT_ID);
}
#[test]
fn test_insert_character() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let result = resolver.resolve_with_keymap(&key('a'), &mut state, &input);
assert!(matches!(result, ResolveResult::InsertChar { char: 'a', .. }));
let result = resolver.resolve_with_keymap(&key('Z'), &mut state, &input);
assert!(matches!(result, ResolveResult::InsertChar { char: 'Z', .. }));
let result = resolver.resolve_with_keymap(&key('5'), &mut state, &input);
assert!(matches!(result, ResolveResult::InsertChar { char: '5', .. }));
let result = resolver.resolve_with_keymap(&key(' '), &mut state, &input);
assert!(matches!(result, ResolveResult::InsertChar { char: ' ', .. }));
}
#[test]
fn test_insert_tab() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let result = resolver.resolve_with_keymap(&KeyEvent::new(KeyCode::Tab), &mut state, &input);
assert!(matches!(result, ResolveResult::InsertChar { char: '\t', .. }));
}
#[test]
fn test_insert_enter() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let result = resolver.resolve_with_keymap(&KeyEvent::new(KeyCode::Enter), &mut state, &input);
assert!(matches!(result, ResolveResult::InsertChar { char: '\n', .. }));
}
#[test]
fn test_escape_not_handled() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let result = resolver.resolve_with_keymap(&KeyEvent::new(KeyCode::Escape), &mut state, &input);
assert!(matches!(result, ResolveResult::NotHandled));
}
#[test]
fn test_ctrl_bracket_not_handled() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let result =
resolver.resolve_with_keymap(&key_with_mod('[', Modifiers::CTRL), &mut state, &input);
assert!(matches!(result, ResolveResult::NotHandled));
}
#[test]
fn test_ctrl_char_not_inserted() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let result =
resolver.resolve_with_keymap(&key_with_mod('h', Modifiers::CTRL), &mut state, &input);
assert!(matches!(result, ResolveResult::NotHandled));
}
#[test]
fn test_alt_char_not_inserted() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let result =
resolver.resolve_with_keymap(&key_with_mod('a', Modifiers::ALT), &mut state, &input);
assert!(matches!(result, ResolveResult::NotHandled));
}
#[test]
fn test_backspace_not_handled() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let result =
resolver.resolve_with_keymap(&KeyEvent::new(KeyCode::Backspace), &mut state, &input);
assert!(matches!(result, ResolveResult::NotHandled));
}
#[test]
fn test_arrow_keys_not_handled() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let result = resolver.resolve_with_keymap(&KeyEvent::new(KeyCode::Left), &mut state, &input);
assert!(matches!(result, ResolveResult::NotHandled));
let result = resolver.resolve_with_keymap(&KeyEvent::new(KeyCode::Up), &mut state, &input);
assert!(matches!(result, ResolveResult::NotHandled));
}
#[test]
fn test_mode_id() {
let resolver = VimInsertResolver::new();
assert_eq!(resolver.mode_id().name(), "insert");
}
#[test]
fn test_inherits_from() {
let resolver = VimInsertResolver::new();
assert!(resolver.inherits_from().is_none());
}
#[test]
fn test_shift_allowed_for_uppercase() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let result =
resolver.resolve_with_keymap(&key_with_mod('A', Modifiers::SHIFT), &mut state, &input);
assert!(matches!(result, ResolveResult::InsertChar { char: 'A', .. }));
}
#[test]
fn test_default_impl() {
let resolver = VimInsertResolver::default();
assert_eq!(resolver.mode_id(), &VimMode::INSERT_ID);
}
#[test]
fn test_reset_is_noop() {
let mut resolver = VimInsertResolver::new();
resolver.reset();
assert_eq!(resolver.mode_id(), &VimMode::INSERT_ID);
}
#[test]
fn test_insert_special_chars() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let result = resolver.resolve_with_keymap(&key('!'), &mut state, &input);
assert!(matches!(result, ResolveResult::InsertChar { char: '!', .. }));
let result = resolver.resolve_with_keymap(&key('@'), &mut state, &input);
assert!(matches!(result, ResolveResult::InsertChar { char: '@', .. }));
let result = resolver.resolve_with_keymap(&key('#'), &mut state, &input);
assert!(matches!(result, ResolveResult::InsertChar { char: '#', .. }));
let result = resolver.resolve_with_keymap(&key('~'), &mut state, &input);
assert!(matches!(result, ResolveResult::InsertChar { char: '~', .. }));
}
#[cfg_attr(coverage_nightly, coverage(off))]
#[test]
fn test_insert_digits() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
for c in '0'..='9' {
let result = resolver.resolve_with_keymap(&key(c), &mut state, &input);
assert!(
matches!(result, ResolveResult::InsertChar { char: ch, .. } if ch == c),
"digit '{c}' should be insertable"
);
}
}
#[test]
fn test_delete_key_not_handled() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let result = resolver.resolve_with_keymap(&KeyEvent::new(KeyCode::Delete), &mut state, &input);
assert!(matches!(result, ResolveResult::NotHandled));
}
#[test]
fn test_home_end_not_handled() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let result = resolver.resolve_with_keymap(&KeyEvent::new(KeyCode::Home), &mut state, &input);
assert!(matches!(result, ResolveResult::NotHandled));
let result = resolver.resolve_with_keymap(&KeyEvent::new(KeyCode::End), &mut state, &input);
assert!(matches!(result, ResolveResult::NotHandled));
}
#[test]
fn test_f_keys_not_handled() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let result = resolver.resolve_with_keymap(&KeyEvent::new(KeyCode::F(1)), &mut state, &input);
assert!(matches!(result, ResolveResult::NotHandled));
}
struct ExactKeymap;
#[cfg_attr(coverage_nightly, coverage(off))]
impl KeymapQuery for ExactKeymap {
fn query(&self, _mode: &ModeId, _keys: &KeySequence) -> KeyLookupState {
KeyLookupState::ExactOnly(reovim_kernel::api::v1::CommandId::new(
reovim_kernel::api::v1::ModuleId::new("test"),
"test-cmd",
))
}
}
#[test]
#[cfg_attr(coverage_nightly, coverage(off))]
fn test_escape_executes_with_keymap_binding() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = ExactKeymap;
let input = resolve_input(&keymap);
let result = resolver.resolve_with_keymap(&KeyEvent::new(KeyCode::Escape), &mut state, &input);
match result {
ResolveResult::Execute(cmd, _) => {
assert_eq!(cmd.name(), "test-cmd");
}
_ => panic!("expected Execute, got {result:?}"),
}
}
#[test]
#[cfg_attr(coverage_nightly, coverage(off))]
fn test_backspace_executes_with_keymap_binding() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = ExactKeymap;
let input = resolve_input(&keymap);
let result =
resolver.resolve_with_keymap(&KeyEvent::new(KeyCode::Backspace), &mut state, &input);
match result {
ResolveResult::Execute(cmd, _) => {
assert_eq!(cmd.name(), "test-cmd");
}
_ => panic!("expected Execute, got {result:?}"),
}
}
struct PrefixKeymap;
#[cfg_attr(coverage_nightly, coverage(off))]
impl KeymapQuery for PrefixKeymap {
fn query(&self, _mode: &ModeId, _keys: &KeySequence) -> KeyLookupState {
KeyLookupState::PrefixOnly
}
}
#[test]
fn test_prefix_only_returns_pending() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = PrefixKeymap;
let input = resolve_input(&keymap);
let result = resolver.resolve_with_keymap(&KeyEvent::new(KeyCode::Escape), &mut state, &input);
assert!(matches!(result, ResolveResult::Pending));
}
#[test]
fn test_ctrl_alt_not_insertable() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let mods = Modifiers::CTRL | Modifiers::ALT;
let result = resolver.resolve_with_keymap(&key_with_mod('a', mods), &mut state, &input);
assert!(matches!(result, ResolveResult::NotHandled));
}
#[test]
fn test_resolve_with_extensions_tracks_inserted_char() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let mut extensions = reovim_driver_input::ExtensionMap::new();
let mut shared_ext = reovim_driver_input::ExtensionMap::new();
let _ = extensions.get_or_insert::<VimSessionState>();
let result = resolver.resolve_with_extensions(
&key('a'),
&mut state,
&input,
&mut shared_ext,
&mut extensions,
);
assert!(matches!(result, ResolveResult::InsertChar { char: 'a', .. }));
let vim = extensions.get::<VimSessionState>().unwrap();
assert_eq!(vim.insert_buffer, "a");
}
#[test]
fn test_resolve_with_extensions_tracks_multiple_chars() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let mut extensions = reovim_driver_input::ExtensionMap::new();
let mut shared_ext = reovim_driver_input::ExtensionMap::new();
let _ = extensions.get_or_insert::<VimSessionState>();
resolver.resolve_with_extensions(
&key('h'),
&mut state,
&input,
&mut shared_ext,
&mut extensions,
);
resolver.resolve_with_extensions(
&key('e'),
&mut state,
&input,
&mut shared_ext,
&mut extensions,
);
resolver.resolve_with_extensions(
&key('l'),
&mut state,
&input,
&mut shared_ext,
&mut extensions,
);
resolver.resolve_with_extensions(
&key('l'),
&mut state,
&input,
&mut shared_ext,
&mut extensions,
);
resolver.resolve_with_extensions(
&key('o'),
&mut state,
&input,
&mut shared_ext,
&mut extensions,
);
let vim = extensions.get::<VimSessionState>().unwrap();
assert_eq!(vim.insert_buffer, "hello");
}
#[test]
fn test_resolve_with_extensions_tracks_tab() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let mut extensions = reovim_driver_input::ExtensionMap::new();
let mut shared_ext = reovim_driver_input::ExtensionMap::new();
let _ = extensions.get_or_insert::<VimSessionState>();
resolver.resolve_with_extensions(
&KeyEvent::new(KeyCode::Tab),
&mut state,
&input,
&mut shared_ext,
&mut extensions,
);
let vim = extensions.get::<VimSessionState>().unwrap();
assert_eq!(vim.insert_buffer, "\t");
}
#[test]
fn test_resolve_with_extensions_tracks_enter() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let mut extensions = reovim_driver_input::ExtensionMap::new();
let mut shared_ext = reovim_driver_input::ExtensionMap::new();
let _ = extensions.get_or_insert::<VimSessionState>();
resolver.resolve_with_extensions(
&KeyEvent::new(KeyCode::Enter),
&mut state,
&input,
&mut shared_ext,
&mut extensions,
);
let vim = extensions.get::<VimSessionState>().unwrap();
assert_eq!(vim.insert_buffer, "\n");
}
#[test]
#[cfg_attr(coverage_nightly, coverage(off))]
fn test_resolve_with_extensions_non_insertable_delegates_to_keymap() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = ExactKeymap;
let input = resolve_input(&keymap);
let mut extensions = reovim_driver_input::ExtensionMap::new();
let mut shared_ext = reovim_driver_input::ExtensionMap::new();
let _ = extensions.get_or_insert::<VimSessionState>();
let result = resolver.resolve_with_extensions(
&KeyEvent::new(KeyCode::Escape),
&mut state,
&input,
&mut shared_ext,
&mut extensions,
);
match result {
ResolveResult::Execute(cmd, _) => {
assert_eq!(cmd.name(), "test-cmd");
}
_ => panic!("expected Execute, got {result:?}"),
}
let vim = extensions.get::<VimSessionState>().unwrap();
assert!(vim.insert_buffer.is_empty());
}
#[test]
fn test_resolve_with_extensions_ctrl_char_not_tracked() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let mut extensions = reovim_driver_input::ExtensionMap::new();
let mut shared_ext = reovim_driver_input::ExtensionMap::new();
let _ = extensions.get_or_insert::<VimSessionState>();
let result = resolver.resolve_with_extensions(
&key_with_mod('h', Modifiers::CTRL),
&mut state,
&input,
&mut shared_ext,
&mut extensions,
);
assert!(matches!(result, ResolveResult::NotHandled));
let vim = extensions.get::<VimSessionState>().unwrap();
assert!(vim.insert_buffer.is_empty());
}
#[test]
fn test_resolve_with_extensions_without_vim_session_state() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = NotFoundKeymap;
let input = resolve_input(&keymap);
let mut extensions = reovim_driver_input::ExtensionMap::new();
let mut shared_ext = reovim_driver_input::ExtensionMap::new();
let result = resolver.resolve_with_extensions(
&key('x'),
&mut state,
&input,
&mut shared_ext,
&mut extensions,
);
assert!(matches!(result, ResolveResult::InsertChar { char: 'x', .. }));
}
struct ExactWithLongerKeymap;
#[cfg_attr(coverage_nightly, coverage(off))]
impl KeymapQuery for ExactWithLongerKeymap {
fn query(&self, _mode: &ModeId, _keys: &KeySequence) -> KeyLookupState {
KeyLookupState::ExactWithLonger {
exact: reovim_kernel::api::v1::CommandId::new(
reovim_kernel::api::v1::ModuleId::new("test"),
"longer-cmd",
),
}
}
}
#[test]
#[cfg_attr(coverage_nightly, coverage(off))]
fn test_exact_with_longer_executes_exact() {
let resolver = VimInsertResolver::new();
let mut state = test_state();
let keymap = ExactWithLongerKeymap;
let input = resolve_input(&keymap);
let result = resolver.resolve_with_keymap(&KeyEvent::new(KeyCode::Escape), &mut state, &input);
match result {
ResolveResult::Execute(cmd, _) => {
assert_eq!(cmd.name(), "longer-cmd");
}
_ => panic!("expected Execute, got {result:?}"),
}
}