Merge branch 'fix/invalidation' into feat/override-layout-behavior

Author: thecoolwinter

Sources/CodeEditTextView/TextLayoutManager/TextLayoutManager+Edits.swift

@@ -45,7 +45,8 @@ extension TextLayoutManager: NSTextStorageDelegate {
         let insertedStringRange = NSRange(location: editedRange.location, length: editedRange.length - delta)
         removeLayoutLinesIn(range: insertedStringRange)
         insertNewLines(for: editedRange)
-        invalidateLayoutForRange(editedRange)
+
+        setNeedsLayout()
     }
 
     /// Removes all lines in the range, as if they were deleted. This is a setup for inserting the lines back in on an
@@ -65,10 +66,10 @@ extension TextLayoutManager: NSTextStorageDelegate {
                 lineStorage.delete(lineAt: nextLine.range.location)
                 let delta = -intersection.length + nextLine.range.length
                 if delta != 0 {
-                    lineStorage.update(atIndex: linePosition.range.location, delta: delta, deltaHeight: 0)
+                    lineStorage.update(atOffset: linePosition.range.location, delta: delta, deltaHeight: 0)
                 }
             } else {
-                lineStorage.update(atIndex: linePosition.range.location, delta: -intersection.length, deltaHeight: 0)
+                lineStorage.update(atOffset: linePosition.range.location, delta: -intersection.length, deltaHeight: 0)
             }
         }
     }
@@ -100,7 +101,7 @@ extension TextLayoutManager: NSTextStorageDelegate {
             if location == lineStorage.length {
                 // Insert a new line at the end of the document, need to insert a new line 'cause there's nothing to
                 // split. Also, append the new text to the last line.
-                lineStorage.update(atIndex: location, delta: insertedString.length, deltaHeight: 0.0)
+                lineStorage.update(atOffset: location, delta: insertedString.length, deltaHeight: 0.0)
                 lineStorage.insert(
                     line: TextLine(),
                     atOffset: location + insertedString.length,
@@ -114,7 +115,7 @@ extension TextLayoutManager: NSTextStorageDelegate {
                 let splitLength = linePosition.range.max - location
                 let lineDelta = insertedString.length - splitLength // The difference in the line being edited
                 if lineDelta != 0 {
-                    lineStorage.update(atIndex: location, delta: lineDelta, deltaHeight: 0.0)
+                    lineStorage.update(atOffset: location, delta: lineDelta, deltaHeight: 0.0)
                 }
 
                 lineStorage.insert(
@@ -125,7 +126,7 @@ extension TextLayoutManager: NSTextStorageDelegate {
                 )
             }
         } else {
-            lineStorage.update(atIndex: location, delta: insertedString.length, deltaHeight: 0.0)
+            lineStorage.update(atOffset: location, delta: insertedString.length, deltaHeight: 0.0)
         }
     }
 }

Sources/CodeEditTextView/TextLayoutManager/TextLayoutManager+Invalidation.swift

@@ -14,7 +14,8 @@ extension TextLayoutManager {
         for linePosition in lineStorage.linesStartingAt(rect.minY, until: rect.maxY) {
             linePosition.data.setNeedsLayout()
         }
-        layoutLines()
+
+        layoutView?.needsLayout = true
     }
 
     /// Invalidates layout for the given range of text.
@@ -24,11 +25,12 @@ extension TextLayoutManager {
             linePosition.data.setNeedsLayout()
         }
 
-        layoutLines()
+        layoutView?.needsLayout = true
     }
 
     public func setNeedsLayout() {
         needsLayout = true
         visibleLineIds.removeAll(keepingCapacity: true)
+        layoutView?.needsLayout = true
     }
 }

Sources/CodeEditTextView/TextLayoutManager/TextLayoutManager+Layout.swift

@@ -1,13 +1,20 @@
 //
-//  File.swift
+//  TextLayoutManager+ensureLayout.swift
 //  CodeEditTextView
 //
