Achieve Generics Nirvana

Author: thecoolwinter

CodeEdit.xcodeproj/project.pbxproj

@@ -373,6 +373,8 @@
 		6C14CEB028777D3C001468FE /* FindNavigatorListViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C14CEAF28777D3C001468FE /* FindNavigatorListViewController.swift */; };
 		6C14CEB32877A68F001468FE /* FindNavigatorMatchListCell.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C14CEB22877A68F001468FE /* FindNavigatorMatchListCell.swift */; };
 		6C18620A298BF5A800C663EA /* RecentProjectsListView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C186209298BF5A800C663EA /* RecentProjectsListView.swift */; };
+		6C1A7E942D5D557D001B951C /* CodeEditSourceEditor in Frameworks */ = {isa = PBXBuildFile; productRef = 6C5246732D1E612700F57F11 /* CodeEditSourceEditor */; };
+		6C1A7E962D5D5762001B951C /* LanguageServerDocument.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C1A7E952D5D5762001B951C /* LanguageServerDocument.swift */; };
 		6C1CC9982B1E770B0002349B /* AsyncFileIterator.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C1CC9972B1E770B0002349B /* AsyncFileIterator.swift */; };
 		6C1CC99B2B1E7CBC0002349B /* FindNavigatorIndexBar.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C1CC99A2B1E7CBC0002349B /* FindNavigatorIndexBar.swift */; };
 		6C1F3DA22C18C55800F6DEF6 /* ShellIntegrationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C1F3DA12C18C55800F6DEF6 /* ShellIntegrationTests.swift */; };
@@ -408,7 +410,6 @@
 		6C52466B2D1E507500F57F11 /* SemanticTokenStorageTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C52466A2D1E506C00F57F11 /* SemanticTokenStorageTests.swift */; };
 		6C52466D2D1E515700F57F11 /* SemanticToken+Position.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C52466C2D1E515700F57F11 /* SemanticToken+Position.swift */; };
 		6C5246702D1E5CC100F57F11 /* SemanticTokenRange.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C52466F2D1E5CC100F57F11 /* SemanticTokenRange.swift */; };
-		6C5246742D1E612700F57F11 /* CodeEditSourceEditor in Frameworks */ = {isa = PBXBuildFile; productRef = 6C5246732D1E612700F57F11 /* CodeEditSourceEditor */; };
 		6C53AAD829A6C4FD00EE9ED6 /* SplitView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C53AAD729A6C4FD00EE9ED6 /* SplitView.swift */; };
 		6C578D8129CD294800DC73B2 /* ExtensionActivatorView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C578D8029CD294800DC73B2 /* ExtensionActivatorView.swift */; };
 		6C578D8429CD343800DC73B2 /* ExtensionDetailView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C578D8329CD343800DC73B2 /* ExtensionDetailView.swift */; };
@@ -431,7 +432,6 @@
 		6C6BD70129CD172700235D17 /* ExtensionsListView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C6BD70029CD172700235D17 /* ExtensionsListView.swift */; };
 		6C6BD70429CD17B600235D17 /* ExtensionsManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C6BD70329CD17B600235D17 /* ExtensionsManager.swift */; };
 		6C7256D729A3D7D000C2D3E0 /* SplitViewControllerView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C7256D629A3D7D000C2D3E0 /* SplitViewControllerView.swift */; };
-		6C73A6D32D4F1E550012D95C /* CodeEditSourceEditor in Frameworks */ = {isa = PBXBuildFile; productRef = 6C73A6D22D4F1E550012D95C /* CodeEditSourceEditor */; };
 		6C7D6D462C9092EC00B69EE0 /* BufferingServerConnection.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C7D6D452C9092EC00B69EE0 /* BufferingServerConnection.swift */; };
 		6C7F37FE2A3EA6FA00217B83 /* View+focusedValue.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C7F37FD2A3EA6FA00217B83 /* View+focusedValue.swift */; };
 		6C81916729B3E80700B75C92 /* ModifierKeysObserver.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C81916629B3E80700B75C92 /* ModifierKeysObserver.swift */; };
