Use NSImageRep instead of NSImage

andrews05 · andrews05 · commit ea8180ca1b58 · 2025-05-14T21:30:01.000+12:00
diff --git a/Plug-Ins/Image Editor/ImageWindowController.swift b/Plug-Ins/Image Editor/ImageWindowController.swift
@@ -206,7 +206,7 @@ class ImageWindowController: AbstractEditor, ResourceEditor, PreviewProvider, Ex
 
     @IBAction func paste(_ sender: Any) {
         guard imageView.isEditable,
-              let image = NSPasteboard.general.readObjects(forClasses: [NSImage.self])?.first as? NSImage
+              let image = NSImage(pasteboard: .general)
         else {
             return
         }
diff --git a/Plug-Ins/NovaTools/Sprite Editor/Sprite.swift b/Plug-Ins/NovaTools/Sprite Editor/Sprite.swift
@@ -23,9 +23,9 @@ protocol WriteableSprite: Sprite {
     // Init for writing
     init(width: Int, height: Int, count: Int)
 
-    func writeSheet(_ image: NSImage, dither: Bool) -> [NSBitmapImageRep]
+    func writeSheet(_ rep: NSImageRep, dither: Bool) -> [NSBitmapImageRep]
 
-    func writeFrames(_ images: [NSImage], dither: Bool) -> [NSBitmapImageRep]
+    func writeFrames(_ reps: [NSImageRep], dither: Bool) -> [NSBitmapImageRep]
 }
 
 // Utility functions helpful for implementers
diff --git a/Plug-Ins/NovaTools/Sprite Editor/SpriteImporter.swift b/Plug-Ins/NovaTools/Sprite Editor/SpriteImporter.swift
@@ -41,8 +41,8 @@ class SpriteImporter: NSObject, NSOpenSavePanelDelegate {
         }
     }
     @objc dynamic private var directory = true
