-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CodyInlineCompletionProvider as an alternative for inlay completi…
…ons (#2304) Fixes https://linear.app/sourcegraph/issue/CODY-3742. <!-- start git-machete generated --> # Based on PR #2303 ## Full chain of PRs as of 2024-09-16 * PR #2304: `mkondratek/feat/completion-provider` ➔ `mkondratek/chore/ui-fixes` * PR #2303: `mkondratek/chore/ui-fixes` ➔ `main` <!-- end git-machete generated --> ## Test plan AUTOMATIC 1. Run IDE in Remote Development mode 2. Open a project, open a file 3. Hit Enter to trigger autocomplete Expected: autocompletion suggested INVOKE 1. `shift + option + \` on **macOS** Expected: autocompletion suggested
- Loading branch information
1 parent
2446c5c
commit e84c6ce
Showing
9 changed files
with
469 additions
and
146 deletions.
There are no files selected for viewing
This file contains 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
92 changes: 92 additions & 0 deletions
92
src/main/kotlin/com/intellij/codeInsight/inline/completion/InlineCompletionEvent.kt
This file contains 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,92 @@ | ||
// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the | ||
// Apache 2.0 license. | ||
package com.intellij.codeInsight.inline.completion | ||
|
||
import com.intellij.codeInsight.lookup.LookupElement | ||
import com.intellij.codeInsight.lookup.LookupEvent | ||
import com.intellij.openapi.actionSystem.DataContext | ||
import com.intellij.openapi.application.runReadAction | ||
import com.intellij.openapi.editor.Caret | ||
import com.intellij.openapi.editor.Document | ||
import com.intellij.openapi.editor.Editor | ||
import com.intellij.openapi.project.Project | ||
import com.intellij.openapi.util.UserDataHolderBase | ||
import com.intellij.psi.PsiDocumentManager | ||
import com.intellij.psi.PsiFile | ||
import com.intellij.psi.impl.source.PsiFileImpl | ||
import com.intellij.psi.util.PsiUtilBase | ||
import com.intellij.util.concurrency.annotations.RequiresBlockingContext | ||
|
||
class InlineCompletionRequest( | ||
val event: InlineCompletionEvent, | ||
val file: PsiFile, | ||
val editor: Editor, | ||
val document: Document, | ||
val startOffset: Int, | ||
val endOffset: Int, | ||
val lookupElement: LookupElement? = null, | ||
) : UserDataHolderBase() | ||
|
||
/** | ||
* Be aware that creating your own event is unsafe for a while and might face compatibility issues | ||
*/ | ||
interface InlineCompletionEvent { | ||
|
||
@RequiresBlockingContext fun toRequest(): InlineCompletionRequest? | ||
|
||
/** A class representing a direct call in the code editor by [InsertInlineCompletionAction]. */ | ||
class DirectCall( | ||
val editor: Editor, | ||
val caret: Caret, | ||
val context: DataContext? = null, | ||
) : InlineCompletionEvent { | ||
override fun toRequest(): InlineCompletionRequest? { | ||
val offset = runReadAction { caret.offset } | ||
val project = editor.project ?: return null | ||
val file = getPsiFile(caret, project) ?: return null | ||
return InlineCompletionRequest(this, file, editor, editor.document, offset, offset) | ||
} | ||
} | ||
|
||
sealed interface InlineLookupEvent : InlineCompletionEvent { | ||
val event: LookupEvent | ||
|
||
override fun toRequest(): InlineCompletionRequest? { | ||
val editor = runReadAction { event.lookup?.editor } ?: return null | ||
val caretModel = editor.caretModel | ||
if (caretModel.caretCount != 1) return null | ||
|
||
val project = editor.project ?: return null | ||
|
||
val (file, offset) = | ||
runReadAction { getPsiFile(caretModel.currentCaret, project) to caretModel.offset } | ||
if (file == null) return null | ||
|
||
return InlineCompletionRequest( | ||
this, file, editor, editor.document, offset, offset, event.item) | ||
} | ||
} | ||
} | ||
|
||
@RequiresBlockingContext | ||
private fun getPsiFile(caret: Caret, project: Project): PsiFile? { | ||
return runReadAction { | ||
val file = | ||
PsiDocumentManager.getInstance(project).getPsiFile(caret.editor.document) | ||
?: return@runReadAction null | ||
// * [PsiUtilBase] takes into account injected [PsiFile] (like in Jupyter Notebooks) | ||
// * However, it loads a file into the memory, which is expensive | ||
// * Some tests forbid loading a file when tearing down | ||
// * On tearing down, Lookup Cancellation happens, which causes the event | ||
// * Existence of [treeElement] guarantees that it's in the memory | ||
if (file.isLoadedInMemory()) { | ||
PsiUtilBase.getPsiFileInEditor(caret, project) | ||
} else { | ||
file | ||
} | ||
} | ||
} | ||
|
||
private fun PsiFile.isLoadedInMemory(): Boolean { | ||
return (this as? PsiFileImpl)?.treeElement != null | ||
} |
34 changes: 34 additions & 0 deletions
34
src/main/kotlin/com/intellij/codeInsight/inline/completion/InlineCompletionSuggestion.kt
This file contains 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,34 @@ | ||
// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the | ||
// Apache 2.0 license. | ||
package com.intellij.codeInsight.inline.completion | ||
|
||
import com.intellij.codeInsight.inline.completion.elements.InlineCompletionElement | ||
import com.intellij.openapi.util.UserDataHolderBase | ||
import kotlinx.coroutines.flow.Flow | ||
import kotlinx.coroutines.flow.FlowCollector | ||
import kotlinx.coroutines.flow.emptyFlow | ||
import kotlinx.coroutines.flow.flow | ||
|
||
/** | ||
* Abstract class representing an inline completion suggestion. | ||
* | ||
* Provides the suggestion flow for generating only one suggestion. | ||
* | ||
* @see InlineCompletionElement | ||
*/ | ||
abstract class InlineCompletionSuggestion : UserDataHolderBase() { | ||
abstract val suggestionFlow: Flow<InlineCompletionElement> | ||
|
||
class Default(override val suggestionFlow: Flow<InlineCompletionElement>) : | ||
InlineCompletionSuggestion() | ||
|
||
companion object { | ||
fun empty(): InlineCompletionSuggestion = Default(emptyFlow()) | ||
|
||
fun withFlow( | ||
buildSuggestion: suspend FlowCollector<InlineCompletionElement>.() -> Unit | ||
): InlineCompletionSuggestion { | ||
return Default(flow(buildSuggestion)) | ||
} | ||
} | ||
} |
5 changes: 5 additions & 0 deletions
5
...ain/kotlin/com/intellij/codeInsight/inline/completion/elements/InlineCompletionElement.kt
This file contains 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,5 @@ | ||
// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the | ||
// Apache 2.0 license. | ||
package com.intellij.codeInsight.inline.completion.elements | ||
|
||
interface InlineCompletionElement |
5 changes: 5 additions & 0 deletions
5
...in/com/intellij/codeInsight/inline/completion/elements/InlineCompletionGrayTextElement.kt
This file contains 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,5 @@ | ||
// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the | ||
// Apache 2.0 license. | ||
package com.intellij.codeInsight.inline.completion.elements | ||
|
||
class InlineCompletionGrayTextElement(val text: String) : InlineCompletionElement |
This file contains 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.