@@ -1083,6 +1083,7 @@
 		6C14CEAF28777D3C001468FE /* FindNavigatorListViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FindNavigatorListViewController.swift; sourceTree = "<group>"; };
 		6C14CEB22877A68F001468FE /* FindNavigatorMatchListCell.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FindNavigatorMatchListCell.swift; sourceTree = "<group>"; };
 		6C186209298BF5A800C663EA /* RecentProjectsListView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = RecentProjectsListView.swift; sourceTree = "<group>"; };
+		6C1A7E952D5D5762001B951C /* LanguageServerDocument.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LanguageServerDocument.swift; sourceTree = "<group>"; };
 		6C1CC9972B1E770B0002349B /* AsyncFileIterator.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AsyncFileIterator.swift; sourceTree = "<group>"; };
 		6C1CC99A2B1E7CBC0002349B /* FindNavigatorIndexBar.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FindNavigatorIndexBar.swift; sourceTree = "<group>"; };
 		6C1F3DA12C18C55800F6DEF6 /* ShellIntegrationTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ShellIntegrationTests.swift; sourceTree = "<group>"; };
@@ -1365,6 +1366,7 @@
 			isa = PBXFrameworksBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				6C1A7E942D5D557D001B951C /* CodeEditSourceEditor in Frameworks */,
 				6C85BB402C2105ED00EB5DEF /* CodeEditKit in Frameworks */,
 				6C66C31329D05CDC00DE9ED2 /* GRDB in Frameworks */,
 				58F2EB1E292FB954004A9BDE /* Sparkle in Frameworks */,
@@ -1379,7 +1381,6 @@
 				6C6BD6F429CD142C00235D17 /* CollectionConcurrencyKit in Frameworks */,
 				6C85BB442C210EFD00EB5DEF /* SwiftUIIntrospect in Frameworks */,
 				6CB446402B6DFF3A00539ED0 /* CodeEditSourceEditor in Frameworks */,
-				6C9AE6992D1DD84600FAE8D2 /* CodeEditSourceEditor in Frameworks */,
 				2816F594280CF50500DD548B /* CodeEditSymbols in Frameworks */,
 				30CB64942C16CA9100CC8A9E /* LanguageClient in Frameworks */,
 				6C6BD6F829CD14D100235D17 /* CodeEditKit in Frameworks */,
@@ -1630,6 +1631,7 @@
 		30B087FB2C0D53080063A882 /* LSP */ = {
 			isa = PBXGroup;
 			children = (
+				6C1A7E952D5D5762001B951C /* LanguageServerDocument.swift */,
 				30B087FA2C0D53080063A882 /* LSPUtil.swift */,
 				6C1A7E932D5D508A001B951C /* Features */,
 				6CD26C732C8EA71F00ADBA38 /* LanguageServer */,
@@ -3878,7 +3880,6 @@
 				6CD3CA542C8B508200D83DCD /* CodeEditSourceEditor */,
 				6CB94D022CA1205100E8651C /* AsyncAlgorithms */,
 				6CC00A8A2CBEF150004E8134 /* CodeEditSourceEditor */,
-				6C9AE6982D1DD84600FAE8D2 /* CodeEditSourceEditor */,
 				6C5246732D1E612700F57F11 /* CodeEditSourceEditor */,
 			);
 			productName = CodeEdit;
@@ -4633,6 +4634,7 @@
 				58822525292C280D00E83CDE /* StatusBarMenuStyle.swift in Sources */,
 				6C147C4229A328C10089B630 /* Editor.swift in Sources */,
 				B6C4F2A32B3CA74800B2B140 /* CommitDetailsView.swift in Sources */,
+				6C1A7E962D5D5762001B951C /* LanguageServerDocument.swift in Sources */,
 				6C2C155829B4F49100EA60A5 /* SplitViewItem.swift in Sources */,
 				6CDA84AD284C1BA000C1CC3A /* EditorTabBarContextMenu.swift in Sources */,
 				6C81916729B3E80700B75C92 /* ModifierKeysObserver.swift in Sources */,
@@ -5983,10 +5985,6 @@
 			isa = XCSwiftPackageProductDependency;
 			productName = CodeEditKit;
 		};
