Use Generic State Type, Track Scroll Position

thecoolwinter · thecoolwinter · commit 013860a24e98 · 2025-06-19T12:49:29.000-05:00
diff --git a/Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved b/Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
diff --git a/Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample/Views/ContentView.swift b/Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample/Views/ContentView.swift
@@ -19,7 +19,9 @@ struct ContentView: View {
 
     @State private var language: CodeLanguage = .default
     @State private var theme: EditorTheme = .light
-    @State private var cursorPositions: [CursorPosition] = [.init(line: 1, column: 1)]
+    @State private var editorState = SourceEditorState(
+        cursorPositions: [CursorPosition(line: 1, column: 1)]
+    )
 
     @State private var font: NSFont = NSFont.monospacedSystemFont(ofSize: 12, weight: .medium)
     @AppStorage("wrapLines") private var wrapLines: Bool = true
@@ -67,15 +69,15 @@ struct ContentView: View {
                         warningCharacters: warningCharacters
                     )
                 ),
-                cursorPositions: $cursorPositions
+                state: $editorState
             )
             .overlay(alignment: .bottom) {
                 StatusBar(
                     fileURL: fileURL,
                     document: $document,
                     wrapLines: $wrapLines,
                     useSystemCursor: $useSystemCursor,
-                    cursorPositions: $cursorPositions,
+                    state: $editorState,
                     isInLongParse: $isInLongParse,
                     language: $language,
                     theme: $theme,
diff --git a/Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample/Views/StatusBar.swift b/Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample/Views/StatusBar.swift
@@ -18,7 +18,7 @@ struct StatusBar: View {
     @Binding var document: CodeEditSourceEditorExampleDocument
     @Binding var wrapLines: Bool
     @Binding var useSystemCursor: Bool
-    @Binding var cursorPositions: [CursorPosition]
+    @Binding var state: SourceEditorState
     @Binding var isInLongParse: Bool
     @Binding var language: CodeLanguage
     @Binding var theme: EditorTheme
@@ -100,9 +100,9 @@ struct StatusBar: View {
                             .controlSize(.small)
                         Text("Parsing Document")
                     }
-                } else {
-                    Text(getLabel(cursorPositions))
                 }
+                scrollPosition
+                Text(getLabel(state.cursorPositions))
             }
             .foregroundStyle(.secondary)
             Divider()
@@ -133,6 +133,14 @@ struct StatusBar: View {
         }
     }
 
