Skip to content
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.

Sign up for GitHub

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

Use reflection-based PsiElement in error reporting #445

Merged
merged 1 commit into from
Dec 10, 2024
Merged

Use reflection-based PsiElement in error reporting #445

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 35 additions & 8 deletions poko-compiler-plugin/src/main/kotlin/dev/drewhamilton/poko/fir/PokoFirCheckersExtension.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
package dev.drewhamilton.poko.fir

import org.jetbrains.kotlin.KtFakeSourceElementKind
import org.jetbrains.kotlin.com.intellij.psi.PsiElement
import org.jetbrains.kotlin.descriptors.ClassKind
import org.jetbrains.kotlin.diagnostics.AbstractSourceElementPositioningStrategy
import org.jetbrains.kotlin.diagnostics.DiagnosticFactory0DelegateProvider
import org.jetbrains.kotlin.diagnostics.DiagnosticReporter
import org.jetbrains.kotlin.diagnostics.KtDiagnosticFactoryToRendererMap
import org.jetbrains.kotlin.diagnostics.Severity
import org.jetbrains.kotlin.diagnostics.SourceElementPositioningStrategies
import org.jetbrains.kotlin.diagnostics.error0
import org.jetbrains.kotlin.diagnostics.rendering.BaseDiagnosticRendererFactory
import org.jetbrains.kotlin.diagnostics.rendering.RootDiagnosticRendererFactory
import org.jetbrains.kotlin.diagnostics.reportOn
Expand Down Expand Up @@ -78,27 +79,40 @@ internal class PokoFirCheckersExtension(

private object Errors : BaseDiagnosticRendererFactory() {

val PokoOnNonClass by error0<PsiElement>(
/**
* The compiler and the IDE use a different version of this class, so use reflection to find the available
* version.
*/
// Adapted from https://github.com/TadeasKriz/K2PluginBase/blob/main/kotlin-plugin/src/main/kotlin/com/tadeaskriz/example/ExamplePluginErrors.kt#L8
private val psiElementClass by lazy {
try {
Class.forName("org.jetbrains.kotlin.com.intellij.psi.PsiElement")
} catch (_: ClassNotFoundException) {
Class.forName("com.intellij.psi.PsiElement")
Comment on lines +88 to +91
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I swapped the order from the example, because I think the former is the one used by the compiler while the latter is used by the IDE, and I want the compiler to be faster. Not sure about this though.

}.kotlin
}

val PokoOnNonClass by error0(
positioningStrategy = SourceElementPositioningStrategies.NAME_IDENTIFIER,
)

val PokoOnDataClass by error0<PsiElement>(
val PokoOnDataClass by error0(
positioningStrategy = SourceElementPositioningStrategies.DATA_MODIFIER,
)

val PokoOnValueClass by error0<PsiElement>(
val PokoOnValueClass by error0(
positioningStrategy = SourceElementPositioningStrategies.INLINE_OR_VALUE_MODIFIER,
)

val PokoOnInnerClass by error0<PsiElement>(
val PokoOnInnerClass by error0(
positioningStrategy = SourceElementPositioningStrategies.INNER_MODIFIER,
)

val PrimaryConstructorRequired by error0<PsiElement>(
val PrimaryConstructorRequired by error0(
positioningStrategy = SourceElementPositioningStrategies.NAME_IDENTIFIER,
)

val PrimaryConstructorPropertiesRequired by error0<PsiElement>(
val PrimaryConstructorPropertiesRequired by error0(
positioningStrategy = SourceElementPositioningStrategies.NAME_IDENTIFIER,
)

Expand Down Expand Up @@ -132,5 +146,18 @@ internal class PokoFirCheckersExtension(
init {
RootDiagnosticRendererFactory.registerFactory(this)
}

/**
* Copy of [org.jetbrains.kotlin.diagnostics.error0] with hack for correct `PsiElement` class.
*/
private fun error0(
positioningStrategy: AbstractSourceElementPositioningStrategy = SourceElementPositioningStrategies.DEFAULT,
): DiagnosticFactory0DelegateProvider {
return DiagnosticFactory0DelegateProvider(
severity = Severity.ERROR,
positioningStrategy = positioningStrategy,
psiType = psiElementClass,
)
}
}
}
Loading