Fix Swift backwards compat for the WiFiVersionType enum. (#28086)

* Fix Swift backwards compat for the WiFiVersionType enum. The names used to be like "80211a", which got exposed in Swift as "type80211a", then became "A". When the "A" names were non-deprecated and the "80211a" names were deprecated, Swift saw either just "A" or "A" and "type80211a"; I am not entirely clear which. Now that they are all deprecated, Swift by default sees "typeA" and "type80211a", which is compat-breaking. So annotate the "type80211*" names with SwiftName explicitly, which makes the auto-importer ignore them for purposes of determining the other names, and goes back to having "A" in Swift. * Also map the new enum values to lowercase, since that's more idiomatic for Swift.
project-chip · Aug 24, 2023 · a960333 · a960333
1 parent 87cbdb2
commit a960333
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/src/darwin/Framework/CHIP/Matter.apinotes b/src/darwin/Framework/CHIP/Matter.apinotes
@@ -0,0 +1,31 @@
+Name: Matter
+
+Enumerators:
+     # The Swift importer seems to get very confused about
+     # MTRWiFiNetworkDiagnosticsWiFiVersionType enum value naming depending on
+     # which set of them is deprecated.  Give explicit Swift names to the
+     # older-deprecated bits, so the importer does the same thing it used to do
+     # with the bits that got deprecated more recently.
+    - Name: MTRWiFiNetworkDiagnosticsWiFiVersionType80211a
+      SwiftName: type80211a
+    - Name: MTRWiFiNetworkDiagnosticsWiFiVersionType80211b
+      SwiftName: type80211b
+    - Name: MTRWiFiNetworkDiagnosticsWiFiVersionType80211g
+      SwiftName: type80211g
+    - Name: MTRWiFiNetworkDiagnosticsWiFiVersionType80211n
+      SwiftName: type80211n
+    - Name: MTRWiFiNetworkDiagnosticsWiFiVersionType80211ac
+      SwiftName: type80211ac
+    - Name: MTRWiFiNetworkDiagnosticsWiFiVersionType80211ax
+      SwiftName: type80211ax
+
+    # Make the names for MTRWiFiNetworkDiagnosticsWiFiVersion all be
+    # lowercase instead of having uppercase A and lowercase ax.
+    - Name: MTRWiFiNetworkDiagnosticsWiFiVersionA
+      SwiftName: a
+    - Name: MTRWiFiNetworkDiagnosticsWiFiVersionB
+      SwiftName: b
+    - Name: MTRWiFiNetworkDiagnosticsWiFiVersionG
+      SwiftName: g
+    - Name: MTRWiFiNetworkDiagnosticsWiFiVersionN
+      SwiftName: n
diff --git a/src/darwin/Framework/Matter.xcodeproj/project.pbxproj b/src/darwin/Framework/Matter.xcodeproj/project.pbxproj
@@ -135,6 +135,7 @@
 		3DFCB32C29678C9500332B35 /* MTRConversion.h in Headers */ = {isa = PBXBuildFile; fileRef = 3DFCB32B29678C9500332B35 /* MTRConversion.h */; };
 		51029DF6293AA6100087AFB0 /* MTROperationalCertificateIssuer.mm in Sources */ = {isa = PBXBuildFile; fileRef = 51029DF5293AA6100087AFB0 /* MTROperationalCertificateIssuer.mm */; };
 		510470FB2A2F7DF60053EA7E /* MTRBackwardsCompatShims.mm in Sources */ = {isa = PBXBuildFile; fileRef = 510470FA2A2F7DF60053EA7E /* MTRBackwardsCompatShims.mm */; };
+		510A07492A685D3900A9241C /* Matter.apinotes in Headers */ = {isa = PBXBuildFile; fileRef = 510A07482A685D3900A9241C /* Matter.apinotes */; settings = {ATTRIBUTES = (Public, ); }; };
 		510CECA8297F72970064E0B3 /* MTROperationalCertificateIssuerTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 510CECA6297F72470064E0B3 /* MTROperationalCertificateIssuerTests.m */; };
 		5117DD3829A931AE00FFA1AA /* MTROperationalBrowser.mm in Sources */ = {isa = PBXBuildFile; fileRef = 5117DD3629A931AD00FFA1AA /* MTROperationalBrowser.mm */; };
 		5117DD3929A931AE00FFA1AA /* MTROperationalBrowser.h in Headers */ = {isa = PBXBuildFile; fileRef = 5117DD3729A931AE00FFA1AA /* MTROperationalBrowser.h */; };
@@ -436,6 +437,7 @@
 		3DFCB32B29678C9500332B35 /* MTRConversion.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MTRConversion.h; sourceTree = "<group>"; };
 		51029DF5293AA6100087AFB0 /* MTROperationalCertificateIssuer.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = MTROperationalCertificateIssuer.mm; sourceTree = "<group>"; };
 		510470FA2A2F7DF60053EA7E /* MTRBackwardsCompatShims.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = MTRBackwardsCompatShims.mm; sourceTree = "<group>"; };
+		510A07482A685D3900A9241C /* Matter.apinotes */ = {isa = PBXFileReference; lastKnownFileType = text.apinotes; name = Matter.apinotes; path = CHIP/Matter.apinotes; sourceTree = "<group>"; };
 		510CECA6297F72470064E0B3 /* MTROperationalCertificateIssuerTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = MTROperationalCertificateIssuerTests.m; sourceTree = "<group>"; };
 		5117DD3629A931AD00FFA1AA /* MTROperationalBrowser.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = MTROperationalBrowser.mm; sourceTree = "<group>"; };
 		5117DD3729A931AE00FFA1AA /* MTROperationalBrowser.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MTROperationalBrowser.h; sourceTree = "<group>"; };
@@ -952,6 +954,7 @@
 		B20252832459E34F00F97062 = {
 			isa = PBXGroup;
 			children = (
+				510A07482A685D3900A9241C /* Matter.apinotes */,
 				BA107AEE2470CFBB004287EB /* chip_xcode_build_connector.sh */,
 				B202528F2459E34F00F97062 /* CHIP */,
 				B202529A2459E34F00F97062 /* CHIPTests */,
@@ -1190,6 +1193,7 @@
 			isa = PBXHeadersBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				510A07492A685D3900A9241C /* Matter.apinotes in Headers */,
 				51EF279F2A2A3EB100E33F75 /* MTRBackwardsCompatShims.h in Headers */,
 				5173A47729C0E2ED00F67F48 /* MTRFabricInfo.h in Headers */,
 				517BF3F0282B62B800A8B7DB /* MTRCertificates.h in Headers */,