Use System Cursor (#251)

Author: thecoolwinter

Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -19,6 +19,7 @@ struct ContentView: View {
     @State private var font: NSFont = NSFont.monospacedSystemFont(ofSize: 12, weight: .regular)
     @AppStorage("wrapLines") private var wrapLines: Bool = true
     @State private var cursorPositions: [CursorPosition] = []
+    @AppStorage("systemCursor") private var useSystemCursor: Bool = false
 
     init(document: Binding<CodeEditSourceEditorExampleDocument>, fileURL: URL?) {
         self._document = document
@@ -32,6 +33,13 @@ struct ContentView: View {
                 LanguagePicker(language: $language)
                     .frame(maxWidth: 100)
                 Toggle("Wrap Lines", isOn: $wrapLines)
+                if #available(macOS 14, *) {
+                    Toggle("Use System Cursor", isOn: $useSystemCursor)
+                } else {
+                    Toggle("Use System Cursor", isOn: $useSystemCursor)
+                        .disabled(true)
+                        .help("macOS 14 required")
+                }
                 Spacer()
                 Text(getLabel(cursorPositions))
             }
@@ -47,7 +55,8 @@ struct ContentView: View {
                 tabWidth: 4,
                 lineHeight: 1.2,
                 wrapLines: wrapLines,
-                cursorPositions: $cursorPositions
+                cursorPositions: $cursorPositions,
+                useSystemCursor: useSystemCursor
             )
         }
         .onAppear {

Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample/Views/ContentView.swift

@@ -42,6 +42,7 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
     ///                    character's width between characters, etc. Defaults to `1.0`
     ///   - bracketPairHighlight: The type of highlight to use to highlight bracket pairs.
     ///                           See `BracketPairHighlight` for more information. Defaults to `nil`
+    ///   - useSystemCursor: If true, uses the system cursor on `>=macOS 14`.
     ///   - undoManager: The undo manager for the text view. Defaults to `nil`, which will create a new CEUndoManager
     ///   - coordinators: Any text coordinators for the view to use. See ``TextViewCoordinator`` for more information.
     public init(
@@ -62,6 +63,7 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
         isSelectable: Bool = true,
         letterSpacing: Double = 1.0,
         bracketPairHighlight: BracketPairHighlight? = nil,
+        useSystemCursor: Bool = true,
         undoManager: CEUndoManager? = nil,
         coordinators: [any TextViewCoordinator] = []
     ) {
@@ -82,6 +84,11 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
         self.isSelectable = isSelectable
         self.letterSpacing = letterSpacing
         self.bracketPairHighlight = bracketPairHighlight
+        if #available(macOS 14, *) {
+            self.useSystemCursor = useSystemCursor
+        } else {
+            self.useSystemCursor = false
+        }
         self.undoManager = undoManager
         self.coordinators = coordinators
     }
@@ -131,6 +138,7 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
         isSelectable: Bool = true,
         letterSpacing: Double = 1.0,
         bracketPairHighlight: BracketPairHighlight? = nil,
+        useSystemCursor: Bool = true,
         undoManager: CEUndoManager? = nil,
         coordinators: [any TextViewCoordinator] = []
     ) {
@@ -151,6 +159,11 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
         self.isSelectable = isSelectable
         self.letterSpacing = letterSpacing
         self.bracketPairHighlight = bracketPairHighlight
+        if #available(macOS 14, *) {
+            self.useSystemCursor = useSystemCursor
+        } else {
+            self.useSystemCursor = false
+        }
         self.undoManager = undoManager
         self.coordinators = coordinators
     }
@@ -172,6 +185,7 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
     private var isSelectable: Bool
     private var letterSpacing: Double
     private var bracketPairHighlight: BracketPairHighlight?
+    private var useSystemCursor: Bool
     private var undoManager: CEUndoManager?
     package var coordinators: [any TextViewCoordinator]
 