-//  Created by Khan Winter on 4/10/25.
+//  Created by Khan Winter on 4/7/25.
 //
 
 import AppKit
 
 extension TextLayoutManager {
+    /// Contains all data required to perform layout on a text line.
+    private struct LineLayoutData {
+        let minY: CGFloat
+        let maxY: CGFloat
+        let maxWidth: CGFloat
+    }
+
     /// Asserts that the caller is not in an active layout pass.
     /// See docs on ``isInLayout`` for more details.
     private func assertNotInLayout() {
@@ -60,7 +67,7 @@ extension TextLayoutManager {
                 )
                 if lineSize.height != linePosition.height {
                     lineStorage.update(
-                        atIndex: linePosition.range.location,
+                        atOffset: linePosition.range.location,
                         delta: 0,
                         deltaHeight: lineSize.height - linePosition.height
                     )
@@ -200,7 +207,7 @@ extension TextLayoutManager {
     /// Invalidates and prepares a line position for display.
     /// - Parameter position: The line position to prepare.
     /// - Returns: The height of the newly laid out line and all it's fragments.
-    package func preparePositionForDisplay(_ position: TextLineStorage<TextLine>.TextLinePosition) -> CGFloat {
+    func preparePositionForDisplay(_ position: TextLineStorage<TextLine>.TextLinePosition) -> CGFloat {
         guard let textStorage else { return 0 }
         let displayData = TextLine.DisplayData(
             maxWidth: maxLineLayoutWidth,

Sources/CodeEditTextView/TextLayoutManager/TextLayoutManager+Public.swift

@@ -121,10 +121,7 @@ extension TextLayoutManager {
             return nil
         }
         if linePosition.data.lineFragments.isEmpty {
-            let newHeight = preparePositionForDisplay(linePosition)
-            if linePosition.height != newHeight {
-                delegate?.layoutManagerHeightDidUpdate(newHeight: lineStorage.height)
-            }
+            ensureLayoutUntil(offset)
         }
 
         guard let fragmentPosition = linePosition.data.typesetter.lineFragments.getLine(
@@ -293,7 +290,7 @@ extension TextLayoutManager {
             let height = preparePositionForDisplay(linePosition)
             if height != linePosition.height {
                 lineStorage.update(
-                    atIndex: linePosition.range.location,
+                    atOffset: linePosition.range.location,
                     delta: 0,
                     deltaHeight: height - linePosition.height
                 )

Sources/CodeEditTextView/TextLayoutManager/TextLayoutManager.swift

@@ -101,13 +101,6 @@ public class TextLayoutManager: NSObject {
         (delegate?.textViewportSize().width ?? .greatestFiniteMagnitude) - edgeInsets.horizontal
     }
 
-    /// Contains all data required to perform layout on a text line.
-    struct LineLayoutData {
-        let minY: CGFloat
-        let maxY: CGFloat
-        let maxWidth: CGFloat
-    }
-
     // MARK: - Init
 
     /// Initialize a text layout manager and prepare it for use.

Sources/CodeEditTextView/TextLineStorage/TextLineStorage.swift

@@ -190,26 +190,29 @@ public final class TextLineStorage<Data: Identifiable> {
     /// - Complexity `O(m log n)` where `m` is the number of lines that need to be deleted as a result of this update.
     ///              and `n` is the number of lines stored in the tree.
     /// - Parameters:
-    ///   - index: The index where the edit began
+    ///   - offset: The offset where the edit began
     ///   - delta: The change in length of the document. Negative for deletes, positive for insertions.
     ///   - deltaHeight: The change in height of the document.
-    public func update(atIndex index: Int, delta: Int, deltaHeight: CGFloat) {
-        assert(index >= 0 && index <= self.length, "Invalid index, expected between 0 and \(self.length). Got \(index)")
+    public func update(atOffset offset: Int, delta: Int, deltaHeight: CGFloat) {
+        assert(
+            offset >= 0 && offset <= self.length,
+            "Invalid index, expected between 0 and \(self.length). Got \(offset)"
+        )
         assert(delta != 0 || deltaHeight != 0, "Delta must be non-0")
         let position: NodePosition?
-        if index == self.length { // Updates at the end of the document are valid
+        if offset == self.length { // Updates at the end of the document are valid
             position = lastNode
         } else {
-            position = search(for: index)
+            position = search(for: offset)
         }
         guard let position else {
-            assertionFailure("No line found at index \(index)")
+            assertionFailure("No line found at index \(offset)")
             return
         }
         if delta < 0 {
             assert(
-                index - position.textPos > delta,
-                "Delta too large. Deleting \(-delta) from line at position \(index) extends beyond the line's range."
+                offset - position.textPos > delta,
+                "Delta too large. Deleting \(-delta) from line at position \(offset) extends beyond the line's range."
             )
         }
         length += delta

Sources/CodeEditTextView/TextView/TextView+Layout.swift

@@ -9,8 +9,8 @@ import Foundation
 
 extension TextView {
     override public func layout() {
-        layoutManager.layoutLines()
         super.layout()
+        layoutManager.layoutLines()
     }
 
     open override class var isCompatibleWithResponsiveScrolling: Bool {

Sources/CodeEditTextView/TextView/TextView+SetText.swift

@@ -27,9 +27,16 @@ extension TextView {
         textStorage.addAttributes(typingAttributes, range: documentRange)
         layoutManager.textStorage = textStorage
         layoutManager.reset()
+        storageDelegate.addDelegate(layoutManager)
 
         selectionManager.textStorage = textStorage
         selectionManager.setSelectedRanges(selectionManager.textSelections.map { $0.range })
+        NotificationCenter.default.post(
+            Notification(
+                name: TextSelectionManager.selectionChangedNotification,
+                object: selectionManager
+            )
+        )
 
         _undoManager?.clearStack()
 

Tests/CodeEditTextViewTests/TextLayoutLineStorageTests.swift

@@ -89,7 +89,7 @@ final class TextLayoutLineStorageTests: XCTestCase {
 
         // Single Element
         tree.insert(line: TextLine(), atOffset: 0, length: 1, height: 1.0)
-        tree.update(atIndex: 0, delta: 20, deltaHeight: 5.0)
+        tree.update(atOffset: 0, delta: 20, deltaHeight: 5.0)
         XCTAssertEqual(tree.length, 21, "Tree length incorrect")
         XCTAssertEqual(tree.count, 1, "Tree count incorrect")
         XCTAssertEqual(tree.height, 6, "Tree height incorrect")
@@ -98,7 +98,7 @@ final class TextLayoutLineStorageTests: XCTestCase {
 
         // Update First
         tree = createBalancedTree()
-        tree.update(atIndex: 0, delta: 12, deltaHeight: -0.5)
+        tree.update(atOffset: 0, delta: 12, deltaHeight: -0.5)
         XCTAssertEqual(tree.height, 14.5, "Tree height incorrect")
         XCTAssertEqual(tree.count, 15, "Tree count changed")
         XCTAssertEqual(tree.length, 132, "Tree length incorrect")
@@ -107,7 +107,7 @@ final class TextLayoutLineStorageTests: XCTestCase {
 
         // Update Last
         tree = createBalancedTree()
-        tree.update(atIndex: tree.length - 1, delta: -14, deltaHeight: 1.75)
+        tree.update(atOffset: tree.length - 1, delta: -14, deltaHeight: 1.75)
         XCTAssertEqual(tree.height, 16.75, "Tree height incorrect")
         XCTAssertEqual(tree.count, 15, "Tree count changed")
         XCTAssertEqual(tree.length, 106, "Tree length incorrect")
@@ -116,7 +116,7 @@ final class TextLayoutLineStorageTests: XCTestCase {
 
         // Update middle
         tree = createBalancedTree()
-        tree.update(atIndex: 45, delta: -9, deltaHeight: 1.0)
+        tree.update(atOffset: 45, delta: -9, deltaHeight: 1.0)
         XCTAssertEqual(tree.height, 16.0, "Tree height incorrect")
         XCTAssertEqual(tree.count, 15, "Tree count changed")
         XCTAssertEqual(tree.length, 111, "Tree length incorrect")
@@ -131,7 +131,7 @@ final class TextLayoutLineStorageTests: XCTestCase {
             let originalHeight = tree.height
             let originalCount = tree.count
             let originalLength = tree.length
-            tree.update(atIndex: Int.random(in: 0..<tree.length), delta: delta, deltaHeight: deltaHeight)
+            tree.update(atOffset: Int.random(in: 0..<tree.length), delta: delta, deltaHeight: deltaHeight)
             XCTAssert(originalCount == tree.count, "Tree count should not change on update")
             XCTAssert(originalHeight + deltaHeight == tree.height, "Tree height incorrect")
             XCTAssert(originalLength + delta == tree.length, "Tree length incorrect")