Organization, Implement Correct Binary Search

Author: thecoolwinter

CodeEdit.xcodeproj/project.pbxproj

@@ -3,7 +3,7 @@
 	archiveVersion = 1;
 	classes = {
 	};
-	objectVersion = 60;
+	objectVersion = 55;
 	objects = {
 
 /* Begin PBXBuildFile section */
@@ -452,8 +452,8 @@
 		6C9AE6712D14A9F700FAE8D2 /* LazyServiceWrapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C9AE6702D14A9F700FAE8D2 /* LazyServiceWrapper.swift */; };
 		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 /* LSPSemanticTokenStorage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C9AE69C2D1DF84300FAE8D2 /* LSPSemanticTokenStorage.swift */; };
+		6C9AE69B2D1DF80300FAE8D2 /* GenericSemanticTokenStorage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C9AE69A2D1DF80300FAE8D2 /* GenericSemanticTokenStorage.swift */; };
+		6C9AE69D2D1DF84300FAE8D2 /* SemanticTokenStorage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C9AE69C2D1DF84300FAE8D2 /* SemanticTokenStorage.swift */; };
 		6CA1AE952B46950000378EAB /* EditorInstance.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6CA1AE942B46950000378EAB /* EditorInstance.swift */; };
 		6CAAF68A29BC9C2300A1F48A /* (null) in Sources */ = {isa = PBXBuildFile; };
 		6CAAF69229BCC71C00A1F48A /* (null) in Sources */ = {isa = PBXBuildFile; };
@@ -1152,8 +1152,8 @@
 		6C9AE66E2D148DD200FAE8D2 /* URL+FindWorkspace.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "URL+FindWorkspace.swift"; sourceTree = "<group>"; };
 		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 /* LSPSemanticTokenStorage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LSPSemanticTokenStorage.swift; sourceTree = "<group>"; };
+		6C9AE69A2D1DF80300FAE8D2 /* GenericSemanticTokenStorage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GenericSemanticTokenStorage.swift; sourceTree = "<group>"; };
+		6C9AE69C2D1DF84300FAE8D2 /* SemanticTokenStorage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SemanticTokenStorage.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>"; };
@@ -1629,10 +1629,10 @@
 		30B087FB2C0D53080063A882 /* LSP */ = {
 			isa = PBXGroup;
 			children = (
-				6C3B4CD22D0E2C5400C6759E /* Editor */,
+				30B087FA2C0D53080063A882 /* LSPUtil.swift */,
+				6C1A7E932D5D508A001B951C /* Features */,
 				6CD26C732C8EA71F00ADBA38 /* LanguageServer */,
 				6CD26C742C8EA79100ADBA38 /* Service */,
-				30B087FA2C0D53080063A882 /* LSPUtil.swift */,
 			);
 			path = LSP;
 			sourceTree = "<group>";
@@ -2943,6 +2943,23 @@
 			path = FindNavigatorResultList;
 			sourceTree = "<group>";
 		};
