Patch Cleaning

Author: thecoolwinter

CodeEdit.xcodeproj/project.pbxproj

@@ -453,7 +453,7 @@
 		6C9AE6962D1DD71500FAE8D2 /* SemanticTokenHighlightProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C9AE6952D1DD71500FAE8D2 /* SemanticTokenHighlightProvider.swift */; };
 		6C9AE6992D1DD84600FAE8D2 /* CodeEditSourceEditor in Frameworks */ = {isa = PBXBuildFile; productRef = 6C9AE6982D1DD84600FAE8D2 /* CodeEditSourceEditor */; };
 		6C9AE69B2D1DF80300FAE8D2 /* SemanticTokenStorage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C9AE69A2D1DF80300FAE8D2 /* SemanticTokenStorage.swift */; };
-		6C9AE69D2D1DF84300FAE8D2 /* ConcreteSemanticTokenStorage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C9AE69C2D1DF84300FAE8D2 /* ConcreteSemanticTokenStorage.swift */; };
+		6C9AE69D2D1DF84300FAE8D2 /* LSPSemanticTokenStorage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C9AE69C2D1DF84300FAE8D2 /* LSPSemanticTokenStorage.swift */; };
 		6CA1AE952B46950000378EAB /* EditorInstance.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6CA1AE942B46950000378EAB /* EditorInstance.swift */; };
 		6CAAF68A29BC9C2300A1F48A /* (null) in Sources */ = {isa = PBXBuildFile; };
 		6CAAF69229BCC71C00A1F48A /* (null) in Sources */ = {isa = PBXBuildFile; };