+    @ViewBuilder private var scrollPosition: some View {
+        Text("{")
+        + Text(Double(state.scrollPosition?.x ?? -1), format: .number.precision(.fractionLength(1)))
+        + Text(",")
+        + Text(Double(state.scrollPosition?.y ?? -1), format: .number.precision(.fractionLength(1)))
+        + Text("}")
+    }
+
     private func detectLanguage(fileURL: URL?) -> CodeLanguage? {
         guard let fileURL else { return nil  }
         return CodeLanguage.detectLanguageFrom(
diff --git a/Package.swift b/Package.swift
@@ -16,8 +16,9 @@ let package = Package(
     dependencies: [
         // A fast, efficient, text view for code.
         .package(
-            url: "https://github.com/CodeEditApp/CodeEditTextView.git",
-            from: "0.11.2"
+            path: "../CodeEditTextView"
+//            url: "https://github.com/CodeEditApp/CodeEditTextView.git",
+//            from: "0.11.2"
         ),
         // tree-sitter languages
         .package(
diff --git a/Sources/CodeEditSourceEditor/Controller/TextViewController+LoadView.swift b/Sources/CodeEditSourceEditor/Controller/TextViewController+LoadView.swift
@@ -103,6 +103,7 @@ extension TextViewController {
             guard let clipView = notification.object as? NSClipView else { return }
             self?.gutterView.needsDisplay = true
             self?.minimapXConstraint?.constant = clipView.bounds.origin.x
+            NotificationCenter.default.post(name: Self.scrollPositionDidUpdateNotification, object: self)
         }
     }
 
@@ -115,6 +116,7 @@ extension TextViewController {
             self?.gutterView.needsDisplay = true
             self?.emphasisManager?.removeEmphases(for: EmphasisGroup.brackets)
             self?.updateTextInsets()
+            NotificationCenter.default.post(name: Self.scrollPositionDidUpdateNotification, object: self)
         }
     }
 
diff --git a/Sources/CodeEditSourceEditor/Controller/TextViewController.swift b/Sources/CodeEditSourceEditor/Controller/TextViewController.swift
@@ -19,6 +19,8 @@ import TextFormation
 public class TextViewController: NSViewController {
     // swiftlint:disable:next line_length
     public static let cursorPositionUpdatedNotification: Notification.Name = .init("TextViewController.cursorPositionNotification")
+    // swiftlint:disable:next line_length
+    public static let scrollPositionDidUpdateNotification: Notification.Name = .init("TextViewController.scrollPositionDidUpdateNotification")
 
     // MARK: - Views and Child VCs
 
diff --git a/Sources/CodeEditSourceEditor/SourceEditor/SourceEditor+Coordinator.swift b/Sources/CodeEditSourceEditor/SourceEditor/SourceEditor+Coordinator.swift
@@ -5,40 +5,61 @@
 //  Created by Khan Winter on 5/20/24.
 //
 
-import Foundation
+import AppKit
 import SwiftUI
+import Combine
 import CodeEditTextView
 
 extension SourceEditor {
     @MainActor
     public class Coordinator: NSObject {
-        weak var controller: TextViewController?
+        private weak var controller: TextViewController?
         var isUpdatingFromRepresentable: Bool = false
         var isUpdateFromTextView: Bool = false
         var text: TextAPI
-        @Binding var cursorPositions: [CursorPosition]
+        @Binding var editorState: SourceEditorState
 
         private(set) var highlightProviders: [any HighlightProviding]
 
-        init(text: TextAPI, cursorPositions: Binding<[CursorPosition]>, highlightProviders: [any HighlightProviding]?) {
+        private var cancellables: Set<AnyCancellable> = []
+
+        init(text: TextAPI, editorState: Binding<SourceEditorState>, highlightProviders: [any HighlightProviding]?) {
             self.text = text
-            self._cursorPositions = cursorPositions
+            self._editorState = editorState
             self.highlightProviders = highlightProviders ?? [TreeSitterClient()]
             super.init()
+        }
+
+        func setController(_ controller: TextViewController) {
+            self.controller = controller
+            // swiftlint:disable:this notification_center_detachment
+            NotificationCenter.default.removeObserver(self)
 
             NotificationCenter.default.addObserver(
                 self,
                 selector: #selector(textViewDidChangeText(_:)),
                 name: TextView.textDidChangeNotification,
-                object: nil
+                object: controller.textView
             )
 
             NotificationCenter.default.addObserver(
                 self,
                 selector: #selector(textControllerCursorsDidUpdate(_:)),
                 name: TextViewController.cursorPositionUpdatedNotification,
-                object: nil
+                object: controller
             )
+
+            // Needs to be put on the main runloop or SwiftUI gets mad
+            NotificationCenter.default
+                .publisher(
+                    for: TextViewController.scrollPositionDidUpdateNotification,
+                    object: controller
+                )
+                .receive(on: RunLoop.main)
+                .sink { [weak self] notification in
+                    self?.textControllerScrollDidChange(notification)
+                }
+                .store(in: &cancellables)
         }
 
         func updateHighlightProviders(_ highlightProviders: [any HighlightProviding]?) {
@@ -50,24 +71,33 @@ extension SourceEditor {
         }
 
         @objc func textViewDidChangeText(_ notification: Notification) {
-            guard let textView = notification.object as? TextView,
-                  let controller,
-                  controller.textView === textView else {
+            guard let textView = notification.object as? TextView else {
                 return
             }
+            // A plain string binding is one-way (from this view, up the hierarchy) so it's not in the state binding
             if case .binding(let binding) = text {
                 binding.wrappedValue = textView.string
             }
         }
 
         @objc func textControllerCursorsDidUpdate(_ notification: Notification) {
-            guard let notificationController = notification.object as? TextViewController,
-                  notificationController === controller else {
+            guard let controller = notification.object as? TextViewController else {
                 return
             }
+            updateState { $0.cursorPositions = controller.cursorPositions }
+        }
+
+        func textControllerScrollDidChange(_ notification: Notification) {
+            guard let controller = notification.object as? TextViewController else {
+                return
+            }
+            updateState { $0.scrollPosition = controller.scrollView.contentView.bounds.origin }
+        }
+
+        private func updateState(_ modifyCallback: (inout SourceEditorState) -> Void) {
             guard !isUpdatingFromRepresentable else { return }
             self.isUpdateFromTextView = true
-            cursorPositions = notificationController.cursorPositions
+            modifyCallback(&editorState)
         }
 
         deinit {
diff --git a/Sources/CodeEditSourceEditor/SourceEditor/SourceEditor.swift b/Sources/CodeEditSourceEditor/SourceEditor/SourceEditor.swift
@@ -10,9 +10,28 @@ import SwiftUI
 import CodeEditTextView
 import CodeEditLanguages
 
+public struct SourceEditorState: Equatable, Hashable, Sendable, Codable {
+    public var cursorPositions: [CursorPosition] = []
+    public var scrollPosition: CGPoint?
+    public var findText: String?
+    public var isShowingFindResults: Bool = false
+
+    public init(
+        cursorPositions: [CursorPosition],
+        scrollPosition: CGPoint? = nil,
+        findText: String? = nil,
+        isShowingFindResults: Bool = false
+    ) {
+        self.cursorPositions = cursorPositions
+        self.scrollPosition = scrollPosition
+        self.findText = findText
+        self.isShowingFindResults = isShowingFindResults
+    }
+}
+
 /// A SwiftUI View that provides source editing functionality.
 public struct SourceEditor: NSViewControllerRepresentable {
-    package enum TextAPI {
+    enum TextAPI {
         case binding(Binding<String>)
         case storage(NSTextStorage)
     }
@@ -32,15 +51,15 @@ public struct SourceEditor: NSViewControllerRepresentable {
         _ text: Binding<String>,
         language: CodeLanguage,
         configuration: SourceEditorConfiguration,
-        cursorPositions: Binding<[CursorPosition]>,
+        state: Binding<SourceEditorState>,
         highlightProviders: [any HighlightProviding]? = nil,
         undoManager: CEUndoManager? = nil,
         coordinators: [any TextViewCoordinator] = []
     ) {
         self.text = .binding(text)
         self.language = language
         self.configuration = configuration
-        self.cursorPositions = cursorPositions
+        self._state = state
         self.highlightProviders = highlightProviders
         self.undoManager = undoManager
         self.coordinators = coordinators
@@ -61,27 +80,27 @@ public struct SourceEditor: NSViewControllerRepresentable {
         _ text: NSTextStorage,
         language: CodeLanguage,
         configuration: SourceEditorConfiguration,
-        cursorPositions: Binding<[CursorPosition]>,
+        state: Binding<SourceEditorState>,
         highlightProviders: [any HighlightProviding]? = nil,
         undoManager: CEUndoManager? = nil,
         coordinators: [any TextViewCoordinator] = []
     ) {
         self.text = .storage(text)
         self.language = language
         self.configuration = configuration
-        self.cursorPositions = cursorPositions
+        self._state = state
         self.highlightProviders = highlightProviders
         self.undoManager = undoManager
         self.coordinators = coordinators
     }
 
-    package var text: TextAPI
-    private var language: CodeLanguage
-    private var configuration: SourceEditorConfiguration
-    package var cursorPositions: Binding<[CursorPosition]>
-    private var highlightProviders: [any HighlightProviding]?
-    private var undoManager: CEUndoManager?
-    package var coordinators: [any TextViewCoordinator]
+    var text: TextAPI
+    var language: CodeLanguage
+    var configuration: SourceEditorConfiguration
+    @Binding var state: SourceEditorState
+    var highlightProviders: [any HighlightProviding]?
+    var undoManager: CEUndoManager?
+    var coordinators: [any TextViewCoordinator]
 
     public typealias NSViewControllerType = TextViewController
 
@@ -90,7 +109,7 @@ public struct SourceEditor: NSViewControllerRepresentable {
             string: "",
             language: language,
             configuration: configuration,
-            cursorPositions: cursorPositions.wrappedValue,
+            cursorPositions: state.cursorPositions,
             highlightProviders: context.coordinator.highlightProviders,
             undoManager: undoManager,
             coordinators: coordinators
@@ -104,28 +123,29 @@ public struct SourceEditor: NSViewControllerRepresentable {
         if controller.textView == nil {
             controller.loadView()
         }
-        if !cursorPositions.isEmpty {
-            controller.setCursorPositions(cursorPositions.wrappedValue)
+        if !state.cursorPositions.isEmpty {
+            controller.setCursorPositions(state.cursorPositions)
         }
 
-        context.coordinator.controller = controller
+        context.coordinator.setController(controller)
         return controller
     }
 
     public func makeCoordinator() -> Coordinator {
-        Coordinator(text: text, cursorPositions: cursorPositions, highlightProviders: highlightProviders)
+        Coordinator(text: text, editorState: $state, highlightProviders: highlightProviders)
     }
 
     public func updateNSViewController(_ controller: TextViewController, context: Context) {
         context.coordinator.updateHighlightProviders(highlightProviders)
 
-        if !context.coordinator.isUpdateFromTextView {
+        if context.coordinator.isUpdateFromTextView {
+            context.coordinator.isUpdateFromTextView = false
+        } else {
             // Prevent infinite loop of update notifications
             context.coordinator.isUpdatingFromRepresentable = true
-            controller.setCursorPositions(cursorPositions.wrappedValue)
+//            controller.setCursorPositions(state.cursorPositions)
+            // TODO: Set scroll position, find text, etc.
             context.coordinator.isUpdatingFromRepresentable = false
-        } else {
-            context.coordinator.isUpdateFromTextView = false
         }
 
         // Set this no matter what to avoid having to compare object pointers.

Original file line number	Diff line number	Diff line change
`@@ -103,6 +103,7 @@ extension TextViewController {`
`103`	`103`	`guard let clipView = notification.object as? NSClipView else { return }`
`104`	`104`	`self?.gutterView.needsDisplay = true`
`105`	`105`	`self?.minimapXConstraint?.constant = clipView.bounds.origin.x`
	`106`	`+ NotificationCenter.default.post(name: Self.scrollPositionDidUpdateNotification, object: self)`
`106`	`107`	`}`
`107`	`108`	`}`
`108`	`109`
`@@ -115,6 +116,7 @@ extension TextViewController {`
`115`	`116`	`self?.gutterView.needsDisplay = true`
`116`	`117`	`self?.emphasisManager?.removeEmphases(for: EmphasisGroup.brackets)`
`117`	`118`	`self?.updateTextInsets()`
	`119`	`+ NotificationCenter.default.post(name: Self.scrollPositionDidUpdateNotification, object: self)`
`118`	`120`	`}`
`119`	`121`	`}`
`120`	`122`