mirror of
https://github.com/chylex/IntelliJ-Inspection-Lens.git
synced 2025-09-14 14:32:17 +02:00
Compare commits
20 Commits
9f395476df
...
debug
Author | SHA1 | Date | |
---|---|---|---|
83ba551f82
|
|||
8936f0e5be
|
|||
89e71d5301
|
|||
4c80573375
|
|||
816440a150
|
|||
4899498522
|
|||
8ee14ff55e
|
|||
632a052ff9
|
|||
f2ec3c3d9b
|
|||
624254fba3
|
|||
c1b52ec3a5
|
|||
a84bc72fd4
|
|||
e28804ad5d
|
|||
043c02e432
|
|||
223fceb6b9
|
|||
640d95cddc
|
|||
fcd4d6588d
|
|||
1c92cf000f
|
|||
83c179574a
|
|||
536650510d
|
1
.gitignore
vendored
1
.gitignore
vendored
@@ -1,4 +1,5 @@
|
||||
/.idea/*
|
||||
!/.idea/dictionaries
|
||||
!/.idea/runConfigurations
|
||||
|
||||
/.gradle/
|
||||
|
7
.idea/dictionaries/default_user.xml
generated
Normal file
7
.idea/dictionaries/default_user.xml
generated
Normal file
@@ -0,0 +1,7 @@
|
||||
<component name="ProjectDictionaryState">
|
||||
<dictionary name="default.user">
|
||||
<words>
|
||||
<w>inspectionlens</w>
|
||||
</words>
|
||||
</dictionary>
|
||||
</component>
|
@@ -1,10 +1,10 @@
|
||||
# Inspection Lens <img align="right" src="logo.png" alt="Plugin Logo">
|
||||
|
||||
IntelliJ plugin that shows errors, warnings, and other inspection highlights inline.
|
||||
Displays errors, warnings, and other inspections inline. Highlights the background of lines with inspections. Supports light and dark themes out of the box.
|
||||
|
||||
After installing the plugin, inspection descriptions will appear after the ends of lines, and the lines will be highlighted with a background color. Shown inspection severities are **Errors**, **Warnings**, **Weak Warnings**, **Server Problems**, **Grammar Errors**, **Typos**, and other inspections from plugins or future IntelliJ versions that have a high enough severity level. Each severity has a different color, with support for both light and dark themes.
|
||||
By default, the plugin shows **Errors**, **Warnings**, **Weak Warnings**, **Server Problems**, **Grammar Errors**, **Typos**, and other inspections with a high enough severity level. Configure visible severities in **Settings | Tools | Inspection Lens**.
|
||||
|
||||
Note: The plugin is not customizable outside the ability to disable/enable the plugin without restarting the IDE. If the defaults don't work for you, I recommend trying the [Inline Error](https://plugins.jetbrains.com/plugin/17302-inlineerror) plugin which can be customized, building your own version of Inspection Lens, or proposing your change in the [issue tracker](https://github.com/chylex/IntelliJ-Inspection-Lens/issues).
|
||||
Left-click an inspection to show quick fixes. Middle-click an inspection to navigate to the relevant code in the editor.
|
||||
|
||||
Inspired by [Error Lens](https://marketplace.visualstudio.com/items?itemName=usernamehw.errorlens) for Visual Studio Code, and [Inline Error](https://plugins.jetbrains.com/plugin/17302-inlineerror) for IntelliJ Platform.
|
||||
|
||||
|
@@ -4,18 +4,18 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
|
||||
|
||||
plugins {
|
||||
kotlin("jvm") version "1.8.0"
|
||||
id("org.jetbrains.intellij") version "1.16.0"
|
||||
id("org.jetbrains.intellij") version "1.17.0"
|
||||
}
|
||||
|
||||
group = "com.chylex.intellij.inspectionlens"
|
||||
version = "1.3.1"
|
||||
version = "1.5"
|
||||
|
||||
repositories {
|
||||
mavenCentral()
|
||||
}
|
||||
|
||||
intellij {
|
||||
version.set("233.11555.11-EAP-SNAPSHOT")
|
||||
version.set("2023.3.3")
|
||||
updateSinceUntilBuild.set(false)
|
||||
|
||||
plugins.add("tanvd.grazi")
|
||||
|
@@ -1,15 +1,11 @@
|
||||
package com.chylex.intellij.inspectionlens
|
||||
|
||||
import com.chylex.intellij.inspectionlens.editor.EditorLensManager
|
||||
import com.chylex.intellij.inspectionlens.editor.LensMarkupModelListener
|
||||
import com.intellij.openapi.Disposable
|
||||
import com.chylex.intellij.inspectionlens.editor.EditorLensFeatures
|
||||
import com.intellij.openapi.application.ApplicationManager
|
||||
import com.intellij.openapi.components.service
|
||||
import com.intellij.openapi.fileEditor.FileEditorManager
|
||||
import com.intellij.openapi.fileEditor.TextEditor
|
||||
import com.intellij.openapi.project.ProjectManager
|
||||
import com.intellij.openapi.rd.createLifetime
|
||||
import com.intellij.openapi.rd.createNestedDisposable
|
||||
import com.jetbrains.rd.util.lifetime.Lifetime
|
||||
|
||||
/**
|
||||
* Handles installation and uninstallation of plugin features in editors.
|
||||
@@ -21,7 +17,7 @@ internal object InspectionLens {
|
||||
* Installs lenses into [editor].
|
||||
*/
|
||||
fun install(editor: TextEditor) {
|
||||
LensMarkupModelListener.register(editor.editor, createEditorDisposable(editor))
|
||||
EditorLensFeatures.install(editor.editor, service<InspectionLensPluginDisposableService>().intersect(editor))
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -31,31 +27,20 @@ internal object InspectionLens {
|
||||
forEachOpenEditor(::install)
|
||||
}
|
||||
|
||||
/**
|
||||
* Uninstalls lenses from all open editors.
|
||||
*/
|
||||
fun uninstall() {
|
||||
forEachOpenEditor {
|
||||
EditorLensManager.remove(it.editor)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Refreshes lenses in all open editors.
|
||||
*/
|
||||
fun refresh() {
|
||||
private fun refresh() {
|
||||
forEachOpenEditor {
|
||||
LensMarkupModelListener.refresh(it.editor)
|
||||
EditorLensFeatures.refresh(it.editor)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a [Disposable] that will be disposed when either the [TextEditor] is disposed or the plugin is unloaded.
|
||||
* Schedules a refresh of lenses in all open editors.
|
||||
*/
|
||||
private fun createEditorDisposable(textEditor: TextEditor): Disposable {
|
||||
val pluginLifetime = ApplicationManager.getApplication().getService(InspectionLensPluginDisposableService::class.java).createLifetime()
|
||||
val editorLifetime = textEditor.createLifetime()
|
||||
return Lifetime.intersect(pluginLifetime, editorLifetime).createNestedDisposable("InspectionLensIntersectedLifetime")
|
||||
fun scheduleRefresh() {
|
||||
Refresh.schedule()
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -70,4 +55,26 @@ internal object InspectionLens {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private object Refresh {
|
||||
private var needsRefresh = false
|
||||
|
||||
fun schedule() {
|
||||
synchronized(this) {
|
||||
if (!needsRefresh) {
|
||||
needsRefresh = true
|
||||
ApplicationManager.getApplication().invokeLater(this::run)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun run() {
|
||||
synchronized(this) {
|
||||
if (needsRefresh) {
|
||||
needsRefresh = false
|
||||
refresh()
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@@ -2,11 +2,21 @@ package com.chylex.intellij.inspectionlens
|
||||
|
||||
import com.intellij.openapi.Disposable
|
||||
import com.intellij.openapi.components.Service
|
||||
import com.intellij.openapi.rd.createLifetime
|
||||
import com.intellij.openapi.rd.createNestedDisposable
|
||||
import com.jetbrains.rd.util.lifetime.Lifetime
|
||||
|
||||
/**
|
||||
* Gets automatically disposed when the plugin is unloaded.
|
||||
*/
|
||||
@Service
|
||||
class InspectionLensPluginDisposableService : Disposable {
|
||||
/**
|
||||
* Creates a [Disposable] that will be disposed when either plugin is unloaded, or the [other] [Disposable] is disposed.
|
||||
*/
|
||||
fun intersect(other: Disposable): Disposable {
|
||||
return Lifetime.intersect(createLifetime(), other.createLifetime()).createNestedDisposable("InspectionLensIntersectedLifetime")
|
||||
}
|
||||
|
||||
override fun dispose() {}
|
||||
}
|
||||
|
@@ -4,7 +4,7 @@ import com.intellij.ide.plugins.DynamicPluginListener
|
||||
import com.intellij.ide.plugins.IdeaPluginDescriptor
|
||||
|
||||
/**
|
||||
* Installs [InspectionLens] in open editors when the plugin is loaded, and uninstalls it when the plugin is unloaded.
|
||||
* Installs [InspectionLens] in open editors when the plugin is loaded.
|
||||
*/
|
||||
class InspectionLensPluginListener : DynamicPluginListener {
|
||||
override fun pluginLoaded(pluginDescriptor: IdeaPluginDescriptor) {
|
||||
@@ -12,10 +12,4 @@ class InspectionLensPluginListener : DynamicPluginListener {
|
||||
InspectionLens.install()
|
||||
}
|
||||
}
|
||||
|
||||
override fun beforePluginUnload(pluginDescriptor: IdeaPluginDescriptor, isUpdate: Boolean) {
|
||||
if (pluginDescriptor.pluginId.idString == InspectionLens.PLUGIN_ID) {
|
||||
InspectionLens.uninstall()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@@ -1,6 +1,6 @@
|
||||
package com.chylex.intellij.inspectionlens.compatibility
|
||||
|
||||
import com.chylex.intellij.inspectionlens.editor.LensSeverity
|
||||
import com.chylex.intellij.inspectionlens.editor.lens.LensSeverity
|
||||
import com.intellij.grazie.ide.TextProblemSeverities
|
||||
import com.intellij.openapi.project.Project
|
||||
import com.intellij.openapi.startup.ProjectActivity
|
||||
|
@@ -0,0 +1,23 @@
|
||||
package com.chylex.intellij.inspectionlens.compatibility
|
||||
|
||||
import com.chylex.intellij.inspectionlens.editor.lens.LensSeverity
|
||||
import com.intellij.lang.annotation.HighlightSeverity
|
||||
import com.intellij.openapi.diagnostic.logger
|
||||
import com.intellij.profile.codeInspection.InspectionProfileManager
|
||||
import com.intellij.spellchecker.SpellCheckerSeveritiesProvider
|
||||
|
||||
internal object SpellCheckerSupport {
|
||||
private val log = logger<SpellCheckerSupport>()
|
||||
|
||||
fun load() {
|
||||
typoSeverity?.let { LensSeverity.registerMapping(it, LensSeverity.TYPO) }
|
||||
}
|
||||
|
||||
private val typoSeverity: HighlightSeverity?
|
||||
get() = try {
|
||||
SpellCheckerSeveritiesProvider.TYPO
|
||||
} catch (e: NoClassDefFoundError) {
|
||||
log.warn("Falling back to registered severity search due to ${e.javaClass.simpleName}: ${e.message}")
|
||||
InspectionProfileManager.getInstance().severityRegistrar.getSeverity("TYPO")
|
||||
}
|
||||
}
|
@@ -0,0 +1,274 @@
|
||||
package com.chylex.intellij.inspectionlens.debug
|
||||
|
||||
import com.chylex.intellij.inspectionlens.editor.lens.ColorGenerator
|
||||
import com.chylex.intellij.inspectionlens.editor.lens.ColorMode
|
||||
import com.chylex.intellij.inspectionlens.editor.lens.EditorLens
|
||||
import com.chylex.intellij.inspectionlens.editor.lens.LensSeverity
|
||||
import com.intellij.codeInsight.daemon.impl.HighlightInfo
|
||||
import com.intellij.codeInsight.daemon.impl.HighlightInfoType
|
||||
import com.intellij.grazie.ide.TextProblemSeverities
|
||||
import com.intellij.lang.annotation.HighlightSeverity
|
||||
import com.intellij.openapi.Disposable
|
||||
import com.intellij.openapi.actionSystem.ActionUpdateThread
|
||||
import com.intellij.openapi.actionSystem.AnAction
|
||||
import com.intellij.openapi.actionSystem.AnActionEvent
|
||||
import com.intellij.openapi.components.service
|
||||
import com.intellij.openapi.editor.Editor
|
||||
import com.intellij.openapi.editor.EditorFactory
|
||||
import com.intellij.openapi.editor.colors.EditorColorsManager
|
||||
import com.intellij.openapi.editor.colors.EditorColorsScheme
|
||||
import com.intellij.openapi.editor.event.CaretEvent
|
||||
import com.intellij.openapi.editor.event.CaretListener
|
||||
import com.intellij.openapi.editor.event.SelectionEvent
|
||||
import com.intellij.openapi.editor.event.SelectionListener
|
||||
import com.intellij.openapi.editor.ex.EditorEx
|
||||
import com.intellij.openapi.project.Project
|
||||
import com.intellij.openapi.ui.DialogPanel
|
||||
import com.intellij.openapi.ui.DialogWrapper
|
||||
import com.intellij.openapi.util.Disposer
|
||||
import com.intellij.openapi.util.Key
|
||||
import com.intellij.spellchecker.SpellCheckerSeveritiesProvider
|
||||
import com.intellij.ui.ColorUtil
|
||||
import com.intellij.ui.dsl.builder.Align
|
||||
import com.intellij.ui.dsl.builder.Cell
|
||||
import com.intellij.ui.dsl.builder.LabelPosition
|
||||
import com.intellij.ui.dsl.builder.Row
|
||||
import com.intellij.ui.dsl.builder.panel
|
||||
import com.intellij.ui.dsl.builder.selected
|
||||
import javax.swing.Action
|
||||
import javax.swing.JSlider
|
||||
|
||||
class ShowColorEditorAction : AnAction() {
|
||||
override fun getActionUpdateThread(): ActionUpdateThread {
|
||||
return ActionUpdateThread.BGT
|
||||
}
|
||||
|
||||
override fun actionPerformed(e: AnActionEvent) {
|
||||
Dialog(e.project).show()
|
||||
}
|
||||
|
||||
private class Dialog(project: Project?) : DialogWrapper(project) {
|
||||
private val editorSyncer = EditorSyncer(disposable)
|
||||
|
||||
init {
|
||||
title = "Inspection Lens - Color Editor"
|
||||
init()
|
||||
}
|
||||
|
||||
@Suppress("DuplicatedCode")
|
||||
override fun createCenterPanel(): DialogPanel {
|
||||
return panel {
|
||||
row {
|
||||
for (scheme in EditorColorsManager.getInstance().allSchemes.sortedWith(compareBy({ ColorUtil.isDark(it.defaultBackground) }, { it.displayName }))) {
|
||||
createEditor(scheme)
|
||||
}
|
||||
}.resizableRow()
|
||||
|
||||
row {
|
||||
val generateColors = checkBox("Generate colors")
|
||||
.selected(ColorGenerator.useGenerator)
|
||||
.onChanged {
|
||||
ColorGenerator.useGenerator = it.isSelected
|
||||
refreshColors()
|
||||
}
|
||||
|
||||
slider(0, 15, 1, 5)
|
||||
.label("Light theme desaturation", LabelPosition.TOP)
|
||||
.enabledIf(generateColors.selected)
|
||||
.bindColorValue(ColorGenerator::lightThemeDesaturation) { ColorGenerator.lightThemeDesaturation = it }
|
||||
|
||||
slider(0, 15, 1, 5)
|
||||
.label("Dark theme desaturation", LabelPosition.TOP)
|
||||
.enabledIf(generateColors.selected)
|
||||
.bindColorValue(ColorGenerator::darkThemeDesaturation) { ColorGenerator.darkThemeDesaturation = it }
|
||||
|
||||
slider(0, 100, 5, 25)
|
||||
.label("Light theme threshold", LabelPosition.TOP)
|
||||
.enabledIf(generateColors.selected)
|
||||
.bindColorValue(ColorGenerator::lightThemeThreshold) { ColorGenerator.lightThemeThreshold = it }
|
||||
|
||||
slider(0, 100, 5, 25)
|
||||
.label("Dark theme threshold", LabelPosition.TOP)
|
||||
.enabledIf(generateColors.selected)
|
||||
.bindColorValue(ColorGenerator::darkThemeThreshold) { ColorGenerator.darkThemeThreshold = it }
|
||||
|
||||
slider(0, 25, 1, 5)
|
||||
.label("Light theme line alpha", LabelPosition.TOP)
|
||||
.enabledIf(generateColors.selected)
|
||||
.bindColorValue(ColorGenerator::lightThemeLineAlpha) { ColorGenerator.lightThemeLineAlpha = it }
|
||||
|
||||
slider(0, 25, 1, 5)
|
||||
.label("Dark theme line alpha", LabelPosition.TOP)
|
||||
.enabledIf(generateColors.selected)
|
||||
.bindColorValue(ColorGenerator::darkThemeLineAlpha) { ColorGenerator.darkThemeLineAlpha = it }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun Row.createEditor(scheme: EditorColorsScheme) {
|
||||
val editor = createPreviewEditor(scheme, disposable)
|
||||
editorSyncer.add(editor)
|
||||
|
||||
panel {
|
||||
row {
|
||||
cell(editor.component)
|
||||
.label(scheme.displayName, LabelPosition.TOP)
|
||||
.align(Align.FILL)
|
||||
.resizableColumn()
|
||||
}.resizableRow()
|
||||
}.resizableColumn()
|
||||
}
|
||||
|
||||
private fun Cell<JSlider>.bindColorValue(getter: () -> Int, setter: (Int) -> Unit): Cell<JSlider> {
|
||||
return applyToComponent {
|
||||
value = getter()
|
||||
toolTipText = value.toString()
|
||||
|
||||
addChangeListener {
|
||||
toolTipText = value.toString()
|
||||
setter(value)
|
||||
refreshColors()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun refreshColors() {
|
||||
for (severity in LensSeverity.values()) {
|
||||
severity.refreshColors()
|
||||
}
|
||||
|
||||
for (editor in editorSyncer.editors) {
|
||||
recreateLenses(editor)
|
||||
}
|
||||
}
|
||||
|
||||
override fun createActions(): Array<Action> {
|
||||
return arrayOf(okAction)
|
||||
}
|
||||
|
||||
override fun getDimensionServiceKey(): String {
|
||||
return this::class.java.name
|
||||
}
|
||||
}
|
||||
|
||||
private class EditorSyncer(private val disposable: Disposable) {
|
||||
val editors = mutableListOf<Editor>()
|
||||
|
||||
fun add(editor: Editor) {
|
||||
editors.add(editor)
|
||||
|
||||
editor.caretModel.addCaretListener(object : CaretListener {
|
||||
override fun caretPositionChanged(event: CaretEvent) {
|
||||
syncCarets(editor)
|
||||
}
|
||||
|
||||
override fun caretAdded(event: CaretEvent) {
|
||||
syncCarets(editor)
|
||||
}
|
||||
|
||||
override fun caretRemoved(event: CaretEvent) {
|
||||
syncCarets(editor)
|
||||
}
|
||||
}, disposable)
|
||||
|
||||
editor.selectionModel.addSelectionListener(object : SelectionListener {
|
||||
override fun selectionChanged(e: SelectionEvent) {
|
||||
syncCarets(editor)
|
||||
}
|
||||
}, disposable)
|
||||
}
|
||||
|
||||
private var isSyncing = false
|
||||
|
||||
private fun syncCarets(mainEditor: Editor) {
|
||||
val caretsAndSelections = mainEditor.caretModel.caretsAndSelections
|
||||
|
||||
syncEditors(mainEditor) {
|
||||
it.caretModel.caretsAndSelections = caretsAndSelections
|
||||
}
|
||||
}
|
||||
|
||||
private inline fun syncEditors(mainEditor: Editor, action: (Editor) -> Unit) {
|
||||
if (isSyncing) {
|
||||
return
|
||||
}
|
||||
|
||||
isSyncing = true
|
||||
try {
|
||||
for (editor in editors) {
|
||||
if (editor !== mainEditor) {
|
||||
action(editor)
|
||||
}
|
||||
}
|
||||
} finally {
|
||||
isSyncing = false
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private companion object {
|
||||
private val SEVERITIES = listOf(
|
||||
HighlightSeverity.ERROR,
|
||||
HighlightSeverity.WARNING,
|
||||
HighlightSeverity.WEAK_WARNING,
|
||||
HighlightSeverity.GENERIC_SERVER_ERROR_OR_WARNING,
|
||||
TextProblemSeverities.STYLE_SUGGESTION,
|
||||
SpellCheckerSeveritiesProvider.TYPO,
|
||||
HighlightSeverity("Other", 50)
|
||||
)
|
||||
|
||||
private val LENSES_KEY = Key.create<MutableList<EditorLens>>("InspectionLens.ShowColorEditorAction.Lenses")
|
||||
|
||||
private fun createPreviewEditor(scheme: EditorColorsScheme, disposable: Disposable): Editor {
|
||||
val editorFactory = EditorFactory.getInstance()
|
||||
|
||||
val document = editorFactory.createDocument(('A'..'Z').take(SEVERITIES.size * 3).joinToString(separator = "\n", postfix = "\n\n") { "$it = 0;" })
|
||||
val editor = editorFactory.createViewer(document) as EditorEx
|
||||
|
||||
editor.colorsScheme = scheme
|
||||
editor.caretModel.moveToOffset(editor.document.textLength)
|
||||
|
||||
with(editor.settings) {
|
||||
additionalColumnsCount = 0
|
||||
additionalLinesCount = 0
|
||||
isIndentGuidesShown = false
|
||||
isLineMarkerAreaShown = false
|
||||
isLineNumbersShown = true
|
||||
isRightMarginShown = false
|
||||
isWhitespacesShown = true
|
||||
setGutterIconsShown(false)
|
||||
}
|
||||
|
||||
ColorMode.setForEditor(editor, if (ColorUtil.isDark(scheme.defaultBackground)) ColorMode.ALWAYS_DARK else ColorMode.ALWAYS_LIGHT)
|
||||
recreateLenses(editor)
|
||||
|
||||
Disposer.register(disposable) { editorFactory.releaseEditor(editor) }
|
||||
return editor
|
||||
}
|
||||
|
||||
private fun recreateLenses(editor: Editor) {
|
||||
LENSES_KEY.get(editor)?.forEach(EditorLens::hide)
|
||||
|
||||
val lenses = mutableListOf<EditorLens>()
|
||||
LENSES_KEY.set(editor, lenses)
|
||||
|
||||
for ((index, severity) in SEVERITIES.withIndex()) {
|
||||
addLens(editor, severity, index, lenses)
|
||||
addLens(editor, severity, (index * 2) + 1 + SEVERITIES.size, lenses)
|
||||
}
|
||||
}
|
||||
|
||||
private fun addLens(editor: Editor, severity: HighlightSeverity, line: Int, list: MutableList<EditorLens>) {
|
||||
val startOffset = editor.document.getLineStartOffset(line)
|
||||
val endOffset = editor.document.getLineEndOffset(line)
|
||||
|
||||
val highlightInfo = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR)
|
||||
.severity(severity)
|
||||
.range(startOffset, endOffset)
|
||||
.descriptionAndTooltip("Example - ${severity.displayCapitalizedName}")
|
||||
.createUnconditionally()
|
||||
|
||||
EditorLens.show(editor, highlightInfo, service())?.let(list::add)
|
||||
}
|
||||
}
|
||||
}
|
@@ -1,36 +0,0 @@
|
||||
package com.chylex.intellij.inspectionlens.editor
|
||||
|
||||
import com.intellij.codeInsight.daemon.impl.HighlightInfo
|
||||
import com.intellij.openapi.editor.Editor
|
||||
|
||||
internal class EditorLens private constructor(private var inlay: EditorLensInlay, private var lineBackground: EditorLensLineBackground) {
|
||||
fun update(info: HighlightInfo): Boolean {
|
||||
val editor = inlay.editor
|
||||
|
||||
if (!inlay.tryUpdate(info)) {
|
||||
inlay = EditorLensInlay.show(editor, info) ?: return false
|
||||
}
|
||||
|
||||
if (lineBackground.shouldRecreate(info)) {
|
||||
lineBackground.hide(editor)
|
||||
lineBackground = EditorLensLineBackground.show(editor, info)
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
fun hide() {
|
||||
val editor = inlay.editor
|
||||
|
||||
inlay.hide()
|
||||
lineBackground.hide(editor)
|
||||
}
|
||||
|
||||
companion object {
|
||||
fun show(editor: Editor, info: HighlightInfo): EditorLens? {
|
||||
val inlay = EditorLensInlay.show(editor, info) ?: return null
|
||||
val lineBackground = EditorLensLineBackground.show(editor, info)
|
||||
return EditorLens(inlay, lineBackground)
|
||||
}
|
||||
}
|
||||
}
|
@@ -0,0 +1,56 @@
|
||||
package com.chylex.intellij.inspectionlens.editor
|
||||
|
||||
import com.intellij.openapi.Disposable
|
||||
import com.intellij.openapi.editor.Editor
|
||||
import com.intellij.openapi.editor.ex.FoldingModelEx
|
||||
import com.intellij.openapi.editor.ex.MarkupModelEx
|
||||
import com.intellij.openapi.editor.impl.DocumentMarkupModel
|
||||
import com.intellij.openapi.util.Disposer
|
||||
import com.intellij.openapi.util.Key
|
||||
|
||||
/**
|
||||
* Manages Inspection Lens features for a single [Editor].
|
||||
*/
|
||||
internal class EditorLensFeatures private constructor(
|
||||
editor: Editor,
|
||||
private val markupModel: MarkupModelEx,
|
||||
foldingModel: FoldingModelEx?,
|
||||
disposable: Disposable
|
||||
) {
|
||||
private val lensManager = EditorLensManager(editor)
|
||||
private val lensManagerDispatcher = EditorLensManagerDispatcher(lensManager)
|
||||
private val markupModelListener = LensMarkupModelListener(lensManagerDispatcher)
|
||||
|
||||
init {
|
||||
markupModel.addMarkupModelListener(disposable, markupModelListener)
|
||||
markupModelListener.showAllValid(markupModel.allHighlighters)
|
||||
|
||||
foldingModel?.addListener(LensFoldingModelListener(lensManager), disposable)
|
||||
}
|
||||
|
||||
private fun refresh() {
|
||||
markupModelListener.hideAll()
|
||||
markupModelListener.showAllValid(markupModel.allHighlighters)
|
||||
}
|
||||
|
||||
companion object {
|
||||
private val EDITOR_KEY = Key<EditorLensFeatures>(EditorLensFeatures::class.java.name)
|
||||
|
||||
fun install(editor: Editor, disposable: Disposable) {
|
||||
if (editor.getUserData(EDITOR_KEY) != null) {
|
||||
return
|
||||
}
|
||||
|
||||
val markupModel = DocumentMarkupModel.forDocument(editor.document, editor.project, false) as? MarkupModelEx ?: return
|
||||
val foldingModel = editor.foldingModel as? FoldingModelEx
|
||||
val features = EditorLensFeatures(editor, markupModel, foldingModel, disposable)
|
||||
|
||||
editor.putUserData(EDITOR_KEY, features)
|
||||
Disposer.register(disposable) { editor.putUserData(EDITOR_KEY, null) }
|
||||
}
|
||||
|
||||
fun refresh(editor: Editor) {
|
||||
editor.getUserData(EDITOR_KEY)?.refresh()
|
||||
}
|
||||
}
|
||||
}
|
@@ -1,45 +1,36 @@
|
||||
package com.chylex.intellij.inspectionlens.editor
|
||||
|
||||
import com.chylex.intellij.inspectionlens.editor.lens.EditorLens
|
||||
import com.chylex.intellij.inspectionlens.settings.LensSettingsState
|
||||
import com.intellij.openapi.components.service
|
||||
import com.intellij.openapi.editor.Editor
|
||||
import com.intellij.openapi.editor.markup.RangeHighlighter
|
||||
import com.intellij.openapi.util.Key
|
||||
import java.util.IdentityHashMap
|
||||
|
||||
/**
|
||||
* Manages visible inspection lenses for an [Editor].
|
||||
*/
|
||||
class EditorLensManager private constructor(private val editor: Editor) {
|
||||
companion object {
|
||||
private val EDITOR_KEY = Key<EditorLensManager>(EditorLensManager::class.java.name)
|
||||
|
||||
fun getOrCreate(editor: Editor): EditorLensManager {
|
||||
return editor.getUserData(EDITOR_KEY) ?: EditorLensManager(editor).also { editor.putUserData(EDITOR_KEY, it) }
|
||||
}
|
||||
|
||||
fun remove(editor: Editor) {
|
||||
val manager = editor.getUserData(EDITOR_KEY)
|
||||
if (manager != null) {
|
||||
manager.hideAll()
|
||||
editor.putUserData(EDITOR_KEY, null)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
internal class EditorLensManager(private val editor: Editor) {
|
||||
private val lenses = IdentityHashMap<RangeHighlighter, EditorLens>()
|
||||
private val settings = service<LensSettingsState>()
|
||||
|
||||
private fun show(highlighterWithInfo: HighlighterWithInfo) {
|
||||
val (highlighter, info) = highlighterWithInfo
|
||||
|
||||
if (!highlighter.isValid) {
|
||||
return
|
||||
}
|
||||
|
||||
val existingLens = lenses[highlighter]
|
||||
if (existingLens != null) {
|
||||
if (existingLens.update(info)) {
|
||||
if (existingLens.update(info, settings)) {
|
||||
return
|
||||
}
|
||||
|
||||
existingLens.hide()
|
||||
}
|
||||
|
||||
val newLens = EditorLens.show(editor, info)
|
||||
val newLens = EditorLens.show(editor, info, settings)
|
||||
if (newLens != null) {
|
||||
lenses[highlighter] = newLens
|
||||
}
|
||||
@@ -48,22 +39,10 @@ class EditorLensManager private constructor(private val editor: Editor) {
|
||||
}
|
||||
}
|
||||
|
||||
fun show(highlightersWithInfo: Collection<HighlighterWithInfo>) {
|
||||
executeInBatchMode(highlightersWithInfo.size) {
|
||||
highlightersWithInfo.forEach(::show)
|
||||
}
|
||||
}
|
||||
|
||||
private fun hide(highlighter: RangeHighlighter) {
|
||||
lenses.remove(highlighter)?.hide()
|
||||
}
|
||||
|
||||
fun hide(highlighters: Collection<RangeHighlighter>) {
|
||||
executeInBatchMode(highlighters.size) {
|
||||
highlighters.forEach(::hide)
|
||||
}
|
||||
}
|
||||
|
||||
fun hideAll() {
|
||||
executeInBatchMode(lenses.size) {
|
||||
lenses.values.forEach(EditorLens::hide)
|
||||
@@ -71,6 +50,38 @@ class EditorLensManager private constructor(private val editor: Editor) {
|
||||
}
|
||||
}
|
||||
|
||||
fun execute(commands: Collection<Command>) {
|
||||
executeInBatchMode(commands.size) {
|
||||
commands.forEach { it.apply(this) }
|
||||
}
|
||||
}
|
||||
|
||||
fun onFoldRegionsChanged() {
|
||||
lenses.values.forEach(EditorLens::onFoldRegionsChanged)
|
||||
}
|
||||
|
||||
sealed interface Command {
|
||||
fun apply(lensManager: EditorLensManager)
|
||||
|
||||
class Show(private val highlighter: HighlighterWithInfo) : Command {
|
||||
override fun apply(lensManager: EditorLensManager) {
|
||||
lensManager.show(highlighter)
|
||||
}
|
||||
}
|
||||
|
||||
class Hide(private val highlighter: RangeHighlighter) : Command {
|
||||
override fun apply(lensManager: EditorLensManager) {
|
||||
lensManager.hide(highlighter)
|
||||
}
|
||||
}
|
||||
|
||||
object HideAll : Command {
|
||||
override fun apply(lensManager: EditorLensManager) {
|
||||
lensManager.hideAll()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Batch mode affects both inlays and highlighters used for line colors.
|
||||
*/
|
||||
|
@@ -0,0 +1,45 @@
|
||||
package com.chylex.intellij.inspectionlens.editor
|
||||
|
||||
import com.intellij.openapi.application.ApplicationManager
|
||||
import com.intellij.openapi.editor.markup.RangeHighlighter
|
||||
|
||||
internal class EditorLensManagerDispatcher(private val lensManager: EditorLensManager) {
|
||||
private var queuedItems = mutableListOf<EditorLensManager.Command>()
|
||||
private var isEnqueued = false
|
||||
|
||||
fun show(highlighterWithInfo: HighlighterWithInfo) {
|
||||
enqueue(EditorLensManager.Command.Show(highlighterWithInfo))
|
||||
}
|
||||
|
||||
fun hide(highlighter: RangeHighlighter) {
|
||||
enqueue(EditorLensManager.Command.Hide(highlighter))
|
||||
}
|
||||
|
||||
fun hideAll() {
|
||||
enqueue(EditorLensManager.Command.HideAll)
|
||||
}
|
||||
|
||||
private fun enqueue(item: EditorLensManager.Command) {
|
||||
synchronized(this) {
|
||||
queuedItems.add(item)
|
||||
|
||||
// Enqueue even if already on dispatch thread to debounce consecutive calls.
|
||||
if (!isEnqueued) {
|
||||
isEnqueued = true
|
||||
ApplicationManager.getApplication().invokeLater(::process)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun process() {
|
||||
var itemsToProcess: List<EditorLensManager.Command>
|
||||
|
||||
synchronized(this) {
|
||||
itemsToProcess = queuedItems
|
||||
queuedItems = mutableListOf()
|
||||
isEnqueued = false
|
||||
}
|
||||
|
||||
lensManager.execute(itemsToProcess)
|
||||
}
|
||||
}
|
@@ -0,0 +1,12 @@
|
||||
package com.chylex.intellij.inspectionlens.editor
|
||||
|
||||
import com.intellij.openapi.editor.ex.FoldingListener
|
||||
|
||||
/**
|
||||
* Listens for code folding events and reports them to [EditorLensManager].
|
||||
*/
|
||||
internal class LensFoldingModelListener(private val lensManager: EditorLensManager) : FoldingListener {
|
||||
override fun onFoldProcessingEnd() {
|
||||
lensManager.onFoldRegionsChanged()
|
||||
}
|
||||
}
|
@@ -1,26 +1,17 @@
|
||||
package com.chylex.intellij.inspectionlens.editor
|
||||
|
||||
import com.chylex.intellij.inspectionlens.utils.DebouncingInvokeOnDispatchThread
|
||||
import com.chylex.intellij.inspectionlens.settings.LensSettingsState
|
||||
import com.intellij.codeInsight.daemon.impl.HighlightInfo
|
||||
import com.intellij.lang.annotation.HighlightSeverity
|
||||
import com.intellij.openapi.Disposable
|
||||
import com.intellij.openapi.editor.Editor
|
||||
import com.intellij.openapi.editor.ex.MarkupModelEx
|
||||
import com.intellij.openapi.components.service
|
||||
import com.intellij.openapi.editor.ex.RangeHighlighterEx
|
||||
import com.intellij.openapi.editor.impl.DocumentMarkupModel
|
||||
import com.intellij.openapi.editor.impl.event.MarkupModelListener
|
||||
import com.intellij.openapi.editor.markup.RangeHighlighter
|
||||
import com.intellij.openapi.util.Disposer
|
||||
import com.intellij.openapi.util.Key
|
||||
|
||||
/**
|
||||
* Listens for inspection highlights and reports them to [EditorLensManager].
|
||||
*/
|
||||
internal class LensMarkupModelListener private constructor(editor: Editor) : MarkupModelListener {
|
||||
private val lensManager = EditorLensManager.getOrCreate(editor)
|
||||
|
||||
private val showOnDispatchThread = DebouncingInvokeOnDispatchThread(lensManager::show)
|
||||
private val hideOnDispatchThread = DebouncingInvokeOnDispatchThread(lensManager::hide)
|
||||
internal class LensMarkupModelListener(private val lensManagerDispatcher: EditorLensManagerDispatcher) : MarkupModelListener {
|
||||
private val settings = service<LensSettingsState>()
|
||||
|
||||
override fun afterAdded(highlighter: RangeHighlighterEx) {
|
||||
showIfValid(highlighter)
|
||||
@@ -32,80 +23,47 @@ internal class LensMarkupModelListener private constructor(editor: Editor) : Mar
|
||||
|
||||
override fun beforeRemoved(highlighter: RangeHighlighterEx) {
|
||||
if (getFilteredHighlightInfo(highlighter) != null) {
|
||||
hideOnDispatchThread.enqueue(highlighter)
|
||||
lensManagerDispatcher.hide(highlighter)
|
||||
}
|
||||
}
|
||||
|
||||
private fun showIfValid(highlighter: RangeHighlighter) {
|
||||
runWithHighlighterIfValid(highlighter, showOnDispatchThread::enqueue, ::showAsynchronously)
|
||||
runWithHighlighterIfValid(highlighter, lensManagerDispatcher::show, ::showAsynchronously)
|
||||
}
|
||||
|
||||
private fun showAsynchronously(highlighterWithInfo: HighlighterWithInfo.Async) {
|
||||
highlighterWithInfo.requestDescription {
|
||||
if (highlighterWithInfo.highlighter.isValid && highlighterWithInfo.hasDescription) {
|
||||
showOnDispatchThread.enqueue(highlighterWithInfo)
|
||||
lensManagerDispatcher.show(highlighterWithInfo)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun showAllValid(highlighters: Array<RangeHighlighter>) {
|
||||
fun showAllValid(highlighters: Array<RangeHighlighter>) {
|
||||
highlighters.forEach(::showIfValid)
|
||||
}
|
||||
|
||||
companion object {
|
||||
private val EDITOR_KEY = Key<LensMarkupModelListener>(LensMarkupModelListener::class.java.name)
|
||||
private val MINIMUM_SEVERITY = HighlightSeverity.TEXT_ATTRIBUTES.myVal + 1
|
||||
|
||||
private fun getFilteredHighlightInfo(highlighter: RangeHighlighter): HighlightInfo? {
|
||||
return HighlightInfo.fromRangeHighlighter(highlighter)?.takeIf { it.severity.myVal >= MINIMUM_SEVERITY }
|
||||
fun hideAll() {
|
||||
lensManagerDispatcher.hideAll()
|
||||
}
|
||||
|
||||
private fun getFilteredHighlightInfo(highlighter: RangeHighlighter): HighlightInfo? {
|
||||
return HighlightInfo.fromRangeHighlighter(highlighter)?.takeIf { settings.severityFilter.test(it.severity) }
|
||||
}
|
||||
|
||||
private inline fun runWithHighlighterIfValid(highlighter: RangeHighlighter, actionForImmediate: (HighlighterWithInfo) -> Unit, actionForAsync: (HighlighterWithInfo.Async) -> Unit) {
|
||||
val info = highlighter.takeIf { it.isValid }?.let(::getFilteredHighlightInfo)
|
||||
if (info != null) {
|
||||
processHighlighterWithInfo(HighlighterWithInfo.from(highlighter, info), actionForImmediate, actionForAsync)
|
||||
}
|
||||
|
||||
private inline fun runWithHighlighterIfValid(highlighter: RangeHighlighter, actionForImmediate: (HighlighterWithInfo) -> Unit, actionForAsync: (HighlighterWithInfo.Async) -> Unit) {
|
||||
val info = highlighter.takeIf { it.isValid }?.let(::getFilteredHighlightInfo)
|
||||
if (info != null) {
|
||||
processHighlighterWithInfo(HighlighterWithInfo.from(highlighter, info), actionForImmediate, actionForAsync)
|
||||
}
|
||||
}
|
||||
|
||||
private inline fun processHighlighterWithInfo(highlighterWithInfo: HighlighterWithInfo, actionForImmediate: (HighlighterWithInfo) -> Unit, actionForAsync: (HighlighterWithInfo.Async) -> Unit) {
|
||||
if (highlighterWithInfo is HighlighterWithInfo.Async) {
|
||||
actionForAsync(highlighterWithInfo)
|
||||
}
|
||||
|
||||
private inline fun processHighlighterWithInfo(highlighterWithInfo: HighlighterWithInfo, actionForImmediate: (HighlighterWithInfo) -> Unit, actionForAsync: (HighlighterWithInfo.Async) -> Unit) {
|
||||
if (highlighterWithInfo is HighlighterWithInfo.Async) {
|
||||
actionForAsync(highlighterWithInfo)
|
||||
}
|
||||
else if (highlighterWithInfo.hasDescription) {
|
||||
actionForImmediate(highlighterWithInfo)
|
||||
}
|
||||
}
|
||||
|
||||
private fun getMarkupModel(editor: Editor): MarkupModelEx? {
|
||||
return DocumentMarkupModel.forDocument(editor.document, editor.project, false) as? MarkupModelEx
|
||||
}
|
||||
|
||||
/**
|
||||
* Attaches a new [LensMarkupModelListener] to the [Editor], and reports all existing inspection highlights to [EditorLensManager].
|
||||
*/
|
||||
fun register(editor: Editor, disposable: Disposable) {
|
||||
if (editor.getUserData(EDITOR_KEY) != null) {
|
||||
return
|
||||
}
|
||||
|
||||
val markupModel = getMarkupModel(editor) ?: return
|
||||
val listener = LensMarkupModelListener(editor)
|
||||
|
||||
editor.putUserData(EDITOR_KEY, listener)
|
||||
Disposer.register(disposable) { editor.putUserData(EDITOR_KEY, null) }
|
||||
|
||||
markupModel.addMarkupModelListener(disposable, listener)
|
||||
listener.showAllValid(markupModel.allHighlighters)
|
||||
}
|
||||
|
||||
/**
|
||||
* Recreates all inspection highlights in the [Editor].
|
||||
*/
|
||||
fun refresh(editor: Editor) {
|
||||
val listener = editor.getUserData(EDITOR_KEY) ?: return
|
||||
val markupModel = getMarkupModel(editor) ?: return
|
||||
|
||||
listener.showAllValid(markupModel.allHighlighters)
|
||||
else if (highlighterWithInfo.hasDescription) {
|
||||
actionForImmediate(highlighterWithInfo)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@@ -1,63 +0,0 @@
|
||||
package com.chylex.intellij.inspectionlens.editor
|
||||
|
||||
import com.intellij.codeInsight.daemon.impl.HighlightInfo
|
||||
import com.intellij.codeInsight.daemon.impl.HintRenderer
|
||||
import com.intellij.openapi.editor.Editor
|
||||
import com.intellij.openapi.editor.Inlay
|
||||
import com.intellij.openapi.editor.markup.TextAttributes
|
||||
import com.intellij.openapi.util.text.StringUtil
|
||||
import java.awt.Graphics
|
||||
import java.awt.Rectangle
|
||||
|
||||
/**
|
||||
* Renders the text of an inspection lens.
|
||||
*/
|
||||
class LensRenderer(info: HighlightInfo) : HintRenderer(null) {
|
||||
private lateinit var severity: LensSeverity
|
||||
|
||||
init {
|
||||
setPropertiesFrom(info)
|
||||
}
|
||||
|
||||
fun setPropertiesFrom(info: HighlightInfo) {
|
||||
text = getValidDescriptionText(info.description)
|
||||
severity = LensSeverity.from(info.severity)
|
||||
}
|
||||
|
||||
override fun paint(inlay: Inlay<*>, g: Graphics, r: Rectangle, textAttributes: TextAttributes) {
|
||||
fixBaselineForTextRendering(r)
|
||||
super.paint(inlay, g, r, textAttributes)
|
||||
}
|
||||
|
||||
override fun getTextAttributes(editor: Editor): TextAttributes {
|
||||
return severity.textAttributes
|
||||
}
|
||||
|
||||
override fun useEditorFont(): Boolean {
|
||||
return true
|
||||
}
|
||||
|
||||
private companion object {
|
||||
private fun getValidDescriptionText(text: String?): String {
|
||||
return if (text.isNullOrBlank()) " " else addMissingPeriod(convertHtmlToText(text))
|
||||
}
|
||||
|
||||
private fun convertHtmlToText(potentialHtml: String): String {
|
||||
return potentialHtml
|
||||
.ifContains('<') { StringUtil.stripHtml(it, " ") }
|
||||
.ifContains('&', StringUtil::unescapeXmlEntities)
|
||||
}
|
||||
|
||||
private fun addMissingPeriod(text: String): String {
|
||||
return if (text.endsWith('.')) text else "$text."
|
||||
}
|
||||
|
||||
private inline fun String.ifContains(charToTest: Char, action: (String) -> String): String {
|
||||
return if (this.contains(charToTest)) action(this) else this
|
||||
}
|
||||
|
||||
private fun fixBaselineForTextRendering(rect: Rectangle) {
|
||||
rect.y += 1
|
||||
}
|
||||
}
|
||||
}
|
@@ -0,0 +1,80 @@
|
||||
package com.chylex.intellij.inspectionlens.editor.lens
|
||||
|
||||
import com.intellij.ui.ColorUtil
|
||||
import java.awt.Color
|
||||
import java.util.Locale
|
||||
import kotlin.math.abs
|
||||
import kotlin.math.pow
|
||||
|
||||
internal object ColorGenerator {
|
||||
private const val HACK_BRIGHTNESS_STEP = 1.025F
|
||||
|
||||
var useGenerator = false
|
||||
var lightThemeDesaturation = 1
|
||||
var lightThemeThreshold = 32
|
||||
var lightThemeLineAlpha = 10
|
||||
var darkThemeDesaturation = 2
|
||||
var darkThemeThreshold = 62
|
||||
var darkThemeLineAlpha = 13
|
||||
|
||||
data class Theme(
|
||||
val lightThemeTextColor: Color,
|
||||
val lightThemeLineColor: Color,
|
||||
val darkThemeTextColor: Color,
|
||||
val darkThemeLineColor: Color,
|
||||
)
|
||||
|
||||
fun generate(name: String, baseColor: Color): Theme {
|
||||
val lightThemeTextColor: Color = findColorWithPerceivedBrightness("$name / Light", baseColor, lightThemeDesaturation, 50 downTo -50) { it <= lightThemeThreshold }
|
||||
val darkThemeTextColor: Color = findColorWithPerceivedBrightness("$name / Dark", baseColor, darkThemeDesaturation, -50..50) { it >= darkThemeThreshold }
|
||||
|
||||
val lightThemeLineColor = ColorUtil.toAlpha(lightThemeTextColor, lightThemeLineAlpha)
|
||||
val darkThemeLineColor = ColorUtil.toAlpha(darkThemeTextColor, darkThemeLineAlpha)
|
||||
|
||||
return Theme(lightThemeTextColor, lightThemeLineColor, darkThemeTextColor, darkThemeLineColor)
|
||||
}
|
||||
|
||||
private fun findColorWithPerceivedBrightness(name: String, baseColor: Color, desaturation: Int, steps: IntProgression, testPerceivedBrightness: (Double) -> Boolean): Color {
|
||||
var finalColor = baseColor
|
||||
var finalBrightening = 0
|
||||
var finalPerceivedBrightness = 0.0
|
||||
|
||||
for (brightening in steps) {
|
||||
finalColor = ColorUtil.desaturate(ColorUtil.hackBrightness(baseColor, abs(brightening), if (brightening < 0) 1F / HACK_BRIGHTNESS_STEP else HACK_BRIGHTNESS_STEP), desaturation)
|
||||
finalBrightening = brightening
|
||||
finalPerceivedBrightness = getPerceivedBrightness(finalColor)
|
||||
|
||||
if (testPerceivedBrightness(finalPerceivedBrightness)) {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
println("$name - ${baseColor.red},${baseColor.green},${baseColor.blue} --> step $finalBrightening; brightness ${String.format(Locale.ROOT, "%.2f", finalPerceivedBrightness)}; color ${finalColor.red},${finalColor.green},${finalColor.blue}")
|
||||
return finalColor
|
||||
}
|
||||
|
||||
private fun getLuminance(r: Double, g: Double, b: Double): Double {
|
||||
return 0.2126 * srgbToLinearRgb(r) + 0.7152 * srgbToLinearRgb(g) + 0.0722 * srgbToLinearRgb(b)
|
||||
}
|
||||
|
||||
private fun srgbToLinearRgb(channel: Double): Double {
|
||||
return if (channel <= 0.04045)
|
||||
channel / 12.92
|
||||
else
|
||||
((channel + 0.055) / 1.055).pow(2.4)
|
||||
}
|
||||
|
||||
private fun getPerceivedBrightness(luminance: Double): Double {
|
||||
return if (luminance <= (216.0 / 24389.0))
|
||||
luminance * (24389.0 / 27.0)
|
||||
else
|
||||
luminance.pow(1.0 / 3.0) * 116 - 16
|
||||
}
|
||||
|
||||
private fun getPerceivedBrightness(color: Color): Double {
|
||||
val r = color.red / 255.0
|
||||
val g = color.green / 255.0
|
||||
val b = color.blue / 255.0
|
||||
return getPerceivedBrightness(getLuminance(r, g, b))
|
||||
}
|
||||
}
|
@@ -0,0 +1,35 @@
|
||||
package com.chylex.intellij.inspectionlens.editor.lens
|
||||
|
||||
import com.intellij.openapi.editor.Editor
|
||||
import com.intellij.openapi.util.Key
|
||||
import com.intellij.ui.JBColor
|
||||
import java.awt.Color
|
||||
import java.util.EnumMap
|
||||
|
||||
internal enum class ColorMode {
|
||||
AUTO,
|
||||
ALWAYS_LIGHT,
|
||||
ALWAYS_DARK;
|
||||
|
||||
companion object {
|
||||
private val KEY = Key.create<ColorMode>("InspectionLens.ColorMode")
|
||||
|
||||
fun getFromEditor(editor: Editor): ColorMode {
|
||||
return KEY.get(editor, AUTO)
|
||||
}
|
||||
|
||||
fun setForEditor(editor: Editor, colorMode: ColorMode) {
|
||||
KEY.set(editor, colorMode)
|
||||
}
|
||||
|
||||
inline fun createColorAttributes(lightThemeColor: Color, darkThemeColor: Color, attributesFactory: (JBColor) -> LensSeverityTextAttributes): EnumMap<ColorMode, LensSeverityTextAttributes> {
|
||||
val result = EnumMap<ColorMode, LensSeverityTextAttributes>(ColorMode::class.java)
|
||||
|
||||
result[AUTO] = attributesFactory(JBColor(lightThemeColor, darkThemeColor))
|
||||
result[ALWAYS_LIGHT] = attributesFactory(JBColor(lightThemeColor, lightThemeColor))
|
||||
result[ALWAYS_DARK] = attributesFactory(JBColor(darkThemeColor, darkThemeColor))
|
||||
|
||||
return result
|
||||
}
|
||||
}
|
||||
}
|
@@ -0,0 +1,43 @@
|
||||
package com.chylex.intellij.inspectionlens.editor.lens
|
||||
|
||||
import com.chylex.intellij.inspectionlens.settings.LensSettingsState
|
||||
import com.intellij.codeInsight.daemon.impl.HighlightInfo
|
||||
import com.intellij.openapi.editor.Editor
|
||||
|
||||
internal class EditorLens private constructor(private var inlay: EditorLensInlay, private var lineBackground: EditorLensLineBackground, private var severity: LensSeverity) {
|
||||
fun update(info: HighlightInfo, settings: LensSettingsState): Boolean {
|
||||
val editor = inlay.editor
|
||||
val oldSeverity = severity
|
||||
|
||||
severity = LensSeverity.from(info.severity)
|
||||
|
||||
if (!inlay.tryUpdate(info)) {
|
||||
inlay = EditorLensInlay.show(editor, info, settings) ?: return false
|
||||
}
|
||||
|
||||
if (lineBackground.isInvalid || oldSeverity != severity) {
|
||||
lineBackground.hide(editor)
|
||||
lineBackground = EditorLensLineBackground.show(editor, info)
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
fun onFoldRegionsChanged() {
|
||||
lineBackground.onFoldRegionsChanged(inlay.editor, severity)
|
||||
}
|
||||
|
||||
fun hide() {
|
||||
inlay.hide()
|
||||
lineBackground.hide(inlay.editor)
|
||||
}
|
||||
|
||||
companion object {
|
||||
fun show(editor: Editor, info: HighlightInfo, settings: LensSettingsState): EditorLens? {
|
||||
val inlay = EditorLensInlay.show(editor, info, settings) ?: return null
|
||||
val lineBackground = EditorLensLineBackground.show(editor, info)
|
||||
val severity = LensSeverity.from(info.severity)
|
||||
return EditorLens(inlay, lineBackground, severity)
|
||||
}
|
||||
}
|
||||
}
|
@@ -1,5 +1,6 @@
|
||||
package com.chylex.intellij.inspectionlens.editor
|
||||
package com.chylex.intellij.inspectionlens.editor.lens
|
||||
|
||||
import com.chylex.intellij.inspectionlens.settings.LensSettingsState
|
||||
import com.intellij.codeInsight.daemon.impl.HighlightInfo
|
||||
import com.intellij.openapi.editor.Editor
|
||||
import com.intellij.openapi.editor.Inlay
|
||||
@@ -25,14 +26,19 @@ internal value class EditorLensInlay(private val inlay: Inlay<LensRenderer>) {
|
||||
}
|
||||
|
||||
companion object {
|
||||
fun show(editor: Editor, info: HighlightInfo): EditorLensInlay? {
|
||||
fun show(editor: Editor, info: HighlightInfo, settings: LensSettingsState): EditorLensInlay? {
|
||||
val offset = getInlayHintOffset(info)
|
||||
val priority = getInlayHintPriority(editor, info)
|
||||
val renderer = LensRenderer(info, settings)
|
||||
|
||||
val renderer = LensRenderer(info)
|
||||
val properties = InlayProperties().relatesToPrecedingText(true).disableSoftWrapping(true).priority(priority)
|
||||
val properties = InlayProperties()
|
||||
.relatesToPrecedingText(true)
|
||||
.disableSoftWrapping(true)
|
||||
.priority(priority)
|
||||
|
||||
return editor.inlayModel.addAfterLineEndElement(offset, properties, renderer)?.let(::EditorLensInlay)
|
||||
return editor.inlayModel.addAfterLineEndElement(offset, properties, renderer)
|
||||
?.also(renderer::setInlay)
|
||||
?.let(::EditorLensInlay)
|
||||
}
|
||||
|
||||
/**
|
@@ -1,34 +1,22 @@
|
||||
package com.chylex.intellij.inspectionlens.editor
|
||||
package com.chylex.intellij.inspectionlens.editor.lens
|
||||
|
||||
import com.intellij.codeInsight.daemon.impl.HighlightInfo
|
||||
import com.intellij.openapi.editor.Editor
|
||||
import com.intellij.openapi.editor.ex.RangeHighlighterEx
|
||||
import com.intellij.openapi.editor.markup.HighlighterLayer
|
||||
import com.intellij.openapi.editor.markup.HighlighterTargetArea.LINES_IN_RANGE
|
||||
import com.intellij.openapi.editor.markup.RangeHighlighter
|
||||
import com.intellij.openapi.editor.markup.TextAttributes
|
||||
|
||||
@JvmInline
|
||||
internal value class EditorLensLineBackground(private val highlighter: RangeHighlighter) {
|
||||
@Suppress("RedundantIf")
|
||||
fun shouldRecreate(info: HighlightInfo): Boolean {
|
||||
if (!highlighter.isValid) {
|
||||
return true
|
||||
val isInvalid
|
||||
get() = !highlighter.isValid
|
||||
|
||||
fun onFoldRegionsChanged(editor: Editor, severity: LensSeverity) {
|
||||
if (highlighter is RangeHighlighterEx) {
|
||||
highlighter.textAttributes = getAttributes(editor, highlighter.startOffset, highlighter.endOffset, severity)
|
||||
}
|
||||
|
||||
val severity = LensSeverity.from(info.severity)
|
||||
|
||||
val currentTextAttributes = highlighter.getTextAttributes(null)
|
||||
val newTextAttributes = severity.lineAttributes
|
||||
if (currentTextAttributes !== newTextAttributes) {
|
||||
return true
|
||||
}
|
||||
|
||||
val currentLayer = highlighter.layer
|
||||
val newLayer = getHighlightLayer(severity)
|
||||
if (currentLayer != newLayer) {
|
||||
return true
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
fun hide(editor: Editor) {
|
||||
@@ -42,12 +30,20 @@ internal value class EditorLensLineBackground(private val highlighter: RangeHigh
|
||||
|
||||
val severity = LensSeverity.from(info.severity)
|
||||
val layer = getHighlightLayer(severity)
|
||||
val attributes = getAttributes(editor, startOffset, endOffset, severity)
|
||||
|
||||
return EditorLensLineBackground(editor.markupModel.addRangeHighlighter(startOffset, endOffset, layer, severity.lineAttributes, LINES_IN_RANGE))
|
||||
return EditorLensLineBackground(editor.markupModel.addRangeHighlighter(startOffset, endOffset, layer, attributes, LINES_IN_RANGE))
|
||||
}
|
||||
|
||||
private fun getHighlightLayer(severity: LensSeverity): Int {
|
||||
return HighlighterLayer.CARET_ROW - 100 - severity.ordinal
|
||||
}
|
||||
|
||||
private fun getAttributes(editor: Editor, startOffset: Int, endOffset: Int, severity: LensSeverity): TextAttributes? {
|
||||
return if (editor.foldingModel.let { it.isOffsetCollapsed(startOffset) || it.isOffsetCollapsed(endOffset) })
|
||||
null
|
||||
else
|
||||
severity.getLineAttributes(ColorMode.getFromEditor(editor))
|
||||
}
|
||||
}
|
||||
}
|
@@ -0,0 +1,36 @@
|
||||
package com.chylex.intellij.inspectionlens.editor.lens
|
||||
|
||||
import com.intellij.codeInsight.daemon.impl.IntentionsUI
|
||||
import com.intellij.codeInsight.hint.HintManager
|
||||
import com.intellij.codeInsight.intention.impl.ShowIntentionActionsHandler
|
||||
import com.intellij.lang.LangBundle
|
||||
import com.intellij.openapi.editor.Editor
|
||||
import com.intellij.openapi.project.Project
|
||||
import com.intellij.psi.PsiDocumentManager
|
||||
import com.intellij.psi.PsiFile
|
||||
import com.intellij.psi.util.PsiUtilBase
|
||||
|
||||
internal object IntentionsPopup {
|
||||
fun show(editor: Editor) {
|
||||
if (!tryShow(editor)) {
|
||||
HintManager.getInstance().showInformationHint(editor, LangBundle.message("hint.text.no.context.actions.available.at.this.location"))
|
||||
}
|
||||
}
|
||||
|
||||
private fun tryShow(editor: Editor): Boolean {
|
||||
val project = editor.project ?: return false
|
||||
val file = PsiUtilBase.getPsiFileInEditor(editor, project) ?: return false
|
||||
|
||||
PsiDocumentManager.getInstance(project).commitAllDocuments()
|
||||
IntentionsUI.getInstance(project).hide()
|
||||
|
||||
HANDLER.showIntentionHint(project, editor, file, showFeedbackOnEmptyMenu = true)
|
||||
return true
|
||||
}
|
||||
|
||||
private val HANDLER = object : ShowIntentionActionsHandler() {
|
||||
public override fun showIntentionHint(project: Project, editor: Editor, file: PsiFile, showFeedbackOnEmptyMenu: Boolean) {
|
||||
super.showIntentionHint(project, editor, file, showFeedbackOnEmptyMenu)
|
||||
}
|
||||
}
|
||||
}
|
@@ -0,0 +1,185 @@
|
||||
package com.chylex.intellij.inspectionlens.editor.lens
|
||||
|
||||
import com.chylex.intellij.inspectionlens.settings.LensSettingsState
|
||||
import com.intellij.codeInsight.daemon.impl.HighlightInfo
|
||||
import com.intellij.codeInsight.daemon.impl.HintRenderer
|
||||
import com.intellij.codeInsight.hints.presentation.InputHandler
|
||||
import com.intellij.openapi.editor.Editor
|
||||
import com.intellij.openapi.editor.Inlay
|
||||
import com.intellij.openapi.editor.ScrollType
|
||||
import com.intellij.openapi.editor.colors.EditorFontType
|
||||
import com.intellij.openapi.editor.ex.EditorEx
|
||||
import com.intellij.openapi.editor.impl.EditorImpl
|
||||
import com.intellij.openapi.editor.markup.TextAttributes
|
||||
import com.intellij.openapi.util.text.StringUtil
|
||||
import com.intellij.ui.paint.EffectPainter
|
||||
import java.awt.Cursor
|
||||
import java.awt.Graphics
|
||||
import java.awt.Graphics2D
|
||||
import java.awt.Point
|
||||
import java.awt.Rectangle
|
||||
import java.awt.event.MouseEvent
|
||||
import java.util.regex.Pattern
|
||||
import javax.swing.SwingUtilities
|
||||
|
||||
/**
|
||||
* Renders the text of an inspection lens.
|
||||
*/
|
||||
class LensRenderer(private var info: HighlightInfo, settings: LensSettingsState) : HintRenderer(null), InputHandler {
|
||||
private val useEditorFont = settings.useEditorFont
|
||||
private lateinit var inlay: Inlay<*>
|
||||
private lateinit var severity: LensSeverity
|
||||
private var extraRightPadding = 0
|
||||
private var hovered = false
|
||||
|
||||
init {
|
||||
setPropertiesFrom(info)
|
||||
}
|
||||
|
||||
fun setInlay(inlay: Inlay<*>) {
|
||||
check(!this::inlay.isInitialized) { "Inlay already set" }
|
||||
this.inlay = inlay
|
||||
}
|
||||
|
||||
fun setPropertiesFrom(info: HighlightInfo) {
|
||||
this.info = info
|
||||
val description = getValidDescriptionText(info.description)
|
||||
|
||||
text = description
|
||||
severity = LensSeverity.from(info.severity)
|
||||
extraRightPadding = if (description.lastOrNull() == '.') 2 else 0
|
||||
}
|
||||
|
||||
override fun paint(inlay: Inlay<*>, g: Graphics, r: Rectangle, textAttributes: TextAttributes) {
|
||||
fixBaselineForTextRendering(r)
|
||||
super.paint(inlay, g, r, textAttributes)
|
||||
|
||||
if (hovered) {
|
||||
paintHoverEffect(inlay, g, r)
|
||||
}
|
||||
}
|
||||
|
||||
private fun paintHoverEffect(inlay: Inlay<*>, g: Graphics, r: Rectangle) {
|
||||
val editor = inlay.editor
|
||||
if (editor !is EditorImpl) {
|
||||
return
|
||||
}
|
||||
|
||||
val font = editor.colorsScheme.getFont(EditorFontType.PLAIN)
|
||||
val x = r.x + TEXT_HORIZONTAL_PADDING
|
||||
val y = r.y + editor.ascent + 1
|
||||
val w = inlay.widthInPixels - UNDERLINE_WIDTH_REDUCTION - extraRightPadding
|
||||
val h = editor.descent
|
||||
|
||||
g.color = getTextAttributes(editor).foregroundColor
|
||||
EffectPainter.LINE_UNDERSCORE.paint(g as Graphics2D, x, y, w, h, font)
|
||||
}
|
||||
|
||||
override fun getTextAttributes(editor: Editor): TextAttributes {
|
||||
return severity.getTextAttributes(ColorMode.getFromEditor(editor))
|
||||
}
|
||||
|
||||
override fun useEditorFont(): Boolean {
|
||||
return useEditorFont
|
||||
}
|
||||
|
||||
override fun mouseMoved(event: MouseEvent, translated: Point) {
|
||||
setHovered(isHoveringText(translated))
|
||||
}
|
||||
|
||||
override fun mouseExited() {
|
||||
setHovered(false)
|
||||
}
|
||||
|
||||
private fun setHovered(hovered: Boolean) {
|
||||
if (this.hovered == hovered) {
|
||||
return
|
||||
}
|
||||
|
||||
this.hovered = hovered
|
||||
|
||||
val editor = inlay.editor
|
||||
if (editor is EditorEx) {
|
||||
val cursor = if (hovered) Cursor.getPredefinedCursor(Cursor.HAND_CURSOR) else null
|
||||
editor.setCustomCursor(this::class.java, cursor)
|
||||
}
|
||||
|
||||
inlay.repaint()
|
||||
}
|
||||
|
||||
override fun mousePressed(event: MouseEvent, translated: Point) {
|
||||
if (!isHoveringText(translated)) {
|
||||
return
|
||||
}
|
||||
|
||||
if (SwingUtilities.isLeftMouseButton(event) || SwingUtilities.isMiddleMouseButton(event)) {
|
||||
event.consume()
|
||||
|
||||
val editor = inlay.editor
|
||||
moveToOffset(editor, info.actualStartOffset)
|
||||
|
||||
if (SwingUtilities.isLeftMouseButton(event)) {
|
||||
IntentionsPopup.show(editor)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun isHoveringText(point: Point): Boolean {
|
||||
return point.x >= HOVER_HORIZONTAL_PADDING
|
||||
&& point.y >= 4
|
||||
&& point.x < inlay.widthInPixels - HOVER_HORIZONTAL_PADDING - extraRightPadding
|
||||
&& point.y < inlay.heightInPixels - 1
|
||||
}
|
||||
|
||||
private companion object {
|
||||
/**
|
||||
* [HintRenderer.paintHint] renders padding around text, but not around effects.
|
||||
*/
|
||||
private const val TEXT_HORIZONTAL_PADDING = 7
|
||||
private const val HOVER_HORIZONTAL_PADDING = TEXT_HORIZONTAL_PADDING - 2
|
||||
private const val UNDERLINE_WIDTH_REDUCTION = (TEXT_HORIZONTAL_PADDING * 2) - 1
|
||||
|
||||
private const val MAX_DESCRIPTION_LENGTH = 120
|
||||
|
||||
/**
|
||||
* Kotlin compiler inspections have an `[UPPERCASE_TAG]` at the beginning.
|
||||
*/
|
||||
private val UPPERCASE_TAG_REGEX = Pattern.compile("^\\[[A-Z_]+] ")
|
||||
|
||||
private fun getValidDescriptionText(text: String?): String {
|
||||
return if (text.isNullOrBlank()) " " else addEllipsisOrMissingPeriod(unescapeHtmlEntities(stripUppercaseTag(text)))
|
||||
}
|
||||
|
||||
private fun stripUppercaseTag(text: String): String {
|
||||
if (text.startsWith('[')) {
|
||||
val matcher = UPPERCASE_TAG_REGEX.matcher(text)
|
||||
if (matcher.find()) {
|
||||
return text.substring(matcher.end())
|
||||
}
|
||||
}
|
||||
|
||||
return text
|
||||
}
|
||||
|
||||
private fun unescapeHtmlEntities(text: String): String {
|
||||
return if (text.contains('&')) StringUtil.unescapeXmlEntities(text) else text
|
||||
}
|
||||
|
||||
private fun addEllipsisOrMissingPeriod(text: String): String {
|
||||
return when {
|
||||
text.length > MAX_DESCRIPTION_LENGTH -> text.take(MAX_DESCRIPTION_LENGTH).trimEnd { it.isWhitespace() || it == '.' } + "…"
|
||||
!text.endsWith('.') -> "$text."
|
||||
else -> text
|
||||
}
|
||||
}
|
||||
|
||||
private fun fixBaselineForTextRendering(rect: Rectangle) {
|
||||
rect.y += 1
|
||||
}
|
||||
|
||||
private fun moveToOffset(editor: Editor, offset: Int) {
|
||||
editor.caretModel.moveToOffset(offset)
|
||||
editor.scrollingModel.scrollToCaret(ScrollType.MAKE_VISIBLE)
|
||||
}
|
||||
}
|
||||
}
|
@@ -1,21 +1,21 @@
|
||||
package com.chylex.intellij.inspectionlens.editor
|
||||
package com.chylex.intellij.inspectionlens.editor.lens
|
||||
|
||||
import com.chylex.intellij.inspectionlens.InspectionLens
|
||||
import com.chylex.intellij.inspectionlens.utils.DebouncingInvokeOnDispatchThread
|
||||
import com.chylex.intellij.inspectionlens.compatibility.SpellCheckerSupport
|
||||
import com.chylex.intellij.inspectionlens.editor.lens.ColorMode.Companion.createColorAttributes
|
||||
import com.intellij.lang.annotation.HighlightSeverity
|
||||
import com.intellij.spellchecker.SpellCheckerSeveritiesProvider
|
||||
import com.intellij.ui.ColorUtil
|
||||
import com.intellij.ui.ColorUtil.toAlpha
|
||||
import com.intellij.ui.JBColor
|
||||
import java.awt.Color
|
||||
import java.awt.Font
|
||||
import java.util.Collections
|
||||
import java.util.EnumMap
|
||||
|
||||
/**
|
||||
* Determines properties of inspection lenses based on severity.
|
||||
*/
|
||||
@Suppress("UseJBColor", "InspectionUsingGrayColors")
|
||||
enum class LensSeverity(baseColor: Color, lightThemeDarkening: Int, darkThemeBrightening: Int) {
|
||||
enum class LensSeverity(private val baseColor: Color, private val lightThemeDarkening: Int, private val darkThemeBrightening: Int) {
|
||||
ERROR (Color(158, 41, 39), lightThemeDarkening = 2, darkThemeBrightening = 4),
|
||||
WARNING (Color(190, 145, 23), lightThemeDarkening = 5, darkThemeBrightening = 1),
|
||||
WEAK_WARNING (Color(117, 109, 86), lightThemeDarkening = 4, darkThemeBrightening = 4),
|
||||
@@ -24,18 +24,37 @@ enum class LensSeverity(baseColor: Color, lightThemeDarkening: Int, darkThemeBri
|
||||
TYPO (Color( 73, 156, 84), lightThemeDarkening = 4, darkThemeBrightening = 1),
|
||||
OTHER (Color(128, 128, 128), lightThemeDarkening = 2, darkThemeBrightening = 2);
|
||||
|
||||
val textAttributes: LensSeverityTextAttributes
|
||||
val lineAttributes: LensSeverityTextAttributes
|
||||
private lateinit var textAttributes: EnumMap<ColorMode, LensSeverityTextAttributes>
|
||||
private lateinit var lineAttributes: EnumMap<ColorMode, LensSeverityTextAttributes>
|
||||
|
||||
init {
|
||||
val lightThemeColor = ColorUtil.saturate(ColorUtil.darker(baseColor, lightThemeDarkening), 1)
|
||||
val darkThemeColor = ColorUtil.desaturate(ColorUtil.brighter(baseColor, darkThemeBrightening), 2)
|
||||
refreshColors()
|
||||
}
|
||||
|
||||
internal fun refreshColors() {
|
||||
val theme = if (ColorGenerator.useGenerator) {
|
||||
ColorGenerator.generate(name, baseColor)
|
||||
}
|
||||
else {
|
||||
val lightThemeTextColor = ColorUtil.saturate(ColorUtil.darker(baseColor, lightThemeDarkening), 1)
|
||||
val darkThemeTextColor = ColorUtil.desaturate(ColorUtil.brighter(baseColor, darkThemeBrightening), 2)
|
||||
|
||||
val lightThemeLineColor = toAlpha(lightThemeTextColor, 10)
|
||||
val darkThemeLineColor = toAlpha(darkThemeTextColor, 13)
|
||||
|
||||
ColorGenerator.Theme(lightThemeTextColor, lightThemeLineColor, darkThemeTextColor, darkThemeLineColor)
|
||||
}
|
||||
|
||||
val textColor = JBColor(lightThemeColor, darkThemeColor)
|
||||
val lineColor = JBColor(toAlpha(lightThemeColor, 10), toAlpha(darkThemeColor, 13))
|
||||
|
||||
textAttributes = LensSeverityTextAttributes(foregroundColor = textColor, fontStyle = Font.ITALIC)
|
||||
lineAttributes = LensSeverityTextAttributes(backgroundColor = lineColor)
|
||||
textAttributes = createColorAttributes(theme.lightThemeTextColor, theme.darkThemeTextColor) { LensSeverityTextAttributes(foregroundColor = it, fontStyle = Font.ITALIC) }
|
||||
lineAttributes = createColorAttributes(theme.lightThemeLineColor, theme.darkThemeLineColor) { LensSeverityTextAttributes(backgroundColor = it) }
|
||||
}
|
||||
|
||||
internal fun getTextAttributes(colorMode: ColorMode): LensSeverityTextAttributes {
|
||||
return textAttributes.getValue(colorMode)
|
||||
}
|
||||
|
||||
internal fun getLineAttributes(colorMode: ColorMode): LensSeverityTextAttributes {
|
||||
return lineAttributes.getValue(colorMode)
|
||||
}
|
||||
|
||||
companion object {
|
||||
@@ -44,17 +63,18 @@ enum class LensSeverity(baseColor: Color, lightThemeDarkening: Int, darkThemeBri
|
||||
HighlightSeverity.WARNING to WARNING,
|
||||
HighlightSeverity.WEAK_WARNING to WEAK_WARNING,
|
||||
HighlightSeverity.GENERIC_SERVER_ERROR_OR_WARNING to SERVER_PROBLEM,
|
||||
SpellCheckerSeveritiesProvider.TYPO to TYPO,
|
||||
))
|
||||
|
||||
private val refreshLater = DebouncingInvokeOnDispatchThread<Unit> { InspectionLens.refresh() }
|
||||
init {
|
||||
SpellCheckerSupport.load()
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a mapping from a [HighlightSeverity] to a [LensSeverity], and refreshes all open editors.
|
||||
*/
|
||||
internal fun registerMapping(severity: HighlightSeverity, lensSeverity: LensSeverity) {
|
||||
if (mapping.put(severity, lensSeverity) != lensSeverity) {
|
||||
refreshLater.enqueue(Unit)
|
||||
InspectionLens.scheduleRefresh()
|
||||
}
|
||||
}
|
||||
|
@@ -0,0 +1,31 @@
|
||||
package com.chylex.intellij.inspectionlens.editor.lens
|
||||
|
||||
import com.intellij.codeInsight.daemon.impl.SeverityRegistrar
|
||||
import com.intellij.lang.annotation.HighlightSeverity
|
||||
import java.util.function.Predicate
|
||||
|
||||
class LensSeverityFilter(private val hiddenSeverityIds: Set<String>, private val showUnknownSeverities: Boolean) : Predicate<HighlightSeverity> {
|
||||
private val knownSeverityIds = getSupportedSeverities().mapTo(HashSet(), HighlightSeverity::getName)
|
||||
|
||||
override fun test(severity: HighlightSeverity): Boolean {
|
||||
if (!isSupported(severity)) {
|
||||
return false
|
||||
}
|
||||
|
||||
return if (severity.name in knownSeverityIds)
|
||||
severity.name !in hiddenSeverityIds
|
||||
else
|
||||
showUnknownSeverities
|
||||
}
|
||||
|
||||
companion object {
|
||||
@Suppress("DEPRECATION")
|
||||
private fun isSupported(severity: HighlightSeverity): Boolean {
|
||||
return severity > HighlightSeverity.TEXT_ATTRIBUTES && severity !== HighlightSeverity.INFO
|
||||
}
|
||||
|
||||
fun getSupportedSeverities(registrar: SeverityRegistrar = SeverityRegistrar.getSeverityRegistrar(null)): List<HighlightSeverity> {
|
||||
return registrar.allSeverities.filter(::isSupported)
|
||||
}
|
||||
}
|
||||
}
|
@@ -1,4 +1,4 @@
|
||||
package com.chylex.intellij.inspectionlens.editor
|
||||
package com.chylex.intellij.inspectionlens.editor.lens
|
||||
|
||||
import com.intellij.openapi.editor.markup.UnmodifiableTextAttributes
|
||||
import com.intellij.ui.JBColor
|
@@ -0,0 +1,129 @@
|
||||
package com.chylex.intellij.inspectionlens.settings
|
||||
|
||||
import com.chylex.intellij.inspectionlens.editor.lens.LensSeverityFilter
|
||||
import com.intellij.codeInsight.daemon.impl.SeverityRegistrar
|
||||
import com.intellij.lang.annotation.HighlightSeverity
|
||||
import com.intellij.openapi.components.service
|
||||
import com.intellij.openapi.editor.event.SelectionEvent
|
||||
import com.intellij.openapi.editor.event.SelectionListener
|
||||
import com.intellij.openapi.editor.markup.TextAttributes
|
||||
import com.intellij.openapi.options.BoundConfigurable
|
||||
import com.intellij.openapi.options.ConfigurableWithId
|
||||
import com.intellij.openapi.ui.DialogPanel
|
||||
import com.intellij.openapi.util.Disposer
|
||||
import com.intellij.ui.DisabledTraversalPolicy
|
||||
import com.intellij.ui.EditorTextFieldCellRenderer.SimpleRendererComponent
|
||||
import com.intellij.ui.components.JBCheckBox
|
||||
import com.intellij.ui.dsl.builder.Cell
|
||||
import com.intellij.ui.dsl.builder.RightGap
|
||||
import com.intellij.ui.dsl.builder.Row
|
||||
import com.intellij.ui.dsl.builder.RowLayout
|
||||
import com.intellij.ui.dsl.builder.bindSelected
|
||||
import com.intellij.ui.dsl.builder.panel
|
||||
import java.awt.Cursor
|
||||
|
||||
class LensApplicationConfigurable : BoundConfigurable("Inspection Lens"), ConfigurableWithId {
|
||||
companion object {
|
||||
const val ID = "InspectionLens"
|
||||
}
|
||||
|
||||
private data class DisplayedSeverity(
|
||||
val id: String,
|
||||
val severity: StoredSeverity,
|
||||
val textAttributes: TextAttributes? = null,
|
||||
) {
|
||||
constructor(
|
||||
severity: HighlightSeverity,
|
||||
registrar: SeverityRegistrar,
|
||||
) : this(
|
||||
id = severity.name,
|
||||
severity = StoredSeverity(severity),
|
||||
textAttributes = registrar.getHighlightInfoTypeBySeverity(severity).attributesKey.defaultAttributes
|
||||
)
|
||||
}
|
||||
|
||||
private val settingsService = service<LensSettingsState>()
|
||||
|
||||
private val allSeverities by lazy(LazyThreadSafetyMode.NONE) {
|
||||
val settings = settingsService.state
|
||||
val registrar = SeverityRegistrar.getSeverityRegistrar(null)
|
||||
|
||||
val knownSeverities = LensSeverityFilter.getSupportedSeverities(registrar).map { DisplayedSeverity(it, registrar) }
|
||||
val knownSeverityIds = knownSeverities.mapTo(HashSet(), DisplayedSeverity::id)
|
||||
|
||||
// Update names and priorities of stored severities.
|
||||
for ((id, knownSeverity, _) in knownSeverities) {
|
||||
val storedSeverity = settings.hiddenSeverities[id]
|
||||
if (storedSeverity != null && storedSeverity != knownSeverity) {
|
||||
settings.hiddenSeverities[id] = knownSeverity
|
||||
}
|
||||
}
|
||||
|
||||
val unknownSeverities = settings.hiddenSeverities.entries
|
||||
.filterNot { it.key in knownSeverityIds }
|
||||
.map { DisplayedSeverity(it.key, it.value) }
|
||||
|
||||
(knownSeverities + unknownSeverities).sortedByDescending { it.severity.priority }
|
||||
}
|
||||
|
||||
override fun getId(): String {
|
||||
return ID
|
||||
}
|
||||
|
||||
override fun createPanel(): DialogPanel {
|
||||
val settings = settingsService.state
|
||||
|
||||
return panel {
|
||||
group("Shown Severities") {
|
||||
for ((id, severity, textAttributes) in allSeverities) {
|
||||
row {
|
||||
checkBox(severity.name)
|
||||
.bindSelectedToNotIn(settings.hiddenSeverities, id, severity)
|
||||
.gap(RightGap.COLUMNS)
|
||||
|
||||
labelWithAttributes("Example", textAttributes)
|
||||
}.layout(RowLayout.PARENT_GRID)
|
||||
}
|
||||
|
||||
row {
|
||||
checkBox("Other").bindSelected(settings::showUnknownSeverities)
|
||||
}
|
||||
}
|
||||
|
||||
group("Appearance") {
|
||||
row {
|
||||
checkBox("Use editor font").bindSelected(settings::useEditorFont)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun <K, V> Cell<JBCheckBox>.bindSelectedToNotIn(collection: MutableMap<K, V>, key: K, value: V): Cell<JBCheckBox> {
|
||||
return bindSelected({ key !in collection }, { if (it) collection.remove(key) else collection[key] = value })
|
||||
}
|
||||
|
||||
private fun Row.labelWithAttributes(text: String, textAttributes: TextAttributes?): Cell<SimpleRendererComponent> {
|
||||
val label = SimpleRendererComponent(null, null, true)
|
||||
label.setText(text, textAttributes, false)
|
||||
label.focusTraversalPolicy = DisabledTraversalPolicy()
|
||||
|
||||
val editor = label.editor
|
||||
editor.setCustomCursor(this, Cursor.getDefaultCursor())
|
||||
editor.contentComponent.setOpaque(false)
|
||||
editor.selectionModel.addSelectionListener(object : SelectionListener {
|
||||
override fun selectionChanged(e: SelectionEvent) {
|
||||
if (!e.newRange.isEmpty) {
|
||||
editor.selectionModel.removeSelection(true)
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
Disposer.register(disposable!!, label)
|
||||
return cell(label)
|
||||
}
|
||||
|
||||
override fun apply() {
|
||||
super.apply()
|
||||
settingsService.update()
|
||||
}
|
||||
}
|
@@ -0,0 +1,48 @@
|
||||
package com.chylex.intellij.inspectionlens.settings
|
||||
|
||||
import com.chylex.intellij.inspectionlens.InspectionLens
|
||||
import com.chylex.intellij.inspectionlens.editor.lens.LensSeverityFilter
|
||||
import com.intellij.openapi.components.BaseState
|
||||
import com.intellij.openapi.components.SettingsCategory
|
||||
import com.intellij.openapi.components.SimplePersistentStateComponent
|
||||
import com.intellij.openapi.components.State
|
||||
import com.intellij.openapi.components.Storage
|
||||
import com.intellij.util.xmlb.annotations.XMap
|
||||
|
||||
@State(
|
||||
name = LensApplicationConfigurable.ID,
|
||||
storages = [ Storage("chylex.inspectionLens.xml") ],
|
||||
category = SettingsCategory.UI
|
||||
)
|
||||
class LensSettingsState : SimplePersistentStateComponent<LensSettingsState.State>(State()) {
|
||||
class State : BaseState() {
|
||||
@get:XMap
|
||||
val hiddenSeverities by map<String, StoredSeverity>()
|
||||
|
||||
var showUnknownSeverities by property(true)
|
||||
var useEditorFont by property(true)
|
||||
}
|
||||
|
||||
@get:Synchronized
|
||||
@set:Synchronized
|
||||
var severityFilter = createSeverityFilter()
|
||||
private set
|
||||
|
||||
val useEditorFont
|
||||
get() = state.useEditorFont
|
||||
|
||||
override fun loadState(state: State) {
|
||||
super.loadState(state)
|
||||
update()
|
||||
}
|
||||
|
||||
fun update() {
|
||||
severityFilter = createSeverityFilter()
|
||||
InspectionLens.scheduleRefresh()
|
||||
}
|
||||
|
||||
private fun createSeverityFilter(): LensSeverityFilter {
|
||||
val state = state
|
||||
return LensSeverityFilter(state.hiddenSeverities.keys, state.showUnknownSeverities)
|
||||
}
|
||||
}
|
@@ -0,0 +1,9 @@
|
||||
package com.chylex.intellij.inspectionlens.settings
|
||||
|
||||
import com.intellij.lang.annotation.HighlightSeverity
|
||||
import com.intellij.util.xmlb.annotations.Tag
|
||||
|
||||
@Tag("severity")
|
||||
data class StoredSeverity(var name: String = "", var priority: Int = 0) {
|
||||
constructor(severity: HighlightSeverity) : this(severity.displayCapitalizedName, severity.myVal)
|
||||
}
|
@@ -1,32 +0,0 @@
|
||||
package com.chylex.intellij.inspectionlens.utils
|
||||
|
||||
import com.intellij.openapi.application.ApplicationManager
|
||||
|
||||
class DebouncingInvokeOnDispatchThread<T>(private val action: (List<T>) -> Unit) {
|
||||
private var queuedItems = mutableListOf<T>()
|
||||
private var isEnqueued = false
|
||||
|
||||
fun enqueue(item: T) {
|
||||
synchronized(this) {
|
||||
queuedItems.add(item)
|
||||
|
||||
// Enqueue even if already on dispatch thread to debounce consecutive calls.
|
||||
if (!isEnqueued) {
|
||||
isEnqueued = true
|
||||
ApplicationManager.getApplication().invokeLater(::process)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun process() {
|
||||
var itemsToProcess: List<T>
|
||||
|
||||
synchronized(this) {
|
||||
itemsToProcess = queuedItems
|
||||
queuedItems = mutableListOf()
|
||||
isEnqueued = false
|
||||
}
|
||||
|
||||
action(itemsToProcess)
|
||||
}
|
||||
}
|
@@ -4,19 +4,42 @@
|
||||
<vendor url="https://chylex.com">chylex</vendor>
|
||||
|
||||
<description><![CDATA[
|
||||
Shows errors, warnings, and other inspection highlights inline.
|
||||
Displays errors, warnings, and other inspections inline. Highlights the background of lines with inspections. Supports light and dark themes out of the box.
|
||||
<br><br>
|
||||
After installing the plugin, inspection descriptions will appear after the ends of lines, and the lines will be highlighted with a background color.
|
||||
Shown inspection severities are <b>Errors</b>, <b>Warnings</b>, <b>Weak Warnings</b>, <b>Server Problems</b>, <b>Grammar Errors</b>, <b>Typos</b>, and other inspections from plugins or future IntelliJ versions that have a high enough severity level.
|
||||
Each severity has a different color, with support for both light and dark themes.
|
||||
By default, the plugin shows <b>Errors</b>, <b>Warnings</b>, <b>Weak Warnings</b>, <b>Server Problems</b>, <b>Grammar Errors</b>, <b>Typos</b>, and other inspections with a high enough severity level. Configure visible severities in <b>Settings | Tools | Inspection Lens</a>.
|
||||
<br><br>
|
||||
Note: The plugin is not customizable outside the ability to disable/enable the plugin without restarting the IDE.
|
||||
If the defaults don't work for you, I recommend trying the <a href="https://plugins.jetbrains.com/plugin/17302-inlineerror">Inline Error</a> plugin which can be customized, building your own version of Inspection Lens, or proposing your change in the <a href="https://github.com/chylex/IntelliJ-Inspection-Lens/issues">issue tracker</a>.
|
||||
Left-click an inspection to show quick fixes. Middle-click an inspection to navigate to the relevant code in the editor.
|
||||
<br><br>
|
||||
Inspired by <a href="https://marketplace.visualstudio.com/items?itemName=usernamehw.errorlens">Error Lens</a> for VS Code, and <a href="https://plugins.jetbrains.com/plugin/17302-inlineerror">Inline Error</a> for IntelliJ Platform.
|
||||
]]></description>
|
||||
|
||||
<change-notes><![CDATA[
|
||||
<b>Version 1.5</b>
|
||||
<ul>
|
||||
<li>Added possibility to left-click an inspection to show quick fixes.</li>
|
||||
<li>Added possibility to middle-click an inspection to navigate to relevant code in the editor.</li>
|
||||
<li>Added option to use UI font instead of editor font.</li>
|
||||
<li>Long inspection descriptions are now truncated to 120 characters.</li>
|
||||
<li>Improved descriptions of Kotlin compiler inspections.</li>
|
||||
<li>Fixed visual artifacts in Rendered Doc comments.</li>
|
||||
</ul>
|
||||
<b>Version 1.4.1</b>
|
||||
<ul>
|
||||
<li>Fixed warnings in usage of IntelliJ SDK.</li>
|
||||
</ul>
|
||||
<b>Version 1.4</b>
|
||||
<ul>
|
||||
<li>Added configuration of visible severities to <b>Settings | Tools | Inspection Lens</b>.</li>
|
||||
</ul>
|
||||
<b>Version 1.3.3</b>
|
||||
<ul>
|
||||
<li>Partially reverted fix for inspections that include HTML in their description due to breaking inspections with angled brackets.</li>
|
||||
<li>Fixed plugin not working when installed on JetBrains Gateway Client.</li>
|
||||
</ul>
|
||||
<b>Version 1.3.2</b>
|
||||
<ul>
|
||||
<li>Fixed inspections randomly not disappearing.</li>
|
||||
</ul>
|
||||
<b>Version 1.3.1</b>
|
||||
<ul>
|
||||
<li>Updated minimum version to IntelliJ 2023.3 due to breaking API changes.</li>
|
||||
@@ -54,6 +77,14 @@
|
||||
<depends>com.intellij.modules.platform</depends>
|
||||
<depends optional="true" config-file="compatibility/InspectionLens-Grazie.xml">tanvd.grazi</depends>
|
||||
|
||||
<extensions defaultExtensionNs="com.intellij">
|
||||
<applicationService serviceImplementation="com.chylex.intellij.inspectionlens.settings.LensSettingsState" />
|
||||
<applicationConfigurable id="com.chylex.intellij.inspectionlens.settings.LensApplicationConfigurable"
|
||||
instance="com.chylex.intellij.inspectionlens.settings.LensApplicationConfigurable"
|
||||
displayName="Inspection Lens"
|
||||
parentId="tools" />
|
||||
</extensions>
|
||||
|
||||
<applicationListeners>
|
||||
<listener class="com.chylex.intellij.inspectionlens.InspectionLensPluginListener" topic="com.intellij.ide.plugins.DynamicPluginListener" />
|
||||
</applicationListeners>
|
||||
@@ -61,4 +92,10 @@
|
||||
<projectListeners>
|
||||
<listener class="com.chylex.intellij.inspectionlens.InspectionLensFileOpenedListener" topic="com.intellij.openapi.fileEditor.FileOpenedSyncListener" />
|
||||
</projectListeners>
|
||||
|
||||
<actions>
|
||||
<action id="com.chylex.intellij.inspectionlens.debug.ShowColorEditorAction" class="com.chylex.intellij.inspectionlens.debug.ShowColorEditorAction" text="Inspection Lens - Show Color Editor">
|
||||
<add-to-group group-id="ToolsMenu" anchor="last" />
|
||||
</action>
|
||||
</actions>
|
||||
</idea-plugin>
|
||||
|
@@ -1,6 +1,5 @@
|
||||
package com.chylex.intellij.inspectionlens
|
||||
package com.chylex.intellij.inspectionlens.editor.lens
|
||||
|
||||
import com.chylex.intellij.inspectionlens.editor.EditorLensInlay
|
||||
import com.intellij.lang.annotation.HighlightSeverity
|
||||
import org.junit.jupiter.api.Assertions.assertEquals
|
||||
import org.junit.jupiter.api.Nested
|
||||
@@ -48,7 +47,7 @@ class EditorLensTest {
|
||||
}
|
||||
|
||||
/**
|
||||
* If any of these change, re-evaluate [EditorLensInlay.MAXIMUM_SEVERITY] and the priority calculations.
|
||||
* If any of these changes, re-evaluate [EditorLensInlay.MAXIMUM_SEVERITY] and the priority calculations.
|
||||
*/
|
||||
@Nested
|
||||
inner class IdeaHighlightSeverityAssumptions {
|
Reference in New Issue
Block a user