Rework Async tree-sitter Model, Fix Strong Ref Cycle (#225)

Author: thecoolwinter

Package.resolved

@@ -22,7 +22,7 @@ let package = Package(
         // tree-sitter languages
         .package(
             url: "https://github.com/CodeEditApp/CodeEditLanguages.git",
-            exact: "0.1.17"
+            exact: "0.1.18"
         ),
         // SwiftLint
         .package(

Package.swift

@@ -212,7 +212,7 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
     @MainActor
     public class Coordinator: NSObject {
         var parent: CodeEditSourceEditor
-        var controller: TextViewController?
+        weak var controller: TextViewController?
         var isUpdatingFromRepresentable: Bool = false
         var isUpdateFromTextView: Bool = false
 

Sources/CodeEditSourceEditor/CodeEditSourceEditor.swift

@@ -15,11 +15,11 @@ extension TextViewController {
         for range in textView.selectionManager.textSelections.map({ $0.range }) {
             if range.isEmpty,
                range.location > 0, // Range is not the beginning of the document
-               let preceedingCharacter = textView.textStorage.substring(
+               let precedingCharacter = textView.textStorage.substring(
                 from: NSRange(location: range.location - 1, length: 1) // The preceding character exists
                ) {
                 for pair in BracketPairs.allValues {
-                    if preceedingCharacter == pair.0 {
+                    if precedingCharacter == pair.0 {
                         // Walk forwards
                         if let characterIndex = findClosingPair(
                             pair.0,
@@ -34,7 +34,7 @@ extension TextViewController {
                                 highlightCharacter(range.location - 1)
                             }
                         }
-                    } else if preceedingCharacter == pair.1 && range.location - 1 > 0 {
+                    } else if precedingCharacter == pair.1 && range.location - 1 > 0 {
                         // Walk backwards
                         if let characterIndex = findClosingPair(
                             pair.1,

Sources/CodeEditSourceEditor/Controller/TextViewController+HighlightBracket.swift

@@ -32,11 +32,8 @@ extension TextViewController {
         if let highlightProvider = highlightProvider {
             provider = highlightProvider
         } else {
-            let textProvider: ResolvingQueryCursor.TextProvider = { [weak self] range, _ -> String? in
-                return self?.textView.textStorage.mutableString.substring(with: range)
-            }
-
-            provider = TreeSitterClient(textProvider: textProvider)
+            self.treeSitterClient = TreeSitterClient()
+            provider = self.treeSitterClient!
         }
 
         if let provider = provider {

Sources/CodeEditSourceEditor/Controller/TextViewController+Highlighter.swift

@@ -149,7 +149,12 @@ public class TextViewController: NSViewController {
         }
     }
 
-    internal var highlighter: Highlighter?
+    var highlighter: Highlighter?
+
+    /// The tree sitter client managed by the source editor.
+    ///
+    /// This will be `nil` if another highlighter provider is passed to the source editor.
+    internal(set) public var treeSitterClient: TreeSitterClient?
 
     private var fontCharWidth: CGFloat { (" " as NSString).size(withAttributes: [.font: font]).width }
 

Sources/CodeEditSourceEditor/Controller/TextViewController.swift

@@ -6,7 +6,7 @@
 //
 
 /// A collection of possible capture names for `tree-sitter` with their respected raw values.
-public enum CaptureName: String, CaseIterable {
+public enum CaptureName: String, CaseIterable, Sendable {
     case include
     case constructor
     case keyword

Sources/CodeEditSourceEditor/Enums/CaptureName.swift

@@ -6,27 +6,30 @@
 //
 
 import Foundation
+import CodeEditTextView
 import SwiftTreeSitter
 
 extension InputEdit {
-    init?(range: NSRange, delta: Int, oldEndPoint: Point) {
+    init?(range: NSRange, delta: Int, oldEndPoint: Point, textView: TextView) {
         let newEndLocation = NSMaxRange(range) + delta
 
         if newEndLocation < 0 {
             assertionFailure("Invalid range/delta")
             return nil
         }
 
-        // TODO: - Ask why Neon only uses .zero for these
-        let startPoint: Point = .zero
-        let newEndPoint: Point = .zero
+        let newRange = NSRange(location: range.location, length: range.length + delta)
+        let startPoint = textView.pointForLocation(newRange.location) ?? .zero
+        let newEndPoint = textView.pointForLocation(newEndLocation) ?? .zero
 
-        self.init(startByte: UInt32(range.location * 2),
-                  oldEndByte: UInt32(NSMaxRange(range) * 2),
-                  newEndByte: UInt32(newEndLocation * 2),
-                  startPoint: startPoint,
-                  oldEndPoint: oldEndPoint,
-                  newEndPoint: newEndPoint)
+        self.init(
+            startByte: UInt32(range.location * 2),
+            oldEndByte: UInt32(NSMaxRange(range) * 2),
+            newEndByte: UInt32(newEndLocation * 2),
+            startPoint: startPoint,
+            oldEndPoint: oldEndPoint,
+            newEndPoint: newEndPoint
+        )
     }
 }
 

Sources/CodeEditSourceEditor/Extensions/NSRange+/NSRange+InputEdit.swift

@@ -0,0 +1,18 @@
+//
+//  TextView+Point.swift
+//  CodeEditSourceEditor
+//
+//  Created by Khan Winter on 1/18/24.
+//
+
+import Foundation
+import CodeEditTextView
+import SwiftTreeSitter
+
+extension TextView {
+    func pointForLocation(_ location: Int) -> Point? {
+        guard let linePosition = layoutManager.textLineForOffset(location) else { return nil }
+        let column = location - linePosition.range.location
+        return Point(row: linePosition.index, column: column)
+    }
+}