Jump To Definition

Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample.xcodeproj/project.pbxproj

@@ -20,6 +20,7 @@
 		6C1365462B8A7F2D004A1D18 /* LanguagePicker.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C1365452B8A7F2D004A1D18 /* LanguagePicker.swift */; };
 		6C1365482B8A7FBF004A1D18 /* EditorTheme+Default.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C1365472B8A7FBF004A1D18 /* EditorTheme+Default.swift */; };
 		6C13654D2B8A821E004A1D18 /* NSColor+Hex.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C13654C2B8A821E004A1D18 /* NSColor+Hex.swift */; };
+		6C730A042E32CA2A00FE1F32 /* MockJumpToDefinitionDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C730A032E32CA2A00FE1F32 /* MockJumpToDefinitionDelegate.swift */; };
 		6C8B564C2E3018CC00DC3F29 /* MockCompletionDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C8B564B2E3018CC00DC3F29 /* MockCompletionDelegate.swift */; };
 		6CF31D4E2DB6A252006A77FD /* StatusBar.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6CF31D4D2DB6A252006A77FD /* StatusBar.swift */; };
 /* End PBXBuildFile section */
@@ -39,6 +40,7 @@
 		6C1365452B8A7F2D004A1D18 /* LanguagePicker.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LanguagePicker.swift; sourceTree = "<group>"; };
 		6C1365472B8A7FBF004A1D18 /* EditorTheme+Default.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "EditorTheme+Default.swift"; sourceTree = "<group>"; };
 		6C13654C2B8A821E004A1D18 /* NSColor+Hex.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "NSColor+Hex.swift"; sourceTree = "<group>"; };
+		6C730A032E32CA2A00FE1F32 /* MockJumpToDefinitionDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockJumpToDefinitionDelegate.swift; sourceTree = "<group>"; };
 		6C8B564B2E3018CC00DC3F29 /* MockCompletionDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockCompletionDelegate.swift; sourceTree = "<group>"; };
 		6CF31D4D2DB6A252006A77FD /* StatusBar.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StatusBar.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
@@ -123,6 +125,7 @@
 				6CF31D4D2DB6A252006A77FD /* StatusBar.swift */,
 				6C1365452B8A7F2D004A1D18 /* LanguagePicker.swift */,
 				1CB30C392DAA1C28008058A7 /* IndentPicker.swift */,
+				6C730A032E32CA2A00FE1F32 /* MockJumpToDefinitionDelegate.swift */,
 			);
 			path = Views;
 			sourceTree = "<group>";
@@ -212,6 +215,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				6C730A042E32CA2A00FE1F32 /* MockJumpToDefinitionDelegate.swift in Sources */,
 				6C1365482B8A7FBF004A1D18 /* EditorTheme+Default.swift in Sources */,
 				6C13654D2B8A821E004A1D18 /* NSColor+Hex.swift in Sources */,
 				6C1365302B8A7B94004A1D18 /* CodeEditSourceEditorExampleDocument.swift in Sources */,

Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample/Views/ContentView.swift

@@ -23,6 +23,7 @@ struct ContentView: View {
         cursorPositions: [CursorPosition(line: 1, column: 1)]
     )
     @StateObject private var suggestions: MockCompletionDelegate = MockCompletionDelegate()
+    @StateObject private var jumpToDefinition: MockJumpToDefinitionDelegate = MockJumpToDefinitionDelegate()
 
     @State private var font: NSFont = NSFont.monospacedSystemFont(ofSize: 12, weight: .medium)
     @AppStorage("wrapLines") private var wrapLines: Bool = true
@@ -73,7 +74,8 @@ struct ContentView: View {
                     )
                 ),
                 state: $editorState,
