Add abstract source element and switch diagnostics to it

2021-09-27 20:08:27 +02:00
parent 524e40708d
commit 9e60c70db7
12 changed files with 181 additions and 54 deletions
@@ -190,10 +190,19 @@ sealed class KtFakeSourceElementKind : KtSourceElementKind() {
    object ParameterNameAnnotationCall : KtFakeSourceElementKind()
 }

-sealed class KtSourceElement {
-    abstract val elementType: IElementType
+abstract class AbstractKtSourceElement {
    abstract val startOffset: Int
    abstract val endOffset: Int
+}
+
+class KtOffsetsOnlySourceElement(
+    override val startOffset: Int,
+    override val endOffset: Int,
+) : AbstractKtSourceElement()
+
+// TODO: consider renaming to something like AstBasedSourceElement
+sealed class KtSourceElement : AbstractKtSourceElement() {
+    abstract val elementType: IElementType
    abstract val kind: KtSourceElementKind
    abstract val lighterASTNode: LighterASTNode
    abstract val treeStructure: FlyweightCapableTreeStructure<LighterASTNode>
@@ -390,7 +399,7 @@ class KtLightSourceElement(
    }
 }

-val KtSourceElement?.psi: PsiElement? get() = (this as? KtPsiSourceElement)?.psi
+val AbstractKtSourceElement?.psi: PsiElement? get() = (this as? KtPsiSourceElement)?.psi

 val KtSourceElement?.text: CharSequence?
    get() = when (this) {
@@ -6,27 +6,21 @@
 package org.jetbrains.kotlin.diagnostics

 import com.intellij.openapi.util.TextRange
-import org.jetbrains.kotlin.KtSourceElement
+import org.jetbrains.kotlin.AbstractKtSourceElement

 abstract class AbstractSourceElementPositioningStrategy {
    abstract fun markDiagnostic(diagnostic: KtDiagnostic): List<TextRange>

-    abstract fun isValid(element: KtSourceElement): Boolean
+    abstract fun isValid(element: AbstractKtSourceElement): Boolean

    companion object {

-        private val defaultProxy = object : AbstractSourceElementPositioningStrategy() {
-            lateinit var currentDefault: AbstractSourceElementPositioningStrategy
-
-            override fun markDiagnostic(diagnostic: KtDiagnostic): List<TextRange> = currentDefault.markDiagnostic(diagnostic)
-            override fun isValid(element: KtSourceElement): Boolean = currentDefault.isValid(element)
-        }
-
        @JvmStatic
        fun setDefault(default: AbstractSourceElementPositioningStrategy) {
-            defaultProxy.currentDefault = default
+            DEFAULT = default
        }

-        val DEFAULT: AbstractSourceElementPositioningStrategy = defaultProxy
+        var DEFAULT: AbstractSourceElementPositioningStrategy = OffsetsOnlyPositioningStrategy()
+            private set
    }
 }
@@ -8,15 +8,14 @@ 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
-import org.jetbrains.kotlin.KtSourceElement
-import org.jetbrains.kotlin.diagnostics.*

 // ------------------------------ diagnostics ------------------------------

 sealed class KtDiagnostic : DiagnosticMarker {
-    abstract val element: KtSourceElement
+    abstract val element: AbstractKtSourceElement
    abstract val severity: Severity
    abstract val factory: AbstractKtDiagnosticFactory
    abstract val positioningStrategy: AbstractSourceElementPositioningStrategy
@@ -206,3 +205,58 @@ data class KtLightDiagnosticWithParameters4<A, B, C, D>(
    override val factory: KtDiagnosticFactory4<A, B, C, D>,
    override val positioningStrategy: AbstractSourceElementPositioningStrategy
 ) : KtDiagnosticWithParameters4<A, B, C, D>(), 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<A>(
+    override val element: AbstractKtSourceElement,
+    override val a: A,
+    override val severity: Severity,
+    override val factory: KtDiagnosticFactory1<A>,
+    override val positioningStrategy: AbstractSourceElementPositioningStrategy
+) : KtDiagnosticWithParameters1<A>(), KtOffsetsOnlyDiagnostic
+
+data class KtOffsetsOnlyDiagnosticWithParameters2<A, B>(
+    override val element: AbstractKtSourceElement,
+    override val a: A,
+    override val b: B,
+    override val severity: Severity,
+    override val factory: KtDiagnosticFactory2<A, B>,
+    override val positioningStrategy: AbstractSourceElementPositioningStrategy
+) : KtDiagnosticWithParameters2<A, B>(), KtOffsetsOnlyDiagnostic
+
+data class KtOffsetsOnlyDiagnosticWithParameters3<A, B, C>(
+    override val element: AbstractKtSourceElement,
+    override val a: A,
+    override val b: B,
+    override val c: C,
+    override val severity: Severity,
+    override val factory: KtDiagnosticFactory3<A, B, C>,
+    override val positioningStrategy: AbstractSourceElementPositioningStrategy
+) : KtDiagnosticWithParameters3<A, B, C>(), KtOffsetsOnlyDiagnostic
+
+data class KtOffsetsOnlyDiagnosticWithParameters4<A, B, C, D>(
+    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<A, B, C, D>,
+    override val positioningStrategy: AbstractSourceElementPositioningStrategy
+) : KtDiagnosticWithParameters4<A, B, C, D>(), KtOffsetsOnlyDiagnostic
@@ -7,9 +7,9 @@

 package org.jetbrains.kotlin.diagnostics

+import org.jetbrains.kotlin.AbstractKtSourceElement
 import org.jetbrains.kotlin.KtLightSourceElement
 import org.jetbrains.kotlin.KtPsiSourceElement
-import org.jetbrains.kotlin.KtSourceElement
 import org.jetbrains.kotlin.config.LanguageFeature
 import kotlin.reflect.KClass

@@ -39,7 +39,7 @@ class KtDiagnosticFactory0(

    @InternalDiagnosticFactoryMethod
    fun on(
-        element: KtSourceElement,
+        element: AbstractKtSourceElement,
        positioningStrategy: AbstractSourceElementPositioningStrategy?
    ): KtSimpleDiagnostic {
        return when (element) {
@@ -47,6 +47,7 @@ class KtDiagnosticFactory0(
                element, severity, this, positioningStrategy ?: defaultPositioningStrategy
            )
            is KtLightSourceElement -> KtLightSimpleDiagnostic(element, severity, this, positioningStrategy ?: defaultPositioningStrategy)
+            else -> KtOffsetsOnlySimpleDiagnostic(element, severity, this, positioningStrategy ?: defaultPositioningStrategy)
        }
    }
 }
@@ -64,7 +65,7 @@ class KtDiagnosticFactory1<A>(

    @InternalDiagnosticFactoryMethod
    fun on(
-        element: KtSourceElement,
+        element: AbstractKtSourceElement,
        a: A,
        positioningStrategy: AbstractSourceElementPositioningStrategy?
    ): KtDiagnosticWithParameters1<A> {
@@ -79,6 +80,9 @@ class KtDiagnosticFactory1<A>(
                this,
                positioningStrategy ?: defaultPositioningStrategy
            )
+            else -> KtOffsetsOnlyDiagnosticWithParameters1(
+                element, a, severity, this, positioningStrategy ?: defaultPositioningStrategy
+            )
        }
    }
 }
@@ -97,7 +101,7 @@ class KtDiagnosticFactory2<A, B>(

    @InternalDiagnosticFactoryMethod
    fun on(
-        element: KtSourceElement,
+        element: AbstractKtSourceElement,
        a: A,
        b: B,
        positioningStrategy: AbstractSourceElementPositioningStrategy?
@@ -114,6 +118,9 @@ class KtDiagnosticFactory2<A, B>(
                this,
                positioningStrategy ?: defaultPositioningStrategy
            )
+            else -> KtOffsetsOnlyDiagnosticWithParameters2(
+                element, a, b, severity, this, positioningStrategy ?: defaultPositioningStrategy
+            )
        }
    }
 }
@@ -133,7 +140,7 @@ class KtDiagnosticFactory3<A, B, C>(

    @InternalDiagnosticFactoryMethod
    fun on(
-        element: KtSourceElement,
+        element: AbstractKtSourceElement,
        a: A,
        b: B,
        c: C,
@@ -152,6 +159,9 @@ class KtDiagnosticFactory3<A, B, C>(
                this,
                positioningStrategy ?: defaultPositioningStrategy
            )
+            else -> KtOffsetsOnlyDiagnosticWithParameters3(
+                element, a, b, c, severity, this, positioningStrategy ?: defaultPositioningStrategy
+            )
        }
    }
 }
