Handle selection UI updates on the CoreGraphics renderer

Author: migueldeicaza

Sources/SwiftTerm/Apple/TerminalRenderOwner.swift

@@ -481,6 +481,18 @@ final class TerminalRenderOwner: Sendable {
                     cursor: session.snapshot.cursor,
                     cursorRowCount: session.snapshot.rowCount,
                     scrollPosition: capturedScrollPosition)
+            } else if session.snapshot.appearanceChanged {
+                let region = request.viewState.viewBounds
+                session.snapshot.cgRegion = region
+                session.snapshot.rangeChanged = nil
+                result = TerminalView.PreparedFrame(
+                    region: region,
+                    rangeChanged: nil,
+                    notifyAccessibility: false,
+                    needsMetalDisplay: metalActive,
+                    cursor: session.snapshot.cursor,
+                    cursorRowCount: session.snapshot.rowCount,
+                    scrollPosition: capturedScrollPosition)
             } else {
                 let changed = request.viewState.notifyUpdateChanges
                     ? (start: buffer.yDisp + buffer.y, end: buffer.yDisp + buffer.y)

Sources/SwiftTerm/Apple/TerminalSnapshot.swift

@@ -325,6 +325,9 @@ final class TerminalSnapshot {
     var ansiColors: [Color] = []
     var cgRegion: CGRect?
     var rangeChanged: (start: Int, end: Int)?
+    /// True when view-dependent appearance changed without a cell-content
+    /// change. Core Graphics uses this to invalidate the visible surface.
+    private(set) var appearanceChanged = false
     /// The context that goes with this snapshot's contents, built by `refresh`
     /// from the view state it was handed. Nil until the first refresh.
     private(set) var renderContext: SnapshotRenderContext?
@@ -385,6 +388,7 @@ final class TerminalSnapshot {
             textBlinkVisible: viewState.textBlinkVisible)
         let styleChanged = previousStyle?.hasSameValue(as: newStyle) != true ||
             previousAnsiColors != terminal.ansiColors
+        appearanceChanged = styleChanged
         let bidiFont = ObjectIdentifier(viewState.fonts.normal)
         let bidiInputsChanged = previousBidiHostPolicy != viewState.bidiHostPolicy ||
             previousBidiFont != bidiFont

TerminalApp/MacTerminal/AppDelegate.swift

@@ -13,7 +13,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
     @IBOutlet var loggingMenuItem: NSMenuItem?
 
     func applicationDidFinishLaunching(_ aNotification: Notification) {
-        ResizeTrace.reset()
+        // Insert code here to initialize your application
     }
 
     func applicationWillTerminate(_ aNotification: Notification) {

TerminalApp/MacTerminal/ViewController.swift

@@ -10,50 +10,6 @@ import Cocoa
 import SwiftTerm
 import UniformTypeIdentifiers
 
-@MainActor
-enum ResizeTrace {
-    static let path = "/tmp/MacTerminal-resize.log"
-
-    private static var fileHandle: FileHandle?
-    private static var startTime = ProcessInfo.processInfo.systemUptime
-
-    static func reset() {
-        try? fileHandle?.close()
-        _ = FileManager.default.createFile(atPath: path, contents: nil)
-        fileHandle = FileHandle(forWritingAtPath: path)
-        startTime = ProcessInfo.processInfo.systemUptime
-        log("trace-start pid=\(ProcessInfo.processInfo.processIdentifier)")
-    }
-
-    static func log(_ message: String) {
-        if fileHandle == nil {
-            reset()
-            return
-        }
-        let elapsed = ProcessInfo.processInfo.systemUptime - startTime
-        let line = String(format: "%10.6f %@\n", elapsed, message)
-        guard let data = line.data(using: .utf8) else { return }
-        try? fileHandle?.write(contentsOf: data)
-        try? fileHandle?.synchronize()
-    }
-
-    static func rect(_ value: NSRect) -> String {
-        String(
-            format: "{x=%.1f y=%.1f w=%.1f h=%.1f maxX=%.1f maxY=%.1f}",
-            value.origin.x,
-            value.origin.y,
-            value.size.width,
-            value.size.height,
-            value.maxX,
-            value.maxY
-        )
-    }
-
-    static func point(_ value: NSPoint) -> String {
-        String(format: "{x=%.1f y=%.1f}", value.x, value.y)
-    }
-}
-
 private actor InputLatencyPendingFrame {
     private var awaitingNanoseconds: UInt64?
     private var recordedMilliseconds: Double?
@@ -93,17 +49,9 @@ class ViewController: NSViewController, @MainActor LocalProcessTerminalViewDeleg
     var zoomGesture: NSMagnificationGestureRecognizer?
     var postedTitle: String = ""
     var postedDirectory: String? = nil
-    private var resizeTraceObservers = [NSObjectProtocol]()
-    private var resizeTraceLastFrame: NSRect?
-    private var resizeTraceHasOriginStack = false
 
-    func sizeChanged(source: LocalProcessTerminalView, newCols: Int, newRows: Int) {
+    func sizeChanged(source _: LocalProcessTerminalView, newCols _: Int, newRows _: Int) {
         // LocalProcessTerminalView updates the PTY. Do not resize the window here.
-        let windowFrame = source.window.map { ResizeTrace.rect($0.frame) } ?? "nil"
-        ResizeTrace.log(
-            "terminal-size cols=\(newCols) rows=\(newRows) "
-                + "view=\(ResizeTrace.rect(source.frame)) window=\(windowFrame)"
-        )
     }
 
     func updateWindowTitle ()
@@ -272,7 +220,6 @@ class ViewController: NSViewController, @MainActor LocalProcessTerminalViewDeleg
     override func viewDidAppear() {
         super.viewDidAppear()
         guard let window = view.window else { return }
-        installResizeTrace(for: window)
         if let terminalWindowCloseObserver {
             NotificationCenter.default.removeObserver(terminalWindowCloseObserver)
         }
@@ -314,7 +261,7 @@ class ViewController: NSViewController, @MainActor LocalProcessTerminalViewDeleg
     }
 
     override func viewWillDisappear() {
-        removeResizeTraceObservers()
+        //terminal = nil
     }
 
     @objc
@@ -328,86 +275,8 @@ class ViewController: NSViewController, @MainActor LocalProcessTerminalViewDeleg
 
     override func viewDidLayout() {
         super.viewDidLayout()
-        recordLayoutTrace("viewDidLayout-before")
         terminal.frame = view.frame
         terminal.needsLayout = true
-        recordLayoutTrace("viewDidLayout-after")
-    }
-
-    private func installResizeTrace(for window: NSWindow) {
-        removeResizeTraceObservers()
-        resizeTraceLastFrame = window.frame
-        resizeTraceHasOriginStack = false
-        recordResizeTrace("viewDidAppear", window: window)
-
-        let center = NotificationCenter.default
-        let events: [(Notification.Name, String)] = [
-            (NSWindow.willStartLiveResizeNotification, "willStartLiveResize"),
-            (NSWindow.didResizeNotification, "didResize"),
-            (NSWindow.didMoveNotification, "didMove"),
-            (NSWindow.didEndLiveResizeNotification, "didEndLiveResize"),
-            (NSWindow.didChangeScreenNotification, "didChangeScreen"),
-            (NSWindow.didChangeBackingPropertiesNotification, "didChangeBackingProperties"),
-        ]
-
-        resizeTraceObservers = events.map { name, label in
-            center.addObserver(forName: name, object: window, queue: .main) {
-                [weak self, weak window] _ in
-                MainActor.assumeIsolated {
-                    guard let self, let window else { return }
-                    if name == NSWindow.willStartLiveResizeNotification {
-                        self.resizeTraceLastFrame = window.frame
-                        self.resizeTraceHasOriginStack = false
-                    }
-                    self.recordResizeTrace(label, window: window)
-                }
-            }
-        }
-    }
-
-    private func removeResizeTraceObservers() {
-        resizeTraceObservers.forEach(NotificationCenter.default.removeObserver)
-        resizeTraceObservers.removeAll()
-    }
-
-    private func recordResizeTrace(_ label: String, window: NSWindow) {
-        let frame = window.frame
-        let previous = resizeTraceLastFrame ?? frame
-        let delta = NSRect(
-            x: frame.minX - previous.minX,
-            y: frame.minY - previous.minY,
-            width: frame.width - previous.width,
-            height: frame.height - previous.height
-        )
-        let currentEvent = NSApp.currentEvent
-        let eventName = currentEvent.map { String(describing: $0.type) } ?? "nil"
-        let eventLocation = currentEvent.map { ResizeTrace.point($0.locationInWindow) } ?? "nil"
-        let contentFrame = window.contentView.map { ResizeTrace.rect($0.frame) } ?? "nil"
-        ResizeTrace.log(
-            "window-event=\(label) live=\(window.inLiveResize) "
-                + "frame=\(ResizeTrace.rect(frame)) delta=\(ResizeTrace.rect(delta)) "
-                + "content=\(contentFrame) mouseScreen=\(ResizeTrace.point(NSEvent.mouseLocation)) "
-                + "event=\(eventName) eventWindow=\(eventLocation) "
-                + "buttons=\(NSEvent.pressedMouseButtons)"
-        )
-
-        let originChanged = abs(frame.minX - previous.minX) > 0.01
-            || abs(frame.minY - previous.minY) > 0.01
-        if originChanged && !resizeTraceHasOriginStack {
-            resizeTraceHasOriginStack = true
-            ResizeTrace.log("first-origin-change-stack " + Thread.callStackSymbols.prefix(16).joined(separator: " <- "))
-        }
-        resizeTraceLastFrame = frame
-    }
-
-    private func recordLayoutTrace(_ label: String) {
-        let windowFrame = view.window.map { ResizeTrace.rect($0.frame) } ?? "nil"
-        ResizeTrace.log(
-            "layout=\(label) viewFrame=\(ResizeTrace.rect(view.frame)) "
-                + "viewBounds=\(ResizeTrace.rect(view.bounds)) "
-                + "terminalFrame=\(ResizeTrace.rect(terminal.frame)) "
-                + "terminalBounds=\(ResizeTrace.rect(terminal.bounds)) window=\(windowFrame)"
-        )
     }
 
     @objc @IBAction

Tests/SwiftTermTests/SelectionRedrawTests.swift

@@ -46,7 +46,12 @@ struct SelectionRedrawTests {
         #expect(view.selection.active)
 
         // No explicit markDirty: the selection change alone must wake the driver.
-        await drain(); source.tick(); await drain()
+        await drain()
+
+        let prepared = view.prepareFrame(viewState: FrameViewState(view: view))
+        #expect(prepared?.region == view.bounds)
+
+        source.tick(); await drain()
 
         let selected = view.renderOwner.inspection()
         #expect(selected.selectionActive)
@@ -66,7 +71,12 @@ struct SelectionRedrawTests {
         #expect(view.renderOwner.inspection().selectionActive)
 
         view.selection.selectNone()
-        await drain(); source.tick(); await drain()
+        await drain()
+
+        let prepared = view.prepareFrame(viewState: FrameViewState(view: view))
+        #expect(prepared?.region == view.bounds)
+
+        source.tick(); await drain()
 
         #expect(!view.renderOwner.inspection().selectionActive)
     }