-                completionDelegate: suggestions
+                completionDelegate: suggestions,
+                jumpToDefinitionDelegate: jumpToDefinition
             )
             .overlay(alignment: .bottom) {
                 StatusBar(

Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample/Views/MockCompletionDelegate.swift

@@ -48,15 +48,18 @@ class MockCompletionDelegate: CodeSuggestionDelegate, ObservableObject {
     class Suggestion: CodeSuggestionEntry {
         var label: String
         var detail: String?
-        var pathComponents: [String]? { nil }
-        var targetPosition: CursorPosition? { nil }
-        var sourcePreview: String? { nil }
+        var pathComponents: [String]?
+        var targetPosition: CursorPosition? = CursorPosition(line: 10, column: 20)
+        var sourcePreview: String?
         var image: Image = Image(systemName: "dot.square.fill")
         var imageColor: Color = .gray
         var deprecated: Bool = false
 
-        init(text: String) {
+        init(text: String, detail: String?, sourcePreview: String?, pathComponents: [String]?) {
             self.label = text
+            self.detail = detail
+            self.sourcePreview = sourcePreview
+            self.pathComponents = pathComponents
         }
     }
 
@@ -67,7 +70,14 @@ class MockCompletionDelegate: CodeSuggestionDelegate, ObservableObject {
             let randomString = (0..<Int.random(in: 1..<text.count)).map {
                 text[$0]
             }.shuffled().joined(separator: " ")
-            suggestions.append(Suggestion(text: randomString))
+            suggestions.append(
+                Suggestion(
+                    text: randomString,
+                    detail: text.randomElement()!,
+                    sourcePreview: randomString,
+                    pathComponents: (0..<Int.random(in: 0..<10)).map { text[$0] }
+                )
+            )
         }
         return suggestions
     }
@@ -103,10 +113,12 @@ class MockCompletionDelegate: CodeSuggestionDelegate, ObservableObject {
         textView: TextViewController,
         cursorPosition: CursorPosition?
     ) {
-        guard let suggestion = item as? Suggestion else {
+        guard let suggestion = item as? Suggestion, let cursorPosition else {
             return
         }
         textView.textView.undoManager?.beginUndoGrouping()
+        textView.textView.selectionManager.setSelectedRange(cursorPosition.range)
+
         textView.textView.insertText(suggestion.label)
         textView.textView.undoManager?.endUndoGrouping()
     }

Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample/Views/MockJumpToDefinitionDelegate.swift

@@ -0,0 +1,34 @@
+//
+//  MockJumpToDefinitionDelegate.swift
+//  CodeEditSourceEditorExample
+//
+//  Created by Khan Winter on 7/24/25.
+//
+
+import AppKit
+import CodeEditSourceEditor
+
+final class MockJumpToDefinitionDelegate: JumpToDefinitionDelegate, ObservableObject {
+    func queryLinks(forRange range: NSRange, textView: TextViewController) async -> [JumpToDefinitionLink]? {
+        [
+            JumpToDefinitionLink(
+                url: nil,
+                targetRange: CursorPosition(line: 0, column: 10),
+                typeName: "Start of Document",
+                sourcePreview: "// Comment at start"
+            ),
+            JumpToDefinitionLink(
+                url: URL(string: "https://codeedit.app/"),
+                targetRange: CursorPosition(line: 1024, column: 10),
+                typeName: "CodeEdit Website",
+                sourcePreview: "https://codeedit.app/"
+            )
+        ]
+    }
+
+    func openLink(link: JumpToDefinitionLink) {
+        if let url = link.url {
+            NSWorkspace.shared.open(url)
+        }
+    }
+}

Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample/Views/StatusBar.swift

@@ -211,6 +211,7 @@ struct StatusBar: View {
         }
 
         // When there's a single cursor, display the line and column.
-        return "Line: \(cursorPositions[0].line)  Col: \(cursorPositions[0].column) Range: \(cursorPositions[0].range)"
+        // swiftlint:disable:next line_length
+        return "Line: \(cursorPositions[0].start.line)  Col: \(cursorPositions[0].start.column) Range: \(cursorPositions[0].range)"
     }
 }

Package.swift

@@ -17,7 +17,7 @@ let package = Package(
         // A fast, efficient, text view for code.
         .package(
             url: "https://github.com/CodeEditApp/CodeEditTextView.git",
-            from: "0.12.0"
+            from: "0.12.1"
         ),
         // tree-sitter languages
         .package(

Sources/CodeEditSourceEditor/CodeSuggestion/Model/CodeSuggestionDelegate.swift

@@ -5,6 +5,7 @@
 //  Created by Abe Malla on 12/26/24.
 //
 
+@MainActor
 public protocol CodeSuggestionDelegate: AnyObject {
     func completionTriggerCharacters() -> Set<String>
 

Sources/CodeEditSourceEditor/CodeSuggestion/Model/CodeSuggestionEntry.swift

@@ -12,6 +12,7 @@ import SwiftUI
 public protocol CodeSuggestionEntry {
     var label: String { get }
     var detail: String? { get }
+    var documentation: String? { get }
 
     /// Leave as `nil` if the link is in the same document.
     var pathComponents: [String]? { get }

Sources/CodeEditSourceEditor/CodeSuggestion/Model/SuggestionViewModel.swift

@@ -7,15 +7,16 @@
 
 import AppKit
 
+@MainActor
 final class SuggestionViewModel: ObservableObject {
     /// The items to be displayed in the window
     @Published var items: [CodeSuggestionEntry] = []
     var itemsRequestTask: Task<Void, Never>?
     weak var activeTextView: TextViewController?
 
-    var delegate: CodeSuggestionDelegate? {
-        activeTextView?.completionDelegate
-    }
+    weak var delegate: CodeSuggestionDelegate?
+
+    private var syntaxHighlightedCache: [Int: NSAttributedString] = [:]
 
     func showCompletions(
         textView: TextViewController,
@@ -24,11 +25,13 @@ final class SuggestionViewModel: ObservableObject {
         showWindowOnParent: @escaping @MainActor (NSWindow, NSRect) -> Void
     ) {
         self.activeTextView = nil
+        self.delegate = nil
         itemsRequestTask?.cancel()
 
         guard let targetParentWindow = textView.view.window else { return }
 
         self.activeTextView = textView
+        self.delegate = delegate
         itemsRequestTask = Task {
             defer { itemsRequestTask = nil }
 
@@ -55,6 +58,7 @@ final class SuggestionViewModel: ObservableObject {
                     }
 
                     self.items = completionItems.items
+                    self.syntaxHighlightedCache = [:]
                     showWindowOnParent(targetParentWindow, cursorRect)
                 }
             } catch {
@@ -93,14 +97,13 @@ final class SuggestionViewModel: ObservableObject {
     }
 
     func applySelectedItem(item: CodeSuggestionEntry, window: NSWindow?) {
-        guard let activeTextView,
-              let cursorPosition = activeTextView.cursorPositions.first else {
+        guard let activeTextView else {
             return
         }
         self.delegate?.completionWindowApplyCompletion(
             item: item,
             textView: activeTextView,
-            cursorPosition: cursorPosition
+            cursorPosition: activeTextView.cursorPositions.first
         )
         window?.close()
     }
@@ -109,4 +112,26 @@ final class SuggestionViewModel: ObservableObject {
         items.removeAll()
         activeTextView = nil
     }
+
+    func syntaxHighlights(forIndex index: Int) -> NSAttributedString? {
+        if let cached = syntaxHighlightedCache[index] {
+            return cached
+        }
+
+        if let sourcePreview = items[index].sourcePreview,
+           let theme = activeTextView?.theme,
+           let font = activeTextView?.font,
+           let language = activeTextView?.language {
+            let string = TreeSitterClient.quickHighlight(
+                string: sourcePreview,
+                theme: theme,
+                font: font,
+                language: language
+            )
+            syntaxHighlightedCache[index] = string
+            return string
+        }
+
+        return nil
+    }
 }