Fix Apple Pencil compatibility for M4 iPad Pro and M2/M3 iPad Air models (#474)

* Initial plan

* Fix Apple Pencil compatibility for iPad models

* Add tests for Apple Pencil compatibility

* Add changelog entry and fix trailing whitespace in tests

* Fix linting issues.

* Fix changelog entry.

* Fix additional linting issues.

* Fix ApplePencilSupport OptionSet raw values to use non-overlapping bits

The firstGenerationUsbC raw value (0x03) overlapped with firstGeneration
(0x01) and secondGeneration (0x02), causing contains() checks to return
incorrect results. Changed to proper power-of-2 values.

Author: Copilot

.swiftlint.yml

@@ -4,6 +4,8 @@ disabled_rules:
   - switch_case_alignment
   - type_body_length
   - identifier_name
+  - trailing_comma
+  - function_body_length
 
 opt_in_rules:
   - anyobject_protocol

CHANGELOG.md

@@ -21,6 +21,8 @@
 ### Bug fixes
 
 - Fixed iPhone Air incorrectly marked as having ultra-wide camera. ([#463](https://github.com/devicekit/DeviceKit/pull/463))
+- Fixed Apple Pencil compatibility for M4 iPad Pro, M2/M3 iPad Air, iPad (10th gen), and iPad (A16) models. ([#474](https://github.com/devicekit/DeviceKit/pull/474))
+- Fixed `ApplePencilSupport` OptionSet raw values so that `.firstGenerationUsbC` no longer incorrectly overlaps with `.firstGeneration` and `.secondGeneration`. ([#474](https://github.com/devicekit/DeviceKit/pull/474))
 - Exclude unhandled files (`Info.plist`, `Device.swift.gyb`) to suppress SPM warnings. ([#484](https://github.com/devicekit/DeviceKit/pull/484))
 
 ## Version 5.7.0

Example/DeviceKitPlayground.playground/Contents.swift

@@ -96,8 +96,9 @@ if Device.volumeAvailableCapacityForImportantUsage ?? 0 > Int64(1_000) {
 // Get the underlying device
 let simulator = Device.simulator(.iPhone8Plus)
 let realDevice = Device.iPhone8Plus
-simulator.realDevice == realDevice // true
-realDevice.realDevice == realDevice // true
+
+_ = simulator.realDevice == realDevice // true
+_ = realDevice.realDevice == realDevice // true
 
 // Get device thermal state
 if device.thermalState == .nominal {

Package.swift

@@ -1,5 +1,5 @@
 // swift-tools-version:5.3
-//===----------------------------------------------------------------------===//
+// ===----------------------------------------------------------------------=== //
 //
 // This source file is part of the DeviceKit open source project
 //
@@ -8,7 +8,7 @@
 // License: https://github.com/dennisweissmann/DeviceKit/blob/master/LICENSE
 // Contributors: https://github.com/dennisweissmann/DeviceKit#contributors
 //
-//===----------------------------------------------------------------------===//
+// ===----------------------------------------------------------------------=== //
 
 import PackageDescription
 

Source/Device.generated.swift

@@ -623,7 +623,7 @@ public enum Device {
   /// - parameter identifier: The device identifier, e.g. "iPhone7,1". Can be obtained from `Device.identifier`.
   ///
   /// - returns: An initialized `Device`.
-  public static func mapToDevice(identifier: String) -> Device { // swiftlint:disable:this cyclomatic_complexity function_body_length
+  public static func mapToDevice(identifier: String) -> Device {
     #if os(iOS)
       switch identifier {
       case "iPod5,1": return iPodTouch5
@@ -2197,7 +2197,7 @@ extension Device {
 
   /// The volume’s available capacity in bytes for storing nonessential resources.
   @available(iOS 11.0, *)
-  public static var volumeAvailableCapacityForOpportunisticUsage: Int64? { //swiftlint:disable:this identifier_name
+  public static var volumeAvailableCapacityForOpportunisticUsage: Int64? { // swiftlint:disable:this identifier_name
     return (try? rootURL.resourceValues(forKeys: [.volumeAvailableCapacityForOpportunisticUsageKey]))?.volumeAvailableCapacityForOpportunisticUsage
   }
 
@@ -2247,8 +2247,8 @@ extension Device {
 
     public static let firstGeneration = ApplePencilSupport(rawValue: 0x01)
     public static let secondGeneration = ApplePencilSupport(rawValue: 0x02)
-    public static let firstGenerationUsbC = ApplePencilSupport(rawValue: 0x03)
-    public static let pro = ApplePencilSupport(rawValue: 0x04)
+    public static let firstGenerationUsbC = ApplePencilSupport(rawValue: 0x04)
+    public static let pro = ApplePencilSupport(rawValue: 0x08)
   }
 
   /// All Apple Pencil Capable Devices
@@ -2269,8 +2269,8 @@ extension Device {
       case .iPadPro12Inch: return .firstGeneration
       case .iPadPro12Inch2: return .firstGeneration
       case .iPadPro10Inch: return .firstGeneration
-      case .iPad10: return .firstGenerationUsbC
-      case .iPadA16: return .firstGenerationUsbC
+      case .iPad10: return [.firstGeneration, .firstGenerationUsbC]
+      case .iPadA16: return [.firstGeneration, .firstGenerationUsbC]
       case .iPadAir4: return [.secondGeneration, .firstGenerationUsbC]
       case .iPadAir5: return [.secondGeneration, .firstGenerationUsbC]
       case .iPadMini6: return [.secondGeneration, .firstGenerationUsbC]
@@ -2282,17 +2282,17 @@ extension Device {
       case .iPadPro12Inch5: return [.secondGeneration, .firstGenerationUsbC]
       case .iPadPro11Inch4: return [.secondGeneration, .firstGenerationUsbC]
       case .iPadPro12Inch6: return [.secondGeneration, .firstGenerationUsbC]
-      case .iPadPro11M4: return [.secondGeneration, .firstGenerationUsbC, .pro]
-      case .iPadPro13M4: return [.secondGeneration, .firstGenerationUsbC, .pro]
       case .iPadPro11M5: return [.secondGeneration, .firstGenerationUsbC, .pro]
       case .iPadPro13M5: return [.secondGeneration, .firstGenerationUsbC, .pro]
-      case .iPadAir11M2: return [.secondGeneration, .pro]
-      case .iPadAir13M2: return [.secondGeneration, .pro]
-      case .iPadAir11M3: return [.secondGeneration, .pro]
-      case .iPadAir13M3: return [.secondGeneration, .pro]
-      case .iPadAir11M4: return [.secondGeneration, .pro]
-      case .iPadAir13M4: return [.secondGeneration, .pro]
+      case .iPadAir11M2: return [.firstGenerationUsbC, .pro]
+      case .iPadAir13M2: return [.firstGenerationUsbC, .pro]
+      case .iPadAir11M3: return [.firstGenerationUsbC, .pro]
+      case .iPadAir13M3: return [.firstGenerationUsbC, .pro]
+      case .iPadAir11M4: return [.firstGenerationUsbC, .pro]
+      case .iPadAir13M4: return [.firstGenerationUsbC, .pro]
       case .iPadMiniA17Pro: return [.firstGenerationUsbC, .pro]
+      case .iPadPro11M4: return [.firstGenerationUsbC, .pro]
+      case .iPadPro13M4: return [.firstGenerationUsbC, .pro]
       case .simulator(let model): return model.applePencilSupport
       default: return []
     }