Register Kotlin specific highlight passes via highlightingPassFactory in 193+

2020-03-18 14:40:03 +01:00
parent 2e20cdf2e6
commit 3cdcdbf6a8
9 changed files with 452 additions and 64 deletions
@@ -5,19 +5,16 @@

 package org.jetbrains.kotlin.idea.highlighter

-import com.intellij.codeHighlighting.Pass
-import com.intellij.codeHighlighting.TextEditorHighlightingPass
-import com.intellij.codeHighlighting.TextEditorHighlightingPassFactory
-import com.intellij.codeHighlighting.TextEditorHighlightingPassRegistrar
+import com.intellij.codeHighlighting.*
 import com.intellij.codeInsight.daemon.impl.AnnotationHolderImpl
 import com.intellij.codeInsight.daemon.impl.HighlightInfo
 import com.intellij.codeInsight.daemon.impl.UpdateHighlightersUtil
 import com.intellij.lang.annotation.AnnotationSession
-import com.intellij.openapi.components.ProjectComponent
 import com.intellij.openapi.editor.Document
 import com.intellij.openapi.editor.Editor
 import com.intellij.openapi.progress.ProgressIndicator
 import com.intellij.openapi.project.DumbAware
+import com.intellij.openapi.project.Project
 import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiFile
 import com.intellij.psi.PsiRecursiveElementVisitor
@@ -52,20 +49,22 @@ class KotlinBeforeResolveHighlightingPass(
        annotationHolder = null
    }

