Add stringification for image formats

Author: grynspan

Sources/Overlays/_Testing_CoreGraphics/Attachments/AttachableImageFormat+UTType.swift

@@ -24,14 +24,7 @@ extension AttachableImageFormat {
   ///   @Available(Swift, introduced: 6.3)
   /// }
   public var contentType: UTType {
-    switch kind {
-    case .png:
-      return .png
-    case .jpeg:
-      return .jpeg
-    case let .systemValue(contentType):
-      return contentType as! UTType
-    }
+    kind.contentType
   }
 
   /// Initialize an instance of this type with the given content type and
@@ -102,4 +95,30 @@ extension AttachableImageFormat {
     self.init(contentType: contentType, encodingQuality: encodingQuality)
   }
 }
+
+// MARK: - CustomStringConvertible, CustomDebugStringConvertible
+
+@available(_uttypesAPI, *)
+extension AttachableImageFormat.Kind: CustomStringConvertible, CustomDebugStringConvertible {
+  /// The content type corresponding to this image format.
+  fileprivate var contentType: UTType {
+    switch self {
+    case .png:
+      return .png
+    case .jpeg:
+      return .jpeg
+    case let .systemValue(contentType):
+      return contentType as! UTType
+    }
+  }
+
+  package var description: String {
+    contentType.localizedDescription
+  }
+
+  package var debugDescription: String {
+    let contentType = contentType
+    return "\(contentType.localizedDescription) (\(contentType.identifier))"
+  }
+}
 #endif

Sources/Overlays/_Testing_WinSDK/Attachments/AttachableImageFormat+CLSID.swift

@@ -196,14 +196,7 @@ extension AttachableImageFormat {
   @_spi(_)
 #endif
   public var encoderCLSID: CLSID {
-    switch kind {
-    case .png:
-      CLSID_WICPngEncoder
-    case .jpeg:
-      CLSID_WICJpegEncoder
-    case let .systemValue(clsid):
-      (clsid as! CLSID.Wrapper).rawValue
-    }
+    kind.encoderCLSID
   }
 
   /// Construct an instance of this type with the `CLSID` value of a Windows
@@ -277,4 +270,60 @@ extension AttachableImageFormat {
     self.init(encoderCLSID: encoderCLSID, encodingQuality: encodingQuality)
   }
 }
+
+// MARK: - CustomStringConvertible, CustomDebugStringConvertible
+
+extension AttachableImageFormat.Kind: CustomStringConvertible, CustomDebugStringConvertible {
+  /// The `CLSID` value of the Windows Imaging Component (WIC) encoder class
+  /// that corresponds to this image format.
+  fileprivate var encoderCLSID: CLSID {
+    switch self {
+    case .png:
+      CLSID_WICPngEncoder
+    case .jpeg:
+      CLSID_WICJpegEncoder
+    case let .systemValue(clsid):
+      (clsid as! CLSID.Wrapper).rawValue
+    }
+  }
+
+  /// Get a description of the given `CLSID` value.
+  ///
+  /// - Parameters:
+  ///   - clsid: The `CLSID` value to describe.
+  ///
+  /// - Returns: A description of `clsid`.
+  private static func _description(of clsid: CLSID) -> String {
+    var clsid = clsid
+    var buffer: RPC_WSTR?
+    if RPC_S_OK == UuidToStringW(&clsid, &buffer) {
+      defer {
+        RpcStringFreeW(&buffer)
+      }
+      if let result = String.decodeCString(buffer, as: UTF16.self)?.result {
+        return result
+      }
+    }
+    return String(describing: clsid)
+  }
+
+  package var description: String {
+    let clsid = encoderCLSID
+    let encoderPathExtensionsByCLSID = (try? AttachableImageFormat._encoderPathExtensionsByCLSID.get()) ?? [:]
+    if let ext = encoderPathExtensionsByCLSID[CLSID.Wrapper(clsid)]?.first {
+      return "\(ext.uppercased()) format"
+    }
+    return Self._description(of: clsid)
+  }
+
+  package var debugDescription: String {
+    let clsid = encoderCLSID
+    let clsidDescription = Self._description(of: clsid)
+    let encoderPathExtensionsByCLSID = (try? AttachableImageFormat._encoderPathExtensionsByCLSID.get()) ?? [:]
+    if let ext = encoderPathExtensionsByCLSID[CLSID.Wrapper(clsid)]?.first {
+      return "\(ext.uppercased()) format (\(clsidDescription))"
+    }
+    return clsidDescription
+  }
+}
 #endif

