v0.3.5: fix caret and HUD drift

Author: manitofigh

Sources/Spotlight/MultilineEditor.swift

@@ -835,17 +835,14 @@ final class PlaceholderTextView: NSTextView {
   /// layout manager centers glyphs inside that fragment, so the caret uses
   /// the same vertical inset.
   override func drawInsertionPoint(in rect: NSRect, color: NSColor, turnedOn flag: Bool) {
-    let rect = normalizedInsertionPointRect(rect)
-    let caretFont = font ?? .systemFont(ofSize: 14)
-    let fontHeight = caretFont.ascender - caretFont.descender
-    let centeredGlyphInset = max(0, rect.height - fontHeight) / 2
+    let displayRect = insertionPointDisplayRect(for: rect, turnedOn: flag)
     if vimEngine?.mode == .normal {
-      let blockWidth = max(rect.width, 8)
+      let blockWidth = max(displayRect.width, 8)
       let blockRect = NSRect(
-        x: rect.origin.x,
-        y: rect.origin.y + centeredGlyphInset,
+        x: displayRect.origin.x,
+        y: displayRect.origin.y,
         width: blockWidth,
-        height: fontHeight
+        height: displayRect.height
       )
       guard flag else {
         invalidateInsertionPointRect(blockRect)
@@ -855,14 +852,33 @@ final class PlaceholderTextView: NSTextView {
       color.withAlphaComponent(0.4).setFill()
       blockRect.fill()
     } else {
-      let shrunk = NSRect(
-        x: rect.origin.x,
-        y: rect.origin.y + centeredGlyphInset,
-        width: rect.width,
-        height: fontHeight
-      )
-      super.drawInsertionPoint(in: shrunk, color: color, turnedOn: flag)
+      super.drawInsertionPoint(in: displayRect, color: color, turnedOn: flag)
+      if flag {
+        lastInsertionPointDisplayRect = displayRect
+      } else {
+        invalidateInsertionPointRect(displayRect)
+      }
+    }
+  }
+
+  func insertionPointDisplayRect(for rect: NSRect, turnedOn flag: Bool) -> NSRect {
+    if !flag, let lastInsertionPointDisplayRect {
+      return lastInsertionPointDisplayRect
     }
+    let baseRect = flag ? normalizedInsertionPointRect(rect) : rect
+    return shrinkInsertionPointRectToFont(baseRect)
+  }
+
+  private func shrinkInsertionPointRectToFont(_ rect: NSRect) -> NSRect {
+    let caretFont = font ?? .systemFont(ofSize: 14)
+    let fontHeight = caretFont.ascender - caretFont.descender
+    let centeredGlyphInset = max(0, rect.height - fontHeight) / 2
+    return NSRect(
+      x: rect.origin.x,
+      y: rect.origin.y + centeredGlyphInset,
+      width: rect.width,
+      height: fontHeight
+    )
   }
 
   private func invalidateInsertionPointRect(_ rect: NSRect) {

Sources/Spotlight/SpotlightWindow.swift

@@ -70,6 +70,14 @@ public final class SpotlightWindowController {
     }
   }
   private var navAnchor: NavAnchorState = .none
+  private struct MeasuredHeightCache {
+    let text: String
+    let maxVisibleLines: Int
+    let chromeAbove: CGFloat
+    let chromeBelow: CGFloat
+    let height: CGFloat
+  }
+
   /// Screen-space `y` of the editor card's top edge. Every non-nav
   /// resize (tutorial toggle, editor text growth) keeps this point
   /// fixed so the editor never visually jumps. Reset to nil on every
@@ -78,6 +86,8 @@ public final class SpotlightWindowController {
   /// what snaps the drifted-during-cycling editor back to its rest
   /// position the moment the user starts typing again.
   private var editorTopY: CGFloat?
+  private var measuredHeightCache: MeasuredHeightCache?
+  private var programmaticFrameToIgnore: NSRect?
   private var cancellables: Set<AnyCancellable> = []
 
   /// Layout above the editor card inside the panel (find bar + tutorial
@@ -108,9 +118,24 @@ public final class SpotlightWindowController {
   /// Total panel height SwiftUI will render with the current state.
   /// Mirrors `SpotlightRootView.extraChromeHeight + editor`.
   private var expectedPanelHeight: CGFloat {
+    let chromeAbove = chromeAboveEditor
+    let chromeBelow = chromeBelowEditor
+    if let measuredHeightCache {
+      if hasMeasuredHeight(forChromeAbove: chromeAbove, chromeBelow: chromeBelow) {
+        return measuredHeightCache.height
+      }
+    }
     let lines = EditorMetrics.lineCount(in: session.currentText)
     let editor = EditorMetrics.panelHeight(forLines: lines, maxLines: preferences.maxVisibleLines)
-    return editor + chromeAboveEditor + chromeBelowEditor
+    return editor + chromeAbove + chromeBelow
+  }
+
+  private func hasMeasuredHeight(forChromeAbove chromeAbove: CGFloat, chromeBelow: CGFloat) -> Bool {
+    guard let measuredHeightCache else { return false }
+    return measuredHeightCache.text == session.currentText
+      && measuredHeightCache.maxVisibleLines == preferences.maxVisibleLines
+      && measuredHeightCache.chromeAbove == chromeAbove
+      && measuredHeightCache.chromeBelow == chromeBelow
   }
 
   public init(
@@ -249,7 +274,7 @@ public final class SpotlightWindowController {
       pinnedTopY = top
     }
     let x = (screenFrame.midX - panel.frame.width / 2).rounded()
-    panel.setFrame(
+    setPanelFrame(
       NSRect(x: x, y: top - height, width: panel.frame.width, height: height),
       display: false
     )
@@ -270,12 +295,12 @@ public final class SpotlightWindowController {
     panel.isOpaque = false
     panel.backgroundColor = .clear
     panel.hasShadow = true
-    panel.level = .floating
+    panel.level = Self.panelLevel
     panel.isFloatingPanel = true
     panel.hidesOnDeactivate = false
     panel.becomesKeyOnlyIfNeeded = false
     panel.isMovableByWindowBackground = true
-    panel.collectionBehavior = [.canJoinAllSpaces, .fullScreenAuxiliary]
+    panel.collectionBehavior = Self.panelCollectionBehavior
     panel.contentView = NSHostingView(
       rootView: SpotlightRootView(
         focusTrigger: focusTrigger,
@@ -332,7 +357,10 @@ public final class SpotlightWindowController {
     guard dx <= Self.driftCorrectionThreshold, dy <= Self.driftCorrectionThreshold else {
       return
     }
-    panel.setFrameOrigin(target)
+    setPanelFrame(
+      NSRect(origin: target, size: panel.frame.size),
+      display: true
+    )
   }
 
   private func setPanelHeight(_ height: CGFloat, animated: Bool) {
@@ -356,14 +384,42 @@ public final class SpotlightWindowController {
       width: current.size.width,
       height: height
     )
-    panel.setFrame(newFrame, display: true, animate: animated)
+    measuredHeightCache = MeasuredHeightCache(
+      text: session.currentText,
+      maxVisibleLines: preferences.maxVisibleLines,
+      chromeAbove: chromeAbove,
+      chromeBelow: chromeBelowEditor,
+      height: height
+    )
+    setPanelFrame(newFrame, display: true, animate: animated)
     if case .pendingFirstResize = navAnchor {
       // The overlay is now on screen. Lock its bottom edge for every
       // subsequent cycle.
       navAnchor = .bottomPinned(newY)
     }
   }
 
+  private func setPanelFrame(_ frame: NSRect, display: Bool, animate: Bool = false) {
+    guard let panel else { return }
+    programmaticFrameToIgnore = frame
+    panel.setFrame(frame, display: display, animate: animate)
+  }
+
+  private func shouldIgnoreProgrammaticMove(_ frame: NSRect) -> Bool {
+    guard let expected = programmaticFrameToIgnore else { return false }
+    guard Self.rect(frame, isApproximatelyEqualTo: expected) else { return false }
+    programmaticFrameToIgnore = nil
+    return true
+  }
+
+  private static func rect(_ lhs: NSRect, isApproximatelyEqualTo rhs: NSRect) -> Bool {
+    let tolerance: CGFloat = 0.5
+    return abs(lhs.origin.x - rhs.origin.x) <= tolerance
+      && abs(lhs.origin.y - rhs.origin.y) <= tolerance
+      && abs(lhs.size.width - rhs.size.width) <= tolerance
+      && abs(lhs.size.height - rhs.size.height) <= tolerance
+  }
+
 }
 
 extension SpotlightWindowController {
@@ -405,6 +461,7 @@ extension SpotlightWindowController {
       ) { [weak self, weak panel] _ in
         MainActor.assumeIsolated {
           guard let self, let panel else { return }
+          if self.shouldIgnoreProgrammaticMove(panel.frame) { return }
           let newTop = panel.frame.origin.y + panel.frame.size.height
           self.pinnedTopY = newTop
           self.editorTopY = newTop - self.chromeAboveEditor

Tests/SpotlightTests/LineHeightConsistencyTests.swift

@@ -116,9 +116,6 @@ struct LineHeightConsistencyTests {
       useFixedLayoutManager: true
     )
     #expect(lines.count == 4)
-    let gap12 = (lines[2].baseline - lines[1].baseline * 100).rounded() / 100
-    let gap23 = (lines[3].baseline - lines[2].baseline * 100).rounded() / 100
-    // Use the actual computed gaps, not the intermediate expression
     let realGap12 = lines[2].baseline - lines[1].baseline
     let realGap23 = lines[3].baseline - lines[2].baseline
     #expect(
@@ -131,10 +128,6 @@ struct LineHeightConsistencyTests {
   func multipleEmptyLines() {
     let lines = layoutLines(for: "A\n\n\n\nB\n")
     #expect(lines.count == 5)
-    var gaps: [CGFloat] = []
-    for i in 1..<lines.count {
-      gaps.append((lines[i].baseline - lines[i - 1].baseline * 100).rounded() / 100)
-    }
     let realGaps = (1..<lines.count).map {
       lines[$0].baseline - lines[$0 - 1].baseline
     }

Tests/SpotlightTests/MultilineEditorTokenTests.swift

@@ -341,6 +341,29 @@ struct MultilineEditorChecklistToggleTests {
     #expect(textView.string == "prefix ☑ cursor placement")
   }
 
+  @Test("caret erase uses previously painted rect after selection moves")
+  func caretEraseUsesPreviousPaintedRectAfterSelectionMoves() {
+    let textView = makeChecklistTextView(text: "old caret\nnew caret")
+    textView.setSelectedRange(NSRange(location: 3, length: 0))
+
+    let painted = textView.insertionPointDisplayRect(
+      for: NSRect(x: 30, y: 0, width: 1, height: EditorMetrics.lineHeight),
+      turnedOn: true
+    )
+    let image = NSImage(size: NSSize(width: 240, height: 80))
+    image.lockFocus()
+    defer { image.unlockFocus() }
+    textView.drawInsertionPoint(in: painted, color: .labelColor, turnedOn: true)
+    textView.setSelectedRange(NSRange(location: (textView.string as NSString).length, length: 0))
+
+    let erase = textView.insertionPointDisplayRect(
+      for: NSRect(x: 160, y: EditorMetrics.lineHeight, width: 1, height: EditorMetrics.lineHeight),
+      turnedOn: false
+    )
+
+    #expect(erase == painted)
+  }
+
   private func makeChecklistTextView(text: String) -> PlaceholderTextView {
     let textView = PlaceholderTextView(frame: NSRect(x: 0, y: 0, width: EditorMetrics.panelWidth, height: 200))
     textView.font = .systemFont(ofSize: EditorMetrics.fontSize)