-    private var image: NSImage?
-    private var images: [NSImage]?
+    private var image: NSImageRep?
+    private var images: [NSImageRep]?
 
     override init() {
         gridX = Self.GRID_X
@@ -51,8 +51,8 @@ class SpriteImporter: NSObject, NSOpenSavePanelDelegate {
     }
 
     func beginSheetModal(for window: NSWindow,
-                         sheetCallback: @escaping(NSImage, Int, Int, Bool) -> Void,
-                         framesCallback: @escaping([NSImage], Bool) -> Void) {
+                         sheetCallback: @escaping(NSImageRep, Int, Int, Bool) -> Void,
+                         framesCallback: @escaping([NSImageRep], Bool) -> Void) {
         self.reset()
         let panel = NSOpenPanel()
         panel.allowedFileTypes = ["public.image"]
@@ -74,8 +74,8 @@ class SpriteImporter: NSObject, NSOpenSavePanelDelegate {
     }
 
     func beginSheetModal(for window: NSWindow,
-                         with image: NSImage,
-                         sheetCallback: @escaping(NSImage, Int, Int, Bool) -> Void) {
+                         with image: NSImageRep,
+                         sheetCallback: @escaping(NSImageRep, Int, Int, Bool) -> Void) {
         self.setImage(image)
         self.updateGrid()
         // The width of the options view will change when used in the open panel - reset it to an appropriate value
@@ -85,7 +85,9 @@ class SpriteImporter: NSObject, NSOpenSavePanelDelegate {
         alert.accessoryView = optionsView
         if #available(macOS 11, *) {
             // We don't really want an icon but the alert necessarily has one - on macOS 11 we can use the given image
-            alert.icon = image
+            let icon = NSImage(size: image.size)
+            icon.addRepresentation(image)
+            alert.icon = icon
             alert.messageText = ""
         } else {
             // On older systems the default app icon works better but we do need a title
@@ -107,13 +109,8 @@ class SpriteImporter: NSObject, NSOpenSavePanelDelegate {
     func panel(_ sender: Any, validate url: URL) throws {
         if directory {
             var items = try FileManager.default.contentsOfDirectory(at: url, includingPropertiesForKeys: nil, options: .skipsHiddenFiles)
-            items.sort(by: { $0.path.localizedStandardCompare($1.path) == .orderedAscending })
-            var images: [NSImage] = []
-            for item in items {
-                if let image = NSImage(contentsOf: item), image.isValid {
-                    images.append(image)
-                }
-            }
+            items.sort { $0.path.localizedStandardCompare($1.path) == .orderedAscending }
+            let images = items.compactMap(NSImageRep.init)
             guard !images.isEmpty else {
                 throw SpriteImporterError.noImages
             }
@@ -122,10 +119,10 @@ class SpriteImporter: NSObject, NSOpenSavePanelDelegate {
             guard let image else {
                 throw SpriteImporterError.unsupportedFile
             }
-            guard gridX > 0, image.representations[0].pixelsWide % gridX == 0 else {
+            guard image.pixelsWide.isMultiple(of: gridX) else {
                 throw SpriteImporterError.invalidX(gridX)
             }
-            guard gridY > 0, image.representations[0].pixelsHigh % gridY == 0 else {
+            guard image.pixelsHigh.isMultiple(of: gridY) else {
                 throw SpriteImporterError.invalidY(gridY)
             }
         }
@@ -138,7 +135,7 @@ class SpriteImporter: NSObject, NSOpenSavePanelDelegate {
             if (try? url.resourceValues(forKeys: [.isDirectoryKey]).isDirectory) == true {
                 panel.prompt = NSLocalizedString("Import Folder", comment: "")
             } else {
-                self.setImage(NSImage(contentsOf: url))
+                self.setImage(NSImageRep(contentsOf: url))
                 panel.prompt = NSLocalizedString("Import Image", comment: "")
             }
         }
@@ -151,19 +148,19 @@ class SpriteImporter: NSObject, NSOpenSavePanelDelegate {
             preview.image = nil
             return
         }
-        let width = image.representations[0].pixelsWide
-        let height = image.representations[0].pixelsHigh
-        guard gridX > 0, width % gridX == 0, gridY > 0, height % gridY == 0 else {
+        let width = image.pixelsWide
+        let height = image.pixelsHigh
+        guard width.isMultiple(of: gridX), height.isMultiple(of: gridY) else {
             frameSize.stringValue = "grid mismatch"
             preview.image = nil
             return
         }
         frameSize.stringValue = "\(width/gridX) x \(height/gridY)"
-        let size = NSSize(width: image.size.width/CGFloat(gridX), height: image.size.height/CGFloat(gridY))
-        preview.image = NSImage(size: size)
-        preview.image?.lockFocus()
-        image.draw(at: .zero, from: NSRect(x: 0, y: image.size.height-size.height, width: size.width, height: size.height), operation: .copy, fraction: 1)
-        preview.image?.unlockFocus()
+        let size = NSSize(width: width/gridX, height: height/gridY)
+        preview.image = NSImage(size: size, flipped: false) { rect in
+            let srcRect = NSRect(x: 0, y: image.size.height-size.height, width: size.width, height: size.height)
+            return image.draw(in: rect, from: srcRect, operation: .copy, fraction: 1, respectFlipped: true, hints: nil)
+        }
     }
 
     private func reset() {
@@ -175,16 +172,16 @@ class SpriteImporter: NSObject, NSOpenSavePanelDelegate {
         preview.image = nil
     }
 
-    private func setImage(_ image: NSImage?) {
+    private func setImage(_ image: NSImageRep?) {
         directory = false
         guard let image,
-              let rep = image.representations.first,
-              rep.pixelsWide > 0 && rep.pixelsHigh > 0
+              image.pixelsWide > 0 && image.pixelsHigh > 0
         else {
             imageSize.stringValue = "unsupported"
             return
         }
+        image.size = NSSize(width: image.pixelsWide, height: image.pixelsHigh)
         self.image = image
-        imageSize.stringValue = "\(rep.pixelsWide) x \(rep.pixelsHigh)"
+        imageSize.stringValue = "\(image.pixelsWide) x \(image.pixelsHigh)"
     }
 }
diff --git a/Plug-Ins/NovaTools/Sprite Editor/SpriteWindowController.swift b/Plug-Ins/NovaTools/Sprite Editor/SpriteWindowController.swift
@@ -9,7 +9,7 @@ class SpriteWindowController: AbstractEditor, ResourceEditor, PreviewProvider, E
     ]
 
     let resource: Resource
-    private var sprite: Sprite!
+    private var sprite: Sprite?
     private var frames: [NSBitmapImageRep] = []
     private var currentFrame = 0
     private var timer: Timer?
@@ -86,7 +86,8 @@ class SpriteWindowController: AbstractEditor, ResourceEditor, PreviewProvider, E
         }
         if !resource.data.isEmpty {
             do {
-                sprite = try spriteType.init(resource.data)
+                let sprite = try spriteType.init(resource.data)
+                self.sprite = sprite
                 for _ in 0..<sprite.frameCount {
                     frames.append(try sprite.readFrame())
                 }
@@ -100,8 +101,8 @@ class SpriteWindowController: AbstractEditor, ResourceEditor, PreviewProvider, E
             return
         }
         currentFrame = (currentFrame + 1) % frames.count
-        if !image.representations.isEmpty {
-            image.removeRepresentation(image.representations[0])
+        if let rep = image.representations.first {
+            image.removeRepresentation(rep)
         }
         image.addRepresentation(frames[currentFrame])
         image.size = frames[currentFrame].size
@@ -111,7 +112,7 @@ class SpriteWindowController: AbstractEditor, ResourceEditor, PreviewProvider, E
 
     private func updateView() {
         playing = false
-        if !frames.isEmpty {
+        if let sprite, !frames.isEmpty {
             // Shrink the window
             window?.setContentSize(window!.contentMinSize)
             // Expand to fit
@@ -163,33 +164,31 @@ class SpriteWindowController: AbstractEditor, ResourceEditor, PreviewProvider, E
 
     @IBAction func paste(_ sender: Any) {
         guard writeableType != nil,
-              let image = NSPasteboard.general.readObjects(forClasses: [NSImage.self])?.first as? NSImage
+              let rep = NSImageRep(pasteboard: .general)
         else {
             return
         }
-        importPanel.beginSheetModal(for: window!, with: image, sheetCallback: self.importSheet)
+        importPanel.beginSheetModal(for: window!, with: rep, sheetCallback: self.importSheet)
     }
 
-    private func importSheet(image: NSImage, gridX: Int, gridY: Int, dither: Bool) {
+    private func importSheet(rep: NSImageRep, gridX: Int, gridY: Int, dither: Bool) {
         guard let writeableType else {
             return
         }
-        let rep = image.representations[0]
         let newSprite = writeableType.init(width: rep.pixelsWide / gridX, height: rep.pixelsHigh / gridY, count: gridX * gridY)
         sprite = newSprite
-        frames = newSprite.writeSheet(image, dither: dither)
+        frames = newSprite.writeSheet(rep, dither: dither)
         self.updateView()
         self.setDocumentEdited(true)
     }
 
-    private func importFrames(images: [NSImage], dither: Bool) {
-        guard let writeableType else {
+    private func importFrames(reps: [NSImageRep], dither: Bool) {
+        guard let writeableType, let rep = reps.first else {
             return
         }
-        let rep = images[0].representations[0]
-        let newSprite = writeableType.init(width: rep.pixelsWide, height: rep.pixelsHigh, count: images.count)
+        let newSprite = writeableType.init(width: rep.pixelsWide, height: rep.pixelsHigh, count: reps.count)
         sprite = newSprite
-        frames = newSprite.writeFrames(images, dither: dither)
+        frames = newSprite.writeFrames(reps, dither: dither)
         self.updateView()
         self.setDocumentEdited(true)
     }
diff --git a/Plug-Ins/NovaTools/Sprite Editor/SpriteWorld.swift b/Plug-Ins/NovaTools/Sprite Editor/SpriteWorld.swift
@@ -127,8 +127,7 @@ class SpriteWorld: WriteableSprite {
         }
     }
 
-    func writeSheet(_ image: NSImage, dither: Bool = false) -> [NSBitmapImageRep] {
-        let rep = image.representations[0]
+    func writeSheet(_ rep: NSImageRep, dither: Bool = false) -> [NSBitmapImageRep] {
         // Reset the resolution
         rep.size = NSSize(width: rep.pixelsWide, height: rep.pixelsHigh)
         let gridX = rep.pixelsWide / frameWidth
@@ -150,10 +149,9 @@ class SpriteWorld: WriteableSprite {
         return frames
     }
 
-    func writeFrames(_ images: [NSImage], dither: Bool = false) -> [NSBitmapImageRep] {
+    func writeFrames(_ reps: [NSImageRep], dither: Bool = false) -> [NSBitmapImageRep] {
         var frames: [NSBitmapImageRep] = []
-        for image in images {
-            let rep = image.representations[0]
+        for rep in reps {
             // Reset the resolution
             rep.size = NSSize(width: rep.pixelsWide, height: rep.pixelsHigh)
             let frame = self.newFrame()

Original file line number	Diff line number	Diff line change
`@@ -206,7 +206,7 @@ class ImageWindowController: AbstractEditor, ResourceEditor, PreviewProvider, Ex`
`206`	`206`
`207`	`207`	`@IBAction func paste(_ sender: Any) {`
`208`	`208`	`guard imageView.isEditable,`
`209`		`- let image = NSPasteboard.general.readObjects(forClasses: [NSImage.self])?.first as? NSImage`
	`209`	`+ let image = NSImage(pasteboard: .general)`
`210`	`210`	`else {`
`211`	`211`	`return`
`212`	`212`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,9 +23,9 @@ protocol WriteableSprite: Sprite {`
`23`	`23`	`// Init for writing`
`24`	`24`	`init(width: Int, height: Int, count: Int)`
`25`	`25`
`26`		`- func writeSheet(_ image: NSImage, dither: Bool) -> [NSBitmapImageRep]`
	`26`	`+ func writeSheet(_ rep: NSImageRep, dither: Bool) -> [NSBitmapImageRep]`
`27`	`27`
`28`		`- func writeFrames(_ images: [NSImage], dither: Bool) -> [NSBitmapImageRep]`
	`28`	`+ func writeFrames(_ reps: [NSImageRep], dither: Bool) -> [NSBitmapImageRep]`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`// Utility functions helpful for implementers`