Merge branch 'develop'

Author: DanielStormApps

vibrator/Vibrator/Vibrator.swift

@@ -9,8 +9,8 @@ import Foundation
 import AudioToolbox
 import CoreHaptics
 
-/// A class that allows your app to play system vibrations and Apple Haptic and Audio Pattern (AHAP) files generated with [Lofelt Composer](https://composer.lofelt.com).
-public class Vibrator {
+/// A class that allows your app to play system vibrations and Apple Haptic and Audio Pattern (AHAP) files.
+public final class Vibrator {
 
     /// Options for device vibration rates when looping.
     public enum Frequency {
@@ -25,6 +25,10 @@ public class Vibrator {
         }
     }
 
+    /// Enables/disables logging to the console in a `#DEBUG` environment.
+    /// Default value is `false`.
+    public static var isDebugLoggingEnabled: Bool = false
+    
     /// Indicates if the device supports haptic event playback.
     public let supportsHaptics: Bool = {
         return CHHapticEngine.capabilitiesForHardware().supportsHaptics
@@ -42,7 +46,6 @@ public class Vibrator {
     }
 
     private var hapticPlayer: CHHapticPatternPlayer?
-    
     private var vibrateLoopTimer: Timer?
     private var hapticLoopTimer: Timer?
 
@@ -51,13 +54,15 @@ public class Vibrator {
     public static let shared: Vibrator = Vibrator()
     private init() {
         guard supportsHaptics else { return }
-        hapticEngine = try? CHHapticEngine()
+        do { hapticEngine = try CHHapticEngine() }
+        catch { log("\(#function) -> Could not create haptic engine: \(error)") }
     }
 
     /// Prepares the vibrator by acquiring hardware needed for vibrations.
     public func prepare() {
         guard let hapticEngine: CHHapticEngine = hapticEngine else { return }
-        try? hapticEngine.start()
+        do { try hapticEngine.start() }
+        catch { log("\(#function) -> Could not start haptic engine: \(error)") }
     }
 
     // MARK: - Vibrate
@@ -102,7 +107,7 @@ public class Vibrator {
         guard
             let timer: Timer = vibrateLoopTimer,
             timer.isValid
-            else { return }
+        else { return }
 
         timer.invalidate()
         vibrateLoopTimer = nil
@@ -126,40 +131,74 @@ public class Vibrator {
     /// Has no effect if `loop` is `false` when starting the haptic.
     public func stopHaptic() {
         stopHapticLoopTimer()
-        try? hapticPlayer?.stop(atTime: CHHapticTimeImmediate)
+        do { try hapticPlayer?.stop(atTime: CHHapticTimeImmediate) }
+        catch { log("\(#function) -> Could not stop haptic engine: \(error)") }
         hapticPlayer = nil
     }
 
     private func playHaptic(named filename: String) {
         guard
             let hapticEngine: CHHapticEngine = hapticEngine,
             let hapticPath: String = Bundle.main.path(forResource: filename, ofType: AppleHapticAudioPattern.fileExtension)
-            else { return }
+        else { return }
+        
+        do { try hapticEngine.start() }
+        catch { log("\(#function) -> Could not start haptic engine: \(error)") }
 
-        try? hapticEngine.start()
-        try? hapticEngine.playPattern(from: URL(fileURLWithPath: hapticPath))
+        do { try hapticEngine.playPattern(from: URL(fileURLWithPath: hapticPath)) }
+        catch { log("\(#function) -> Could not play pattern: \(error)") }
     }
 
     private func playHapticLoop(named filename: String) {
         guard
             let hapticEngine: CHHapticEngine = hapticEngine,
             let hapticPath: String = Bundle.main.path(forResource: filename, ofType: AppleHapticAudioPattern.fileExtension),
-            let hapticData: Data = try? Data(contentsOf: URL(fileURLWithPath: hapticPath)),
+            let hapticData: Data = hapticData(hapticPath: hapticPath),
             let appleHapticAudioPattern: AppleHapticAudioPattern = AppleHapticAudioPattern(data: hapticData),
             let appleHapticAudioPatternDictionary: [CHHapticPattern.Key: Any] = appleHapticAudioPattern.dictionaryRepresentation(),
             let hapticDuration: TimeInterval = appleHapticAudioPattern.pattern?.first(where: { $0.event?.eventDuration != nil })?.event?.eventDuration,
-            let hapticPattern: CHHapticPattern = try? CHHapticPattern(dictionary: appleHapticAudioPatternDictionary),
-            let hapticPlayer: CHHapticPatternPlayer = try? hapticEngine.makePlayer(with: hapticPattern)
-            else { return }
+            let hapticPattern: CHHapticPattern = hapticPattern(appleHapticAudioPatternDictionary: appleHapticAudioPatternDictionary),
+            let hapticPlayer: CHHapticPatternPlayer = hapticPlayer(hapticPattern: hapticPattern)
+        else { return }
+        
+        do { try hapticEngine.start() }
+        catch { log("\(#function) -> Could not start haptic engine: \(error)") }
 
-        try? hapticEngine.start()
         self.hapticPlayer = hapticPlayer
-        try? self.hapticPlayer?.start(atTime: CHHapticTimeImmediate)
+        
+        do { try self.hapticPlayer?.start(atTime: CHHapticTimeImmediate) }
+        catch { log("\(#function) -> Could not start haptic player at time CHHapticTimeImmediate: \(error)") }
+        
         startHapticLoopTimer(timeInterval: hapticDuration)
     }
 
+    private func hapticData(hapticPath: String) -> Data? {
+        var hapticData: Data?
+        do { hapticData = try Data(contentsOf: URL(fileURLWithPath: hapticPath)) }
+        catch { log("\(#function) -> Could not load haptic data: \(error)") }
+        return hapticData
+    }
+    
+    private func hapticPattern(appleHapticAudioPatternDictionary: [CHHapticPattern.Key: Any]) -> CHHapticPattern? {
+        var hapticPattern: CHHapticPattern?
+        do { hapticPattern = try CHHapticPattern(dictionary: appleHapticAudioPatternDictionary) }
+        catch { log("\(#function) -> Could not create haptic pattern: \(error)") }
+        return hapticPattern
+    }
+    
+    private func hapticPlayer(hapticPattern: CHHapticPattern) -> CHHapticPatternPlayer? {
+        var hapticPlayer: CHHapticPatternPlayer?
+        // Intentionally creating an advanced player, `CHHapticAdvancedPatternPlayer`, with `.makeAdvancedPlayer` as of iOS 18 here.
+        // Using a standard player, `CHHapticPatternPlayer`, will throw a `CHHapticError.Code.memoryError` `com.apple.CoreHaptics error -4899`.
+        // Apparently advanced players can play larger haptic patterns than standard ones, but that isn't officially documented anywhere...
+        do { hapticPlayer = try hapticEngine?.makeAdvancedPlayer(with: hapticPattern) }
+        catch { log("\(#function) -> Could not create haptic player: \(error)") }
+        return hapticPlayer
+    }
+    
     @objc private func restartHapticPlayer() {
-        try? hapticPlayer?.start(atTime: 0.0)
+        do { try self.hapticPlayer?.start(atTime: 0.0) }
+        catch { log("\(#function) -> Could not start haptic player at time 0.0: \(error)") }
     }
 
     private func startHapticLoopTimer(timeInterval: TimeInterval) {
@@ -175,7 +214,7 @@ public class Vibrator {
         guard
             let timer: Timer = hapticLoopTimer,
             timer.isValid
-            else { return }
+        else { return }
 
         timer.invalidate()
         hapticLoopTimer = nil
@@ -189,7 +228,8 @@ public class Vibrator {
     /// Called when the haptic engine fails. Will attempt to restart the haptic engine.
     private func hapticEngineDidRecoverFromServerError() {
         log("\(#function)")
-        try? hapticEngine?.start()
+        do { try hapticEngine?.start() }
+        catch { log("\(#function) -> Could not start haptic engine: \(error)") }
     }
 
 }
@@ -199,7 +239,8 @@ private extension Vibrator {
     // MARK: - Logging
     func log(_ message: String) {
         #if DEBUG
-            print("\n📳 \(String(describing: Vibrator.self)): \(#function) -> message: \(message)\n")
+            guard Vibrator.isDebugLoggingEnabled else { return }
+            print("📳 \(String(describing: Vibrator.self)) -> message: \(message)")
         #endif
     }
 

vibrator/vibrator-demo/AppDelegate.swift

@@ -8,7 +8,7 @@
 import UIKit
 
 @UIApplicationMain
-class AppDelegate: UIResponder, UIApplicationDelegate {
+final class AppDelegate: UIResponder, UIApplicationDelegate {
 
     // MARK: - UIApplicationDelegate
     func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

vibrator/vibrator-demo/Extensions/UIDevice+Extensions.swift

@@ -9,38 +9,12 @@ import UIKit
 
 extension UIDevice {
 
-    static let isSimulator = UIDevice.current.modelName == Model.simulator.rawValue
-    
-    private var modelName: String {
-        return name(for: modelIdentifier())
-    }
-    
-    private func modelIdentifier() -> String {
-        var systemInfo: utsname = utsname()
-        uname(&systemInfo)
-        
-        let machineMirror: Mirror = Mirror(reflecting: systemInfo.machine)
-        let identifier: String = machineMirror.children.reduce(String()) { identifier, element in
-            guard
-                let value: Int8 = element.value as? Int8,
-                value != 0
-                else { return identifier }
-            
-            return identifier + String(UnicodeScalar(UInt8(value)))
-        }
-        
-        return identifier
-    }
-    
-    private func name(for modelIdentifier: String) -> String {
-        switch modelIdentifier {
-        case "x86_64": return Model.simulator.rawValue
-        default: return modelIdentifier
-        }
-    }
-    
-    private enum Model: String {
-        case simulator = "Simulator"
-    }
+    static let isSimulator: Bool = {
+    #if targetEnvironment(simulator)
+        return true
+    #else
+        return false
+    #endif
+    }()
 
 }

vibrator/vibrator-demo/Home/HomeViewController.swift

@@ -7,7 +7,7 @@
 
 import UIKit
 
-class HomeViewController: UIViewController {
+final class HomeViewController: UIViewController {
 
     @IBOutlet private weak var deviceHapticSupportLabel: UILabel!
     @IBOutlet private weak var heartHapticButton: UIButton!

vibrator/vibrator-demo/SceneDelegate.swift

@@ -7,7 +7,7 @@
 
 import UIKit
 
-class SceneDelegate: UIResponder, UIWindowSceneDelegate {
+final class SceneDelegate: UIResponder, UIWindowSceneDelegate {
 
     var window: UIWindow?
 

vibrator/vibrator.xcodeproj/project.pbxproj

@@ -3,7 +3,7 @@
 	archiveVersion = 1;
 	classes = {
 	};
-	objectVersion = 50;
+	objectVersion = 54;
 	objects = {
 
 /* Begin PBXBuildFile section */
@@ -157,8 +157,9 @@
 		841E136D24216EB100940E53 /* Project object */ = {
 			isa = PBXProject;
 			attributes = {
+				BuildIndependentTargetsInParallel = YES;
 				LastSwiftUpdateCheck = 1130;
-				LastUpgradeCheck = 1130;
+				LastUpgradeCheck = 1640;
 				ORGANIZATIONNAME = "Daniel Storm";
 				TargetAttributes = {
 					841E137424216EB200940E53 = {
@@ -252,6 +253,7 @@
 				CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
 				CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
 				CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
+				CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES;
 				CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
 				CLANG_WARN_STRICT_PROTOTYPES = YES;
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
@@ -260,6 +262,7 @@
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				COPY_PHASE_STRIP = NO;
 				DEBUG_INFORMATION_FORMAT = dwarf;
+				DEVELOPMENT_TEAM = E5BK5K7RRN;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				ENABLE_TESTABILITY = YES;
 				GCC_C_LANGUAGE_STANDARD = gnu11;
@@ -313,6 +316,7 @@
 				CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
 				CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
 				CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
+				CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES;
 				CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
 				CLANG_WARN_STRICT_PROTOTYPES = YES;
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
@@ -321,6 +325,7 @@
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				COPY_PHASE_STRIP = NO;
 				DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
+				DEVELOPMENT_TEAM = E5BK5K7RRN;
 				ENABLE_NS_ASSERTIONS = NO;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				GCC_C_LANGUAGE_STANDARD = gnu11;
@@ -348,9 +353,8 @@
 				CODE_SIGN_IDENTITY = "iPhone Developer";
 				CODE_SIGN_STYLE = Manual;
 				CURRENT_PROJECT_VERSION = 1;
-				DEVELOPMENT_TEAM = E5BK5K7RRN;
 				INFOPLIST_FILE = "vibrator-demo/Info.plist";
-				IPHONEOS_DEPLOYMENT_TARGET = 13.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 16.1;
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",
@@ -371,9 +375,8 @@
 				CODE_SIGN_IDENTITY = "iPhone Developer";
 				CODE_SIGN_STYLE = Manual;
 				CURRENT_PROJECT_VERSION = 1;
-				DEVELOPMENT_TEAM = E5BK5K7RRN;
 				INFOPLIST_FILE = "vibrator-demo/Info.plist";
-				IPHONEOS_DEPLOYMENT_TARGET = 13.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 16.1;
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",