-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
objdiff-gui: Implement keyboard shortcuts (#139)
* Fix missing dependency feature for objdiff-gui * Update .gitignore * Add enter and back hotkeys * Add scroll hotkeys * Add hotkeys to select the next symbol above/below the current one in the listing * Do not clear highlighted symbol when backing out of diff view * Do not clear highlighted symbol when hovering mouse over an unpaired symbol * Auto-scroll the keyboard-selected symbols into view if offscreen * Fix some hotkeys stealing input from focused widgets e.g. The symbol list was stealing the W/S key presses when typing into the symbol filter text edit. If the user actually wants to use these shortcuts while a widget is focused, they can simply press the escape key to unfocus all widgets and then press the shortcut. * Add Ctrl+F/S shortcuts for focusing the object and symbol filter text edits * Add space as alternative to enter hotkey This is for consistency with egui's builtint enter/space hotkey for interacting with the focused widget. * Add hotkeys to change target and base functions * Split function diff view: Enable PageUp/PageDown/Home/End for scrolling * Add escape as an alternative to back hotkey * Fix auto-scrolling to highlighted symbol only working for the left side The flag is cleared after one scroll to avoid doing it continuously, but this breaks when we need to scroll to both the left and the right symbol at the same time. So now each side has its own flag to keep track of this state independently. * Simplify clearing of the autoscroll flag, remove &mut State * Found a better place to clear the autoscroll flag DiffViewState::post_update is where the flag gets set, so clearing it right before that at the start of the function seems to make the most sense, instead of doing it in App::update.
- Loading branch information
1 parent
304df96
commit abe68ef
Showing
7 changed files
with
244 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| use egui::{ | ||
| style::ScrollAnimation, vec2, Context, Key, KeyboardShortcut, Modifiers, PointerButton, | ||
| }; | ||
|
|
||
| fn any_widget_focused(ctx: &Context) -> bool { ctx.memory(|mem| mem.focused().is_some()) } | ||
|
|
||
| pub fn enter_pressed(ctx: &Context) -> bool { | ||
| if any_widget_focused(ctx) { | ||
| return false; | ||
| } | ||
| ctx.input_mut(|i| { | ||
| i.key_pressed(Key::Enter) | ||
| || i.key_pressed(Key::Space) | ||
| || i.pointer.button_pressed(PointerButton::Extra2) | ||
| }) | ||
| } | ||
|
|
||
| pub fn back_pressed(ctx: &Context) -> bool { | ||
| if any_widget_focused(ctx) { | ||
| return false; | ||
| } | ||
| ctx.input_mut(|i| { | ||
| i.key_pressed(Key::Backspace) | ||
| || i.key_pressed(Key::Escape) | ||
| || i.pointer.button_pressed(PointerButton::Extra1) | ||
| }) | ||
| } | ||
|
|
||
| pub fn up_pressed(ctx: &Context) -> bool { | ||
| if any_widget_focused(ctx) { | ||
| return false; | ||
| } | ||
| ctx.input_mut(|i| i.key_pressed(Key::ArrowUp) || i.key_pressed(Key::W)) | ||
| } | ||
|
|
||
| pub fn down_pressed(ctx: &Context) -> bool { | ||
| if any_widget_focused(ctx) { | ||
| return false; | ||
| } | ||
| ctx.input_mut(|i| i.key_pressed(Key::ArrowDown) || i.key_pressed(Key::S)) | ||
| } | ||
|
|
||
| pub fn page_up_pressed(ctx: &Context) -> bool { ctx.input_mut(|i| i.key_pressed(Key::PageUp)) } | ||
|
|
||
| pub fn page_down_pressed(ctx: &Context) -> bool { ctx.input_mut(|i| i.key_pressed(Key::PageDown)) } | ||
|
|
||
| pub fn home_pressed(ctx: &Context) -> bool { ctx.input_mut(|i| i.key_pressed(Key::Home)) } | ||
|
|
||
| pub fn end_pressed(ctx: &Context) -> bool { ctx.input_mut(|i| i.key_pressed(Key::End)) } | ||
|
|
||
| pub fn check_scroll_hotkeys(ui: &mut egui::Ui, include_small_increments: bool) { | ||
| let ui_height = ui.available_rect_before_wrap().height(); | ||
| if up_pressed(ui.ctx()) && include_small_increments { | ||
| ui.scroll_with_delta_animation(vec2(0.0, ui_height / 10.0), ScrollAnimation::none()); | ||
| } else if down_pressed(ui.ctx()) && include_small_increments { | ||
| ui.scroll_with_delta_animation(vec2(0.0, -ui_height / 10.0), ScrollAnimation::none()); | ||
| } else if page_up_pressed(ui.ctx()) { | ||
| ui.scroll_with_delta_animation(vec2(0.0, ui_height), ScrollAnimation::none()); | ||
| } else if page_down_pressed(ui.ctx()) { | ||
| ui.scroll_with_delta_animation(vec2(0.0, -ui_height), ScrollAnimation::none()); | ||
| } else if home_pressed(ui.ctx()) { | ||
| ui.scroll_with_delta_animation(vec2(0.0, f32::INFINITY), ScrollAnimation::none()); | ||
| } else if end_pressed(ui.ctx()) { | ||
| ui.scroll_with_delta_animation(vec2(0.0, -f32::INFINITY), ScrollAnimation::none()); | ||
| } | ||
| } | ||
|
|
||
| pub fn consume_up_key(ctx: &Context) -> bool { | ||
| if any_widget_focused(ctx) { | ||
| return false; | ||
| } | ||
| ctx.input_mut(|i| { | ||
| i.consume_key(Modifiers::NONE, Key::ArrowUp) || i.consume_key(Modifiers::NONE, Key::W) | ||
| }) | ||
| } | ||
|
|
||
| pub fn consume_down_key(ctx: &Context) -> bool { | ||
| if any_widget_focused(ctx) { | ||
| return false; | ||
| } | ||
| ctx.input_mut(|i| { | ||
| i.consume_key(Modifiers::NONE, Key::ArrowDown) || i.consume_key(Modifiers::NONE, Key::S) | ||
| }) | ||
| } | ||
|
|
||
| const OBJECT_FILTER_SHORTCUT: KeyboardShortcut = KeyboardShortcut::new(Modifiers::CTRL, Key::F); | ||
|
|
||
| pub fn consume_object_filter_shortcut(ctx: &Context) -> bool { | ||
| ctx.input_mut(|i| i.consume_shortcut(&OBJECT_FILTER_SHORTCUT)) | ||
| } | ||
|
|
||
| const SYMBOL_FILTER_SHORTCUT: KeyboardShortcut = KeyboardShortcut::new(Modifiers::CTRL, Key::S); | ||
|
|
||
| pub fn consume_symbol_filter_shortcut(ctx: &Context) -> bool { | ||
| ctx.input_mut(|i| i.consume_shortcut(&SYMBOL_FILTER_SHORTCUT)) | ||
| } | ||
|
|
||
| const CHANGE_TARGET_SHORTCUT: KeyboardShortcut = KeyboardShortcut::new(Modifiers::CTRL, Key::T); | ||
|
|
||
| pub fn consume_change_target_shortcut(ctx: &Context) -> bool { | ||
| ctx.input_mut(|i| i.consume_shortcut(&CHANGE_TARGET_SHORTCUT)) | ||
| } | ||
|
|
||
| const CHANGE_BASE_SHORTCUT: KeyboardShortcut = KeyboardShortcut::new(Modifiers::CTRL, Key::B); | ||
|
|
||
| pub fn consume_change_base_shortcut(ctx: &Context) -> bool { | ||
| ctx.input_mut(|i| i.consume_shortcut(&CHANGE_BASE_SHORTCUT)) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,7 @@ mod app; | |
| mod app_config; | ||
| mod config; | ||
| mod fonts; | ||
| mod hotkeys; | ||
| mod jobs; | ||
| mod update; | ||
| mod views; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.