iOS: Haptic tap when long-pressing

3 files changed, 126 insertions, 9 deletions

diff --git a/src/ios.h b/src/ios.h
index 60841aee..9490491f 100644
--- a/src/ios.h
+++ b/src/ios.h
@@ -26,8 +26,13 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
 
 iDeclareType(Window)
 
+enum iHapticEffect {
+    tap_HapticEffect,
+};
+
 void    setupApplication_iOS    (void);
 void    setupWindow_iOS         (iWindow *window);
 iBool   isPhone_iOS             (void);
 void    safeAreaInsets_iOS      (float *left, float *top, float *right, float *bottom);
 iBool   processEvent_iOS        (const SDL_Event *);
+void    playHapticEffect_iOS    (enum iHapticEffect effect);
diff --git a/src/ios.m b/src/ios.m
index 4d1aac37..75824117 100644
--- a/src/ios.m
+++ b/src/ios.m
@@ -22,14 +22,16 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
 
 #include "ios.h"
 #include "app.h"
+#include "ui/command.h"
 #include "ui/window.h"
 #include <SDL_events.h>
 #include <SDL_syswm.h>
 
 #import <UIKit/UIKit.h>
+#import <CoreHaptics/CoreHaptics.h>
 
 static iBool isSystemDarkMode_ = iFalse;