+		6C1A7E922D5D5083001B951C /* DocumentSync */ = {
+			isa = PBXGroup;
+			children = (
+				6C278CC62C93971F0066F6D9 /* LSPContentCoordinator.swift */,
+			);
+			path = DocumentSync;
+			sourceTree = "<group>";
+		};
+		6C1A7E932D5D508A001B951C /* Features */ = {
+			isa = PBXGroup;
+			children = (
+				6C1A7E922D5D5083001B951C /* DocumentSync */,
+				6C3B4CD22D0E2C5400C6759E /* SemanticTokens */,
+			);
+			path = Features;
+			sourceTree = "<group>";
+		};
 		6C2384302C796EBD003FBDD4 /* ChangedFile */ = {
 			isa = PBXGroup;
 			children = (
@@ -2952,16 +2969,15 @@
 			path = ChangedFile;
 			sourceTree = "<group>";
 		};
-		6C3B4CD22D0E2C5400C6759E /* Editor */ = {
+		6C3B4CD22D0E2C5400C6759E /* SemanticTokens */ = {
 			isa = PBXGroup;
 			children = (
-				6C9AE69E2D1DF8DE00FAE8D2 /* SemanticTokenStorage */,
-				6C278CC62C93971F0066F6D9 /* LSPContentCoordinator.swift */,
 				6C9AE6952D1DD71500FAE8D2 /* SemanticTokenHighlightProvider.swift */,
 				6C3B4CD02D0E2C2900C6759E /* SemanticTokenMap.swift */,
 				6CC3D1FC2D14761A00822B65 /* SemanticTokenMapRangeProvider.swift */,
+				6C9AE69E2D1DF8DE00FAE8D2 /* SemanticTokenStorage */,
 			);
-			path = Editor;
+			path = SemanticTokens;
 			sourceTree = "<group>";
 		};
 		6C3E12D42CC830DE00DD12F1 /* Model */ = {
@@ -3106,9 +3122,9 @@
 		6C9AE69E2D1DF8DE00FAE8D2 /* SemanticTokenStorage */ = {
 			isa = PBXGroup;
 			children = (
-				6C9AE69C2D1DF84300FAE8D2 /* LSPSemanticTokenStorage.swift */,
+				6C9AE69A2D1DF80300FAE8D2 /* GenericSemanticTokenStorage.swift */,
 				6C52466F2D1E5CC100F57F11 /* SemanticTokenRange.swift */,
-				6C9AE69A2D1DF80300FAE8D2 /* SemanticTokenStorage.swift */,
+				6C9AE69C2D1DF84300FAE8D2 /* SemanticTokenStorage.swift */,
 			);
 			path = SemanticTokenStorage;
 			sourceTree = "<group>";
@@ -3960,7 +3976,6 @@
 				303E88462C276FD600EEA8D9 /* XCRemoteSwiftPackageReference "LanguageServerProtocol" */,
 				6C4E37FA2C73E00700AEE7B5 /* XCRemoteSwiftPackageReference "SwiftTerm" */,
 				6CB94D012CA1205100E8651C /* XCRemoteSwiftPackageReference "swift-async-algorithms" */,
-				6C5246722D1E612700F57F11 /* XCLocalSwiftPackageReference "../CodeEditSourceEditor" */,
 			);
 			productRefGroup = B658FB2D27DA9E0F00EA4DBD /* Products */;
 			projectDirPath = "";
@@ -4115,7 +4130,7 @@
 				587B9E9229301D8F00AC7927 /* BitBucketAccount.swift in Sources */,
 				DE513F52281B672D002260B9 /* EditorTabBarAccessory.swift in Sources */,
 				6CD26C7A2C8EA8A500ADBA38 /* LSPCache.swift in Sources */,
-				6C9AE69B2D1DF80300FAE8D2 /* SemanticTokenStorage.swift in Sources */,
+				6C9AE69B2D1DF80300FAE8D2 /* GenericSemanticTokenStorage.swift in Sources */,
 				618725A42C29F00400987354 /* WorkspaceMenuItemView.swift in Sources */,
 				2813F93927ECC4C300E305E4 /* NavigatorAreaView.swift in Sources */,
 				B664C3B02B965F6C00816B4E /* NavigationSettings.swift in Sources */,
@@ -4537,7 +4552,7 @@
 				B6041F5229D7D6D6000F3454 /* SettingsWindow.swift in Sources */,
 				6139B9162C29B36500CA584B /* CETaskStatus.swift in Sources */,
 				B6EA1FF829DB78DB001BF195 /* ThemeSettingThemeRow.swift in Sources */,
-				6C9AE69D2D1DF84300FAE8D2 /* LSPSemanticTokenStorage.swift in Sources */,
+				6C9AE69D2D1DF84300FAE8D2 /* SemanticTokenStorage.swift in Sources */,
 				587B9E7629301D8F00AC7927 /* GitTime.swift in Sources */,
 				587B9E5D29301D8F00AC7927 /* GitLabUserRouter.swift in Sources */,
 				588847692992ABCA00996D95 /* Array+SortURLs.swift in Sources */,
@@ -5764,13 +5779,6 @@
 		};
 /* End XCConfigurationList section */
 
-/* Begin XCLocalSwiftPackageReference section */
-		6C5246722D1E612700F57F11 /* XCLocalSwiftPackageReference "../CodeEditSourceEditor" */ = {
-			isa = XCLocalSwiftPackageReference;
-			relativePath = ../CodeEditSourceEditor;
-		};
-/* End XCLocalSwiftPackageReference section */
-
 /* Begin XCRemoteSwiftPackageReference section */
 		2816F592280CF50500DD548B /* XCRemoteSwiftPackageReference "CodeEditSymbols" */ = {
 			isa = XCRemoteSwiftPackageReference;

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<LSPSemanticTokenStorage>?
+    @Published var lspHighlightProvider: SemanticTokenHighlightProvider<SemanticTokenStorage>?
 
     /// Used to override detected languages.
     @Published var language: CodeLanguage?

CodeEdit/Features/Documents/CodeFileDocument/CodeFileDocument.swift

@@ -21,7 +21,7 @@ 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: SemanticTokenStorage>: HighlightProviding {
+final class SemanticTokenHighlightProvider<Storage: GenericSemanticTokenStorage>: HighlightProviding {
     enum HighlightError: Error {
         case lspRangeFailure
     }

CodeEdit/Features/LSP/Editor/LSPContentCoordinator.swift renamed to CodeEdit/Features/LSP/Features/DocumentSync/LSPContentCoordinator.swift

@@ -1,5 +1,5 @@
 //
-//  SemanticTokenStorage.swift
+//  GenericSemanticTokenStorage.swift
 //  CodeEdit
 //
 //  Created by Khan Winter on 12/26/24.
@@ -12,8 +12,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 useful  in testing.
-/// See ``LSPSemanticTokenStorage`` for use.
-protocol SemanticTokenStorage: AnyObject {
+/// See ``SemanticTokenStorage`` for use.
+protocol GenericSemanticTokenStorage: AnyObject {
     var lastResultId: String? { get }
     var hasTokens: Bool { get }
 

CodeEdit/Features/LSP/Editor/SemanticTokenHighlightProvider.swift renamed to CodeEdit/Features/LSP/Features/SemanticTokens/SemanticTokenHighlightProvider.swift

@@ -1,5 +1,5 @@
 //
-//  ConcreteSemanticTokenStorage.swift
+//  SemanticTokenStorage.swift
 //  CodeEdit
 //
 //  Created by Khan Winter on 12/26/24.
@@ -16,7 +16,7 @@ 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 LSPSemanticTokenStorage: SemanticTokenStorage {
+final class SemanticTokenStorage: GenericSemanticTokenStorage {
     /// Represents compressed semantic token data received from a language server.
     struct CurrentState {
         let resultId: String?
@@ -46,11 +46,14 @@ final class LSPSemanticTokenStorage: SemanticTokenStorage {
         }
         var tokens: [SemanticToken] = []
 
-//        var idx = findLowerBound(of: range.start, data: state.tokens[...])
-//        while idx < state.tokens.count && state.tokens[idx].startPosition < range.end {
-//            tokens.append(state.tokens[idx])
-//            idx += 1
-//        }
+        guard var idx = findLowerBound(in: range, data: state.tokens[...]) else {
+            return []
+        }
+
+        while idx < state.tokens.count && state.tokens[idx].startPosition < range.end {
+            tokens.append(state.tokens[idx])
+            idx += 1
+        }
 
         return tokens
     }
@@ -134,26 +137,33 @@ final class LSPSemanticTokenStorage: SemanticTokenStorage {
 
     // MARK: - Binary Search
 
-    /// Perform a binary search to find the given position
-    /// - Complexity: O(log n)
+    /// Finds the lowest index of a `SemanticToken` that is entirely within the specified range.
+    /// - Complexity: Runs an **O(log n)** binary search on the data array.
+    /// - Parameters:
+    ///   - range: The range to search in, *not* inclusive.
+    ///   - data: The tokens to search. Takes an array slice to avoid unnecessary copying. This must be ordered by
+    ///           `startPosition`.
+    /// - Returns: The index in the data array of the lowest data element that lies within the given range, or `nil`
+    ///            if none are found.
     func findLowerBound(in range: LSPRange, data: ArraySlice<SemanticToken>) -> Int? {
-        // TODO: This needs to find the closest value in a range, there's a good chance there's no result for a
-        // specific indice
-//        var lower = 0
-//        var upper = data.count
-//        var idx = 0
-//        while lower < upper {
-//            idx = lower + upper / 2
-//            if data[idx].startPosition < position {
-//                lower = idx + 1
-//            } else if data[idx].startPosition > position {
-//                upper = idx
-//            } else {
-//                return idx
-//            }
-//        }
-//
-//        return (data[idx].startPosition..<data[idx].endPosition).contains(position) ? idx : nil
+        var low = 0
+        var high = data.count
+
+        // Find the first token with startPosition >= range.start.
+        while low < high {
+            let mid = low + (high - low) / 2
+            if data[mid].startPosition < range.start {
+                low = mid + 1
+            } else {
+                high = mid
+            }
+        }
+
+        // Return the item at `low` if it's valid.
+        if low < data.count && data[low].startPosition >= range.start && data[low].endPosition < range.end {
+            return low
+        }
+
         return nil
     }
 }