org.jetbrains.kotlin.diagnostics.KtDiagnostic.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-compiler-embeddable Show documentation
Show all versions of kotlin-compiler-embeddable Show documentation
the Kotlin compiler embeddable
/*
* Copyright 2010-2021 JetBrains s.r.o. and Kotlin Programming Language contributors.
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
*/
package org.jetbrains.kotlin.diagnostics
import com.intellij.openapi.util.TextRange
import com.intellij.psi.PsiElement
import com.intellij.psi.PsiFile
import org.jetbrains.kotlin.AbstractKtSourceElement
import org.jetbrains.kotlin.KtLightSourceElement
import org.jetbrains.kotlin.KtPsiSourceElement
// ------------------------------ diagnostics ------------------------------
sealed class KtDiagnostic : DiagnosticMarker {
abstract val element: AbstractKtSourceElement
abstract val severity: Severity
abstract val factory: AbstractKtDiagnosticFactory
abstract val positioningStrategy: AbstractSourceElementPositioningStrategy
val textRanges: List
get() = positioningStrategy.markDiagnostic(this)
val isValid: Boolean
get() = positioningStrategy.isValid(element)
override val factoryName: String
get() = factory.name
}
sealed class KtSimpleDiagnostic : KtDiagnostic() {
abstract override val factory: KtDiagnosticFactory0
}
sealed class KtDiagnosticWithParameters1 : KtDiagnostic(), DiagnosticWithParameters1Marker {
abstract override val a: A
abstract override val factory: KtDiagnosticFactory1
}
sealed class KtDiagnosticWithParameters2 : KtDiagnostic(), DiagnosticWithParameters2Marker {
abstract override val a: A
abstract override val b: B
abstract override val factory: KtDiagnosticFactory2
}
sealed class KtDiagnosticWithParameters3 : KtDiagnostic(), DiagnosticWithParameters3Marker {
abstract override val a: A
abstract override val b: B
abstract override val c: C
abstract override val factory: KtDiagnosticFactory3
}
sealed class KtDiagnosticWithParameters4 : KtDiagnostic(), DiagnosticWithParameters4Marker {
abstract override val a: A
abstract override val b: B
abstract override val c: C
abstract override val d: D
abstract override val factory: KtDiagnosticFactory4
}
// ------------------------------ psi diagnostics ------------------------------
interface KtPsiDiagnostic : DiagnosticMarker {
val factory: AbstractKtDiagnosticFactory
val element: KtPsiSourceElement
val textRanges: List
val severity: Severity
override val psiElement: PsiElement
get() = element.psi
val psiFile: PsiFile
get() = psiElement.containingFile
}
private const val CHECK_PSI_CONSISTENCY_IN_DIAGNOSTICS = true
private fun KtPsiDiagnostic.checkPsiTypeConsistency() {
if (CHECK_PSI_CONSISTENCY_IN_DIAGNOSTICS) {
require(factory.psiType.isInstance(element.psi)) {
"${element.psi::class} is not a subtype of ${factory.psiType} for factory $factory"
}
}
}
data class KtPsiSimpleDiagnostic(
override val element: KtPsiSourceElement,
override val severity: Severity,
override val factory: KtDiagnosticFactory0,
override val positioningStrategy: AbstractSourceElementPositioningStrategy
) : KtSimpleDiagnostic(), KtPsiDiagnostic {
init {
checkPsiTypeConsistency()
}
}
data class KtPsiDiagnosticWithParameters1(
override val element: KtPsiSourceElement,
override val a: A,
override val severity: Severity,
override val factory: KtDiagnosticFactory1,
override val positioningStrategy: AbstractSourceElementPositioningStrategy
) : KtDiagnosticWithParameters1(), KtPsiDiagnostic {
init {
checkPsiTypeConsistency()
}
}
data class KtPsiDiagnosticWithParameters2(
override val element: KtPsiSourceElement,
override val a: A,
override val b: B,
override val severity: Severity,
override val factory: KtDiagnosticFactory2,
override val positioningStrategy: AbstractSourceElementPositioningStrategy
) : KtDiagnosticWithParameters2(), KtPsiDiagnostic {
init {
checkPsiTypeConsistency()
}
}
data class KtPsiDiagnosticWithParameters3(
override val element: KtPsiSourceElement,
override val a: A,
override val b: B,
override val c: C,
override val severity: Severity,
override val factory: KtDiagnosticFactory3,
override val positioningStrategy: AbstractSourceElementPositioningStrategy
) : KtDiagnosticWithParameters3(), KtPsiDiagnostic {
init {
checkPsiTypeConsistency()
}
}
data class KtPsiDiagnosticWithParameters4(
override val element: KtPsiSourceElement,
override val a: A,
override val b: B,
override val c: C,
override val d: D,
override val severity: Severity,
override val factory: KtDiagnosticFactory4,
override val positioningStrategy: AbstractSourceElementPositioningStrategy
) : KtDiagnosticWithParameters4(), KtPsiDiagnostic {
init {
checkPsiTypeConsistency()
}
}
// ------------------------------ light tree diagnostics ------------------------------
interface KtLightDiagnostic : DiagnosticMarker {
val element: KtLightSourceElement
@Deprecated("Should not be called", level = DeprecationLevel.HIDDEN)
override val psiElement: PsiElement
get() = error("psiElement should not be called on KtLightDiagnostic")
}
data class KtLightSimpleDiagnostic(
override val element: KtLightSourceElement,
override val severity: Severity,
override val factory: KtDiagnosticFactory0,
override val positioningStrategy: AbstractSourceElementPositioningStrategy
) : KtSimpleDiagnostic(), KtLightDiagnostic
data class KtLightDiagnosticWithParameters1(
override val element: KtLightSourceElement,
override val a: A,
override val severity: Severity,
override val factory: KtDiagnosticFactory1,
override val positioningStrategy: AbstractSourceElementPositioningStrategy
) : KtDiagnosticWithParameters1(), KtLightDiagnostic
data class KtLightDiagnosticWithParameters2(
override val element: KtLightSourceElement,
override val a: A,
override val b: B,
override val severity: Severity,
override val factory: KtDiagnosticFactory2,
override val positioningStrategy: AbstractSourceElementPositioningStrategy
) : KtDiagnosticWithParameters2(), KtLightDiagnostic
data class KtLightDiagnosticWithParameters3(
override val element: KtLightSourceElement,
override val a: A,
override val b: B,
override val c: C,
override val severity: Severity,
override val factory: KtDiagnosticFactory3,
override val positioningStrategy: AbstractSourceElementPositioningStrategy
) : KtDiagnosticWithParameters3(), KtLightDiagnostic
data class KtLightDiagnosticWithParameters4(
override val element: KtLightSourceElement,
override val a: A,
override val b: B,
override val c: C,
override val d: D,
override val severity: Severity,
override val factory: KtDiagnosticFactory4,
override val positioningStrategy: AbstractSourceElementPositioningStrategy
) : KtDiagnosticWithParameters4(), KtLightDiagnostic
// ------------------------------ light tree diagnostics ------------------------------
interface KtOffsetsOnlyDiagnostic : DiagnosticMarker {
val element: AbstractKtSourceElement
@Deprecated("Should not be called", level = DeprecationLevel.HIDDEN)
override val psiElement: PsiElement
get() = error("psiElement should not be called on KtOffsetsOnlyDiagnostic")
}
data class KtOffsetsOnlySimpleDiagnostic(
override val element: AbstractKtSourceElement,
override val severity: Severity,
override val factory: KtDiagnosticFactory0,
override val positioningStrategy: AbstractSourceElementPositioningStrategy
) : KtSimpleDiagnostic(), KtOffsetsOnlyDiagnostic
data class KtOffsetsOnlyDiagnosticWithParameters1(
override val element: AbstractKtSourceElement,
override val a: A,
override val severity: Severity,
override val factory: KtDiagnosticFactory1,
override val positioningStrategy: AbstractSourceElementPositioningStrategy
) : KtDiagnosticWithParameters1(), KtOffsetsOnlyDiagnostic
data class KtOffsetsOnlyDiagnosticWithParameters2(
override val element: AbstractKtSourceElement,
override val a: A,
override val b: B,
override val severity: Severity,
override val factory: KtDiagnosticFactory2,
override val positioningStrategy: AbstractSourceElementPositioningStrategy
) : KtDiagnosticWithParameters2(), KtOffsetsOnlyDiagnostic
data class KtOffsetsOnlyDiagnosticWithParameters3(
override val element: AbstractKtSourceElement,
override val a: A,
override val b: B,
override val c: C,
override val severity: Severity,
override val factory: KtDiagnosticFactory3,
override val positioningStrategy: AbstractSourceElementPositioningStrategy
) : KtDiagnosticWithParameters3(), KtOffsetsOnlyDiagnostic
data class KtOffsetsOnlyDiagnosticWithParameters4(
override val element: AbstractKtSourceElement,
override val a: A,
override val b: B,
override val c: C,
override val d: D,
override val severity: Severity,
override val factory: KtDiagnosticFactory4,
override val positioningStrategy: AbstractSourceElementPositioningStrategy
) : KtDiagnosticWithParameters4(), KtOffsetsOnlyDiagnostic