@amazon-devices/react-native-gesture-handler 4.0.0 → 4.0.2

package/src/web/tools/EventManager.ts

@@ -1,108 +0,0 @@
-/* eslint-disable @typescript-eslint/no-empty-function */
-import { AdaptedEvent, EventTypes } from '../interfaces';
-
-type PointerEventCallback = (event: AdaptedEvent) => void;
-
-export default abstract class EventManager<T> {
-  protected readonly view: T;
-  protected pointersInBounds: number[] = [];
-  protected activePointersCounter: number;
-
-  constructor(view: T) {
-    this.view = view;
-    this.activePointersCounter = 0;
-  }
-
-  public abstract registerListeners(): void;
-  public abstract unregisterListeners(): void;
-
-  protected abstract mapEvent(
-    event: Event,
-    eventType: EventTypes
-  ): AdaptedEvent;
-
-  protected onPointerDown(_event: AdaptedEvent): void {}
-  protected onPointerAdd(_event: AdaptedEvent): void {}
-  protected onPointerUp(_event: AdaptedEvent): void {}
-  protected onPointerRemove(_event: AdaptedEvent): void {}
-  protected onPointerMove(_event: AdaptedEvent): void {}
-  protected onPointerLeave(_event: AdaptedEvent): void {} // Called only when pointer is pressed (or touching)
-  protected onPointerEnter(_event: AdaptedEvent): void {} // Called only when pointer is pressed (or touching)
-  protected onPointerCancel(_event: AdaptedEvent): void {
-    // When pointer cancel is triggered and there are more pointers on the view, only one pointer is cancelled
-    // Because we want all pointers to be cancelled by that event, we are doing it manually by reseting handler and changing activePointersCounter to 0
-    // Events that correspond to removing the pointer (pointerup, touchend) have condition, that they don't perform any action when activePointersCounter
-    // is equal to 0. This prevents counter from going to negative values, when pointers are removed from view after one of them has been cancelled
-  }
-  protected onPointerOutOfBounds(_event: AdaptedEvent): void {}
-  protected onPointerMoveOver(_event: AdaptedEvent): void {}
-  protected onPointerMoveOut(_event: AdaptedEvent): void {}
-  protected onWheel(_event: AdaptedEvent): void {}
-
-  public setOnPointerDown(callback: PointerEventCallback): void {
-    this.onPointerDown = callback;
-  }
-  public setOnPointerAdd(callback: PointerEventCallback): void {
-    this.onPointerAdd = callback;
-  }
-  public setOnPointerUp(callback: PointerEventCallback): void {
-    this.onPointerUp = callback;
-  }
-  public setOnPointerRemove(callback: PointerEventCallback): void {
-    this.onPointerRemove = callback;
-  }
-  public setOnPointerMove(callback: PointerEventCallback): void {
-    this.onPointerMove = callback;
-  }
-  public setOnPointerLeave(callback: PointerEventCallback): void {
-    this.onPointerLeave = callback;
-  }
-  public setOnPointerEnter(callback: PointerEventCallback): void {
-    this.onPointerEnter = callback;
-  }
-  public setOnPointerCancel(callback: PointerEventCallback): void {
-    this.onPointerCancel = callback;
-  }
-  public setOnPointerOutOfBounds(callback: PointerEventCallback): void {
-    this.onPointerOutOfBounds = callback;
-  }
-  public setOnPointerMoveOver(callback: PointerEventCallback): void {
-    this.onPointerMoveOver = callback;
-  }
-  public setOnPointerMoveOut(callback: PointerEventCallback): void {
-    this.onPointerMoveOut = callback;
-  }
-  public setOnWheel(callback: PointerEventCallback): void {
-    this.onWheel = callback;
-  }
-
-  protected markAsInBounds(pointerId: number): void {
-    if (this.pointersInBounds.indexOf(pointerId) >= 0) {
-      return;
-    }
-
-    this.pointersInBounds.push(pointerId);
-  }
-
-  protected markAsOutOfBounds(pointerId: number): void {
-    const index: number = this.pointersInBounds.indexOf(pointerId);
-
-    if (index < 0) {
-      return;
-    }
-
-    this.pointersInBounds.splice(index, 1);
-  }
-
-  public resetManager(): void {
-    // Reseting activePointersCounter is necessary to make gestures such as pinch work properly
-    // There are gestures that end when there is still one active pointer (like pinch/rotation)
-    // When these gestures end, they are reset, but they still receive events from pointer that is active
-    // This causes trouble, since only onPointerDown registers gesture in orchestrator, and while gestures receive
-    // Events from active pointer after they finished, next pointerdown event will be registered as additional pointer, not the first one
-    // This casues trouble like gestures getting stuck in END state, even though they should have gone to UNDETERMINED
-
-    this.activePointersCounter = 0;
-    this.pointersInBounds = [];
-  }
-}