@@ -195,6 +209,7 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
             isEditable: isEditable,
             isSelectable: isSelectable,
             letterSpacing: letterSpacing,
+            useSystemCursor: useSystemCursor,
             bracketPairHighlight: bracketPairHighlight,
             undoManager: undoManager
         )
@@ -238,6 +253,15 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
             return
         }
 
+        updateControllerParams(controller: controller)
+
+        controller.reloadUI()
+        return
+    }
+
+    /// Update the parameters of the controller.
+    /// - Parameter controller: The controller to update.
+    func updateControllerParams(controller: TextViewController) {
         if controller.font != font {
             controller.font = font
         }
@@ -276,12 +300,16 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
             controller.letterSpacing = letterSpacing
         }
 
-        controller.bracketPairHighlight = bracketPairHighlight
+        if controller.useSystemCursor != useSystemCursor {
+            controller.useSystemCursor = useSystemCursor
+        }
 
-        controller.reloadUI()
-        return
+        controller.bracketPairHighlight = bracketPairHighlight
     }
 
+    /// Checks if the controller needs updating.
+    /// - Parameter controller: The controller to check.
+    /// - Returns: True, if the controller's parameters should be updated.
     func paramsAreEqual(controller: NSViewControllerType) -> Bool {
         controller.font == font &&
         controller.isEditable == isEditable &&
@@ -296,7 +324,8 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
         controller.indentOption == indentOption &&
         controller.tabWidth == tabWidth &&
         controller.letterSpacing == letterSpacing &&
-        controller.bracketPairHighlight == bracketPairHighlight
+        controller.bracketPairHighlight == bracketPairHighlight &&
+        controller.useSystemCursor == useSystemCursor
     }
 }
 

Package.resolved

@@ -153,6 +153,18 @@ public class TextViewController: NSViewController {
         }
     }
 
+    /// If true, uses the system cursor on macOS 14 or greater.
+    public var useSystemCursor: Bool {
+        get {
+            textView.useSystemCursor
+        }
+        set {
+            if #available(macOS 14, *) {
+                textView.useSystemCursor = newValue
+            }
+        }
+    }
+
     var highlighter: Highlighter?
 
     /// The tree sitter client managed by the source editor.
@@ -198,6 +210,7 @@ public class TextViewController: NSViewController {
         isEditable: Bool,
         isSelectable: Bool,
         letterSpacing: Double,
+        useSystemCursor: Bool,
         bracketPairHighlight: BracketPairHighlight?,
         undoManager: CEUndoManager? = nil
     ) {
@@ -221,6 +234,13 @@ public class TextViewController: NSViewController {
 
         super.init(nibName: nil, bundle: nil)
 
+        let platformGuardedSystemCursor: Bool
+        if #available(macOS 14, *) {
+            platformGuardedSystemCursor = useSystemCursor
+        } else {
+            platformGuardedSystemCursor = false
+        }
+
         self.textView = TextView(
             string: string,
             font: font,
@@ -230,6 +250,7 @@ public class TextViewController: NSViewController {
             isEditable: isEditable,
             isSelectable: isSelectable,
             letterSpacing: letterSpacing,
+            useSystemCursor: platformGuardedSystemCursor,
             delegate: self
         )
     }

Sources/CodeEditSourceEditor/CodeEditSourceEditor/CodeEditSourceEditor.swift

@@ -47,6 +47,7 @@ final class TagEditingTests: XCTestCase {
             isEditable: true,
             isSelectable: true,
             letterSpacing: 1.0,
+            useSystemCursor: false,
             bracketPairHighlight: .flash
         )
         let tsClient = TreeSitterClient(executor: .init(forceSync: true))

Sources/CodeEditSourceEditor/Controller/TextViewController.swift

@@ -47,6 +47,7 @@ final class TextViewControllerTests: XCTestCase {
             isEditable: true,
             isSelectable: true,
             letterSpacing: 1.0,
+            useSystemCursor: false,
             bracketPairHighlight: .flash
         )