-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Intellij Plugin: Implement registered name codeVision hint (#248)
* Implement registered name codeVision hint * Rename codeVision class * Specify type explicitly * Fix type specification * Update plugin versions and fix detekt errors * Fix compatibility with IJ203 * Fix missed renames
- Loading branch information
Showing
6 changed files
with
200 additions
and
6 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
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
178 changes: 178 additions & 0 deletions
178
...tellij-plugin/src/main/kotlin/godot/intellij/plugin/codevision/RegisteredNameInlayHint.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,178 @@ | ||
| package godot.intellij.plugin.codevision | ||
|
|
||
| import com.intellij.codeInsight.hints.ChangeListener | ||
| import com.intellij.codeInsight.hints.FactoryInlayHintsCollector | ||
| import com.intellij.codeInsight.hints.ImmediateConfigurable | ||
| import com.intellij.codeInsight.hints.InlayHintsCollector | ||
| import com.intellij.codeInsight.hints.InlayHintsProvider | ||
| import com.intellij.codeInsight.hints.InlayHintsSink | ||
| import com.intellij.codeInsight.hints.InlayPresentationFactory | ||
| import com.intellij.codeInsight.hints.NoSettings | ||
| import com.intellij.codeInsight.hints.SettingsKey | ||
| import com.intellij.openapi.editor.Editor | ||
| import com.intellij.openapi.editor.ex.util.EditorUtil | ||
| import com.intellij.openapi.ide.CopyPasteManager | ||
| import com.intellij.psi.PsiElement | ||
| import com.intellij.psi.PsiFile | ||
| import com.intellij.refactoring.suggested.startOffset | ||
| import com.intellij.ui.layout.panel | ||
| import godot.intellij.plugin.GodotPluginBundle | ||
| import godot.intellij.plugin.data.model.REGISTER_CLASS_ANNOTATION | ||
| import godot.intellij.plugin.data.model.REGISTER_FUNCTION_ANNOTATION | ||
| import godot.intellij.plugin.data.model.REGISTER_PROPERTY_ANNOTATION | ||
| import godot.intellij.plugin.data.model.REGISTER_SIGNAL_ANNOTATION | ||
| import godot.intellij.plugin.extension.camelToSnakeCase | ||
| import org.jetbrains.kotlin.idea.util.findAnnotation | ||
| import org.jetbrains.kotlin.name.FqName | ||
| import org.jetbrains.kotlin.psi.KtClass | ||
| import org.jetbrains.kotlin.psi.KtFile | ||
| import org.jetbrains.kotlin.psi.KtNamedFunction | ||
| import org.jetbrains.kotlin.psi.KtProperty | ||
| import java.awt.Point | ||
| import java.awt.datatransfer.StringSelection | ||
| import java.awt.event.MouseEvent | ||
| import javax.swing.JPanel | ||
|
|
||
| @Suppress("UnstableApiUsage") | ||
| class RegisteredNameInlayHint : InlayHintsProvider<NoSettings> { | ||
|
|
||
| override val key: SettingsKey<NoSettings> = SettingsKey("RegisteredNameInlayHint") | ||
| override val name: String = GodotPluginBundle.message("codeVision.name") | ||
| override val previewText: String? = null | ||
|
|
||
| override fun createConfigurable(settings: NoSettings): ImmediateConfigurable = object : ImmediateConfigurable { | ||
| override fun reset() { | ||
| // no op | ||
| } | ||
|
|
||
| override fun createComponent(listener: ChangeListener): JPanel = panel {} | ||
| override val cases: List<ImmediateConfigurable.Case> = emptyList() | ||
| override val mainCheckboxText: String = GodotPluginBundle.message("codeVision.settings.enableCheckbox") | ||
| } | ||
|
|
||
| override fun createSettings(): NoSettings = NoSettings() | ||
|
|
||
| override fun getCollectorFor( | ||
| file: PsiFile, | ||
| editor: Editor, | ||
| settings: NoSettings, | ||
| sink: InlayHintsSink | ||
| ): InlayHintsCollector { | ||
| return object : InlayHintsCollector, FactoryInlayHintsCollector(editor) { | ||
| override fun collect(element: PsiElement, editor: Editor, sink: InlayHintsSink): Boolean { | ||
| return if (element is KtFile) { | ||
| val classes = element | ||
| .children | ||
| .filterIsInstance<KtClass>() | ||
|
|
||
| val registeredClasses = classes | ||
| .filter { it.findAnnotation(FqName(REGISTER_CLASS_ANNOTATION)) != null } | ||
|
|
||
| val functions = classes | ||
| .flatMap { it.declarations.filterIsInstance<KtNamedFunction>() } | ||
| .filter { it.findAnnotation(FqName(REGISTER_FUNCTION_ANNOTATION)) != null } | ||
| .filter { it.name != null } | ||
|
|
||
| val properties = classes | ||
| .flatMap { it.declarations.filterIsInstance<KtProperty>() } | ||
| .filter { it.findAnnotation(FqName(REGISTER_PROPERTY_ANNOTATION)) != null } | ||
| .filter { it.name != null } | ||
|
|
||
| val signals = classes | ||
| .flatMap { it.declarations.filterIsInstance<KtProperty>() } | ||
| .filter { it.findAnnotation(FqName(REGISTER_SIGNAL_ANNOTATION)) != null } | ||
| .filter { it.name != null } | ||
|
|
||
| registeredClasses.forEach { ktClass -> | ||
| showCodeVision( | ||
| textOffset = ktClass.textOffset, | ||
| startOffset = ktClass.startOffset, | ||
| convertedName = ktClass | ||
| .fqName | ||
| ?.asString() | ||
| ?.replace(".", "_") | ||
| ?: "<unknown>", | ||
| editor = editor, | ||
| sink = sink | ||
| ) | ||
| } | ||
|
|
||
| functions.forEach { ktFunction -> | ||
| showCodeVision( | ||
| textOffset = ktFunction.textOffset, | ||
| startOffset = ktFunction.startOffset, | ||
| convertedName = ktFunction.name?.camelToSnakeCase() ?: "<unknown>", | ||
| editor = editor, | ||
| sink = sink | ||
| ) | ||
| } | ||
|
|
||
| properties.forEach { ktProperty -> | ||
| showCodeVision( | ||
| textOffset = ktProperty.textOffset, | ||
| startOffset = ktProperty.startOffset, | ||
| convertedName = ktProperty.name?.camelToSnakeCase() ?: "<unknown>", | ||
| editor = editor, | ||
| sink = sink | ||
| ) | ||
| } | ||
|
|
||
| signals.forEach { ktProperty -> | ||
| showCodeVision( | ||
| textOffset = ktProperty.textOffset, | ||
| startOffset = ktProperty.startOffset, | ||
| convertedName = ktProperty | ||
| .name | ||
| ?.removePrefix("signal") | ||
| ?.camelToSnakeCase() | ||
| ?: "<unknown>", | ||
| editor = editor, | ||
| sink = sink | ||
| ) | ||
| } | ||
|
|
||
| registeredClasses.isNotEmpty() || functions.isNotEmpty() || properties.isNotEmpty() || signals.isNotEmpty() | ||
| } else false | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun FactoryInlayHintsCollector.showCodeVision( | ||
| textOffset: Int, | ||
| startOffset: Int, | ||
| convertedName: String, | ||
| editor: Editor, | ||
| sink: InlayHintsSink | ||
| ) { | ||
| val line = editor.document.getLineNumber(startOffset) | ||
| val lineStart = editor.document.getLineStartOffset(line) | ||
| val indent = EditorUtil.getPlainSpaceWidth(editor) * (startOffset - lineStart) | ||
| sink.addBlockElement( | ||
| offset = textOffset, | ||
| relatesToPrecedingText = false, | ||
| showAbove = true, | ||
| priority = 0, | ||
| presentation = factory.inset( | ||
| factory.withTooltip( | ||
| GodotPluginBundle.message("codeVision.registeredName.tooltip"), | ||
| factory.referenceOnHover( | ||
| factory.text( | ||
| GodotPluginBundle.message( | ||
| "codeVision.registeredName.text", | ||
| convertedName | ||
| ) | ||
| ), | ||
| // has to be explicit for backwards compatibility with IJ203 | ||
| @Suppress("ObjectLiteralToLambda") | ||
| object : InlayPresentationFactory.ClickListener { | ||
| override fun onClick(event: MouseEvent, translated: Point) { | ||
| CopyPasteManager.getInstance().setContents(StringSelection(convertedName)) | ||
| } | ||
| } | ||
| ) | ||
| ), | ||
| indent | ||
| ) | ||
| ) | ||
| } | ||
| } |
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
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
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