Sources/Overlays/_Testing_WinSDK/Support/Additions/GUIDAdditions.swift

@@ -25,7 +25,9 @@ extension GUID {
   }
 }
 
-extension GUID.Wrapper: Equatable, Hashable {
+// MARK: -
+
+extension GUID.Wrapper: Equatable, Hashable, CustomStringConvertible {
   init(_ rawValue: GUID) {
     self.init(rawValue: rawValue)
   }
@@ -44,6 +46,10 @@ extension GUID.Wrapper: Equatable, Hashable {
   func hash(into hasher: inout Hasher) {
     hasher.combine(_uint128Value)
   }
+
+  var description: String {
+    String(describing: rawValue)
+  }
 #endif
 }
 #endif

Sources/Testing/Attachments/Images/AttachableImageFormat.swift

@@ -118,6 +118,28 @@ extension AttachableImageFormat.Kind: Equatable, Hashable {
   }
 }
 
+// MARK: - CustomStringConvertible, CustomDebugStringConvertible
+
+#if SWT_NO_IMAGE_ATTACHMENTS
+@_unavailableInEmbedded
+@available(*, unavailable, message: "Image attachments are not available on this platform.")
+#endif
+@available(_uttypesAPI, *)
+extension AttachableImageFormat: CustomStringConvertible, CustomDebugStringConvertible {
+  public var description: String {
+    let kindDescription = String(describing: kind)
+    if encodingQuality < 1.0 {
+      return "\(kindDescription) at \(Int(encodingQuality * 100.0))% quality"
+    }
+    return kindDescription
+  }
+
+  public var debugDescription: String {
+    let kindDescription = String(reflecting: kind)
+    return "\(kindDescription) at quality \(encodingQuality)"
+  }
+}
+
 // MARK: -
 
 #if SWT_NO_IMAGE_ATTACHMENTS

Tests/TestingTests/AttachmentTests.swift

@@ -869,6 +869,30 @@ extension AttachmentTests {
       #expect(format2.hashValue != format3.hashValue)
       #expect(format1.hashValue != format3.hashValue)
     }
+
+    @available(_uttypesAPI, *)
+    @Test func imageFormatStringification() {
+      let format: AttachableImageFormat = AttachableImageFormat.png
+#if canImport(CoreGraphics) && canImport(_Testing_CoreGraphics)
+      #expect(String(describing: format) == UTType.png.localizedDescription)
+      #expect(String(reflecting: format) == "\(UTType.png.localizedDescription) (\(UTType.png.identifier))")
+#elseif canImport(WinSDK) && canImport(_Testing_WinSDK)
+      #expect(String(describing: format) == "PNG format")
+      #expect(String(reflecting: format) == "PNG format (27949969-876a-41d7-9447-568f6a35a4dc) at quality 1.0")
+#endif
+    }
+
+    @available(_uttypesAPI, *)
+    @Test func imageFormatStringificationWithQuality() {
+      let format: AttachableImageFormat = AttachableImageFormat.jpeg(withEncodingQuality: 0.5)
+#if canImport(CoreGraphics) && canImport(_Testing_CoreGraphics)
+      #expect(String(describing: format) == "\(UTType.jpeg.localizedDescription) at 50% quality")
+      #expect(String(reflecting: format) == "\(UTType.jpeg.localizedDescription) (\(UTType.jpeg.identifier)) at quality 0.5")
+#elseif canImport(WinSDK) && canImport(_Testing_WinSDK)
+      #expect(String(describing: format) == "JPEG format at 50% quality")
+      #expect(String(reflecting: format) == "JPEG format (1a34f5c1-4a5a-46dc-b644-1f4567e7a676) at quality 0.5")
+#endif
+    }
 #endif
   }
 }