-		6C73A6D22D4F1E550012D95C /* CodeEditSourceEditor */ = {
-			isa = XCSwiftPackageProductDependency;
-			productName = CodeEditSourceEditor;
-		};
 		6C7B1C752A1D57CE005CBBFC /* SwiftLint */ = {
 			isa = XCSwiftPackageProductDependency;
 			package = 287136B1292A407E00E9F5F4 /* XCRemoteSwiftPackageReference "SwiftLintPlugin" */;

CodeEdit.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -50,12 +50,6 @@ final class CodeFileDocument: NSDocument, ObservableObject {
     /// See ``CodeEditSourceEditor/CombineCoordinator``.
     @Published var contentCoordinator: CombineCoordinator = CombineCoordinator()
 
-    /// Set by ``LanguageServer`` when initialized.
-    @Published var lspCoordinator: LSPContentCoordinator?
-
-    /// Set by ``LanguageServer`` when initialized.
-    @Published var lspHighlightProvider: SemanticTokenHighlightProvider<SemanticTokenStorage>?
-
     /// Used to override detected languages.
     @Published var language: CodeLanguage?
 
@@ -68,6 +62,9 @@ final class CodeFileDocument: NSDocument, ObservableObject {
     /// Document-specific overridden line wrap preference.
     @Published var wrapLines: Bool?
 
+    /// Set up by ``LanguageServer``, conforms this type to ``LanguageServerDocument``.
+    @Published var languageServerObjects: LanguageServerDocumentObjects<CodeFileDocument> = .init()
+
     /// The type of data this file document contains.
     ///
     /// If its text content is not nil, a `text` UTType is returned.
@@ -86,9 +83,6 @@ final class CodeFileDocument: NSDocument, ObservableObject {
         return type
     }
 
-    /// A stable string to use when identifying documents with language servers.
-    var languageServerURI: String? { fileURL?.absolutePath }
-
     /// Specify options for opening the file such as the initial cursor positions.
     /// Nulled by ``CodeFileView`` on first load.
     var openOptions: OpenOptions?
@@ -194,6 +188,10 @@ final class CodeFileDocument: NSDocument, ObservableObject {
         NotificationCenter.default.post(name: Self.didCloseNotification, object: fileURL)
     }
 
+    /// Determines the code language of the document.
+    /// Use ``CodeFileDocument/language`` for the default value before using this. That property is used to override
+    /// the file's language.
+    /// - Returns: The detected code language.
     func getLanguage() -> CodeLanguage {
         guard let url = fileURL else {
             return .default
@@ -209,3 +207,10 @@ final class CodeFileDocument: NSDocument, ObservableObject {
         fileURL?.findWorkspace()
     }
 }
+
+// MARK: LanguageServerDocument
+
+extension CodeFileDocument: LanguageServerDocument {
+    /// A stable string to use when identifying documents with language servers.
+    var languageServerURI: String? { fileURL?.absolutePath }
+}

CodeEdit/Features/Documents/CodeFileDocument/CodeFileDocument.swift

@@ -63,7 +63,7 @@ struct CodeFileView: View {
 
         self.textViewCoordinators = textViewCoordinators
             + [codeFile.contentCoordinator]
-            + [codeFile.lspCoordinator].compactMap({ $0 })
+        + [codeFile.languageServerObjects.textCoordinator].compactMap({ $0 })
         self.isEditable = isEditable
 
         if let openOptions = codeFile.openOptions {
@@ -162,8 +162,8 @@ struct CodeFileView: View {
         .onChange(of: bracketHighlight) { _ in
             bracketPairHighlight = getBracketPairHighlight()
         }
-        .onReceive(codeFile.$lspHighlightProvider) { provider in
-            updateHighlightProviders(provider)
+        .onReceive(codeFile.$languageServerObjects) { languageServerObjects in
+            updateHighlightProviders(languageServerObjects.highlightProvider)
         }
     }
 

CodeEdit/Features/Editor/Views/CodeFileView.swift

@@ -19,7 +19,7 @@ import LanguageServerProtocol
 /// Language servers expect edits to be sent in chunks (and it helps reduce processing overhead). To do this, this class
 /// keeps an async stream around for the duration of its lifetime. The stream is sent edit notifications, which are then
 /// chunked into 250ms timed groups before being sent to the ``LanguageServer``.
-class LSPContentCoordinator: TextViewCoordinator, TextViewDelegate {
+class LSPContentCoordinator<DocumentType: LanguageServerDocument>: TextViewCoordinator, TextViewDelegate {
     // Required to avoid a large_tuple lint error
     private struct SequenceElement: Sendable {
         let uri: String
@@ -32,11 +32,11 @@ class LSPContentCoordinator: TextViewCoordinator, TextViewDelegate {
     private var sequenceContinuation: AsyncStream<SequenceElement>.Continuation?
     private var task: Task<Void, Never>?
 
-    weak var languageServer: LanguageServer?
+    weak var languageServer: LanguageServer<DocumentType>?
     var documentURI: String
 
     /// Initializes a content coordinator, and begins an async stream of updates
-    init(documentURI: String, languageServer: LanguageServer) {
+    init(documentURI: String, languageServer: LanguageServer<DocumentType>) {
         self.documentURI = documentURI
         self.languageServer = languageServer
         self.stream = AsyncStream { continuation in

CodeEdit/Features/LSP/Features/DocumentSync/LSPContentCoordinator.swift

@@ -21,7 +21,10 @@ import CodeEditLanguages
 /// ``SemanticTokenHighlightProvider/applyEdit(textView:range:delta:completion:)`` method. One might expect this class
 /// to respond to that method immediately, but it does not. It instead stores the completion passed in that method until
 /// it can respond to the edit with invalidated indices.
-final class SemanticTokenHighlightProvider<Storage: GenericSemanticTokenStorage>: HighlightProviding {
+final class SemanticTokenHighlightProvider<
+    Storage: GenericSemanticTokenStorage,
+    DocumentType: LanguageServerDocument
+>: HighlightProviding {
     enum HighlightError: Error {
         case lspRangeFailure
     }
@@ -31,7 +34,7 @@ final class SemanticTokenHighlightProvider<Storage: GenericSemanticTokenStorage>
 
     private let tokenMap: SemanticTokenMap
     private let documentURI: String
-    private weak var languageServer: LanguageServer?
+    private weak var languageServer: LanguageServer<DocumentType>?
     private weak var textView: TextView?
 
     private var lastEditCallback: EditCallback?
@@ -42,7 +45,7 @@ final class SemanticTokenHighlightProvider<Storage: GenericSemanticTokenStorage>
         textView?.documentRange ?? .zero
     }
 
-    init(tokenMap: SemanticTokenMap, languageServer: LanguageServer, documentURI: String) {
+    init(tokenMap: SemanticTokenMap, languageServer: LanguageServer<DocumentType>, documentURI: String) {
         self.tokenMap = tokenMap
         self.languageServer = languageServer
         self.documentURI = documentURI
@@ -88,7 +91,7 @@ final class SemanticTokenHighlightProvider<Storage: GenericSemanticTokenStorage>
 
     /// Requests and applies a token delta. Requires a previous response identifier.
     private func requestDeltaTokens(
-        languageServer: LanguageServer,
+        languageServer: LanguageServer<DocumentType>,
         textView: TextView,
         lastResultId: String
     ) async throws {
@@ -108,7 +111,7 @@ final class SemanticTokenHighlightProvider<Storage: GenericSemanticTokenStorage>
 
     /// Requests and applies tokens for an entire document. This does not require a previous response id, and should be
     /// used in place of `requestDeltaTokens` when that's the case.
-    private func requestTokens(languageServer: LanguageServer, textView: TextView) async throws {
+    private func requestTokens(languageServer: LanguageServer<DocumentType>, textView: TextView) async throws {
         guard let response = try await languageServer.requestSemanticTokens(for: documentURI) else {
             return
         }

CodeEdit/Features/LSP/Features/SemanticTokens/SemanticTokenHighlightProvider.swift

@@ -12,7 +12,7 @@ extension LanguageServer {
     /// Tells the language server we've opened a document and would like to begin working with it.
     /// - Parameter document: The code document to open.
     /// - Throws: Throws errors produced by the language server connection.
-    func openDocument(_ document: CodeFileDocument) async throws {
+    func openDocument(_ document: DocumentType) async throws {
         do {
             guard resolveOpenCloseSupport(), let content = await getIsolatedDocumentContent(document) else {
                 return
@@ -104,7 +104,7 @@ extension LanguageServer {
 
             // Let the semantic token provider know about the update.
             // Note for future: If a related LSP object need notifying about document changes, do it here.
-            try await document.lspHighlightProvider?.documentDidChange()
+            try await document.languageServerObjects.highlightProvider?.documentDidChange()
         } catch {
             logger.warning("closeDocument: Error \(error)")
             throw error
@@ -115,7 +115,7 @@ extension LanguageServer {
 
     /// Helper function for grabbing a document's content from the main actor.
     @MainActor
-    private func getIsolatedDocumentContent(_ document: CodeFileDocument) -> DocumentContent? {
+    private func getIsolatedDocumentContent(_ document: DocumentType) -> DocumentContent? {
         guard let uri = document.languageServerURI,
               let content = document.content?.string else {
             return nil
@@ -124,9 +124,9 @@ extension LanguageServer {
     }
 
     @MainActor
-    private func updateIsolatedDocument(_ document: CodeFileDocument) {
-        document.lspCoordinator = openFiles.contentCoordinator(for: document)
-        document.lspHighlightProvider = openFiles.semanticHighlighter(for: document)
+    private func updateIsolatedDocument(_ document: DocumentType) {
+        document.languageServerObjects.textCoordinator = openFiles.contentCoordinator(for: document)
+        document.languageServerObjects.highlightProvider = openFiles.semanticHighlighter(for: document)
     }
 
     // swiftlint:disable line_length

CodeEdit/Features/LSP/LanguageServer/Capabilities/LanguageServer+DocumentSync.swift

@@ -11,8 +11,10 @@ import LanguageClient
 import LanguageServerProtocol
 import OSLog
 
-class LanguageServer {
-    static let logger = Logger(subsystem: Bundle.main.bundleIdentifier ?? "", category: "LanguageServer")
+class LanguageServer<DocumentType: LanguageServerDocument> {
+    static var logger: Logger {
+        Logger(subsystem: Bundle.main.bundleIdentifier ?? "", category: "LanguageServer")
+    }
     let logger: Logger
 
     /// Identifies which language the server belongs to
@@ -25,7 +27,7 @@ class LanguageServer {
     /// Tracks documents and their associated objects.
     /// Use this property when adding new objects that need to track file data, or have a state associated with the
     /// language server and a document. For example, the content coordinator.
-    let openFiles: LanguageServerFileMap
+    let openFiles: LanguageServerFileMap<DocumentType>
 
     /// Maps the language server's highlight config to one CodeEdit can read. See ``SemanticTokenMap``.
     let highlightMap: SemanticTokenMap?