Struct KeybindingResolver 

pub struct KeybindingResolver { /* private fields */ }

Resolves key events to actions based on configuration

Implementations

impl KeybindingResolver

pub fn new(config: &Config) -> Self

Create a new resolver from configuration

pub fn load_plugin_default( &mut self, context: KeyContext, key_code: KeyCode, modifiers: KeyModifiers, action: Action, )

Load a plugin default binding (for mode bindings registered via defineMode)

pub fn load_plugin_chord_default( &mut self, context: KeyContext, sequence: Vec<(KeyCode, KeyModifiers)>, action: Action, )

Load a plugin default chord binding (for mode chord bindings from defineMode)

pub fn clear_plugin_defaults_for_mode(&mut self, mode_name: &str)

Clear all plugin default bindings (single-key and chord) for a specific mode

pub fn set_mode_inherits_normal_bindings( &mut self, mode_name: &str, inherit: bool, )

Mark (or unmark) a plugin mode as inheriting Normal-context bindings for keys it doesn’t bind itself.

pub fn get_plugin_defaults( &self, ) -> &HashMap<KeyContext, HashMap<(KeyCode, KeyModifiers), Action>>

Get all plugin default bindings (for keybinding editor display)

pub fn is_terminal_ui_action(action: &Action) -> bool

Check if an action is a UI action that should work in terminal mode (without keyboard capture). These are general navigation and UI actions that don’t involve text editing.

pub fn resolve_chord( &self, chord_state: &[(KeyCode, KeyModifiers)], event: &KeyEvent, context: KeyContext, ) -> ChordResolution

Resolve a key event with chord state to check for multi-key sequences Returns:

• Complete(action): The sequence is complete, execute the action
• Partial: The sequence is partial (prefix of a chord), wait for more keys
• NoMatch: The sequence doesn’t match any chord binding

pub fn resolve(&self, event: &KeyEvent, context: KeyContext) -> Action

Resolve a key event to an action in the given context

pub fn resolve_in_context_only( &self, event: &KeyEvent, context: KeyContext, ) -> Option<Action>

Resolve a key event looking only in the specified context (no Global fallback). This is used when a modal context (like Prompt) needs to check if it has a specific binding without being overridden by Global bindings. Returns None if no binding found in the specified context.

pub fn has_explicit_binding( &self, event: &KeyEvent, context: &KeyContext, ) -> bool

true iff this context has its own binding for event — either user-customised, built-in default, or plugin-default (from defineMode). Unlike [resolve], this does not fall back to Global or Normal-context bindings; it’s the “did someone explicitly claim this key for this mode” check used by dispatch_floating_widget_key to decide whether to let mode dispatch override its smart-key defaults.

pub fn resolve_terminal_ui_action(&self, event: &KeyEvent) -> Action

Resolve a key event to a UI action for terminal mode. Only returns actions that are classified as UI actions (is_terminal_ui_action). Returns Action::None if the key doesn’t map to a UI action.

pub fn bound_plugin_action_names(&self) -> HashSet<String>

Find the primary keybinding for a given action (for display in menus) Returns a formatted string like “Ctrl+S” or “F12” Names of every PluginAction bound in any context (custom or default). Used to populate getKeybindingLabel for plugin actions, which aren’t in Action::all_action_names().

pub fn find_keybinding_for_action( &self, action_name: &str, context: KeyContext, ) -> Option<String>

pub fn find_menu_mnemonic(&self, menu_name: &str) -> Option<char>

Find the mnemonic character for a menu (based on Alt+letter keybindings) Returns the character that should be underlined in the menu label

pub fn get_all_bindings(&self) -> Vec<(String, String)>

Create default keybindings organized by context Get all keybindings (for help display) Returns a Vec of (key_description, action_description)

pub fn format_action(action: &Action) -> String

Format an action as a readable description

pub fn parse_key_public(key: &str) -> Option<KeyCode>

Public wrapper for parse_key (for keybinding editor)

pub fn parse_modifiers_public(modifiers: &[String]) -> KeyModifiers

Public wrapper for parse_modifiers (for keybinding editor)

pub fn format_action_from_str(action_name: &str) -> String

Format an action name string as a human-readable description. Used by the keybinding editor to display action names without needing a full Action enum parse.

pub fn format_action_from_str_with_args( action_name: &str, args: &HashMap<String, Value>, ) -> String

Like format_action_from_str but uses the provided args so parameterised actions (e.g. menu_open with {"name": "File"}) produce distinct, informative descriptions instead of a generic fallback.

pub fn all_action_names() -> Vec<String>

Return a sorted list of all valid action name strings. Delegates to Action::all_action_names() which is generated by the define_action_str_mapping! macro (same source of truth as Action::from_str).

pub fn get_keybinding_for_action( &self, action: &Action, context: KeyContext, ) -> Option<String>

Get the keybinding string for an action in a specific context Returns the first keybinding found (prioritizing custom bindings over defaults) When multiple keybindings exist for the same action, prefers canonical keys over terminal equivalents (e.g., “Space” over “@”) Returns None if no binding is found

pub fn get_keybinding_event_for_action( &self, action: &Action, context: KeyContext, ) -> Option<(KeyCode, KeyModifiers)>

Raw-event counterpart to get_keybinding_for_action: returns the (KeyCode, KeyModifiers) pair bound to action in context — or falls through to the same Normal-context chain the string version does — so callers (notably tests simulating user input) can feed the bound key through the editor’s key dispatcher without hardcoding a default that a rebind would invalidate.

pub fn reload(&mut self, config: &Config)

Reload bindings from config (for hot reload)

Trait Implementations

impl Clone for KeybindingResolver

fn clone(&self) -> KeybindingResolver

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.