react-native-gesture-handler 1.10.3 → 2.1.2

package/ios/Handlers/RNTapHandler.m

@@ -38,15 +38,20 @@
   NSInteger _maxNumberOfTouches;
 }
 
+static const NSUInteger defaultNumberOfTaps = 1;
+static const NSInteger defaultMinPointers = 1;
+static const CGFloat defaultMaxDelay = 0.2;
+static const NSTimeInterval defaultMaxDuration = 0.5;
+
 - (id)initWithGestureHandler:(RNGestureHandler*)gestureHandler
 {
   if ((self = [super initWithTarget:gestureHandler action:@selector(handleGesture:)])) {
     _gestureHandler = gestureHandler;
     _tapsSoFar = 0;
-    _numberOfTaps = 1;
-    _minPointers = 1;
-    _maxDelay = 0.2;
-    _maxDuration = NAN;
+    _numberOfTaps = defaultNumberOfTaps;
+    _minPointers = defaultMinPointers;
+    _maxDelay = defaultMaxDelay;
+    _maxDuration = defaultMaxDuration;
     _maxDeltaX = NAN;
     _maxDeltaY = NAN;
     _maxDistSq = NAN;
@@ -67,8 +72,14 @@
 - (void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event
 {
   [super touchesBegan:touches withEvent:event];
+  [_gestureHandler.pointerTracker touchesBegan:touches withEvent:event];
+  
   if (_tapsSoFar == 0) {
-    _initPosition = [self locationInView:self.view];
+    // this recognizer sends UNDETERMINED -> BEGAN state change event before gestureRecognizerShouldBegin
+    // is called (it resets the gesture handler), making it send whatever the last known state as oldState
+    // in the event. If we reset it here it correctly sends UNDETERMINED as oldState.
+    [_gestureHandler reset];
+    _initPosition = [self locationInView:self.view.window];
   }
   _tapsSoFar++;
   if (_tapsSoFar) {
@@ -88,6 +99,8 @@
 - (void)touchesMoved:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event
 {
   [super touchesMoved:touches withEvent:event];
+  [_gestureHandler.pointerTracker touchesMoved:touches withEvent:event];
+  
   NSInteger numberOfTouches = [touches count];
   if (numberOfTouches > _maxNumberOfTouches) {
     _maxNumberOfTouches = numberOfTouches;
@@ -109,7 +122,7 @@
 }
 
 - (CGPoint)translationInView {
-  CGPoint currentPosition = [self locationInView:self.view];
+  CGPoint currentPosition = [self locationInView:self.view.window];
   return CGPointMake(currentPosition.x - _initPosition.x, currentPosition.y - _initPosition.y);
 }
 
@@ -128,7 +141,7 @@
   if (TEST_MAX_IF_NOT_NAN(fabs(trans.y), _maxDeltaY)) {
     return YES;
   }
-  if (TEST_MAX_IF_NOT_NAN(fabs(trans.y * trans.y + trans.x + trans.x), _maxDistSq)) {
+  if (TEST_MAX_IF_NOT_NAN(fabs(trans.y * trans.y + trans.x * trans.x), _maxDistSq)) {
     return YES;
   }
   return NO;
@@ -137,6 +150,8 @@
 - (void)touchesEnded:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event
 {
   [super touchesEnded:touches withEvent:event];
+  [_gestureHandler.pointerTracker touchesEnded:touches withEvent:event];
+  
   if (_numberOfTaps == _tapsSoFar && _maxNumberOfTouches >= _minPointers) {
     self.state = UIGestureRecognizerStateEnded;
     [self reset];
@@ -148,6 +163,8 @@
 - (void)touchesCancelled:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event
 {
   [super touchesCancelled:touches withEvent:event];
+  [_gestureHandler.pointerTracker touchesCancelled:touches withEvent:event];
+  
   self.state = UIGestureRecognizerStateCancelled;
   [self reset];
 }
@@ -157,6 +174,8 @@
   if (self.state == UIGestureRecognizerStateFailed) {
     [self triggerAction];
   }
+  [_gestureHandler.pointerTracker reset];
+
   [NSObject cancelPreviousPerformRequestsWithTarget:self selector:@selector(cancel) object:nil];
   _tapsSoFar = 0;
   _maxNumberOfTouches = 0;
@@ -178,6 +197,20 @@
   return self;
 }
 
+- (void)resetConfig
+{
+  [super resetConfig];
+  RNBetterTapGestureRecognizer *recognizer = (RNBetterTapGestureRecognizer *)_recognizer;
+  
+  recognizer.numberOfTaps = defaultNumberOfTaps;
+  recognizer.minPointers = defaultMinPointers;
+  recognizer.maxDeltaX = NAN;
+  recognizer.maxDeltaY = NAN;
+  recognizer.maxDelay = defaultMaxDelay;
+  recognizer.maxDuration = defaultMaxDuration;
+  recognizer.maxDistSq = NAN;
+}
+
 - (void)configure:(NSDictionary *)config
 {
   [super configure:config];
@@ -205,7 +238,8 @@
   }
 }
 
-- (RNGestureHandlerEventExtraData *)eventExtraData:(UIGestureRecognizer *)recognizer{
+- (RNGestureHandlerEventExtraData *)eventExtraData:(UIGestureRecognizer *)recognizer
+{
     if (recognizer.state == UIGestureRecognizerStateEnded) {
         return _lastData;
     }
@@ -214,5 +248,18 @@
     return _lastData;
 }
 
+- (BOOL)gestureRecognizerShouldBegin:(UIGestureRecognizer *)gestureRecognizer
+{
+  // UNDETERMINED -> BEGAN state change event is sent before this method is called,
+  // in RNGestureHandler it resets _lastSatate variable, making is seem like handler
+  // went from UNDETERMINED to BEGAN and then from UNDETERMINED to ACTIVE.
+  // This way we preserve _lastState between events and keep correct state flow.
+  RNGestureHandlerState savedState = _lastState;
+  BOOL shouldBegin = [super gestureRecognizerShouldBegin:gestureRecognizer];
+  _lastState = savedState;
+  
+  return shouldBegin;
+}
+
 @end
 

package/ios/RNGestureHandler.h

@@ -1,6 +1,7 @@
 #import "RNGestureHandlerState.h"
 #import "RNGestureHandlerDirection.h"
 #import "RNGestureHandlerEvents.h"
+#import "RNGestureHandlerPointerTracker.h"
 
 #import <Foundation/Foundation.h>
 #import <UIKit/UIKit.h>
@@ -15,7 +16,7 @@
 
 #define APPLY_PROP(recognizer, config, type, prop, propName) do { \
 id value = config[propName]; \
-if (value != nil) recognizer.prop = [RCTConvert type:value]; \
+if (value != nil) { recognizer.prop = [RCTConvert type:value]; }\
 } while(0)
 
 #define APPLY_FLOAT_PROP(prop) do { APPLY_PROP(recognizer, config, CGFloat, prop, @#prop); } while(0)
@@ -28,13 +29,17 @@ if (value != nil) recognizer.prop = [RCTConvert type:value]; \
 
 - (void)sendStateChangeEvent:(nonnull RNGestureHandlerStateChange *)event;
 
+- (void)sendTouchDeviceEvent:(nonnull RNGestureHandlerEvent *)event;
+
+- (void)sendStateChangeDeviceEvent:(nonnull RNGestureHandlerStateChange *)event;
+
 @end
 
 
 @protocol RNRootViewGestureRecognizerDelegate <UIGestureRecognizerDelegate>
 
 - (void)gestureRecognizer:(nullable UIGestureRecognizer *)gestureRecognizer
-    didActivateInRootView:(nullable UIView *)rootView;
+    didActivateInViewWithTouchHandler:(nullable UIView *)viewWithTouchHandler;
 
 @end
 
@@ -53,21 +58,30 @@ if (value != nil) recognizer.prop = [RCTConvert type:value]; \
 @property (nonatomic, readonly, nonnull) NSNumber *tag;
 @property (nonatomic, weak, nullable) id<RNGestureHandlerEventEmitter> emitter;
 @property (nonatomic, readonly, nullable) UIGestureRecognizer *recognizer;
+@property (nonatomic, readonly, nullable) RNGestureHandlerPointerTracker *pointerTracker;
 @property (nonatomic) BOOL enabled;
-@property(nonatomic) BOOL shouldCancelWhenOutside;
+@property (nonatomic) BOOL usesDeviceEvents;
+@property (nonatomic) BOOL shouldCancelWhenOutside;
+@property (nonatomic) BOOL needsPointerData;
+@property (nonatomic) BOOL manualActivation;
 
 - (void)bindToView:(nonnull UIView *)view;
 - (void)unbindFromView;
+- (void)resetConfig NS_REQUIRES_SUPER;
 - (void)configure:(nullable NSDictionary *)config NS_REQUIRES_SUPER;
 - (void)handleGesture:(nonnull id)recognizer;
 - (BOOL)containsPointInView;
 - (RNGestureHandlerState)state;
 - (nullable RNGestureHandlerEventExtraData *)eventExtraData:(nonnull id)recognizer;
 
+- (void)stopActivationBlocker;
 - (void)reset;
 - (void)sendEventsInState:(RNGestureHandlerState)state
            forViewWithTag:(nonnull NSNumber *)reactTag
-            withExtraData:(RNGestureHandlerEventExtraData *)extraData;
+            withExtraData:(nonnull RNGestureHandlerEventExtraData *)extraData;
+- (void)sendStateChangeEvent:(nonnull RNGestureHandlerStateChange *)event;
+- (void)sendTouchEventInState:(RNGestureHandlerState)state
+                 forViewWithTag:(nonnull NSNumber *)reactTag;
 
 @end
 

package/ios/RNGestureHandler.m

@@ -1,4 +1,5 @@
 #import "RNGestureHandler.h"
+#import "RNManualActivationRecognizer.h"
 
 #import "Handlers/RNNativeViewHandler.h"
 
@@ -61,6 +62,9 @@ CGRect RNGHHitSlopInsetRect(CGRect rect, RNGHHitSlop hitSlop) {
 static NSHashTable<RNGestureHandler *> *allGestureHandlers;
 
 @implementation RNGestureHandler {
+    RNGestureHandlerPointerTracker *_pointerTracker;
+    RNGestureHandlerState _state;
+    RNManualActivationRecognizer *_manualActivationRecognizer;
     NSArray<NSNumber *> *_handlersToWaitFor;
     NSArray<NSNumber *> *_simultaneousHandlers;
     RNGHHitSlop _hitSlop;
@@ -70,9 +74,12 @@ static NSHashTable<RNGestureHandler *> *allGestureHandlers;
 - (instancetype)initWithTag:(NSNumber *)tag
 {
     if ((self = [super init])) {
+        _pointerTracker = [[RNGestureHandlerPointerTracker alloc] initWithGestureHandler:self];
         _tag = tag;
         _lastState = RNGestureHandlerStateUndetermined;
         _hitSlop = RNGHHitSlopEmpty;
+        _state = RNGestureHandlerStateBegan;
+        _manualActivationRecognizer = nil;
 
         static dispatch_once_t onceToken;
         dispatch_once(&onceToken, ^{
@@ -84,23 +91,42 @@ static NSHashTable<RNGestureHandler *> *allGestureHandlers;
     return self;
 }
 
+- (void)resetConfig
+{
+  self.enabled = YES;
+  _shouldCancelWhenOutside = NO;
+  _handlersToWaitFor = nil;
+  _simultaneousHandlers = nil;
+  _hitSlop = RNGHHitSlopEmpty;
+  _needsPointerData = NO;
+  
+  self.manualActivation = NO;
+}
+
 - (void)configure:(NSDictionary *)config
 {
+  [self resetConfig];
     _handlersToWaitFor = [RCTConvert NSNumberArray:config[@"waitFor"]];
     _simultaneousHandlers = [RCTConvert NSNumberArray:config[@"simultaneousHandlers"]];
 
     id prop = config[@"enabled"];
     if (prop != nil) {
         self.enabled = [RCTConvert BOOL:prop];
-    } else {
-        self.enabled = YES;
     }
 
     prop = config[@"shouldCancelWhenOutside"];
     if (prop != nil) {
         _shouldCancelWhenOutside = [RCTConvert BOOL:prop];
-    } else {
-        _shouldCancelWhenOutside = NO;
+    }
+  
+    prop = config[@"needsPointerData"];
+    if (prop != nil) {
+        _needsPointerData = [RCTConvert BOOL:prop];
+    }
+    
+    prop = config[@"manualActivation"];
+    if (prop != nil) {
+        self.manualActivation = [RCTConvert BOOL:prop];
     }
 
     prop = config[@"hitSlop"];
@@ -141,12 +167,16 @@ static NSHashTable<RNGestureHandler *> *allGestureHandlers;
     view.userInteractionEnabled = YES;
     self.recognizer.delegate = self;
     [view addGestureRecognizer:self.recognizer];
+  
+  [self bindManualActivationToView:view];
 }
 
 - (void)unbindFromView
 {
     [self.recognizer.view removeGestureRecognizer:self.recognizer];
     self.recognizer.delegate = nil;
+  
+    [self unbindManualActivation];
 }
 
 - (RNGestureHandlerEventExtraData *)eventExtraData:(UIGestureRecognizer *)recognizer
@@ -159,6 +189,7 @@ static NSHashTable<RNGestureHandler *> *allGestureHandlers;
 
 - (void)handleGesture:(UIGestureRecognizer *)recognizer
 {
+    _state = [self recognizerState];
     RNGestureHandlerEventExtraData *eventData = [self eventExtraData:recognizer];
     [self sendEventsInState:self.state forViewWithTag:recognizer.view.reactTag withExtraData:eventData];
 }
@@ -176,11 +207,12 @@ static NSHashTable<RNGestureHandler *> *allGestureHandlers;
             self->_eventCoalescingKey = nextEventCoalescingKey++;
 
         } else if (state == RNGestureHandlerStateEnd && _lastState != RNGestureHandlerStateActive) {
-            [self.emitter sendStateChangeEvent:[[RNGestureHandlerStateChange alloc] initWithReactTag:reactTag
-                                                                                          handlerTag:_tag
-                                                                                               state:RNGestureHandlerStateActive
-                                                                                           prevState:_lastState
-                                                                                           extraData:extraData]];
+            id event = [[RNGestureHandlerStateChange alloc] initWithReactTag:reactTag
+                                                                  handlerTag:_tag
+                                                                       state:RNGestureHandlerStateActive
+                                                                   prevState:_lastState
+                                                                   extraData:extraData];
+            [self sendStateChangeEvent:event];
             _lastState = RNGestureHandlerStateActive;
         }
         id stateEvent = [[RNGestureHandlerStateChange alloc] initWithReactTag:reactTag
@@ -188,7 +220,7 @@ static NSHashTable<RNGestureHandler *> *allGestureHandlers;
                                                                         state:state
                                                                     prevState:_lastState
                                                                     extraData:extraData];
-        [self.emitter sendStateChangeEvent:stateEvent];
+        [self sendStateChangeEvent:stateEvent];
         _lastState = state;
     }
 
@@ -198,11 +230,36 @@ static NSHashTable<RNGestureHandler *> *allGestureHandlers;
                                                                   state:state
                                                               extraData:extraData
                                                           coalescingKey:self->_eventCoalescingKey];
-        [self.emitter sendTouchEvent:touchEvent];
+        [self sendStateChangeEvent:touchEvent];
     }
 }
 
-- (RNGestureHandlerState)state
+- (void)sendStateChangeEvent:(RNGestureHandlerStateChange *)event
+{
+    if (self.usesDeviceEvents) {
+        [self.emitter sendStateChangeDeviceEvent:event];
+    } else {
+        [self.emitter sendStateChangeEvent:event];
+    }
+}
+
+- (void)sendTouchEventInState:(RNGestureHandlerState)state
+                 forViewWithTag:(NSNumber *)reactTag
+{
+  id extraData = [RNGestureHandlerEventExtraData forEventType:_pointerTracker.eventType
+                                          withChangedPointers:_pointerTracker.changedPointersData
+                                              withAllPointers:_pointerTracker.allPointersData
+                                          withNumberOfTouches:_pointerTracker.trackedPointersCount];
+  id event = [[RNGestureHandlerEvent alloc] initWithReactTag:reactTag handlerTag:_tag state:state extraData:extraData coalescingKey:[_tag intValue]];
+  
+  if (self.usesDeviceEvents) {
+      [self.emitter sendStateChangeDeviceEvent:event];
+  } else {
+      [self.emitter sendStateChangeEvent:event];
+  }
+}
+
+- (RNGestureHandlerState)recognizerState
 {
     switch (_recognizer.state) {
         case UIGestureRecognizerStateBegan:
@@ -220,6 +277,52 @@ static NSHashTable<RNGestureHandler *> *allGestureHandlers;
     return RNGestureHandlerStateUndetermined;
 }
 
+- (RNGestureHandlerState)state
+{
+    // instead of mapping state of the recognizer directly, use value mapped when handleGesture was
+    // called, making it correct while awaiting for another handler failure
+    return _state;
+}
+
+#pragma mark Manual activation
+
+- (void)stopActivationBlocker
+{
+  if (_manualActivationRecognizer != nil) {
+    [_manualActivationRecognizer fail];
+  }
+}
+
+- (void)setManualActivation:(BOOL)manualActivation
+{
+  _manualActivation = manualActivation;
+  
+  if (manualActivation) {
+    _manualActivationRecognizer = [[RNManualActivationRecognizer alloc] initWithGestureHandler:self];
+
+    if (_recognizer.view != nil) {
+      [_recognizer.view addGestureRecognizer:_manualActivationRecognizer];
+    }
+  } else if (_manualActivationRecognizer != nil) {
+    [_manualActivationRecognizer.view removeGestureRecognizer:_manualActivationRecognizer];
+    _manualActivationRecognizer = nil;
+  }
+}
+
+- (void)bindManualActivationToView:(UIView *)view
+{
+  if (_manualActivationRecognizer != nil) {
+    [view addGestureRecognizer:_manualActivationRecognizer];
+  }
+}
+
+- (void)unbindManualActivation
+{
+  if (_manualActivationRecognizer != nil) {
+    [_manualActivationRecognizer.view removeGestureRecognizer:_manualActivationRecognizer];
+  }
+}
+
 #pragma mark UIGestureRecognizerDelegate
 
 + (RNGestureHandler *)findGestureHandlerByRecognizer:(UIGestureRecognizer *)recognizer
@@ -297,7 +400,14 @@ shouldRecognizeSimultaneouslyWithGestureRecognizer:(UIGestureRecognizer *)otherG
 
 - (void)reset
 {
-    _lastState = RNGestureHandlerStateUndetermined;
+    // do not reset states while gesture is tracking pointers, as gestureRecognizerShouldBegin
+    // might be called after some pointers are down, and after state manipulation by the user.
+    // Pointer tracker calls this method when it resets, and in that case it no longer tracks
+    // any pointers, thus entering this if
+    if (!_needsPointerData || _pointerTracker.trackedPointersCount == 0) {
+        _lastState = RNGestureHandlerStateUndetermined;
+        _state = RNGestureHandlerStateBegan;
+    }
 }
 
  - (BOOL)containsPointInView

package/ios/RNGestureHandlerEvents.h

@@ -4,6 +4,7 @@
 #import <UIKit/UIKit.h>
 
 #import "RNGestureHandlerState.h"
+#import "RNTouchEventType.h"
 
 @interface RNGestureHandlerEventExtraData : NSObject
 
@@ -14,6 +15,10 @@
 + (RNGestureHandlerEventExtraData *)forPosition:(CGPoint)position
                            withAbsolutePosition:(CGPoint)absolutePosition
                             withNumberOfTouches:(NSUInteger)numberOfTouches;
++ (RNGestureHandlerEventExtraData *)forPosition:(CGPoint)position
+                           withAbsolutePosition:(CGPoint)absolutePosition
+                            withNumberOfTouches:(NSUInteger)numberOfTouches
+                                   withDuration:(NSUInteger)duration;
 + (RNGestureHandlerEventExtraData *)forPan:(CGPoint)position
                       withAbsolutePosition:(CGPoint)absolutePosition
                            withTranslation:(CGPoint)translation
@@ -31,6 +36,10 @@
                                 withAnchorPoint:(CGPoint)anchorPoint
                                    withVelocity:(CGFloat)velocity
                             withNumberOfTouches:(NSUInteger)numberOfTouches;
++ (RNGestureHandlerEventExtraData *)forEventType:(RNTouchEventType)eventType
+                             withChangedPointers:(NSArray<NSDictionary *> *)changedPointers
+                                 withAllPointers:(NSArray<NSDictionary *> *)allPointers
+                             withNumberOfTouches:(NSUInteger)numberOfTouches;
 + (RNGestureHandlerEventExtraData *)forPointerInside:(BOOL)pointerInside;
 @end
 

package/ios/RNGestureHandlerEvents.m

@@ -25,6 +25,22 @@
                            @"numberOfPointers": @(numberOfTouches)}];
 }
 
++ (RNGestureHandlerEventExtraData *)forPosition:(CGPoint)position
+                           withAbsolutePosition:(CGPoint)absolutePosition
+                            withNumberOfTouches:(NSUInteger)numberOfTouches
+                                   withDuration:(NSUInteger)duration
+{
+    return [[RNGestureHandlerEventExtraData alloc]
+            initWithData:@{
+                           @"x": @(position.x),
+                           @"y": @(position.y),
+                           @"absoluteX": @(absolutePosition.x),
+                           @"absoluteY": @(absolutePosition.y),
+                           @"numberOfPointers": @(numberOfTouches),
+                           @"duration":@(duration)
+            }];
+}
+
 + (RNGestureHandlerEventExtraData *)forPan:(CGPoint)position
                       withAbsolutePosition:(CGPoint)absolutePosition
                            withTranslation:(CGPoint)translation
@@ -87,6 +103,24 @@
                            @"numberOfPointers": @(numberOfTouches)}];
 }
 
++ (RNGestureHandlerEventExtraData *)forEventType:(RNTouchEventType)eventType
+                             withChangedPointers:(NSArray<NSDictionary *> *)changedPointers
+                                 withAllPointers:(NSArray<NSDictionary *> *)allPointers
+                             withNumberOfTouches:(NSUInteger)numberOfTouches
+{
+    if (changedPointers == nil || allPointers == nil) {
+        changedPointers = @[];
+        allPointers = @[];
+        eventType = RNTouchEventTypeUndetermined;
+    }
+  
+    return [[RNGestureHandlerEventExtraData alloc]
+            initWithData:@{@"eventType": @(eventType),
+                         @"changedTouches": changedPointers,
+                         @"allTouches": allPointers,
+                         @"numberOfTouches": @(numberOfTouches)}];
+}
+
 + (RNGestureHandlerEventExtraData *)forPointerInside:(BOOL)pointerInside
 {
     return [[RNGestureHandlerEventExtraData alloc]

package/ios/RNGestureHandlerManager.h

@@ -2,6 +2,8 @@
 
 #import <React/RCTBridgeModule.h>
 
+#import "RNGestureHandler.h"
+
 @class RCTUIManager;
 @class RCTEventDispatcher;
 
@@ -17,6 +19,9 @@
 - (void)attachGestureHandler:(nonnull NSNumber *)handlerTag
                toViewWithTag:(nonnull NSNumber *)viewTag;
 
+- (void)attachGestureHandlerForDeviceEvents:(nonnull NSNumber *)handlerTag
+                              toViewWithTag:(nonnull NSNumber *)viewTag;
+
 - (void)updateGestureHandler:(nonnull NSNumber *)handlerTag config:(nonnull NSDictionary *)config;
 
 - (void)dropGestureHandler:(nonnull NSNumber *)handlerTag;
@@ -26,4 +31,6 @@
 
 - (void)handleClearJSResponder;
 
+- (nullable RNGestureHandler *)handlerWithTag:(nonnull NSNumber *)handlerTag;
+
 @end