@@ -1153,7 +1153,7 @@
 		6C9AE6702D14A9F700FAE8D2 /* LazyServiceWrapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LazyServiceWrapper.swift; sourceTree = "<group>"; };
 		6C9AE6952D1DD71500FAE8D2 /* SemanticTokenHighlightProvider.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SemanticTokenHighlightProvider.swift; sourceTree = "<group>"; };
 		6C9AE69A2D1DF80300FAE8D2 /* SemanticTokenStorage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SemanticTokenStorage.swift; sourceTree = "<group>"; };
-		6C9AE69C2D1DF84300FAE8D2 /* ConcreteSemanticTokenStorage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ConcreteSemanticTokenStorage.swift; sourceTree = "<group>"; };
+		6C9AE69C2D1DF84300FAE8D2 /* LSPSemanticTokenStorage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LSPSemanticTokenStorage.swift; sourceTree = "<group>"; };
 		6CA1AE942B46950000378EAB /* EditorInstance.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EditorInstance.swift; sourceTree = "<group>"; };
 		6CABB1A029C5593800340467 /* SearchPanelView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = SearchPanelView.swift; sourceTree = "<group>"; };
 		6CB52DC82AC8DC3E002E75B3 /* CEWorkspaceFileManager+FileManagement.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "CEWorkspaceFileManager+FileManagement.swift"; sourceTree = "<group>"; };
@@ -3106,7 +3106,7 @@
 		6C9AE69E2D1DF8DE00FAE8D2 /* SemanticTokenStorage */ = {
 			isa = PBXGroup;
 			children = (
-				6C9AE69C2D1DF84300FAE8D2 /* ConcreteSemanticTokenStorage.swift */,
+				6C9AE69C2D1DF84300FAE8D2 /* LSPSemanticTokenStorage.swift */,
 				6C52466F2D1E5CC100F57F11 /* SemanticTokenRange.swift */,
 				6C9AE69A2D1DF80300FAE8D2 /* SemanticTokenStorage.swift */,
 			);
@@ -4537,7 +4537,7 @@
 				B6041F5229D7D6D6000F3454 /* SettingsWindow.swift in Sources */,
 				6139B9162C29B36500CA584B /* CETaskStatus.swift in Sources */,
 				B6EA1FF829DB78DB001BF195 /* ThemeSettingThemeRow.swift in Sources */,
-				6C9AE69D2D1DF84300FAE8D2 /* ConcreteSemanticTokenStorage.swift in Sources */,
+				6C9AE69D2D1DF84300FAE8D2 /* LSPSemanticTokenStorage.swift in Sources */,
 				587B9E7629301D8F00AC7927 /* GitTime.swift in Sources */,
 				587B9E5D29301D8F00AC7927 /* GitLabUserRouter.swift in Sources */,
 				588847692992ABCA00996D95 /* Array+SortURLs.swift in Sources */,

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

@@ -54,7 +54,7 @@ final class CodeFileDocument: NSDocument, ObservableObject {
     @Published var lspCoordinator: LSPContentCoordinator?
 
     /// Set by ``LanguageServer`` when initialized.
-    @Published var lspHighlightProvider: SemanticTokenHighlightProvider<ConcreteSemanticTokenStorage>?
+    @Published var lspHighlightProvider: SemanticTokenHighlightProvider<LSPSemanticTokenStorage>?
 
     /// Used to override detected languages.
     @Published var language: CodeLanguage?

CodeEdit/Features/Documents/CodeFileDocument/CodeFileDocument.swift

@@ -16,7 +16,8 @@ import CodeEditSourceEditor
 /// tokens and their decoded counterparts. It supports applying delta updates from the language server.
 ///
 /// See ``SemanticTokenHighlightProvider`` for it's connection to the editor view.
-final class ConcreteSemanticTokenStorage: SemanticTokenStorage {
+final class LSPSemanticTokenStorage: SemanticTokenStorage {
+    /// Represents compressed semantic token data received from a language server.
     struct CurrentState {
         let requestId: String?
         let tokenData: [UInt32]
@@ -59,7 +60,7 @@ final class ConcreteSemanticTokenStorage: SemanticTokenStorage {
     /// To calculate invalidated ranges:
     /// - Grabs all semantic tokens that *will* be updated and invalidates their ranges
     /// - Loops over all inserted tokens and invalidates their ranges
-    /// This may result in duplicated ranges. It's up to the object using this method to de-duplicate if necessary.
+    /// This may result in duplicated ranges. It's up to the caller to de-duplicate if necessary.
     ///
     /// - Parameter deltas: The deltas to apply.
     /// - Returns: All ranges invalidated by the applied deltas.
@@ -129,6 +130,7 @@ final class ConcreteSemanticTokenStorage: SemanticTokenStorage {
     // MARK: - Binary Search
 
     /// Perform a binary search to find the given position
+    /// - Complexity: O(log n)
     func findIndex(of position: Position, data: ArraySlice<SemanticToken>) -> Int {
         var lower = 0
         var upper = data.count

CodeEdit/Features/LSP/Editor/SemanticTokenStorage/ConcreteSemanticTokenStorage.swift renamed to CodeEdit/Features/LSP/Editor/SemanticTokenStorage/LSPSemanticTokenStorage.swift

@@ -11,8 +11,8 @@ import CodeEditSourceEditor
 
 /// Defines a protocol for an object to provide a storage mechanism for semantic tokens.
 /// 
-/// There is only one concrete type that conforms to this in CE, but this protocol is used in testing.
-/// See ``ConcreteSemanticTokenStorage`` for use.
+/// There is only one concrete type that conforms to this in CE, but this protocol is useful  in testing.
+/// See ``LSPSemanticTokenStorage`` for use.
 protocol SemanticTokenStorage: AnyObject {
     var lastRequestId: String? { get }
 

CodeEdit/Features/LSP/Editor/SemanticTokenStorage/SemanticTokenStorage.swift

@@ -29,8 +29,7 @@ extension LanguageServer {
             )
             try await lspInstance.textDocumentDidOpen(DidOpenTextDocumentParams(textDocument: textDocument))
 
-            await updateIsolatedDocument(document)
-            try await document.lspHighlightProvider?.documentDidChange()
+            try await updateIsolatedDocument(document)
         } catch {
             logger.warning("addDocument: Error \(error)")
             throw error
@@ -126,9 +125,10 @@ extension LanguageServer {
     }
 
     @MainActor
-    private func updateIsolatedDocument(_ document: CodeFileDocument) {
+    private func updateIsolatedDocument(_ document: CodeFileDocument) async throws {
         document.lspCoordinator = openFiles.contentCoordinator(for: document)
         document.lspHighlightProvider = openFiles.semanticHighlighter(for: document)
+        try await document.lspHighlightProvider?.documentDidChange()
     }
 
     // swiftlint:disable line_length

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

@@ -15,7 +15,7 @@ class LanguageServerFileMap {
         let uri: String
         var documentVersion: Int
         var contentCoordinator: LSPContentCoordinator
-        var semanticHighlighter: SemanticTokenHighlightProvider<ConcreteSemanticTokenStorage>?
+        var semanticHighlighter: SemanticTokenHighlightProvider<LSPSemanticTokenStorage>?
     }
 
     private var trackedDocuments: NSMapTable<NSString, CodeFileDocument>
@@ -98,7 +98,7 @@ class LanguageServerFileMap {
 
     func semanticHighlighter(
         for document: CodeFileDocument
-    ) -> SemanticTokenHighlightProvider<ConcreteSemanticTokenStorage>? {
+    ) -> SemanticTokenHighlightProvider<LSPSemanticTokenStorage>? {
         guard let uri = document.languageServerURI else { return nil }
         return trackedDocumentData[uri]?.semanticHighlighter
     }

CodeEdit/Features/LSP/LanguageServer/LanguageServerFileMap.swift

@@ -12,8 +12,8 @@ import LanguageServerProtocol
 
 final class SemanticTokenStorageTests: XCTestCase {
     func testInvalidation() {
-        let storage = ConcreteSemanticTokenStorage()
-        storage.state = ConcreteSemanticTokenStorage.CurrentState(
+        let storage = LSPSemanticTokenStorage()
+        storage.state = LSPSemanticTokenStorage.CurrentState(
             requestId: nil,
             tokenData: [0, 0, 2, 0, 0],
             tokens: [SemanticToken(line: 0, char: 0, length: 2, type: 0, modifiers: 0)]