feat(web): implementation of modipress, integration with multitap 🐵

common/web/gesture-recognizer/src/engine/headless/gestures/matchers/gestureMatcher.ts

@@ -26,6 +26,7 @@ export interface PredecessorMatch<Type, StateToken> {
   readonly result: MatchResult<Type>;
   readonly model?: GestureModel<Type, any>;
   readonly baseItem: Type;
+  readonly predecessor?: PredecessorMatch<Type, StateToken>;
 }
 
 export interface MatchResult<Type> {
@@ -56,7 +57,7 @@ export class GestureMatcher<Type, StateToken = any> implements PredecessorMatch<
 
   private _isCancelled: boolean = false;
 
-  private readonly predecessor?: PredecessorMatch<Type, StateToken>;
+  readonly predecessor?: PredecessorMatch<Type, StateToken>;
 
   private readonly publishedPromise: ManagedPromise<MatchResult<Type>>; // unsure on the actual typing at the moment.
   private _result: MatchResult<Type>;
@@ -126,10 +127,6 @@ export class GestureMatcher<Type, StateToken = any> implements PredecessorMatch<
         baseContact = srcContact.baseSource;
       }
 
-      if(baseContact.isPathComplete) {
-        throw new Error("GestureMatcher may not be built against already-completed contact points");
-      }
-
       const contactSpec = model.contacts[touchpointIndex];
       /* c8 ignore next 3 */
       if(!contactSpec) {

common/web/gesture-recognizer/src/engine/headless/gestures/matchers/gestureSequence.ts

@@ -230,8 +230,9 @@ export class GestureSequence<Type, StateToken = any> extends EventEmitter<EventM
     // In some automated tests, `this.touchpointCoordinator` may be `null`.
     let selectorNotCurrent = false;
     if(this.touchpointCoordinator) {
-      selectorNotCurrent = ![this.selector, this.pushedSelector].find((sel) => sel == this.touchpointCoordinator.currentSelector);
+      selectorNotCurrent = !this.touchpointCoordinator.selectorStackIncludes(this.selector);
     }
+
     let nextModels = modelSetForAction(selection.result.action, this.gestureConfig, this.baseGestureSetId);
     if(selectorNotCurrent) {
       // If this sequence's selector isn't current, we're in an unrooted state; the parent, base gesture

common/web/gesture-recognizer/src/engine/headless/gestures/matchers/matcherSelector.ts

@@ -193,9 +193,22 @@ export class MatcherSelector<Type, StateToken = any> extends EventEmitter<EventM
      * 'detached', a state not compatible with the needs of this method.
      */
     const sourceNotYetStaged = source instanceof GestureSource;
+
+    const determinePredecessorSources = (source: PredecessorMatch<Type, StateToken>) => {
+      const directSources = (source.sources as GestureSourceSubview<Type>[]).map((source => source.baseSource));
+
+      if(directSources && directSources.length > 0) {
+        return directSources;
+      } else if(!source.predecessor) {
+        return [];
+      } else {
+        return determinePredecessorSources(source.predecessor);
+      }
+    }
+
     const sources = sourceNotYetStaged
       ? [source instanceof GestureSourceSubview ? source.baseSource : source]
-      : (source.sources as GestureSourceSubview<Type>[]).map((source) => source.baseSource);
+      : determinePredecessorSources(source);
 
     // Defining these as locals helps the TS type-checker better infer types within
     // this method; a later assignment to `source` will remove its ability to infer
@@ -451,9 +464,6 @@ export class MatcherSelector<Type, StateToken = any> extends EventEmitter<EventM
       const matchedContactIds = matcher.allSourceIds;
 
       const sourceMetadata = matchedContactIds.map((id) => {
-        // It is fine if there is no match; we build tracking only so far as the most recent
-        // predecessor for disambiguation, so the initial tap/source for a third tap of a
-        // multitap will not be accessible here.
         return this._sourceSelector.find((metadata) => metadata.source.identifier == id);
       }).filter((entry) => !!entry); // remove `undefined` entries, as they're irrelevant.
 

common/web/gesture-recognizer/src/engine/headless/gestures/matchers/pathMatcher.ts

@@ -49,7 +49,8 @@ export class PathMatcher<Type, StateToken = any> {
     this.source = source;
 
     if(model.timer) {
-      this.timerPromise = new TimeoutPromise(model.timer.duration);
+      const offset = model.timer.inheritElapsed ? Math.min(source.path.stats.duration, model.timer.duration) : 0;
+      this.timerPromise = new TimeoutPromise(model.timer.duration - offset);
 
       this.publishedPromise.then(() => {
         this.timerPromise.resolve(false);

common/web/gesture-recognizer/src/engine/headless/gestures/specs/contactModel.ts

@@ -24,7 +24,15 @@ export interface ContactModel<Type, StateToken = any> {
    */
   timer?: {
     duration: number,
-    expectedResult: boolean;
+    expectedResult: boolean,
+    /**
+     * If not defined or set to `false`, any already-elapsed time for the source will be
+     * not be considered; the matching timer will start fresh.
+     *
+     * If `true`, the timer will use the inherited `path.stats.duration` stat as an
+     * offset that has already elapsed, counting it against the timer.
+     */
+    inheritElapsed?: boolean
   }
 
   // This field is primarly used at the `GestureMatcher` level, rather than the

common/web/gesture-recognizer/src/engine/headless/touchpointCoordinator.ts

@@ -96,6 +96,10 @@ export class TouchpointCoordinator<HoveredItemType, StateToken=any> extends Even
     this.currentSelector.stateToken = this.stateToken;
   }
 
+  public selectorStackIncludes(selector: MatcherSelector<HoveredItemType, StateToken>): boolean {
+    return this.selectorStack.includes(selector);
+  }
+
   public get currentSelector() {
     return this.selectorStack[this.selectorStack.length-1];
   }

web/src/engine/main/src/keymanEngine.ts

@@ -54,12 +54,7 @@ export default class KeymanEngine<
       }
     }
 
-    //... probably only applies for physical keystrokes.
-    if(!event.isSynthetic) {
-      if(this.osk?.vkbd?.keyPending) {
-        this.osk.vkbd.keyPending = null;
-      }
-    } else if(this.keyEventRefocus) { // && event.isSynthetic // as in, is from the OSK.
+    if(this.keyEventRefocus) { // && event.isSynthetic // as in, is from the OSK.
       // Do anything needed to guarantee that the outputTarget stays active (`app/browser`: maintains focus).
       // (Interaction with the OSK may have de-focused the element providing active context;
       // we want to restore it in case the user swaps back to the hardware keyboard afterward.)
@@ -72,6 +67,14 @@ export default class KeymanEngine<
     // Deleting matched deadkeys here seems to correct some of the issues.   (JD 6/6/14)
     outputTarget.deadkeys().deleteMatched();      // Delete any matched deadkeys before continuing
 
+    if(event.isSynthetic) {
+      const oskLayer = this.osk.vkbd.layerId;
+
+      // In case of modipresses.
+      if(oskLayer && oskLayer != this.core.keyboardProcessor.layerId) {
+        this.core.keyboardProcessor.layerId = oskLayer;
+      }
+    }
     const result = this.core.processKeyEvent(event, outputTarget);
 
     if(result && result.transcription?.transform) {

web/src/engine/osk/src/input/gestures/browser/modipress.ts

@@ -0,0 +1,71 @@
+import { type KeyElement } from '../../../keyElement.js';
+import VisualKeyboard from '../../../visualKeyboard.js';
+
+import { KeyDistribution, ActiveKeyBase, ManagedPromise } from '@keymanapp/keyboard-processor';
+import { GestureSequence } from '@keymanapp/gesture-recognizer';
+import { GestureHandler } from '../gestureHandler.js';
+
+/**
+ *
+ */
+export default class Modipress implements GestureHandler {
+  private completionCallback: () => void;
+  private originalLayer: string;
+  private shouldRestore: boolean = false;
+  private source: GestureSequence<KeyElement, string>;
+
+  constructor(
+    source: GestureSequence<KeyElement, string>,
+    vkbd: VisualKeyboard,
+    completionCallback: () => void,
+  ) {
+    const initialStage = source.stageReports[0];
+    this.originalLayer = initialStage.sources[0].stateToken;
+    this.source = source;
+
+    this.completionCallback = () => {
+      vkbd.lockLayer(false);
+      if(this.shouldRestore) {
+        vkbd.layerId = this.originalLayer;
+        vkbd.updateState();
+      }
+      completionCallback && completionCallback();
+    };
+
+    vkbd.lockLayer(true);
+
+    source.on('stage', (stage) => {
+      const stageName = stage.matchedId;
+      if(stageName.includes('modipress') && stageName.includes('-end')) {
+        this.cancel();
+      } else if(stageName.includes('modipress') && stageName.includes('-hold')) {
+        this.shouldRestore = true;
+      }
+    });
+  }
+
+  get isLocked(): boolean {
+    return this.shouldRestore;
+  }
+
+  setLocked() {
+    this.shouldRestore = true;
+  }
+
+  get completed(): boolean {
+    return this.completionCallback === undefined;
+  }
+
+  cancel() {
+    const callback = this.completionCallback;
+    this.completionCallback = null;
+    callback && callback();
+    this.source.cancel();
+  }
+
+  readonly hasModalVisualization = false;
+
+  currentStageKeyDistribution(baseDistMap: Map<ActiveKeyBase, number>): KeyDistribution {
+    return null;
+  }
+}

web/src/engine/osk/src/input/gestures/browser/multitap.ts

@@ -2,9 +2,11 @@ import { type KeyElement } from '../../../keyElement.js';
 import VisualKeyboard from '../../../visualKeyboard.js';
 
 import { DeviceSpec, KeyEvent, ActiveSubKey, ActiveKey, KeyDistribution, ActiveKeyBase } from '@keymanapp/keyboard-processor';
-import { GestureSequence } from '@keymanapp/gesture-recognizer';
+import { GestureSequence, GestureStageReport } from '@keymanapp/gesture-recognizer';
 import { GestureHandler } from '../gestureHandler.js';
 import { distributionFromDistanceMaps } from '@keymanapp/input-processor';
+import Modipress from './modipress.js';
+import { keySupportsModipress } from '../specsForLayout.js';
 
 /**
  * Represents a potential multitap gesture's implementation within KeymanWeb.
@@ -23,6 +25,7 @@ export default class Multitap implements GestureHandler {
 
   private readonly multitaps: ActiveSubKey[];
   private tapIndex = 0;
+  private modipress: Modipress;
 
   private sequence: GestureSequence<KeyElement, string>;
 
@@ -35,6 +38,7 @@ export default class Multitap implements GestureHandler {
     this.baseKey = e;
     this.baseContextToken = contextToken;
     this.multitaps = [e.key.spec].concat(e.key.spec.multitap);
+    this.sequence = source;
 
     this.originalLayer = vkbd.layerId;
 
@@ -44,12 +48,23 @@ export default class Multitap implements GestureHandler {
     source.on('complete', () => {
       if(source.stageReports.length > 1) {
       }
+      if(this.modipress) {
+        this.modipress.cancel();
+      }
       // this.currentSelection?.key.highlight(false);
       this.clear();
     });
 
-    source.on('stage', (tap) => {
+    const stageHandler = (tap: GestureStageReport<KeyElement, string>) => {
       switch(tap.matchedId) {
+        // In the case that a modifier key supports multitap, reaching this stage
+        // indicates that the multitapping is over.  Not the modipressing, though.
+        case 'modipress-hold':
+          this.clear();
+          // We'll let the co-existing modipress handler continue.
+          source.off('stage', stageHandler);
+          return;
+        case 'modipress-end-multitap-transition':
         case 'modipress-multitap-end':
         case 'modipress-end':
         case 'multitap-end':
@@ -58,8 +73,8 @@ export default class Multitap implements GestureHandler {
         // Once a multitap starts, it's better to emit keys on keydown; that way,
         // if a user holds long, they get what they see if they decide to stop,
         // but also have time to decide if they want to continue to what's next.
-        case 'multitap-start':
         case 'modipress-multitap-start':
+        case 'multitap-start':
           break;
         default:
           throw new Error(`Unsupported gesture state encountered during multitap: ${tap.matchedId}`);
@@ -74,7 +89,7 @@ export default class Multitap implements GestureHandler {
 
       const coord = tap.sources[0].currentSample;
       const baseDistances = vkbd.getSimpleTapCorrectionDistances(coord, this.baseKey.key.spec as ActiveKey);
-      if(coord.stateToken != vkbd.layerId) {
+      if(coord.stateToken != vkbd.layerId && !tap.matchedId.includes('modipress')) {
         const matchKey = vkbd.layerGroup.findNearestKey({...coord, stateToken: vkbd.layerId});
 
         // Replace the key at the current location for the current layer key
@@ -94,7 +109,17 @@ export default class Multitap implements GestureHandler {
       keyEvent.kNextLayer ||= this.originalLayer;
 
       vkbd.raiseKeyEvent(keyEvent, null);
-    });
+
+      // Now that the key has been processed, with a layer possibly changed as a result...
+      if(tap.matchedId == 'modipress-multitap-start') {
+        const modipressHandler = new Modipress(source, vkbd, () => {
+          this.modipress = vkbd.activeModipress = null;
+        });
+        this.modipress = vkbd.activeModipress = modipressHandler;
+      }
+    };
+
+    source.on('stage', stageHandler);
 
     /* In theory, setting up a specialized recognizer config limited to the base key's surface area
      * would be pretty ideal - it'd provide automatic cancellation if anywhere else were touched.
@@ -117,7 +142,10 @@ export default class Multitap implements GestureHandler {
     const keyIndex = baseDistribution.findIndex((entry) => entry.keySpec == this.baseKey.key.spec);
 
     if(keyIndex == -1) { // also covers undefined, but does not include 0.
-      console.warn("Could not find base key's probability for multitap correction");
+      // Modipress keys generally get left out of the key-correction calculations.
+      if(!keySupportsModipress(this.baseKey)) {
+        console.warn("Could not find base key's probability for multitap correction");
+      }
 
       // Decently recoverable; just use the simple-tap distances instead.
       return baseDistribution;

web/src/engine/osk/src/input/gestures/browser/subkeyPopup.ts

@@ -35,6 +35,8 @@ export default class SubkeyPopup implements GestureHandler {
   private source: GestureSequence<KeyElement>;
   private readonly gestureParams: GestureParams;
 
+  readonly shouldLockLayer: boolean = false;
+
   constructor(
     source: GestureSequence<KeyElement, string>,
     configChanger: ConfigChangeClosure<KeyElement>,
@@ -46,6 +48,10 @@ export default class SubkeyPopup implements GestureHandler {
     this.source = source;
     this.gestureParams = gestureParams;
 
+    if(vkbd.layerLocked) {
+      this.shouldLockLayer = true;
+    }
+
     source.on('complete', () => {
       this.currentSelection?.key.highlight(false);
       this.clear();