Merge branch 'main' into feat/override-layout-behavior

Author: thecoolwinter

Sources/CodeEditTextView/TextLineStorage/TextLineStorage.swift

@@ -58,6 +58,13 @@ public final class TextLineStorage<Data: Identifiable> {
 
     public init() { }
 
+    init(root: Node<Data>, count: Int, length: Int, height: CGFloat) {
+        self.root = root
+        self.count = count
+        self.length = length
+        self.height = height
+    }
+
     // MARK: - Public Methods
 
     /// Inserts a new line for the given range.
@@ -408,9 +415,9 @@ private extension TextLineStorage {
             } else {
                 transplant(nodeY, with: nodeY.right)
 
-                nodeY.right?.leftSubtreeCount = nodeY.leftSubtreeCount
-                nodeY.right?.leftSubtreeHeight = nodeY.leftSubtreeHeight
-                nodeY.right?.leftSubtreeOffset = nodeY.leftSubtreeOffset
+                nodeY.right?.leftSubtreeCount += nodeY.leftSubtreeCount
+                nodeY.right?.leftSubtreeHeight += nodeY.leftSubtreeHeight
+                nodeY.right?.leftSubtreeOffset += nodeY.leftSubtreeOffset
 
                 nodeY.right = nodeZ.right
                 nodeY.right?.parent = nodeY

Sources/CodeEditTextView/TextSelectionManager/TextSelectionManager+Update.swift

@@ -39,8 +39,8 @@ extension TextSelectionManager {
         }
     }
 
-    func notifyAfterEdit() {
-        updateSelectionViews()
+    public func notifyAfterEdit(force: Bool = false) {
+        updateSelectionViews(force: force)
         NotificationCenter.default.post(Notification(name: Self.selectionChangedNotification, object: self))
     }
 }

Sources/CodeEditTextView/TextSelectionManager/TextSelectionManager.swift

@@ -138,7 +138,7 @@ public class TextSelectionManager: NSObject {
 
     /// Update all selection cursors. Placing them in the correct position for each text selection and reseting the
     /// blink timer.
-    func updateSelectionViews() {
+    func updateSelectionViews(force: Bool = false) {
         guard textView?.isFirstResponder ?? false else { return }
         var didUpdate: Bool = false
 
@@ -197,7 +197,7 @@ public class TextSelectionManager: NSObject {
             }
         }
 
-        if didUpdate {
+        if didUpdate || force {
             delegate?.setNeedsDisplay()
             cursorTimer.resetTimer()
             resetSystemCursorTimers()

Sources/CodeEditTextView/TextView/TextView+ReplaceCharacters.swift

@@ -13,15 +13,23 @@ extension TextView {
     /// - Parameters:
     ///   - ranges: The ranges to replace
     ///   - string: The string to insert in the ranges.
-    public func replaceCharacters(in ranges: [NSRange], with string: String) {
+    ///   - skipUpdateSelection: Skips the selection update step
+    public func replaceCharacters(
+        in ranges: [NSRange],
+        with string: String,
+        skipUpdateSelection: Bool = false
+    ) {
         guard isEditable else { return }
         NotificationCenter.default.post(name: Self.textWillChangeNotification, object: self)
         textStorage.beginEditing()
 
+        func valid(range: NSRange, string: String) -> Bool {
+            (!range.isEmpty || !string.isEmpty) &&
+            (delegate?.textView(self, shouldReplaceContentsIn: range, with: string) ?? true)
+        }
+
         // Can't insert an empty string into an empty range. One must be not empty
-        for range in ranges.sorted(by: { $0.location > $1.location }) where
-        (!range.isEmpty || !string.isEmpty) &&
-        (delegate?.textView(self, shouldReplaceContentsIn: range, with: string) ?? true) {
+        for range in ranges.sorted(by: { $0.location > $1.location }) where valid(range: range, string: string) {
             delegate?.textView(self, willReplaceContentsIn: range, with: string)
 
             _undoManager?.registerMutation(
@@ -31,13 +39,23 @@ extension TextView {
                 in: range,
                 with: NSAttributedString(string: string, attributes: typingAttributes)
             )
-            selectionManager.didReplaceCharacters(in: range, replacementLength: (string as NSString).length)
+            if !skipUpdateSelection {
+                selectionManager.didReplaceCharacters(in: range, replacementLength: (string as NSString).length)
+            }
 
             delegate?.textView(self, didReplaceContentsIn: range, with: string)
         }
 
         textStorage.endEditing()
-        selectionManager.notifyAfterEdit()
+
+        // Cause a layout pass now that we've finished editing, if there were any edits.
+        if !ranges.isEmpty {
+            layout()
+        }
+
+        if !skipUpdateSelection {
+            selectionManager.notifyAfterEdit()
+        }
         NotificationCenter.default.post(name: Self.textDidChangeNotification, object: self)
 
         // `scrollSelectionToVisible` is a little expensive to call every time. Instead we just check if the first
@@ -51,7 +69,33 @@ extension TextView {
     /// - Parameters:
     ///   - range: The range to replace.
     ///   - string: The string to insert in the range.
-    public func replaceCharacters(in range: NSRange, with string: String) {
-        replaceCharacters(in: [range], with: string)
+    ///   - skipUpdateSelection: Skips the selection update step
+    public func replaceCharacters(
+        in range: NSRange,
+        with string: String,
+        skipUpdateSelection: Bool = false
+    ) {
+        replaceCharacters(in: [range], with: string, skipUpdateSelection: skipUpdateSelection)
+    }
+
+    /// Iterates over all text selections in the `TextView` and applies the provided callback.
+    ///
+    /// This method is typically used when you need to perform an operation on each text selection in the editor,
+    /// such as adjusting indentation, or other selection-based operations. The callback
+    /// is executed for each selection, and you can modify the selection or perform related tasks.
+    ///
+    /// - Parameters:
+    /// - callback: A closure that will be executed for each selection in the `TextView`. It takes two parameters:
+    /// a `TextView` instance, allowing access to the view's properties and methods and a
+    /// `TextSelectionManager.TextSelection` representing the current selection to operate on.
+    ///
+    /// - Note: The selections are iterated in reverse order, so modifications to earlier selections won't affect later
+    ///   ones. The method automatically calls `notifyAfterEdit()` on the `selectionManager` after all
+    ///   selections are processed.
+    public func editSelections(callback: (TextView, TextSelectionManager.TextSelection) -> Void) {
+        for textSelection in selectionManager.textSelections.reversed() {
+            callback(self, textSelection)
+        }
+        selectionManager.notifyAfterEdit(force: true)
     }
 }

Tests/CodeEditTextViewTests/TextLayoutLineStorageTests.swift

@@ -7,7 +7,12 @@ fileprivate extension CGFloat {
     }
 }
 
-final class TextLayoutLineStorageTests: XCTestCase {
+extension UUID: @retroactive Identifiable {
+    public var id: UUID { self }
+}
+
+final class TextLayoutLineStorageTests: XCTestCase { // swiftlint:disable:this type_body_length
+
     /// Creates a balanced height=3 tree useful for testing and debugging.
     /// - Returns: A new tree.
     fileprivate func createBalancedTree() -> TextLineStorage<TextLine> {
@@ -20,16 +25,16 @@ final class TextLayoutLineStorageTests: XCTestCase {
         return tree
     }
 
+    struct ChildData {
+        let length: Int
+        let count: Int
+        let height: CGFloat
+    }
+
     /// Recursively checks that the given tree has the correct metadata everywhere.
     /// - Parameter tree: The tree to check.
-    fileprivate func assertTreeMetadataCorrect(_ tree: TextLineStorage<TextLine>) throws {
-        struct ChildData {
-            let length: Int
-            let count: Int
-            let height: CGFloat
-        }
-
-        func checkChildren(_ node: TextLineStorage<TextLine>.Node<TextLine>?) -> ChildData {
+    fileprivate func assertTreeMetadataCorrect<T: Identifiable>(_ tree: TextLineStorage<T>) throws {
+        func checkChildren(_ node: TextLineStorage<T>.Node<T>?) -> ChildData {
             guard let node else { return ChildData(length: 0, count: 0, height: 0.0) }
             let leftSubtreeData = checkChildren(node.left)
             let rightSubtreeData = checkChildren(node.right)
@@ -272,4 +277,111 @@ final class TextLayoutLineStorageTests: XCTestCase {
             }
         }
     }
+
+    func test_transplantWithExistingLeftNodes() throws { // swiftlint:disable:this function_body_length
+        typealias Storage = TextLineStorage<UUID>
+        typealias Node = TextLineStorage<UUID>.Node
+        // Test that when transplanting a node with no left nodes, with a node with left nodes, that
+        // the resulting tree has valid 'left_' metadata
+        //         1
+        //       /    \
+        //     7        2
+        //            /
+        //           3     ← this will be moved, this test ensures 4 retains it's left subtree count
+        //             \
+        //              4
+        //             | |
+        //             5 6
+
+        let node5 = Node(
+            length: 5,
+            data: UUID(),
+            leftSubtreeOffset: 0,
+            leftSubtreeHeight: 0,
+            leftSubtreeCount: 0,
+            height: 1,
+            left: nil,
+            right: nil,
+            parent: nil,
+            color: .black
+        )
+
+        let node6 = Node(
+            length: 6,
+            data: UUID(),
+            leftSubtreeOffset: 0,
+            leftSubtreeHeight: 0,
+            leftSubtreeCount: 0,
+            height: 1,
+            left: nil,
+            right: nil,
+            parent: nil,
+            color: .black
+        )
+
+        let node4 = Node(
+            length: 4,
+            data: UUID(),
+            leftSubtreeOffset: 5,
+            leftSubtreeHeight: 1,
+            leftSubtreeCount: 1, // node5 is on the left
+            height: 1,
+            left: node5,
+            right: node6,
+            parent: nil,
+            color: .black
+        )
+        node5.parent = node4
+        node6.parent = node4
+
+        let node3 = Node(
+            length: 3,
+            data: UUID(),
+            leftSubtreeOffset: 0,
+            leftSubtreeHeight: 0,
+            leftSubtreeCount: 0,
+            height: 1,
+            left: nil,
+            right: node4,
+            parent: nil,
+            color: .black
+        )
+        node4.parent = node3
+
+        let node2 = Node(
+            length: 2,
+            data: UUID(),
+            leftSubtreeOffset: 18,
+            leftSubtreeHeight: 4,
+            leftSubtreeCount: 4, // node3 is on the left
+            height: 1,
+            left: node3,
+            right: nil,
+            parent: nil,
+            color: .black
+        )
+        node3.parent = node2
+
+        let node7 = Node(length: 7, data: UUID(), height: 1)
+
+        let node1 = Node(
+            length: 1,
+            data: UUID(),
+            leftSubtreeOffset: 7,
+            leftSubtreeHeight: 1,
+            leftSubtreeCount: 1,
+            height: 1,
+            left: node7,
+            right: node2,
+            parent: nil,
+            color: .black
+        )
+        node2.parent = node1
+
+        let storage = Storage(root: node1, count: 7, length: 28, height: 7)
+
+        storage.delete(lineAt: 7) // Delete the root
+
+        try assertTreeMetadataCorrect(storage)
+    }
 }