From e7fa856884a5376b7b7daf1e3cd567ece964127d Mon Sep 17 00:00:00 2001
From: "Joshua A. Horton" <joshua_horton@sil.org>
Date: Mon, 9 Oct 2023 13:04:00 +0700
Subject: [PATCH] fix(web): roaming disables longpress up-flick

---
 .../osk/src/input/gestures/specsForLayout.ts  | 60 +++++++++++++++++--
 web/src/engine/osk/src/visualKeyboard.ts      |  3 +-
 2 files changed, 57 insertions(+), 6 deletions(-)

diff --git a/web/src/engine/osk/src/input/gestures/specsForLayout.ts b/web/src/engine/osk/src/input/gestures/specsForLayout.ts
index 6e84e085b39..ff9ae757183 100644
--- a/web/src/engine/osk/src/input/gestures/specsForLayout.ts
+++ b/web/src/engine/osk/src/input/gestures/specsForLayout.ts
@@ -189,6 +189,9 @@ export function gestureSetForLayout(layerGroup: OSKLayerGroup, params: GesturePa
     // gestureModels.push // flick-end
 
     // defaultSet.push('flick-start');
+  } else {
+    // A post-roam version of longpress with the up-flick shortcut disabled but roaming still on.
+    gestureModels.push(withKeySpecFiltering(longpressModelWithRoaming(params), 0));
   }
 
   return {
@@ -244,7 +247,7 @@ export function BasicLongpressContactModel(params: GestureParams): ContactModel
   };
 }
 
-export function LongpressContactModelWithShortcut(params: GestureParams): ContactModel {
+export function LongpressContactModelWithShortcut(params: GestureParams, enabledFlicks?: false | undefined): ContactModel {
   const spec = params.longpress;
   const base = BasicLongpressContactModel(params);
 
@@ -263,7 +266,7 @@ export function LongpressContactModelWithShortcut(params: GestureParams): Contac
          * The 'indexOf' allows 'n', 'nw', and 'ne' - approx 67.5 degrees on
          * each side of due N in total.
          */
-        if(spec.permitFlick && (stats.cardinalDirection?.indexOf('n') != -1 ?? false)) {
+        if((enabledFlicks ?? spec.permitFlick) && (stats.cardinalDirection?.indexOf('n') != -1 ?? false)) {
           if(stats.netDistance > spec.flickDist) {
             return 'resolve';
           }
@@ -433,7 +436,6 @@ export function longpressModelWithShortcut(params: GestureParams): GestureModel
     contacts: [
       {
         model: {
-          // Is the version without the up-flick shortcut.
           ...LongpressContactModelWithShortcut(params),
           itemPriority: 1,
           pathInheritance: 'chop'
@@ -457,16 +459,64 @@ export function longpressModelWithShortcut(params: GestureParams): GestureModel
     rejectionActions: {
       item: {
         type: 'replace',
-        replace: 'longpress'
+        replace: 'longpress-roam'
       },
       path: {
         type: 'replace',
-        replace: 'longpress'
+        replace: 'longpress-roam'
       }
     }
   }
 }
 
+/**
+ * For use when a layout doesn't have flicks; has the up-flick shortcut
+ * and facilitates roaming-touch.
+ */
+export function longpressModelWithRoaming(params: GestureParams): GestureModel {
+  return {
+    ...basicLongpressModel(params),
+
+    id: 'longpress-roam',
+    resolutionPriority: 0,
+    contacts: [
+      {
+        model: {
+          // false - disabled shortcut regardless of params
+          ...LongpressContactModelWithShortcut(params, false),
+          itemPriority: 1,
+          pathInheritance: 'chop'
+        },
+        endOnResolve: false
+      }, {
+        model: InstantContactRejectionModel
+      }
+    ],
+    resolutionAction: {
+      type: 'chain',
+      next: 'subkey-select',
+      selectionMode: 'none',
+      item: 'none'
+    },
+
+    /*
+     * Note:  these actions make sense in a 'roaming-touch' context, but not when
+     * flicks are also enabled.
+     */
+    rejectionActions: {
+      item: {
+        type: 'replace',
+        replace: 'longpress-roam'
+      },
+      path: {
+        type: 'replace',
+        replace: 'longpress-roam'
+      }
+    }
+  }
+}
+
+
 export const MultitapModel: GestureModel = {
   id: 'multitap',
   resolutionPriority: 2,
diff --git a/web/src/engine/osk/src/visualKeyboard.ts b/web/src/engine/osk/src/visualKeyboard.ts
index 0f9aca9cd6a..87c1c4f9cee 100644
--- a/web/src/engine/osk/src/visualKeyboard.ts
+++ b/web/src/engine/osk/src/visualKeyboard.ts
@@ -507,7 +507,8 @@ export default class VisualKeyboard extends EventEmitter<EventMap> implements Ke
           // Merely constructing the instance is enough; it'll link into the sequence's events and
           // handle everything that remains for the backspace from here.
           new HeldRepeater(gestureSequence, () => this.modelKeyClick(gestureKey, coord));
-        } else if(gestureStage.matchedId == 'longpress') {
+        } else if(gestureStage.matchedId.indexOf('longpress') > -1) {
+          // Matches:  'longpress', 'longpress-reset'.
           // Likewise.
           new SubkeyPopup(gestureSequence, configChanger, this, gestureSequence.stageReports[0].sources[0].baseItem);
         }