mirror of
https://github.com/openai/codex.git
synced 2026-11-16 22:00:36 +00:00
Wire keyboard selection into transcript overlays (#57223)
## What changed - Add `tui.keymap.global.select_transcript` with an implicit `leader [` shortcut that follows the configured leader, respects explicit remapping or unbinding, and yields to existing bindings. - Connect transcript overlays to keyboard selection, including Find, mouse selection, and navigation to the beginning of paged history. Give selection commands priority over remapped pager shortcuts. - Close selection overlays on exit or after a confirmed copy-and-follow operation, preserving the pending close decision while clipboard confirmation is asynchronous. - Show selection navigation and copy hints that adapt to the available footer width. ## Testing Add coverage for shortcut dispatch, remapping, unbinding, and conflicts; overlay exit behavior; selection across history paging; mouse and keyboard selection interaction; and cursor and footer rendering snapshots. GitOrigin-RevId: 8a920e5fa2b06ff0544d829ba30f8ecb654db0ee
This commit is contained in:
@@ -48,7 +48,40 @@ impl TranscriptView {
|
||||
},
|
||||
]
|
||||
.into(),
|
||||
cursor_column: self.selection.is_none().then_some(cursor),
|
||||
cursor_column: Some(cursor),
|
||||
is_interactive: true,
|
||||
});
|
||||
}
|
||||
if self.select_mode.is_some() {
|
||||
let hints = if has_selected_text {
|
||||
let copy = crate::key_hint::ctrl(KeyCode::Char('c')).display_label();
|
||||
[
|
||||
format!(
|
||||
"arrows/hjkl/w/b/e/shift+arrows move · home/end/0/$/g/G/⌃home/⌃end ends · pgup/pgdn/⌃b/⌃f/⌃u/⌃d page · v/space/V mark · o swap · / find · y/{copy} copy · enter copy & latest · esc clear · q close"
|
||||
),
|
||||
format!(
|
||||
"arrows/hjkl move · o swap · y/{copy} copy · enter copy & latest · esc clear · q close"
|
||||
),
|
||||
format!("y/{copy} copy · enter copy & latest · esc clear · q close"),
|
||||
"enter copy · q close".to_owned(),
|
||||
]
|
||||
} else {
|
||||
[
|
||||
"arrows/hjkl/w/b/e move · home/end/0/$/g/G/⌃home/⌃end ends · pgup/pgdn/⌃b/⌃f/⌃u/⌃d page · v/space/V/shift+arrows mark · / find · n/N next · enter/q/esc close"
|
||||
.to_owned(),
|
||||
"arrows/hjkl/w/b/e move · 0/$/g/G ends · v/space/V mark · / find · enter/q/esc close"
|
||||
.to_owned(),
|
||||
"arrows/hjkl move · v/space/V mark · / find · enter/q/esc close".to_owned(),
|
||||
"v mark · enter/q close".to_owned(),
|
||||
]
|
||||
};
|
||||
return Some(TranscriptFooter {
|
||||
text: first_fitting_line(
|
||||
hints.iter().map(String::as_str).map(navigation_line),
|
||||
width,
|
||||
)
|
||||
.into(),
|
||||
cursor_column: None,
|
||||
is_interactive: true,
|
||||
});
|
||||
}
|
||||
@@ -238,8 +271,15 @@ pub(super) fn navigation_line(navigation: &str) -> Line<'static> {
|
||||
}
|
||||
let action = [
|
||||
" copy & follow",
|
||||
" copy & latest",
|
||||
" clear selection",
|
||||
" copy+↓",
|
||||
" move",
|
||||
" ends",
|
||||
" page",
|
||||
" mark",
|
||||
" find",
|
||||
" swap",
|
||||
" previous",
|
||||
" accept",
|
||||
" cancel",
|
||||
|
||||
@@ -262,7 +262,25 @@ impl TranscriptView {
|
||||
event: MouseEvent,
|
||||
cells: &[Arc<dyn HistoryCell>],
|
||||
) -> Option<ViewAction> {
|
||||
self.handle_mouse_with_mode(event, cells, MouseMode::Selection)
|
||||
let endpoint_changed = matches!(
|
||||
event.kind,
|
||||
MouseEventKind::Down(MouseButton::Left)
|
||||
| MouseEventKind::Drag(MouseButton::Left)
|
||||
| MouseEventKind::Up(MouseButton::Left)
|
||||
);
|
||||
let before = self
|
||||
.selection
|
||||
.as_ref()
|
||||
.map(|selection| (selection.start, selection.end, selection.unit()));
|
||||
let action = self.handle_mouse_with_mode(event, cells, MouseMode::Selection);
|
||||
let after = self
|
||||
.selection
|
||||
.as_ref()
|
||||
.map(|selection| (selection.start, selection.end, selection.unit()));
|
||||
if endpoint_changed && before != after {
|
||||
self.adopt_select_mouse_range();
|
||||
}
|
||||
action
|
||||
}
|
||||
|
||||
fn handle_mouse_with_mode(
|
||||
|
||||
@@ -92,7 +92,6 @@ impl SelectMode {
|
||||
|
||||
impl TranscriptView {
|
||||
/// Enter at the accepted Find hit, preferring the bottommost visible selectable position.
|
||||
#[cfg_attr(not(test), expect(dead_code, reason = "used by a later stack layer"))]
|
||||
pub(crate) fn begin_select_mode(&mut self, cells: &[Arc<dyn HistoryCell>]) -> bool {
|
||||
if self.select_mode.is_some() {
|
||||
return true;
|
||||
@@ -136,6 +135,17 @@ impl TranscriptView {
|
||||
true
|
||||
}
|
||||
|
||||
pub(crate) fn is_select_mode(&self) -> bool {
|
||||
self.select_mode.is_some()
|
||||
}
|
||||
|
||||
/// Finish an explicit beginning traversal after the last older page is installed.
|
||||
pub(crate) fn complete_select_beginning(&mut self, cells: &[Arc<dyn HistoryCell>]) {
|
||||
if self.select_mode.is_some() {
|
||||
self.move_select_cursor(cells, CursorMotion::Beginning);
|
||||
}
|
||||
}
|
||||
|
||||
/// Leave the mode while retaining its displayed revision at the paused reading position.
|
||||
pub(crate) fn end_select_mode(&mut self) {
|
||||
if self.select_mode.take().is_none() {
|
||||
|
||||
@@ -1,8 +1,13 @@
|
||||
use super::*;
|
||||
use crate::clipboard_copy::CopyStatus;
|
||||
use crate::history_cell::PlainHistoryCell;
|
||||
use crossterm::event::MouseButton;
|
||||
use crossterm::event::MouseEvent;
|
||||
use crossterm::event::MouseEventKind;
|
||||
use pretty_assertions::assert_eq;
|
||||
use ratatui::text::Line;
|
||||
use ratatui::widgets::Paragraph;
|
||||
use ratatui::widgets::Widget;
|
||||
|
||||
fn cell(lines: &[&str]) -> Arc<dyn HistoryCell> {
|
||||
Arc::new(PlainHistoryCell::new(
|
||||
@@ -608,3 +613,194 @@ fn accepted_find_pins_an_expanded_match_before_select_mode_exits() {
|
||||
expanded
|
||||
);
|
||||
}
|
||||
#[test]
|
||||
fn beginning_motion_finishes_at_the_first_grapheme_after_paging() {
|
||||
let mut cells = vec![cell(&["newer"])];
|
||||
let mut view = TranscriptView {
|
||||
history: TranscriptHistoryState::Partial,
|
||||
..Default::default()
|
||||
};
|
||||
render(&mut view, &cells);
|
||||
assert!(view.begin_select_mode(&cells));
|
||||
press(&mut view, &cells, KeyCode::Char('g'));
|
||||
assert_eq!(view.history, TranscriptHistoryState::LoadingBeginning);
|
||||
|
||||
cells.insert(/*index*/ 0, cell(&["older"]));
|
||||
view.history_loaded(&cells, 0..1);
|
||||
view.history = TranscriptHistoryState::Complete;
|
||||
view.complete_select_beginning(&cells);
|
||||
press(&mut view, &cells, KeyCode::Char('v'));
|
||||
assert_eq!(view.selected_text(&cells).as_deref(), Some("o"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn shift_click_extends_from_the_keyboard_marks_fixed_anchor() {
|
||||
let cells = vec![cell(&["abcdef"])];
|
||||
let mut view = TranscriptView::default();
|
||||
render(&mut view, &cells);
|
||||
assert!(view.begin_select_mode(&cells));
|
||||
press(&mut view, &cells, KeyCode::Char('g'));
|
||||
press(&mut view, &cells, KeyCode::Right);
|
||||
press(&mut view, &cells, KeyCode::Right);
|
||||
press(&mut view, &cells, KeyCode::Char('v'));
|
||||
press(&mut view, &cells, KeyCode::Right);
|
||||
press(&mut view, &cells, KeyCode::Right);
|
||||
assert_eq!(view.selected_text(&cells).as_deref(), Some("cde"));
|
||||
|
||||
view.handle_mouse(
|
||||
MouseEvent {
|
||||
kind: MouseEventKind::Down(crossterm::event::MouseButton::Left),
|
||||
column: 0,
|
||||
row: 0,
|
||||
modifiers: KeyModifiers::SHIFT,
|
||||
},
|
||||
&cells,
|
||||
);
|
||||
|
||||
assert_eq!(view.selected_text(&cells).as_deref(), Some("abc"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn existing_mouse_selection_keeps_its_word_or_line_unit() {
|
||||
let word_cells = vec![cell(&["alpha beta"])];
|
||||
let mut word_view = TranscriptView::default();
|
||||
render(&mut word_view, &word_cells);
|
||||
word_view.begin_selection(
|
||||
&word_cells,
|
||||
/*column*/ 1,
|
||||
/*row*/ 0,
|
||||
/*clicks*/ 2,
|
||||
);
|
||||
assert!(word_view.begin_select_mode(&word_cells));
|
||||
press(&mut word_view, &word_cells, KeyCode::Char('h'));
|
||||
assert_eq!(
|
||||
word_view.selected_text(&word_cells).as_deref(),
|
||||
Some(&"alpha"[..4])
|
||||
);
|
||||
|
||||
let line_cells = vec![cell(&["first", "second"])];
|
||||
let mut line_view = TranscriptView::default();
|
||||
render(&mut line_view, &line_cells);
|
||||
line_view.begin_selection(
|
||||
&line_cells,
|
||||
/*column*/ 1,
|
||||
/*row*/ 1,
|
||||
/*clicks*/ 3,
|
||||
);
|
||||
assert!(line_view.begin_select_mode(&line_cells));
|
||||
press(&mut line_view, &line_cells, KeyCode::Char('k'));
|
||||
assert_eq!(
|
||||
line_view.selected_text(&line_cells).as_deref(),
|
||||
Some("first\nsecond")
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn passive_mouse_events_do_not_reanchor_a_reverse_line_mark() {
|
||||
let cells = vec![cell(&["first", "second", "third"])];
|
||||
let mut view = TranscriptView::default();
|
||||
render(&mut view, &cells);
|
||||
assert!(view.begin_select_mode(&cells));
|
||||
press(&mut view, &cells, KeyCode::Char('g'));
|
||||
press(&mut view, &cells, KeyCode::Char('j'));
|
||||
press(&mut view, &cells, KeyCode::Char('V'));
|
||||
press(&mut view, &cells, KeyCode::Char('k'));
|
||||
|
||||
for kind in [MouseEventKind::Moved, MouseEventKind::ScrollDown] {
|
||||
view.handle_mouse(
|
||||
MouseEvent {
|
||||
kind,
|
||||
column: 0,
|
||||
row: 0,
|
||||
modifiers: KeyModifiers::NONE,
|
||||
},
|
||||
&cells,
|
||||
);
|
||||
}
|
||||
view.handle_mouse(
|
||||
MouseEvent {
|
||||
kind: MouseEventKind::Down(MouseButton::Left),
|
||||
column: 80,
|
||||
row: 80,
|
||||
modifiers: KeyModifiers::NONE,
|
||||
},
|
||||
&cells,
|
||||
);
|
||||
press(&mut view, &cells, KeyCode::Char('j'));
|
||||
|
||||
assert_eq!(view.selected_text(&cells).as_deref(), Some("second\n"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn select_mode_renders_cursor_and_scannable_footer_hints() {
|
||||
let cells = vec![cell(&["alpha beta", "gamma"])];
|
||||
let mut view = TranscriptView::default();
|
||||
render(&mut view, &cells);
|
||||
assert!(view.begin_select_mode(&cells));
|
||||
let buffer = render(&mut view, &cells);
|
||||
let [unmarked_wide, footer, unmarked_narrow] = [240, 64, 32].map(|width| {
|
||||
view.footer_with_navigation(
|
||||
width,
|
||||
crate::motion::MotionMode::Reduced,
|
||||
/*latest_navigation*/ "",
|
||||
)
|
||||
.expect("select footer")
|
||||
});
|
||||
let area = Rect::new(
|
||||
/*x*/ 0,
|
||||
/*y*/ 0,
|
||||
/*width*/ 64,
|
||||
footer.text.height() as u16,
|
||||
);
|
||||
let mut footer_buffer = Buffer::empty(area);
|
||||
Paragraph::new(footer.text).render(area, &mut footer_buffer);
|
||||
|
||||
press(&mut view, &cells, KeyCode::Char('g'));
|
||||
press(&mut view, &cells, KeyCode::Char('v'));
|
||||
for _ in 0..5 {
|
||||
press(&mut view, &cells, KeyCode::Right);
|
||||
}
|
||||
let marked_buffer = render(&mut view, &cells);
|
||||
let [marked_wide, marked] = [240, 64].map(|width| {
|
||||
view.footer_with_navigation(
|
||||
width,
|
||||
crate::motion::MotionMode::Reduced,
|
||||
/*latest_navigation*/ "",
|
||||
)
|
||||
.expect("select footer")
|
||||
});
|
||||
|
||||
press(&mut view, &cells, KeyCode::Esc);
|
||||
press(&mut view, &cells, KeyCode::Char('/'));
|
||||
assert!(view.paste_search("beta"));
|
||||
while view.advance_search(&cells) {}
|
||||
let find_buffer = render(&mut view, &cells);
|
||||
let find_footer = view
|
||||
.footer_with_navigation(
|
||||
/*width*/ 64,
|
||||
crate::motion::MotionMode::Reduced,
|
||||
/*latest_navigation*/ "",
|
||||
)
|
||||
.expect("find footer");
|
||||
let find_footer_text = find_footer
|
||||
.text
|
||||
.to_string()
|
||||
.lines()
|
||||
.map(str::trim_end)
|
||||
.collect::<Vec<_>>()
|
||||
.join("\n");
|
||||
press(&mut view, &cells, KeyCode::Enter);
|
||||
press(&mut view, &cells, KeyCode::Char('v'));
|
||||
press(&mut view, &cells, KeyCode::Right);
|
||||
let find_marked_buffer = render(&mut view, &cells);
|
||||
|
||||
insta::assert_snapshot!(format!(
|
||||
"{buffer:?}\nunmarked wide: {}\nunmarked:\n{footer_buffer:?}\nunmarked narrow: {}\nmarked:\n{marked_buffer:?}\nmarked wide: {}\nmarked: {}\nfind:\n{find_buffer:?}\nfind footer: {}\nfind cursor: {:?}\nfind marked:\n{find_marked_buffer:?}",
|
||||
unmarked_wide.text,
|
||||
unmarked_narrow.text,
|
||||
marked_wide.text,
|
||||
marked.text,
|
||||
find_footer_text,
|
||||
find_footer.cursor_column,
|
||||
));
|
||||
}
|
||||
|
||||
+99
@@ -0,0 +1,99 @@
|
||||
---
|
||||
source: tui/src/transcript_view/select_mode_tests.rs
|
||||
assertion_line: 627
|
||||
expression: "format!(\"{buffer:?}\\nunmarked wide: {}\\nunmarked:\\n{footer_buffer:?}\\nunmarked narrow: {}\\nmarked:\\n{marked_buffer:?}\\nmarked wide: {}\\nmarked: {}\\nfind:\\n{find_buffer:?}\\nfind footer: {}\\nfind cursor: {:?}\\nfind marked:\\n{find_marked_buffer:?}\",\nunmarked_wide.text, unmarked_narrow.text, marked_wide.text, marked.text,\nfind_footer.text, find_footer.cursor_column,)"
|
||||
---
|
||||
Buffer {
|
||||
area: Rect { x: 0, y: 0, width: 32, height: 6 },
|
||||
content: [
|
||||
"alpha beta ",
|
||||
"gamma ",
|
||||
" ",
|
||||
" ",
|
||||
" ",
|
||||
" ",
|
||||
],
|
||||
styles: [
|
||||
x: 0, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: NONE,
|
||||
x: 0, y: 1, fg: Reset, bg: Reset, underline: Reset, modifier: BOLD | UNDERLINED | REVERSED,
|
||||
x: 1, y: 1, fg: Reset, bg: Reset, underline: Reset, modifier: NONE,
|
||||
]
|
||||
}
|
||||
unmarked wide: arrows/hjkl/w/b/e move · home/end/0/$/g/G/⌃home/⌃end ends · pgup/pgdn/⌃b/⌃f/⌃u/⌃d page · v/space/V/shift+arrows mark · / find · n/N next · enter/q/esc close
|
||||
unmarked:
|
||||
Buffer {
|
||||
area: Rect { x: 0, y: 0, width: 64, height: 1 },
|
||||
content: [
|
||||
"arrows/hjkl move · v/space/V mark · / find · enter/q/esc close ",
|
||||
],
|
||||
styles: [
|
||||
x: 0, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: BOLD,
|
||||
x: 11, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: DIM,
|
||||
x: 19, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: BOLD,
|
||||
x: 28, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: DIM,
|
||||
x: 36, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: BOLD,
|
||||
x: 37, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: DIM,
|
||||
x: 45, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: BOLD,
|
||||
x: 56, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: DIM,
|
||||
x: 62, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: NONE,
|
||||
]
|
||||
}
|
||||
unmarked narrow: v mark · enter/q close
|
||||
marked:
|
||||
Buffer {
|
||||
area: Rect { x: 0, y: 0, width: 32, height: 6 },
|
||||
content: [
|
||||
"alpha beta ",
|
||||
"gamma ",
|
||||
" ",
|
||||
" ",
|
||||
" ",
|
||||
" ",
|
||||
],
|
||||
styles: [
|
||||
x: 0, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: REVERSED,
|
||||
x: 5, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: BOLD | UNDERLINED | REVERSED,
|
||||
x: 6, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: NONE,
|
||||
]
|
||||
}
|
||||
marked wide: arrows/hjkl/w/b/e/shift+arrows move · home/end/0/$/g/G/⌃home/⌃end ends · pgup/pgdn/⌃b/⌃f/⌃u/⌃d page · v/space/V mark · o swap · / find · y/⌃c copy · enter copy & latest · esc clear · q close
|
||||
marked: y/⌃c copy · enter copy & latest · esc clear · q close
|
||||
find:
|
||||
Buffer {
|
||||
area: Rect { x: 0, y: 0, width: 32, height: 6 },
|
||||
content: [
|
||||
"alpha beta ",
|
||||
"gamma ",
|
||||
" ",
|
||||
" ",
|
||||
" ",
|
||||
" ",
|
||||
],
|
||||
styles: [
|
||||
x: 0, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: NONE,
|
||||
x: 5, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: BOLD | UNDERLINED | REVERSED,
|
||||
x: 6, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: REVERSED,
|
||||
x: 10, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: NONE,
|
||||
]
|
||||
}
|
||||
find footer: Find: beta
|
||||
enter accept · ⌃p older · ⌃n newer · esc cancel
|
||||
find cursor: Some(10)
|
||||
find marked:
|
||||
Buffer {
|
||||
area: Rect { x: 0, y: 0, width: 32, height: 6 },
|
||||
content: [
|
||||
"alpha beta ",
|
||||
"gamma ",
|
||||
" ",
|
||||
" ",
|
||||
" ",
|
||||
" ",
|
||||
],
|
||||
styles: [
|
||||
x: 0, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: NONE,
|
||||
x: 6, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: REVERSED,
|
||||
x: 7, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: BOLD | UNDERLINED | REVERSED,
|
||||
x: 8, y: 0, fg: Reset, bg: Reset, underline: Reset, modifier: NONE,
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user