-    class Factory(registrar: TextEditorHighlightingPassRegistrar) : ProjectComponent, TextEditorHighlightingPassFactory {
-        init {
+    class Factory : TextEditorHighlightingPassFactory {
+        override fun createHighlightingPass(file: PsiFile, editor: Editor): TextEditorHighlightingPass? {
+            if (file !is KtFile) return null
+            return KotlinBeforeResolveHighlightingPass(file, editor.document)
+        }
+    }
+
+    class Registrar : TextEditorHighlightingPassFactoryRegistrar {
+        override fun registerHighlightingPassFactory(registrar: TextEditorHighlightingPassRegistrar, project: Project) {
            registrar.registerTextEditorHighlightingPass(
-                this,
+                Factory(),
                TextEditorHighlightingPassRegistrar.Anchor.BEFORE,
                Pass.UPDATE_FOLDING,
                false,
                false
            )
        }
-
-        override fun createHighlightingPass(file: PsiFile, editor: Editor): TextEditorHighlightingPass? {
-            if (file !is KtFile) return null
-            return KotlinBeforeResolveHighlightingPass(file, editor.document)
-        }
    }
 }
@@ -0,0 +1,71 @@
+/*
+ * Copyright 2010-2019 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.idea.highlighter
+
+import com.intellij.codeHighlighting.Pass
+import com.intellij.codeHighlighting.TextEditorHighlightingPass
+import com.intellij.codeHighlighting.TextEditorHighlightingPassFactory
+import com.intellij.codeHighlighting.TextEditorHighlightingPassRegistrar
+import com.intellij.codeInsight.daemon.impl.AnnotationHolderImpl
+import com.intellij.codeInsight.daemon.impl.HighlightInfo
+import com.intellij.codeInsight.daemon.impl.UpdateHighlightersUtil
+import com.intellij.lang.annotation.AnnotationSession
+import com.intellij.openapi.components.ProjectComponent
+import com.intellij.openapi.editor.Document
+import com.intellij.openapi.editor.Editor
+import com.intellij.openapi.progress.ProgressIndicator
+import com.intellij.openapi.project.DumbAware
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiFile
+import com.intellij.psi.PsiRecursiveElementVisitor
+import org.jetbrains.kotlin.psi.KtFile
+
+class KotlinBeforeResolveHighlightingPass(
+    private val file: KtFile,
+    document: Document
+) : TextEditorHighlightingPass(file.project, document), DumbAware {
+
+    @Volatile
+    private var annotationHolder: AnnotationHolderImpl? = null
+
+    override fun doCollectInformation(progress: ProgressIndicator) {
+        val annotationHolder = AnnotationHolderImpl(AnnotationSession(file))
+        val visitor = BeforeResolveHighlightingVisitor(annotationHolder)
+        file.accept(object : PsiRecursiveElementVisitor() {
+            override fun visitElement(element: PsiElement) {
+                super.visitElement(element)
+                element.accept(visitor)
+            }
+        })
+        this.annotationHolder = annotationHolder
+    }
+
+    override fun doApplyInformationToEditor() {
+        if (annotationHolder == null) return
+
+        val infos = annotationHolder!!.map { HighlightInfo.fromAnnotation(it) }
+
+        UpdateHighlightersUtil.setHighlightersToEditor(myProject, myDocument!!, 0, file.textLength, infos, colorsScheme, id)
+        annotationHolder = null
+    }
+
+    class Factory(registrar: TextEditorHighlightingPassRegistrar) : ProjectComponent, TextEditorHighlightingPassFactory {
+        init {
+            registrar.registerTextEditorHighlightingPass(
+                this,
+                TextEditorHighlightingPassRegistrar.Anchor.BEFORE,
+                Pass.UPDATE_FOLDING,
+                false,
+                false
+            )
+        }
+
+        override fun createHighlightingPass(file: PsiFile, editor: Editor): TextEditorHighlightingPass? {
+            if (file !is KtFile) return null
+            return KotlinBeforeResolveHighlightingPass(file, editor.document)
+        }
+    }
+}
@@ -16,21 +16,18 @@

 package org.jetbrains.kotlin.idea.highlighter

-import com.intellij.codeHighlighting.Pass
-import com.intellij.codeHighlighting.TextEditorHighlightingPass
-import com.intellij.codeHighlighting.TextEditorHighlightingPassFactory
-import com.intellij.codeHighlighting.TextEditorHighlightingPassRegistrar
+import com.intellij.codeHighlighting.*
 import com.intellij.codeInsight.daemon.impl.HighlightInfo
 import com.intellij.codeInsight.daemon.impl.UpdateHighlightersUtil
 import com.intellij.lang.annotation.Annotation
 import com.intellij.lang.annotation.HighlightSeverity
 import com.intellij.lang.annotation.HighlightSeverity.*
 import com.intellij.openapi.application.ApplicationManager
-import com.intellij.openapi.components.ProjectComponent
 import com.intellij.openapi.editor.Document
 import com.intellij.openapi.editor.Editor
 import com.intellij.openapi.progress.ProgressIndicator
 import com.intellij.openapi.project.DumbAware
+import com.intellij.openapi.project.Project
 import com.intellij.openapi.ui.MessageType
 import com.intellij.openapi.wm.WindowManager
 import com.intellij.openapi.wm.ex.StatusBarEx
@@ -128,18 +125,19 @@ class ScriptExternalHighlightingPass(
        }
    }

-    class Factory(registrar: TextEditorHighlightingPassRegistrar) : ProjectComponent,
-        TextEditorHighlightingPassFactory {
-        init {
+    class Registrar : TextEditorHighlightingPassFactoryRegistrar {
+        override fun registerHighlightingPassFactory(registrar: TextEditorHighlightingPassRegistrar, project: Project) {
            registrar.registerTextEditorHighlightingPass(
-                this,
+                Factory(),
                TextEditorHighlightingPassRegistrar.Anchor.BEFORE,
                Pass.UPDATE_FOLDING,
                false,
                false
            )
        }
+    }

+    class Factory : TextEditorHighlightingPassFactory {
        override fun createHighlightingPass(file: PsiFile, editor: Editor): TextEditorHighlightingPass? {
            if (file !is KtFile) return null
            return ScriptExternalHighlightingPass(file, editor.document)
@@ -0,0 +1,148 @@
+/*
+ * Copyright 2010-2017 JetBrains s.r.o.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.jetbrains.kotlin.idea.highlighter
+
+import com.intellij.codeHighlighting.Pass
+import com.intellij.codeHighlighting.TextEditorHighlightingPass
+import com.intellij.codeHighlighting.TextEditorHighlightingPassFactory
+import com.intellij.codeHighlighting.TextEditorHighlightingPassRegistrar
+import com.intellij.codeInsight.daemon.impl.HighlightInfo
+import com.intellij.codeInsight.daemon.impl.UpdateHighlightersUtil
+import com.intellij.lang.annotation.Annotation
+import com.intellij.lang.annotation.HighlightSeverity
+import com.intellij.lang.annotation.HighlightSeverity.*
+import com.intellij.openapi.application.ApplicationManager
+import com.intellij.openapi.components.ProjectComponent
+import com.intellij.openapi.editor.Document
+import com.intellij.openapi.editor.Editor
+import com.intellij.openapi.progress.ProgressIndicator
+import com.intellij.openapi.project.DumbAware
+import com.intellij.openapi.ui.MessageType
+import com.intellij.openapi.wm.WindowManager
+import com.intellij.openapi.wm.ex.StatusBarEx
+import com.intellij.psi.PsiFile
+import com.intellij.util.ui.UIUtil
+import org.jetbrains.kotlin.idea.core.script.IdeScriptReportSink
+import org.jetbrains.kotlin.idea.script.ScriptDiagnosticFixProvider
+import org.jetbrains.kotlin.psi.KtFile
+import kotlin.script.experimental.api.ScriptDiagnostic
+import kotlin.script.experimental.api.SourceCode
+
+class ScriptExternalHighlightingPass(
+    private val file: KtFile,
+    document: Document
+) : TextEditorHighlightingPass(file.project, document), DumbAware {
+    override fun doCollectInformation(progress: ProgressIndicator) = Unit
+
+    override fun doApplyInformationToEditor() {
+        val document = document ?: return
+
+        if (!file.isScript()) return
+
+        val reports = IdeScriptReportSink.getReports(file)
+
+        val annotations = reports.mapNotNull { scriptDiagnostic ->
+            val (startOffset, endOffset) = scriptDiagnostic.location?.let { computeOffsets(document, it) } ?: 0 to 0
+            val exception = scriptDiagnostic.exception
+            val exceptionMessage = if (exception != null) " ($exception)" else ""
+            val message = scriptDiagnostic.message + exceptionMessage
+            val annotation = Annotation(
+                startOffset,
+                endOffset,
+                scriptDiagnostic.severity.convertSeverity() ?: return@mapNotNull null,
+                message,
+                message
+            )
+
+            // if range is empty, show notification panel in editor
+            annotation.isFileLevelAnnotation = startOffset == endOffset
+
+            for (provider in ScriptDiagnosticFixProvider.EP_NAME.extensions) {
+                provider.provideFixes(scriptDiagnostic).forEach {
+                    annotation.registerFix(it)
+                }
+            }
+
+            annotation
+        }
+
+        val infos = annotations.map { HighlightInfo.fromAnnotation(it) }
+        UpdateHighlightersUtil.setHighlightersToEditor(myProject, myDocument!!, 0, file.textLength, infos, colorsScheme, id)
+    }
+
+    private fun computeOffsets(document: Document, position: SourceCode.Location): Pair<Int, Int> {
+        val startLine = position.start.line.coerceLineIn(document)
+        val startOffset = document.offsetBy(startLine, position.start.col)
+
+        val endLine = position.end?.line?.coerceAtLeast(startLine)?.coerceLineIn(document) ?: startLine
+        val endOffset = document.offsetBy(
+            endLine,
+            position.end?.col ?: document.getLineEndOffset(endLine)
+        ).coerceAtLeast(startOffset)
+
+        return startOffset to endOffset
+    }
+
+    private fun Int.coerceLineIn(document: Document) = coerceIn(0, document.lineCount - 1)
+
+    private fun Document.offsetBy(line: Int, col: Int): Int {
+        return (getLineStartOffset(line) + col).coerceIn(getLineStartOffset(line), getLineEndOffset(line))
+    }
+
+    private fun ScriptDiagnostic.Severity.convertSeverity(): HighlightSeverity? {
+        return when (this) {
+            ScriptDiagnostic.Severity.FATAL -> ERROR
+            ScriptDiagnostic.Severity.ERROR -> ERROR
+            ScriptDiagnostic.Severity.WARNING -> WARNING
+            ScriptDiagnostic.Severity.INFO -> INFORMATION
+            ScriptDiagnostic.Severity.DEBUG -> if (ApplicationManager.getApplication().isInternal) INFORMATION else null
+        }
+    }
+
+    private fun showNotification(file: KtFile, message: String) {
+        UIUtil.invokeLaterIfNeeded {
+            val ideFrame = WindowManager.getInstance().getIdeFrame(file.project)
+            if (ideFrame != null) {
+                val statusBar = ideFrame.statusBar as StatusBarEx
+                statusBar.notifyProgressByBalloon(
+                    MessageType.WARNING,
+                    message,
+                    null,
+                    null
+                )
+            }
+        }
+    }
+
+    class Factory(registrar: TextEditorHighlightingPassRegistrar) : ProjectComponent,
+        TextEditorHighlightingPassFactory {
+        init {
+            registrar.registerTextEditorHighlightingPass(
+                this,
+                TextEditorHighlightingPassRegistrar.Anchor.BEFORE,
+                Pass.UPDATE_FOLDING,
+                false,
+                false
+            )
+        }
+
+        override fun createHighlightingPass(file: PsiFile, editor: Editor): TextEditorHighlightingPass? {
+            if (file !is KtFile) return null
+            return ScriptExternalHighlightingPass(file, editor.document)
+        }
+    }
+}