From efe3ba5510f7b0f07d3bad98ef701a23d7fa245f Mon Sep 17 00:00:00 2001
From: Johannes Faltermeier <jfaltermeier@eclipsesource.com>
Date: Mon, 20 Nov 2023 14:51:22 +0100
Subject: [PATCH] Reset shift key in pan_and_zoom_handler

Reset if the keyboard_event_handler opens a modal dialog, e.g. for the
help view. Reasoning is that the keyboard event handler will not receive
any key events while the modal dialog is open.
---
 ui/src/frontend/keyboard_event_handler.ts | 41 +++++++++++++++--------
 ui/src/frontend/pan_and_zoom_handler.ts   | 16 +++++++--
 2 files changed, 41 insertions(+), 16 deletions(-)

diff --git a/ui/src/frontend/keyboard_event_handler.ts b/ui/src/frontend/keyboard_event_handler.ts
index 6031c27702..fe06214bcb 100644
--- a/ui/src/frontend/keyboard_event_handler.ts
+++ b/ui/src/frontend/keyboard_event_handler.ts
@@ -28,9 +28,22 @@ const INSTANT_FOCUS_DURATION = 1n;
 const INCOMPLETE_SLICE_DURATION = 30_000n;
 type Direction = 'Forward'|'Backward';
 
+export interface HandleKeyResult {
+  wasHandled: boolean;
+  resetShift?: boolean;
+}
+
+function handleKeyResult(wasHandled: boolean, resetShift?: boolean):
+  HandleKeyResult {
+  return {
+    wasHandled,
+    resetShift,
+  };
+}
+
 // Handles all key events than are not handled by the
 // pan and zoom handler. Returns true if the event was handled.
-export function handleKey(e: KeyboardEvent, down: boolean): boolean {
+export function handleKey(e: KeyboardEvent, down: boolean): HandleKeyResult {
   const key = e.key.toLowerCase();
   const selection = globals.state.currentSelection;
   const noModifiers = !(e.ctrlKey || e.metaKey || e.altKey || e.shiftKey);
@@ -44,11 +57,11 @@ export function handleKey(e: KeyboardEvent, down: boolean): boolean {
     } else if (selection) {
       lockSliceSpan(e.shiftKey);
     }
-    return true;
+    return handleKeyResult(true);
   }
   if (down && 'f' === key && noModifiers) {
     findCurrentSelection();
-    return true;
+    return handleKeyResult(true);
   }
   if (down && 'a' === key && ctrlOrMeta) {
     let tracksToSelect: string[] = [];
@@ -82,48 +95,48 @@ export function handleKey(e: KeyboardEvent, down: boolean): boolean {
       },
     }));
     e.preventDefault();
-    return true;
+    return handleKeyResult(true);
   }
   if (down && 'b' === key && ctrlOrMeta) {
     globals.dispatch(Actions.toggleSidebar({}));
-    return true;
+    return handleKeyResult(true);
   }
   if (down && '?' === key && maybeShift) {
     toggleHelp();
-    return true;
+    return handleKeyResult(true, true);
   }
   if (down && 'enter' === key && maybeShift) {
     e.preventDefault();
     executeSearch(e.shiftKey);
-    return true;
+    return handleKeyResult(true);
   }
   if (down && 'escape' === key) {
     globals.frontendLocalState.deselectArea();
     globals.makeSelection(Actions.deselect({}));
     globals.dispatch(Actions.removeNote({id: '0'}));
-    return true;
+    return handleKeyResult(true);
   }
   if (down && ']' === key && ctrlOrMeta) {
     focusOtherFlow('Forward');
-    return true;
+    return handleKeyResult(true);
   }
   if (down && ']' === key && noModifiers) {
     moveByFocusedFlow('Forward');
-    return true;
+    return handleKeyResult(true);
   }
   if (down && '[' === key && ctrlOrMeta) {
     focusOtherFlow('Backward');
-    return true;
+    return handleKeyResult(true);
   }
   if (down && '[' === key && noModifiers) {
     moveByFocusedFlow('Backward');
-    return true;
+    return handleKeyResult(true);
   }
   if (down && 'v' === key && noModifiers) {
     globals.frontendLocalState.toggleVsyncHighlight();
-    return true;
+    return handleKeyResult(true);
   }
-  return false;
+  return handleKeyResult(false);
 }
 
 // Search |boundFlows| for |flowId| and return the id following it.
diff --git a/ui/src/frontend/pan_and_zoom_handler.ts b/ui/src/frontend/pan_and_zoom_handler.ts
index c5b5dae80b..5c600ce257 100644
--- a/ui/src/frontend/pan_and_zoom_handler.ts
+++ b/ui/src/frontend/pan_and_zoom_handler.ts
@@ -275,7 +275,13 @@ export class PanAndZoomHandler {
     if (!this.shouldHandlekey(e)) return;
 
     // Handle key events that are not pan or zoom.
-    if (handleKey(e, true)) return;
+    const handleKeyResult = handleKey(e, true);
+    if (handleKeyResult.resetShift) {
+      this.updateShift(false);
+    }
+    if (handleKeyResult.wasHandled) {
+      return;
+    }
 
     if (keyToPan(e) !== Pan.None) {
       if (this.panning !== keyToPan(e)) {
@@ -305,7 +311,13 @@ export class PanAndZoomHandler {
     if (!this.shouldHandlekey(e)) return;
 
     // Handle key events that are not pan or zoom.
-    if (handleKey(e, false)) return;
+    const handleKeyResult = handleKey(e, false);
+    if (handleKeyResult.resetShift) {
+      this.updateShift(false);
+    }
+    if (handleKeyResult.wasHandled) {
+      return;
+    }
 
     if (keyToPan(e) === this.panning) {
       this.panning = Pan.None;