@@ -172,7 +182,7 @@ class KtDiagnosticFactory4<A, B, C, D>(

    @InternalDiagnosticFactoryMethod
    fun on(
-        element: KtSourceElement,
+        element: AbstractKtSourceElement,
        a: A,
        b: B,
        c: C,
@@ -193,14 +203,13 @@ class KtDiagnosticFactory4<A, B, C, D>(
                this,
                positioningStrategy ?: defaultPositioningStrategy
            )
+            else -> KtOffsetsOnlyDiagnosticWithParameters4(
+                element, a, b, c, d, severity, this, positioningStrategy ?: defaultPositioningStrategy
+            )
        }
    }
 }

-private fun incorrectElement(element: KtSourceElement): Nothing {
-    throw IllegalArgumentException("Unknown element type: ${element::class}")
-}
-
 // ------------------------------ factories for deprecation ------------------------------

 sealed class KtDiagnosticFactoryForDeprecation<F : AbstractKtDiagnosticFactory>(
@@ -7,10 +7,10 @@

 package org.jetbrains.kotlin.diagnostics

-import org.jetbrains.kotlin.KtSourceElement
+import org.jetbrains.kotlin.AbstractKtSourceElement

 fun DiagnosticReporter.reportOn(
-    source: KtSourceElement?,
+    source: AbstractKtSourceElement?,
    factory: KtDiagnosticFactory0,
    context: DiagnosticContext,
    positioningStrategy: AbstractSourceElementPositioningStrategy? = null
@@ -19,7 +19,7 @@ fun DiagnosticReporter.reportOn(
 }

 fun <A : Any> DiagnosticReporter.reportOn(
-    source: KtSourceElement?,
+    source: AbstractKtSourceElement?,
    factory: KtDiagnosticFactory1<A>,
    a: A,
    context: DiagnosticContext,
@@ -29,7 +29,7 @@ fun <A : Any> DiagnosticReporter.reportOn(
 }

 fun <A : Any, B : Any> DiagnosticReporter.reportOn(
-    source: KtSourceElement?,
+    source: AbstractKtSourceElement?,
    factory: KtDiagnosticFactory2<A, B>,
    a: A,
    b: B,
@@ -40,7 +40,7 @@ fun <A : Any, B : Any> DiagnosticReporter.reportOn(
 }

 fun <A : Any, B : Any, C : Any> DiagnosticReporter.reportOn(
-    source: KtSourceElement?,
+    source: AbstractKtSourceElement?,
    factory: KtDiagnosticFactory3<A, B, C>,
    a: A,
    b: B,
@@ -52,7 +52,7 @@ fun <A : Any, B : Any, C : Any> DiagnosticReporter.reportOn(
 }

 fun <A : Any, B : Any, C : Any, D : Any> DiagnosticReporter.reportOn(
-    source: KtSourceElement?,
+    source: AbstractKtSourceElement?,
    factory: KtDiagnosticFactory4<A, B, C, D>,
    a: A,
    b: B,
@@ -65,7 +65,7 @@ fun <A : Any, B : Any, C : Any, D : Any> DiagnosticReporter.reportOn(
 }

 fun DiagnosticReporter.reportOn(
-    source: KtSourceElement?,
+    source: AbstractKtSourceElement?,
    factory: KtDiagnosticFactoryForDeprecation0,
    context: DiagnosticContext,
    positioningStrategy: AbstractSourceElementPositioningStrategy? = null
@@ -74,7 +74,7 @@ fun DiagnosticReporter.reportOn(
 }

 fun <A : Any> DiagnosticReporter.reportOn(
-    source: KtSourceElement?,
+    source: AbstractKtSourceElement?,
    factory: KtDiagnosticFactoryForDeprecation1<A>,
    a: A,
    context: DiagnosticContext,
@@ -84,7 +84,7 @@ fun <A : Any> DiagnosticReporter.reportOn(
 }

 fun <A : Any, B : Any> DiagnosticReporter.reportOn(
-    source: KtSourceElement?,
+    source: AbstractKtSourceElement?,
    factory: KtDiagnosticFactoryForDeprecation2<A, B>,
    a: A,
    b: B,
@@ -95,7 +95,7 @@ fun <A : Any, B : Any> DiagnosticReporter.reportOn(
 }

 fun <A : Any, B : Any, C : Any> DiagnosticReporter.reportOn(
-    source: KtSourceElement?,
+    source: AbstractKtSourceElement?,
    factory: KtDiagnosticFactoryForDeprecation3<A, B, C>,
    a: A,
    b: B,
@@ -107,7 +107,7 @@ fun <A : Any, B : Any, C : Any> DiagnosticReporter.reportOn(
 }

 fun <A : Any, B : Any, C : Any, D : Any> DiagnosticReporter.reportOn(
-    source: KtSourceElement?,
+    source: AbstractKtSourceElement?,
    factory: KtDiagnosticFactoryForDeprecation4<A, B, C, D>,
    a: A,
    b: B,
@@ -0,0 +1,47 @@
+/*
+ * 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 org.jetbrains.kotlin.AbstractKtSourceElement
+import org.jetbrains.kotlin.KtLightSourceElement
+import org.jetbrains.kotlin.KtPsiSourceElement
+
+open class OffsetsOnlyPositioningStrategy : AbstractSourceElementPositioningStrategy() {
+    open fun markKtDiagnostic(element: AbstractKtSourceElement, diagnostic: KtDiagnostic): List<TextRange> {
+        return mark(element.startOffset, element.endOffset)
+    }
+
+    open fun mark(
+        startOffset: Int,
+        endOffset: Int,
+    ): List<TextRange> {
+        return markElement(startOffset, endOffset)
+    }
+
+    override fun markDiagnostic(diagnostic: KtDiagnostic): List<TextRange> = markKtDiagnostic(diagnostic.element, diagnostic)
+
+    override fun isValid(element: AbstractKtSourceElement): Boolean = true
+}
+
+fun markElement(
+    startOffset: Int,
+    endOffset: Int,
+): List<TextRange> = markRange(startOffset, endOffset)
+
+fun markRange(
+    startOffset: Int,
+    endOffset: Int,
+): List<TextRange> {
+    return listOf(markSingleElement(startOffset, endOffset))
+}
+
+fun markSingleElement(
+    startOffset: Int,
+    endOffset: Int,
+): TextRange {
+    return TextRange(startOffset, endOffset)
+}
@@ -5,7 +5,7 @@

 package org.jetbrains.kotlin.diagnostics.impl

-import org.jetbrains.kotlin.KtSourceElement
+import org.jetbrains.kotlin.AbstractKtSourceElement
 import org.jetbrains.kotlin.diagnostics.AbstractKtDiagnosticFactory
 import org.jetbrains.kotlin.diagnostics.DiagnosticContext
 import org.jetbrains.kotlin.diagnostics.DiagnosticReporter
@@ -13,7 +13,7 @@ import org.jetbrains.kotlin.diagnostics.KtDiagnostic

 class DeduplicatingDiagnosticReporter(private val inner: DiagnosticReporter) : DiagnosticReporter() {

-    private val reported = mutableSetOf<Pair<KtSourceElement, AbstractKtDiagnosticFactory>>()
+    private val reported = mutableSetOf<Pair<AbstractKtSourceElement, AbstractKtDiagnosticFactory>>()

    override fun report(diagnostic: KtDiagnostic?, context: DiagnosticContext) {
        if (diagnostic != null && reported.add(Pair(diagnostic.element, diagnostic.factory))) {