-static iBool isPhone_ = iFalse;
+static iBool isPhone_          = iFalse;
 
 static UIViewController *viewController_(iWindow *window) {
     SDL_SysWMinfo wm;
@@ -41,11 +43,104 @@ static UIViewController *viewController_(iWindow *window) {
     return NULL;
 }
 
-@interface KeyboardObserver : NSObject
--(void)keyboardOnScreen:(NSNotification *)notification;
+/*----------------------------------------------------------------------------------------------*/
+
+API_AVAILABLE(ios(13.0))
+@interface HapticState : NSObject
+@property (nonatomic, strong) CHHapticEngine *engine;
+@property (nonatomic, strong) NSDictionary   *tapDef;
+@end
+
+@implementation HapticState
+
+-(void)setup {
+    NSError *error;
+    self.engine = [[CHHapticEngine alloc] initAndReturnError:&error];
+    __weak HapticState *hs = self;
+    [self.engine setResetHandler:^{
+        NSLog(@"Haptic engine reset");
+        NSError *startupError;
+        [hs.engine startAndReturnError:&startupError];
+        if (startupError) {
+            NSLog(@"Engine couldn't restart");
+        }
+        else {
+            // TODO: Create pattern players.
+        }
+    }];
+    [self.engine setStoppedHandler:^(CHHapticEngineStoppedReason reason){
+        NSLog(@"Haptic engine stopped");
+        switch (reason) {
+            case CHHapticEngineStoppedReasonAudioSessionInterrupt:
+                break;
+            case CHHapticEngineStoppedReasonApplicationSuspended:
+                break;
+            case CHHapticEngineStoppedReasonIdleTimeout:
+                break;
+            case CHHapticEngineStoppedReasonSystemError:
+                break;
+            default:
+                break;
+        }
+    }];
+    self.tapDef = @{
+        CHHapticPatternKeyPattern:
+            @[
+                @{
+                    CHHapticPatternKeyEvent: @{
+                        CHHapticPatternKeyEventType:    CHHapticEventTypeHapticTransient,
+                        CHHapticPatternKeyTime:         @0.0,
+                        CHHapticPatternKeyEventDuration:@0.1
+                    },
+                },
+            ],
+    };
+}
+
+-(void)playTapEffect {
+    NSError *error = nil;
+    CHHapticPattern *pattern = [[CHHapticPattern alloc] initWithDictionary:self.tapDef
+                                                                     error:&error];
+    // TODO: Check the error.
+    id<CHHapticPatternPlayer> player = [self.engine createPlayerWithPattern:pattern error:&error];
+    // TODO: Check the error.
+    [self.engine startWithCompletionHandler:^(NSError *err){
+        if (err == nil) {
+            [self.engine notifyWhenPlayersFinished:^(NSError * _Nullable error) {
+                return CHHapticEngineFinishedActionStopEngine;
+            }];
+            NSError *startError = nil;
+            [player startAtTime:0.0 error:&startError];
+        }
+    }];
+}
+
+@end
+
+/*----------------------------------------------------------------------------------------------*/
+
+@interface AppState : NSObject
+@property (nonatomic, assign) BOOL isHapticsAvailable;
+@property (nonatomic, strong) NSObject *haptic;
 @end
 
-@implementation KeyboardObserver
+static AppState *appState_;
+
+@implementation AppState
+
+-(void)setupHaptics {
+    if (@available(iOS 13.0, *)) {
+        self.isHapticsAvailable = CHHapticEngine.capabilitiesForHardware.supportsHaptics;
+        if (self.isHapticsAvailable) {
+            HapticState *hs = [[HapticState alloc] init];
+            [hs setup];
+            self.haptic = hs;
+        }
+    } else {
+        self.isHapticsAvailable = NO;
+    }
+}
+
 -(void)keyboardOnScreen:(NSNotification *)notification {
     NSDictionary *info   = notification.userInfo;
     NSValue      *value  = info[UIKeyboardFrameEndUserInfoKey];
@@ -70,21 +165,20 @@ static void enableMouse_(iBool yes) {
     SDL_EventState(SDL_MOUSEBUTTONUP, yes);
 }
 
-KeyboardObserver *keyObs_;
-
 void setupApplication_iOS(void) {
     enableMouse_(iFalse);
     NSString *deviceModel = [[UIDevice currentDevice] model];
     if ([deviceModel isEqualToString:@"iPhone"]) {
         isPhone_ = iTrue;
     }
-    keyObs_ = [[KeyboardObserver alloc] init];
+    appState_ = [[AppState alloc] init];
+    [appState_ setupHaptics];
     NSNotificationCenter *center = [NSNotificationCenter defaultCenter];
-    [center addObserver:keyObs_
+    [center addObserver:appState_
                selector:@selector(keyboardOnScreen:)
                    name:UIKeyboardWillShowNotification
                  object:nil];
-    [center addObserver:keyObs_
+    [center addObserver:appState_
                selector:@selector(keyboardOffScreen:)
                    name:UIKeyboardWillHideNotification
                  object:nil];
@@ -128,6 +222,17 @@ void setupWindow_iOS(iWindow *window) {
     postCommandf_App("~os.theme.changed dark:%d contrast:1", isSystemDarkMode_ ? 1 : 0);
 }
 
+void playHapticEffect_iOS(enum iHapticEffect effect) {
+    if (@available(iOS 13.0, *)) {
+        HapticState *hs = (HapticState *) appState_.haptic;
+        switch(effect) {
+            case tap_HapticEffect:
+                [hs playTapEffect];
+                break;
+        }
+    }
+}
+
 iBool processEvent_iOS(const SDL_Event *ev) {
     if (ev->type == SDL_WINDOWEVENT) {
         if (ev->window.event == SDL_WINDOWEVENT_RESTORED) {
diff --git a/src/ui/touch.c b/src/ui/touch.c
index f15eda6f..136457a5 100644
--- a/src/ui/touch.c
+++ b/src/ui/touch.c
@@ -28,6 +28,10 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
 #include <the_Foundation/math.h>
 #include <SDL_timer.h>
 
+#if defined (iPlatformAppleMobile)
+#   include "../ios.h"
+#endif
+
 iDeclareType(Touch)
 iDeclareType(TouchState)
 iDeclareType(Momentum)
@@ -174,6 +178,9 @@ static void update_TouchState_(void *ptr) {
                 touch->isTapAndHold = iTrue;
                 touch->hasMoved = iFalse;
                 touch->startPos = touch->pos[0];
+#if defined (iPlatformAppleMobile)
+                playHapticEffect_iOS(tap_HapticEffect);
+#endif
             }
         }
     }