package/src/web/tools/GestureHandlerDelegate.ts

@@ -1,26 +0,0 @@
-import { Config } from '../interfaces';
-
-export interface MeasureResult {
-  pageX: number;
-  pageY: number;
-  width: number;
-  height: number;
-}
-
-export interface GestureHandlerDelegate<TComponent, THandler> {
-  view: TComponent;
-
-  init(viewRef: number, handler: THandler): void;
-  isPointerInBounds({ x, y }: { x: number; y: number }): boolean;
-  measureView(): MeasureResult;
-  reset(): void;
-
-  onBegin(): void;
-  onActivate(): void;
-  onEnd(): void;
-  onCancel(): void;
-  onFail(): void;
-  onEnabledChange(enabled: boolean): void;
-
-  destroy(config: Config): void;
-}

package/src/web/tools/GestureHandlerOrchestrator.ts

@@ -1,392 +0,0 @@
-import { PointerType } from '../../PointerType';
-import { State } from '../../State';
-
-import type IGestureHandler from '../handlers/IGestureHandler';
-import PointerTracker from './PointerTracker';
-
-export default class GestureHandlerOrchestrator {
-  private static _instance: GestureHandlerOrchestrator;
-
-  private gestureHandlers: IGestureHandler[] = [];
-  private awaitingHandlers: IGestureHandler[] = [];
-  private awaitingHandlersTags: Set<number> = new Set();
-
-  private handlingChangeSemaphore = 0;
-  private activationIndex = 0;
-
-  // Private beacuse of Singleton
-  // eslint-disable-next-line no-useless-constructor, @typescript-eslint/no-empty-function
-  private constructor() {}
-
-  private scheduleFinishedHandlersCleanup(): void {
-    if (this.handlingChangeSemaphore === 0) {
-      this.cleanupFinishedHandlers();
-    }
-  }
-
-  private cleanHandler(handler: IGestureHandler): void {
-    handler.reset();
-    handler.active = false;
-    handler.awaiting = false;
-    handler.activationIndex = Number.MAX_VALUE;
-  }
-
-  public removeHandlerFromOrchestrator(handler: IGestureHandler): void {
-    const indexInGestureHandlers = this.gestureHandlers.indexOf(handler);
-    const indexInAwaitingHandlers = this.awaitingHandlers.indexOf(handler);
-
-    if (indexInGestureHandlers >= 0) {
-      this.gestureHandlers.splice(indexInGestureHandlers, 1);
-    }
-
-    if (indexInAwaitingHandlers >= 0) {
-      this.awaitingHandlers.splice(indexInAwaitingHandlers, 1);
-      this.awaitingHandlersTags.delete(handler.handlerTag);
-    }
-  }
-
-  private cleanupFinishedHandlers(): void {
-    const handlersToRemove = new Set<IGestureHandler>();
-
-    for (let i = this.gestureHandlers.length - 1; i >= 0; --i) {
-      const handler = this.gestureHandlers[i];
-
-      if (this.isFinished(handler.state) && !handler.awaiting) {
-        this.cleanHandler(handler);
-        handlersToRemove.add(handler);
-      }
-    }
-
-    this.gestureHandlers = this.gestureHandlers.filter(
-      (handler) => !handlersToRemove.has(handler)
-    );
-  }
-
-  private hasOtherHandlerToWaitFor(handler: IGestureHandler): boolean {
-    const hasToWaitFor = (otherHandler: IGestureHandler) => {
-      return (
-        !this.isFinished(otherHandler.state) &&
-        this.shouldHandlerWaitForOther(handler, otherHandler)
-      );
-    };
-
-    return this.gestureHandlers.some(hasToWaitFor);
-  }
-
-  private shouldBeCancelledByFinishedHandler(
-    handler: IGestureHandler
-  ): boolean {
-    const shouldBeCancelled = (otherHandler: IGestureHandler) => {
-      return (
-        this.shouldHandlerWaitForOther(handler, otherHandler) &&
-        otherHandler.state === State.END
-      );
-    };
-
-    return this.gestureHandlers.some(shouldBeCancelled);
-  }
-
-  private tryActivate(handler: IGestureHandler): void {
-    if (this.shouldBeCancelledByFinishedHandler(handler)) {
-      handler.cancel();
-      return;
-    }
-
-    if (this.hasOtherHandlerToWaitFor(handler)) {
-      this.addAwaitingHandler(handler);
-      return;
-    }
-
-    const handlerState = handler.state;
-
-    if (handlerState === State.CANCELLED || handlerState === State.FAILED) {
-      return;
-    }
-
-    if (this.shouldActivate(handler)) {
-      this.makeActive(handler);
-      return;
-    }
-
-    if (handlerState === State.ACTIVE) {
-      handler.fail();
-      return;
-    }
-
-    if (handlerState === State.BEGAN) {
-      handler.cancel();
-    }
-  }
-
-  private shouldActivate(handler: IGestureHandler): boolean {
-    const shouldBeCancelledBy = (otherHandler: IGestureHandler) => {
-      return this.shouldHandlerBeCancelledBy(handler, otherHandler);
-    };
-
-    return !this.gestureHandlers.some(shouldBeCancelledBy);
-  }
-
-  private cleanupAwaitingHandlers(handler: IGestureHandler): void {
-    const shouldWait = (otherHandler: IGestureHandler) => {
-      return (
-        !otherHandler.awaiting &&
-        this.shouldHandlerWaitForOther(otherHandler, handler)
-      );
-    };
-
-    for (const otherHandler of this.awaitingHandlers) {
-      if (shouldWait(otherHandler)) {
-        this.cleanHandler(otherHandler);
-        this.awaitingHandlersTags.delete(otherHandler.handlerTag);
-      }
-    }
-
-    this.awaitingHandlers = this.awaitingHandlers.filter((otherHandler) =>
-      this.awaitingHandlersTags.has(otherHandler.handlerTag)
-    );
-  }
-
-  public onHandlerStateChange(
-    handler: IGestureHandler,
-    newState: State,
-    oldState: State,
-    sendIfDisabled?: boolean
-  ): void {
-    if (!handler.enabled && !sendIfDisabled) {
-      return;
-    }
-
-    this.handlingChangeSemaphore += 1;
-
-    if (this.isFinished(newState)) {
-      for (const otherHandler of this.awaitingHandlers) {
-        if (
-          !this.shouldHandlerWaitForOther(otherHandler, handler) ||
-          !this.awaitingHandlersTags.has(otherHandler.handlerTag)
-        ) {
-          continue;
-        }
-
-        if (newState !== State.END) {
-          this.tryActivate(otherHandler);
-          continue;
-        }
-
-        otherHandler.cancel();
-
-        if (otherHandler.state === State.END) {
-          // Handle edge case, where discrete gestures end immediately after activation thus
-          // their state is set to END and when the gesture they are waiting for activates they
-          // should be cancelled, however `cancel` was never sent as gestures were already in the END state.
-          // Send synthetic BEGAN -> CANCELLED to properly handle JS logic
-          otherHandler.sendEvent(State.CANCELLED, State.BEGAN);
-        }
-
-        otherHandler.awaiting = false;
-      }
-    }
-
-    if (newState === State.ACTIVE) {
-      this.tryActivate(handler);
-    } else if (oldState === State.ACTIVE || oldState === State.END) {
-      if (handler.active) {
-        handler.sendEvent(newState, oldState);
-      } else if (
-        oldState === State.ACTIVE &&
-        (newState === State.CANCELLED || newState === State.FAILED)
-      ) {
-        handler.sendEvent(newState, State.BEGAN);
-      }
-    } else if (
-      oldState !== State.UNDETERMINED ||
-      newState !== State.CANCELLED
-    ) {
-      handler.sendEvent(newState, oldState);
-    }
-
-    this.handlingChangeSemaphore -= 1;
-
-    this.scheduleFinishedHandlersCleanup();
-
-    if (!this.awaitingHandlers.includes(handler)) {
-      this.cleanupAwaitingHandlers(handler);
-    }
-  }
-
-  private makeActive(handler: IGestureHandler): void {
-    const currentState = handler.state;
-
-    handler.active = true;
-    handler.shouldResetProgress = true;
-    handler.activationIndex = this.activationIndex++;
-
-    for (let i = this.gestureHandlers.length - 1; i >= 0; --i) {
-      if (this.shouldHandlerBeCancelledBy(this.gestureHandlers[i], handler)) {
-        this.gestureHandlers[i].cancel();
-      }
-    }
-
-    for (const otherHandler of this.awaitingHandlers) {
-      if (this.shouldHandlerBeCancelledBy(otherHandler, handler)) {
-        otherHandler.awaiting = false;
-      }
-    }
-
-    handler.sendEvent(State.ACTIVE, State.BEGAN);
-
-    if (currentState !== State.ACTIVE) {
-      handler.sendEvent(State.END, State.ACTIVE);
-      if (currentState !== State.END) {
-        handler.sendEvent(State.UNDETERMINED, State.END);
-      }
-    }
-
-    if (!handler.awaiting) {
-      return;
-    }
-
-    handler.awaiting = false;
-
-    this.awaitingHandlers = this.awaitingHandlers.filter(
-      (otherHandler) => otherHandler !== handler
-    );
-  }
-
-  private addAwaitingHandler(handler: IGestureHandler): void {
-    if (this.awaitingHandlers.includes(handler)) {
-      return;
-    }
-
-    this.awaitingHandlers.push(handler);
-    this.awaitingHandlersTags.add(handler.handlerTag);
-
-    handler.awaiting = true;
-    handler.activationIndex = this.activationIndex++;
-  }
-
-  public recordHandlerIfNotPresent(handler: IGestureHandler): void {
-    if (this.gestureHandlers.includes(handler)) {
-      return;
-    }
-
-    this.gestureHandlers.push(handler);
-
-    handler.active = false;
-    handler.awaiting = false;
-    handler.activationIndex = Number.MAX_SAFE_INTEGER;
-  }
-
-  private shouldHandlerWaitForOther(
-    handler: IGestureHandler,
-    otherHandler: IGestureHandler
-  ): boolean {
-    return (
-      handler !== otherHandler &&
-      (handler.shouldWaitForHandlerFailure(otherHandler) ||
-        otherHandler.shouldRequireToWaitForFailure(handler))
-    );
-  }
-
-  private canRunSimultaneously(
-    gh1: IGestureHandler,
-    gh2: IGestureHandler
-  ): boolean {
-    return (
-      gh1 === gh2 ||
-      gh1.shouldRecognizeSimultaneously(gh2) ||
-      gh2.shouldRecognizeSimultaneously(gh1)
-    );
-  }
-
-  private shouldHandlerBeCancelledBy(
-    handler: IGestureHandler,
-    otherHandler: IGestureHandler
-  ): boolean {
-    if (this.canRunSimultaneously(handler, otherHandler)) {
-      return false;
-    }
-
-    if (handler.awaiting || handler.state === State.ACTIVE) {
-      return handler.shouldBeCancelledByOther(otherHandler);
-    }
-
-    const handlerPointers: number[] = handler.getTrackedPointersID();
-    const otherPointers: number[] = otherHandler.getTrackedPointersID();
-
-    if (
-      !PointerTracker.shareCommonPointers(handlerPointers, otherPointers) &&
-      handler.delegate.view !== otherHandler.delegate.view
-    ) {
-      return this.checkOverlap(handler, otherHandler);
-    }
-
-    return true;
-  }
-
-  private checkOverlap(
-    handler: IGestureHandler,
-    otherHandler: IGestureHandler
-  ): boolean {
-    // If handlers don't have common pointers, default return value is false.
-    // However, if at least on pointer overlaps with both handlers, we return true
-    // This solves issue in overlapping parents example
-
-    // TODO: Find better way to handle that issue, for example by activation order and handler cancelling
-
-    const isPointerWithinBothBounds = (pointer: number) => {
-      const point = handler.tracker.getLastAbsoluteCoords(pointer);
-
-      return (
-        point &&
-        handler.delegate.isPointerInBounds(point) &&
-        otherHandler.delegate.isPointerInBounds(point)
-      );
-    };
-
-    return handler.getTrackedPointersID().some(isPointerWithinBothBounds);
-  }
-
-  private isFinished(state: State): boolean {
-    return (
-      state === State.END || state === State.FAILED || state === State.CANCELLED
-    );
-  }
-
-  // This function is called when handler receives touchdown event
-  // If handler is using mouse or pen as a pointer and any handler receives touch event,
-  // mouse/pen event dissappears - it doesn't send onPointerCancel nor onPointerUp (and others)
-  // This became a problem because handler was left at active state without any signal to end or fail
-  // To handle this, when new touch event is received, we loop through active handlers and check which type of
-  // pointer they're using. If there are any handler with mouse/pen as a pointer, we cancel them
-  public cancelMouseAndPenGestures(currentHandler: IGestureHandler): void {
-    this.gestureHandlers.forEach((handler: IGestureHandler) => {
-      if (
-        handler.pointerType !== PointerType.MOUSE &&
-        handler.pointerType !== PointerType.STYLUS
-      ) {
-        return;
-      }
-
-      if (handler !== currentHandler) {
-        handler.cancel();
-      } else {
-        // Handler that received touch event should have its pointer tracker reset
-        // This allows handler to smoothly change from mouse/pen to touch
-        // The drawback is, that when we try to use mouse/pen one more time, it doesn't send onPointerDown at the first time
-        // so it is required to click two times to get handler to work
-        //
-        // However, handler will receive manually created onPointerEnter that is triggered in EventManager in onPointerMove method.
-        // There may be possibility to use that fact to make handler respond properly to first mouse click
-        handler.tracker.resetTracker();
-      }
-    });
-  }
-
-  public static get instance(): GestureHandlerOrchestrator {
-    if (!GestureHandlerOrchestrator._instance) {
-      GestureHandlerOrchestrator._instance = new GestureHandlerOrchestrator();
-    }
-
-    return GestureHandlerOrchestrator._instance;
-  }
-}