Feature: Allow syntax highlighting to be disabled

Author: nanashili

Package.resolved

@@ -15,6 +15,7 @@ extension AuroraEditorSourceEditor {
         weak var controller: TextViewController?
         var isUpdatingFromRepresentable: Bool = false
         var isUpdateFromTextView: Bool = false
+        private var lastExternalText: String = ""
 
         init(parent: AuroraEditorSourceEditor) {
             self.parent = parent
@@ -61,6 +62,20 @@ extension AuroraEditorSourceEditor {
                     )
                 }
             }
+            self.isUpdateFromTextView = false
+        }
+
+        func handleExternalTextChange() {
+            guard let controller = controller,
+                  case .binding(let binding) = parent.text,
+                  binding.wrappedValue != lastExternalText else {
+                return
+            }
+
+            isUpdatingFromRepresentable = true
+            controller.textView.setText(binding.wrappedValue)
+            lastExternalText = binding.wrappedValue
+            isUpdatingFromRepresentable = false
         }
 
         deinit {

Sources/AuroraEditorSourceEditor/AuroraEditorSourceEditor/AuroraEditorSourceEditor+Coordinator.swift

@@ -33,6 +33,7 @@ public struct AuroraEditorSourceEditor: NSViewControllerRepresentable {
     ///                         background color
     ///   - highlightProvider: A class you provide to perform syntax highlighting. Leave this as `nil` to use the
     ///                        built-in `TreeSitterClient` highlighter.
+    ///   - isSyntaxHighlightingDisabled: A boolean the allows disabling the syntax highliting for better performance.
     ///   - contentInsets: Insets to use to offset the content in the enclosing scroll view. Leave as `nil` to let the
     ///                    scroll view automatically adjust content insets.
     ///   - isEditable: A Boolean value that controls whether the text view allows the user to edit text.
@@ -57,6 +58,7 @@ public struct AuroraEditorSourceEditor: NSViewControllerRepresentable {
         cursorPositions: Binding<[CursorPosition]>,
         useThemeBackground: Bool = true,
         highlightProvider: HighlightProviding? = nil,
+        isSyntaxHighlightingDisabled: Bool? = false,
         contentInsets: NSEdgeInsets? = nil,
         isEditable: Bool = true,
         isSelectable: Bool = true,
@@ -77,6 +79,7 @@ public struct AuroraEditorSourceEditor: NSViewControllerRepresentable {
         self.editorOverscroll = editorOverscroll
         self.cursorPositions = cursorPositions
         self.highlightProvider = highlightProvider
+        self.isSyntaxHighlightingDisabled = isSyntaxHighlightingDisabled
         self.contentInsets = contentInsets
         self.isEditable = isEditable
         self.isSelectable = isSelectable
@@ -126,6 +129,7 @@ public struct AuroraEditorSourceEditor: NSViewControllerRepresentable {
         cursorPositions: Binding<[CursorPosition]>,
         useThemeBackground: Bool = true,
         highlightProvider: HighlightProviding? = nil,
+        isSyntaxHighlightingDisabled: Bool? = false,
         contentInsets: NSEdgeInsets? = nil,
         isEditable: Bool = true,
         isSelectable: Bool = true,
@@ -146,6 +150,7 @@ public struct AuroraEditorSourceEditor: NSViewControllerRepresentable {
         self.editorOverscroll = editorOverscroll
         self.cursorPositions = cursorPositions
         self.highlightProvider = highlightProvider
+        self.isSyntaxHighlightingDisabled = isSyntaxHighlightingDisabled
         self.contentInsets = contentInsets
         self.isEditable = isEditable
         self.isSelectable = isSelectable
@@ -167,6 +172,7 @@ public struct AuroraEditorSourceEditor: NSViewControllerRepresentable {
     package var cursorPositions: Binding<[CursorPosition]>
     private var useThemeBackground: Bool
     private var highlightProvider: HighlightProviding?
+    private var isSyntaxHighlightingDisabled: Bool?
     private var contentInsets: NSEdgeInsets?
     private var isEditable: Bool
     private var isSelectable: Bool
@@ -191,6 +197,7 @@ public struct AuroraEditorSourceEditor: NSViewControllerRepresentable {
             editorOverscroll: editorOverscroll,
             useThemeBackground: useThemeBackground,
             highlightProvider: highlightProvider,
+            isSyntaxHighlightingDisabled: isSyntaxHighlightingDisabled,
             contentInsets: contentInsets,
             isEditable: isEditable,
             isSelectable: isSelectable,

Sources/AuroraEditorSourceEditor/AuroraEditorSourceEditor/AuroraEditorSourceEditor.swift

@@ -20,13 +20,18 @@ extension TextViewController {
             highlightProvider: highlightProvider,
             theme: theme,
             attributeProvider: self,
-            language: language
+            language: language,
+            isSyntaxHighlightingDisabled: isSyntaxHighlightingDisabled ?? false
         )
         textView.addStorageDelegate(highlighter!)
         setHighlightProvider(self.highlightProvider)
     }
 
     internal func setHighlightProvider(_ highlightProvider: HighlightProviding? = nil) {
+        if isSyntaxHighlightingDisabled == true {
+            return
+        }
+
         var provider: HighlightProviding?
 
         if let highlightProvider = highlightProvider {
@@ -36,6 +41,10 @@ extension TextViewController {
             provider = self.treeSitterClient!
         }
 
+        if isSyntaxHighlightingDisabled == true {
+            return
+        }
+
         if let provider = provider {
             self.highlightProvider = provider
             highlighter?.setHighlightProvider(provider)

Sources/AuroraEditorSourceEditor/Controller/TextViewController+Highlighter.swift

@@ -10,11 +10,26 @@ import AuroraEditorTextView
 import TextStory
 
 extension TextViewController: TextViewDelegate {
-    public func textView(_ textView: TextView, didReplaceContentsIn range: NSRange, with: String) {
+    public func textView(
+        _ textView: TextView,
+        willReplaceContentsIn range: NSRange,
+        with string: String
+    ) { }
+
+    public func textView(
+        _ textView: TextView,
+        didReplaceContentsIn range: NSRange,
+        with string: String
+    ) {
         gutterView.needsDisplay = true
+        onTextDidChange?(string)
     }
 
-    public func textView(_ textView: TextView, shouldReplaceContentsIn range: NSRange, with string: String) -> Bool {
+    public func textView(
+        _ textView: TextView,
+        shouldReplaceContentsIn range: NSRange,
+        with string: String
+    ) -> Bool {
         let mutation = TextMutation(
             string: string,
             range: range,
@@ -23,4 +38,11 @@ extension TextViewController: TextViewDelegate {
 
         return shouldApplyMutation(mutation, to: textView)
     }
+
+    func textViewDidChange(
+        _ textView: TextView,
+        newText: String
+    ) {
+        onTextDidChange?(newText)
+    }
 }

Sources/AuroraEditorSourceEditor/Controller/TextViewController+TextViewDelegate.swift

@@ -155,6 +155,8 @@ public class TextViewController: NSViewController {
 
     var highlighter: Highlighter?
 
+    var isSyntaxHighlightingDisabled: Bool?
+
     /// The tree sitter client managed by the source editor.
     ///
     /// This will be `nil` if another highlighter provider is passed to the source editor.
@@ -167,6 +169,8 @@ public class TextViewController: NSViewController {
 
     internal var cancellables = Set<AnyCancellable>()
 
+    var onTextDidChange: ((String) -> Void)?
+
     /// ScrollView's bottom inset using as editor overscroll
     private var bottomContentInsets: CGFloat {
         let height = view.frame.height
@@ -194,6 +198,7 @@ public class TextViewController: NSViewController {
         editorOverscroll: CGFloat,
         useThemeBackground: Bool,
         highlightProvider: HighlightProviding?,
+        isSyntaxHighlightingDisabled: Bool?,
         contentInsets: NSEdgeInsets?,
         isEditable: Bool,
         isSelectable: Bool,
@@ -212,6 +217,7 @@ public class TextViewController: NSViewController {
         self.editorOverscroll = editorOverscroll
         self.useThemeBackground = useThemeBackground
         self.highlightProvider = highlightProvider
+        self.isSyntaxHighlightingDisabled = isSyntaxHighlightingDisabled
         self.contentInsets = contentInsets
         self.isEditable = isEditable
         self.isSelectable = isSelectable