-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Autocomplete Implementation #1949
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
FastestMolasses
wants to merge
11
commits into
main
Choose a base branch
from
itembox
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
ab126d5
Autocomplete Coordinator
FastestMolasses 4d24153
Merge branch 'main' into itembox
FastestMolasses 02fb3b5
ItemBox updates
FastestMolasses 6f80528
Merge branch 'main' into itembox
FastestMolasses a2de090
Autocomplete updates
FastestMolasses a432688
Update cursor positioning
FastestMolasses e81ac20
UX updates
FastestMolasses 8e29a0c
Added item filtering based on cursor position
FastestMolasses 336cab0
Added CodeSuggestionEntry types to CESE
FastestMolasses 48a7fd6
Remove completion example
FastestMolasses e08fde2
Merge branch 'main' into itembox
FastestMolasses File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,263 @@ | ||
| // | ||
| // AutoCompleteCoordinator.swift | ||
| // CodeEdit | ||
| // | ||
| // Created by Abe Malla on 9/20/24. | ||
| // | ||
|
|
||
| import AppKit | ||
| import SwiftTreeSitter | ||
| import CodeEditTextView | ||
| import CodeEditSourceEditor | ||
| import LanguageServerProtocol | ||
|
|
||
| class AutoCompleteCoordinator: TextViewCoordinator { | ||
| /// A reference to the `TextViewController`, to be able to make edits | ||
| private weak var textViewController: TextViewController? | ||
| /// A reference to the file we are working with, to be able to query file information | ||
| private unowned var file: CEWorkspaceFile | ||
| /// The event monitor that looks for the keyboard shortcut to bring up the autocomplete menu | ||
| private var localEventMonitor: Any? | ||
| /// The `SuggestionController` lets us display the autocomplete items | ||
| private var suggestionController: SuggestionController? | ||
| /// The current TreeSitter node that the main cursor is at | ||
| private var currentNode: SwiftTreeSitter.Node? | ||
| /// The current filter text based on partial token input | ||
| private var currentFilterText: String = "" | ||
| /// Stores the unfiltered completion items | ||
| private var completionItems: [CompletionItem] = [] | ||
|
|
||
| init(_ file: CEWorkspaceFile) { | ||
| self.file = file | ||
| } | ||
|
|
||
| func prepareCoordinator(controller: TextViewController) { | ||
| suggestionController = SuggestionController() | ||
| suggestionController?.delegate = self | ||
| suggestionController?.close() | ||
| self.textViewController = controller | ||
|
|
||
| localEventMonitor = NSEvent.addLocalMonitorForEvents(matching: .keyDown) { event in | ||
| // `ctrl + space` keyboard shortcut listener for the item box to show | ||
| if event.modifierFlags.contains(.control) && event.charactersIgnoringModifiers == " " { | ||
| Task { | ||
| await self.showAutocompleteWindow() | ||
| } | ||
| return nil | ||
| } | ||
| return event | ||
| } | ||
| } | ||
|
|
||
| /// Will query the language server for autocomplete suggestions and then display the window. | ||
| @MainActor | ||
| func showAutocompleteWindow() { | ||
| guard let cursorPos = textViewController?.cursorPositions.first, | ||
| let textView = textViewController?.textView, | ||
| let window = NSApplication.shared.keyWindow, | ||
| let suggestionController = suggestionController | ||
| else { | ||
| return | ||
| } | ||
|
|
||
| var tokenSubstringCount = 0 | ||
| currentFilterText = "" | ||
| do { | ||
| if let token = try textViewController?.treeSitterClient?.nodesAt(range: cursorPos.range).first { | ||
| if tokenIsActionable(token.node) { | ||
| currentNode = token.node | ||
|
|
||
| // Get the string from the start of the token to the location of the cursor | ||
| if cursorPos.range.location > token.node.range.location { | ||
| let selectedRange = NSRange( | ||
| location: token.node.range.location, | ||
| length: cursorPos.range.location - token.node.range.location | ||
| ) | ||
| if let tokenSubstring = textView.textStorage?.substring(from: selectedRange) { | ||
| currentFilterText = tokenSubstring | ||
| tokenSubstringCount = tokenSubstring.count | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } catch { | ||
| print("Error getting TreeSitter node: \(error)") | ||
| } | ||
|
|
||
| Task { | ||
| var textPosition = Position(line: cursorPos.line - 1, character: cursorPos.column - 1) | ||
| // If we are asking for completions in the middle of a token, then | ||
| // query the language server for completion items at the start of the token | ||
| if currentNode != nil { | ||
| textPosition = Position( | ||
| line: cursorPos.line - 1, | ||
| character: cursorPos.column - tokenSubstringCount - 1 | ||
| ) | ||
| } | ||
| completionItems = await fetchCompletions(position: textPosition) | ||
| suggestionController.items = filterCompletionItems(completionItems) | ||
|
|
||
| let cursorRect = textView.firstRect(forCharacterRange: cursorPos.range, actualRange: nil) | ||
| suggestionController.constrainWindowToScreenEdges( | ||
| cursorRect: cursorRect, | ||
| // TODO: CALCULATE PADDING BASED ON FONT SIZE, THIS IS JUST TEMP | ||
| horizontalOffset: 13 + 16.5 + CGFloat(tokenSubstringCount) * 7.4 | ||
| ) | ||
| suggestionController.showWindow(attachedTo: window) | ||
| } | ||
| } | ||
|
|
||
| private func fetchCompletions(position: Position) async -> [CompletionItem] { | ||
| let workspace = await file.fileDocument?.findWorkspace() | ||
| guard let workspacePath = workspace?.fileURL?.absoluteURL.path() else { return [] } | ||
| guard let language = await file.fileDocument?.getLanguage().lspLanguage else { return [] } | ||
|
|
||
| @Service var lspService: LSPService | ||
| guard let client = await lspService.languageClient( | ||
| for: language, | ||
| workspacePath: workspacePath | ||
| ) else { | ||
| return [] | ||
| } | ||
|
|
||
| do { | ||
| let completions = try await client.requestCompletion( | ||
| for: file.url.absoluteURL.path(), | ||
| position: position | ||
| ) | ||
|
|
||
| // Extract the completion items list | ||
| switch completions { | ||
| case .optionA(let completionItems): | ||
| return completionItems | ||
| case .optionB(let completionList): | ||
| return completionList.items | ||
| case .none: | ||
| return [] | ||
| } | ||
| } catch { | ||
| return [] | ||
| } | ||
| } | ||
|
|
||
| /// Filters completion items based on the current partial token input | ||
| private func filterCompletionItems(_ items: [CompletionItem]) -> [CompletionItem] { | ||
| guard !currentFilterText.isEmpty else { | ||
| return items | ||
| } | ||
|
|
||
| return items.filter { item in | ||
| let insertText = LSPCompletionItemsUtil.getInsertText(from: item) | ||
| let label = item.label.lowercased() | ||
| let filterText = currentFilterText.lowercased() | ||
| if insertText.lowercased().hasPrefix(filterText) { | ||
| return true | ||
| } | ||
| if label.hasPrefix(filterText) { | ||
| return true | ||
| } | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| /// Determines if a TreeSitter node is a type where we can build featues off of. This helps filter out | ||
| /// nodes that represent blank spaces or other information that is not useful. | ||
| private func tokenIsActionable(_ node: SwiftTreeSitter.Node) -> Bool { | ||
| // List of node types that should have their text be replaced | ||
| let replaceableTypes: Set<String> = [ | ||
| "identifier", | ||
| "property_identifier", | ||
| "field_identifier", | ||
| "variable_name", | ||
| "method_name", | ||
| "function_name", | ||
| "type_identifier" | ||
| ] | ||
| return replaceableTypes.contains(node.nodeType ?? "") | ||
| } | ||
|
|
||
| deinit { | ||
| suggestionController?.close() | ||
| if let localEventMonitor = localEventMonitor { | ||
| NSEvent.removeMonitor(localEventMonitor) | ||
| self.localEventMonitor = nil | ||
| } | ||
| } | ||
| } | ||
|
|
||
| extension AutoCompleteCoordinator: SuggestionControllerDelegate { | ||
| /// Takes a `CompletionItem` and modifies the text view with the new string | ||
| func applyCompletionItem(item: CodeSuggestionEntry) { | ||
| guard let cursorPos = textViewController?.cursorPositions.first, | ||
| let item = item as? CompletionItem, | ||
| let textView = textViewController?.textView else { | ||
| return | ||
| } | ||
|
|
||
| // Make the updates | ||
| let replacementRange = currentNode?.range ?? cursorPos.range | ||
| let insertText = LSPCompletionItemsUtil.getInsertText(from: item) | ||
| textView.undoManager?.beginUndoGrouping() | ||
| textView.replaceString(in: replacementRange, with: insertText) | ||
| textView.undoManager?.endUndoGrouping() | ||
|
|
||
| // Set cursor position to end of inserted text | ||
| let newCursorRange = NSRange(location: replacementRange.location + insertText.count, length: 0) | ||
| textViewController?.setCursorPositions([CursorPosition(range: newCursorRange)]) | ||
|
|
||
| self.onCompletion() | ||
| } | ||
|
|
||
| func onCompletion() { } | ||
|
|
||
| func onCursorMove() { | ||
| guard let cursorPos = textViewController?.cursorPositions.first, | ||
| let suggestionController = suggestionController, | ||
| let textView = self.textViewController?.textView, | ||
| suggestionController.isVisible | ||
| else { | ||
| return | ||
| } | ||
| guard let currentNode = currentNode, | ||
| !suggestionController.items.isEmpty else { | ||
| self.suggestionController?.close() | ||
| return | ||
| } | ||
|
|
||
| // Moving to a new token requires a new call to the language server | ||
| // We extend the range so that the `contains` can include the end value of | ||
| // the token, since its check is exclusive. | ||
| let adjustedRange = currentNode.range.shifted(endBy: 1) | ||
| if let adjustedRange = adjustedRange, | ||
| !adjustedRange.contains(cursorPos.range.location) { | ||
| suggestionController.close() | ||
| return | ||
| } | ||
|
|
||
| // Check if cursor is at the start of the token | ||
| if cursorPos.range.location == currentNode.range.location { | ||
| currentFilterText = "" | ||
| suggestionController.items = completionItems | ||
| return | ||
| } | ||
|
|
||
| // Filter through the completion items based on how far the cursor is in the token | ||
| if cursorPos.range.location > currentNode.range.location { | ||
| let selectedRange = NSRange( | ||
| location: currentNode.range.location, | ||
| length: cursorPos.range.location - currentNode.range.location | ||
| ) | ||
| if let tokenSubstring = textView.textStorage?.substring(from: selectedRange) { | ||
| currentFilterText = tokenSubstring | ||
| suggestionController.items = filterCompletionItems(completionItems) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func onItemSelect(item: CodeSuggestionEntry) { } | ||
|
|
||
| func onClose() { | ||
| currentNode = nil | ||
| currentFilterText = "" | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.