mirror of
https://github.com/pchuan98/codex.git
synced 2026-07-01 00:31:56 +08:00
feat(tui): add configurable keymap support (#18593)
## Why The TUI currently handles keyboard shortcuts as hard-coded event matches spread across app, composer, pager, list, approval, and navigation code. That makes shortcuts hard to customize, makes displayed hints easy to drift from actual behavior, and makes future keymap work riskier because there is no central action inventory. This PR adds the foundation for configurable, action-based keymaps without adding the interactive remapping UI yet. Onboarding intentionally stays on fixed startup shortcuts because users cannot reasonably configure keymaps before completing onboarding. This is PR1 in the keymap stack: - PR1: #18593: configurable keymap foundation - PR2: #18594: `/keymap` picker and guided remapping UI - PR3: #18595: Vim composer mode and the remap option ## Design Notes The new model resolves named actions into concrete runtime bindings once from config, then passes those bindings to the UI surfaces that handle input or render shortcut hints. The main concepts are: - **Context**: a scope where an action is active, such as `global`, `chat`, `composer`, `editor`, `pager`, `list`, or `approval`. - **Action**: a named operation inside a context, such as `global.open_transcript`, `composer.submit`, or `pager.close`. - **Binding**: one or more single-key shortcuts assigned to an action, written as config strings such as `ctrl-t`, `alt-backspace`, or `page-down`. Multi-step sequences such as `ctrl-x ctrl-s`, `g g`, or leader-key flows are not part of this PR. - **Resolution order**: context-specific config wins first, supported global fallbacks come next, and built-in defaults fill in anything unset. - **Explicit unbinding**: an empty array removes an action binding in that scope and does not fall through to a fallback binding. - **Conflict validation**: a resolved keymap rejects duplicate active bindings inside the same scope so one keypress cannot dispatch two actions. ## What Changed - Added `TuiKeymap` config support under `[tui.keymap]`, including typed contexts/actions, key alias normalization, generated schema coverage, and user-facing config errors. - Added `RuntimeKeymap` resolution in `codex-rs/tui/src/keymap.rs`, including fallback precedence, built-in defaults, explicit unbinding, and per-context conflict validation. - Rewired existing TUI handlers to consume resolved keymap actions instead of directly matching hard-coded keys in each component. - Updated key hint rendering and footer/pager/list surfaces so displayed shortcuts follow the resolved keymap. - Kept onboarding shortcuts fixed in `codex-rs/tui/src/onboarding/keys.rs` instead of exposing them through `[tui.keymap]`. ## Validation The branch includes focused coverage for config parsing, key normalization, runtime fallback resolution, explicit unbinding, duplicate-key conflict validation, default keymap consistency, onboarding startup key behavior, and UI hint snapshots affected by resolved key bindings.
This commit is contained in:
Felipe Coury
@@ -0,0 +1,165 @@
|
||||
//! `ChatWidget` integration points for the `/keymap` picker flow.
|
||||
//!
|
||||
//! The picker model, capture view, and edit semantics live in [`crate::keymap_setup`]. This module
|
||||
//! keeps only the `ChatWidget`-owned responsibilities: opening those views in the bottom pane,
|
||||
//! routing users back to the right picker row after an edit, and synchronizing the committed
|
||||
//! keymap config back into the live widget state. Keeping these methods outside `chatwidget.rs`
|
||||
//! keeps the main transcript/event surface from also owning the `/keymap` navigation details.
|
||||
//!
|
||||
//! The important invariant is that any accepted keymap edit must update three places together:
|
||||
//! the stored `Config.tui_keymap`, the cached copy-response binding used by app-level shortcuts,
|
||||
//! and the bottom pane's runtime keymap bindings. Updating only one of those would make the UI
|
||||
//! appear to accept a remap while some handlers still respond to the old keys.
|
||||
|
||||
use codex_config::types::TuiKeymap;
|
||||
use codex_terminal_detection::terminal_info;
|
||||
|
||||
use super::ChatWidget;
|
||||
use super::queued_message_edit_hint_binding;
|
||||
use crate::app_event::KeymapEditIntent;
|
||||
use crate::keymap::RuntimeKeymap;
|
||||
use crate::keymap_setup;
|
||||
|
||||
impl ChatWidget {
|
||||
/// Opens the root `/keymap` picker using the current `tui.keymap` configuration.
|
||||
///
|
||||
/// This validates the persisted keymap before building picker rows because every subsequent
|
||||
/// picker screen needs the effective runtime bindings, including preset defaults and user
|
||||
/// overrides. If the config is invalid, the user sees the parse error instead of a partial
|
||||
/// picker that could commit edits against stale runtime state.
|
||||
pub(crate) fn open_keymap_picker(&mut self) {
|
||||
match RuntimeKeymap::from_config(&self.config.tui_keymap) {
|
||||
Ok(runtime_keymap) => {
|
||||
let params = keymap_setup::build_keymap_picker_params(
|
||||
&runtime_keymap,
|
||||
&self.config.tui_keymap,
|
||||
);
|
||||
self.bottom_pane.show_selection_view(params);
|
||||
}
|
||||
Err(err) => {
|
||||
self.add_error_message(format!("Invalid `tui.keymap` configuration: {err}"));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Opens the per-action menu for one keymap action.
|
||||
///
|
||||
/// Callers pass the already-resolved runtime keymap from the app event that selected the
|
||||
/// action. Recomputing it here would risk showing a menu for a different config if another
|
||||
/// keymap edit was applied between the picker event and this handler.
|
||||
pub(crate) fn open_keymap_action_menu(
|
||||
&mut self,
|
||||
context: String,
|
||||
action: String,
|
||||
runtime_keymap: &RuntimeKeymap,
|
||||
) {
|
||||
let params = keymap_setup::build_keymap_action_menu_params(
|
||||
context,
|
||||
action,
|
||||
runtime_keymap,
|
||||
&self.config.tui_keymap,
|
||||
);
|
||||
self.bottom_pane.show_selection_view(params);
|
||||
}
|
||||
|
||||
/// Opens the key-capture view for a set, replace, or alternate-binding edit.
|
||||
///
|
||||
/// The capture view owns raw key interpretation, but `ChatWidget` supplies the event sender so
|
||||
/// the captured key can come back through the same app-event path as menu selections. Bypassing
|
||||
/// that path would skip config persistence and leave the runtime keymap cache unchanged.
|
||||
pub(crate) fn open_keymap_capture(
|
||||
&mut self,
|
||||
context: String,
|
||||
action: String,
|
||||
intent: KeymapEditIntent,
|
||||
runtime_keymap: &RuntimeKeymap,
|
||||
) {
|
||||
let view = keymap_setup::build_keymap_capture_view(
|
||||
context,
|
||||
action,
|
||||
intent,
|
||||
runtime_keymap,
|
||||
self.app_event_tx.clone(),
|
||||
);
|
||||
self.bottom_pane.show_view(Box::new(view));
|
||||
self.request_redraw();
|
||||
}
|
||||
|
||||
/// Opens the menu that lets the user choose which existing binding to replace.
|
||||
///
|
||||
/// This is only used for actions with multiple effective bindings. The chosen binding is
|
||||
/// carried through the subsequent capture intent so replacement edits do not accidentally
|
||||
/// collapse alternate bindings that should remain available.
|
||||
pub(crate) fn open_keymap_replace_binding_menu(
|
||||
&mut self,
|
||||
context: String,
|
||||
action: String,
|
||||
runtime_keymap: &RuntimeKeymap,
|
||||
) {
|
||||
let params =
|
||||
keymap_setup::build_keymap_replace_binding_menu_params(context, action, runtime_keymap);
|
||||
self.bottom_pane.show_selection_view(params);
|
||||
}
|
||||
|
||||
/// Returns to the root picker with the edited action selected.
|
||||
///
|
||||
/// The preferred path replaces any active keymap picker submenu in place so the bottom-pane
|
||||
/// back stack does not accumulate obsolete menus after each edit. If the expected view stack is
|
||||
/// no longer active, this falls back to showing a fresh picker rather than dropping the user on
|
||||
/// a stale screen.
|
||||
pub(crate) fn return_to_keymap_picker(
|
||||
&mut self,
|
||||
context: &str,
|
||||
action: &str,
|
||||
runtime_keymap: &RuntimeKeymap,
|
||||
) {
|
||||
let params = keymap_setup::build_keymap_picker_params_for_selected_action(
|
||||
runtime_keymap,
|
||||
&self.config.tui_keymap,
|
||||
context,
|
||||
action,
|
||||
);
|
||||
let replaced = self.bottom_pane.replace_active_views_with_selection_view(
|
||||
&[
|
||||
keymap_setup::KEYMAP_PICKER_VIEW_ID,
|
||||
keymap_setup::KEYMAP_ACTION_MENU_VIEW_ID,
|
||||
keymap_setup::KEYMAP_REPLACE_BINDING_MENU_VIEW_ID,
|
||||
],
|
||||
params,
|
||||
);
|
||||
if !replaced {
|
||||
let params = keymap_setup::build_keymap_picker_params_for_selected_action(
|
||||
runtime_keymap,
|
||||
&self.config.tui_keymap,
|
||||
context,
|
||||
action,
|
||||
);
|
||||
self.bottom_pane.show_selection_view(params);
|
||||
}
|
||||
self.request_redraw();
|
||||
}
|
||||
|
||||
/// Applies a committed keymap edit to the live chat widget.
|
||||
///
|
||||
/// The caller is responsible for persisting the config file before invoking this method. This
|
||||
/// method updates the in-memory config, app-level copy binding cache, and bottom-pane keymap
|
||||
/// bindings as one unit; callers that update only `self.config.tui_keymap` would leave visible
|
||||
/// picker state and active key handlers disagreeing until the next restart.
|
||||
pub(crate) fn apply_keymap_update(
|
||||
&mut self,
|
||||
keymap_config: TuiKeymap,
|
||||
runtime_keymap: &RuntimeKeymap,
|
||||
) {
|
||||
self.config.tui_keymap = keymap_config;
|
||||
self.copy_last_response_binding = runtime_keymap.app.copy.clone();
|
||||
self.chat_keymap = runtime_keymap.chat.clone();
|
||||
self.queued_message_edit_hint_binding = queued_message_edit_hint_binding(
|
||||
&self.chat_keymap.edit_queued_message,
|
||||
terminal_info(),
|
||||
);
|
||||
self.bottom_pane
|
||||
.set_queued_message_edit_binding(self.queued_message_edit_hint_binding);
|
||||
self.bottom_pane.set_keymap_bindings(runtime_keymap);
|
||||
self.request_redraw();
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user