Skip to content

New: Highlight Expression text in Flow Diagram UI with match colours. #2504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Earthcomputer merged 1 commit into from
Jul 28, 2025
Merged

New: Highlight Expression text in Flow Diagram UI with match colours. #2504

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions src/main/kotlin/platform/mixin/expression/gui/DiagramStyles.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,21 +64,29 @@ object DiagramStyles {
)
val FAILED
get() = mapOf(
mxConstants.STYLE_STROKECOLOR to JBColor.red.hexString,
mxConstants.STYLE_STROKECOLOR to FlowMatchStatus.FAIL.hexColor,
mxConstants.STYLE_STROKEWIDTH to "3.5",
)
val PARTIAL_MATCH
get() = mapOf(
mxConstants.STYLE_STROKECOLOR to JBColor.orange.hexString,
mxConstants.STYLE_STROKECOLOR to FlowMatchStatus.PARTIAL.hexColor,
mxConstants.STYLE_STROKEWIDTH to "2.5",
)
val SUCCESS
get() = mapOf(
mxConstants.STYLE_STROKECOLOR to JBColor.green.hexString,
mxConstants.STYLE_STROKECOLOR to FlowMatchStatus.SUCCESS.hexColor,
mxConstants.STYLE_STROKEWIDTH to "1.5",
)
val CURRENT_EDITOR_FONT
get() = EditorColorsManager.getInstance().globalScheme.getFont(EditorFontType.PLAIN)
}

private val Color.hexString get() = "#%06X".format(rgb)
private val Color.hexString get() = "#%06X".format(rgb and 0xFFFFFF)

val FlowMatchStatus.hexColor
get() = when (this) {
FlowMatchStatus.SUCCESS -> JBColor.green
FlowMatchStatus.PARTIAL -> JBColor.orange
FlowMatchStatus.FAIL -> JBColor.red
FlowMatchStatus.IGNORED -> UIUtil.getLabelForeground()
}.hexString
89 changes: 53 additions & 36 deletions src/main/kotlin/platform/mixin/expression/gui/FlowDiagram.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,8 @@ package com.demonwav.mcdev.platform.mixin.expression.gui

import com.demonwav.mcdev.platform.mixin.expression.MEExpressionMatchUtil
import com.demonwav.mcdev.util.constantStringValue
import com.intellij.openapi.application.ApplicationManager
import com.intellij.openapi.application.EDT
import com.intellij.openapi.application.ModalityState
import com.intellij.openapi.application.ReadAction
import com.intellij.openapi.application.readAction
import com.intellij.openapi.module.Module
import com.intellij.openapi.progress.checkCanceled
import com.intellij.openapi.project.Project
Expand All @@ -41,8 +39,9 @@ import com.mxgraph.util.mxRectangle
import com.mxgraph.view.mxGraph
import java.awt.Dimension
import java.util.SortedMap
import java.util.concurrent.Callable
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch
import kotlinx.coroutines.withContext
import org.objectweb.asm.tree.ClassNode
import org.objectweb.asm.tree.MethodNode
Expand All @@ -53,15 +52,21 @@ private const val INTRA_GROUP_SPACING = 75
private const val LINE_NUMBER_STYLE = "LINE_NUMBER"

class FlowDiagram(
private val scope: CoroutineScope,
val ui: FlowDiagramUi,
private val flowGraph: FlowGraph,
private val clazz: ClassNode,
val method: MethodNode,
) {
companion object {
suspend fun create(project: Project, clazz: ClassNode, method: MethodNode): FlowDiagram? {
suspend fun create(
project: Project,
scope: CoroutineScope,
clazz: ClassNode,
method: MethodNode
): FlowDiagram? {
val flowGraph = FlowGraph.parse(project, clazz, method) ?: return null
return buildDiagram(flowGraph, clazz, method)
return buildDiagram(scope, flowGraph, clazz, method)
}
}

Expand Down Expand Up @@ -91,6 +96,12 @@ class FlowDiagram(
flowGraph.highlightMatches(node, soft)
ui.refresh()
}

flowGraph.onHighlightChanged { exprText, node ->
scope.launch(Dispatchers.EDT) {
ui.showExpr(exprText, node)
}
}
}

fun populateMatchStatuses(
Expand All @@ -105,41 +116,42 @@ class FlowDiagram(
val oldHighlightRoot = flowGraph.highlightRoot
ui.setMatchToolbarVisible(false)
flowGraph.resetMatches()
ReadAction.nonBlocking(Callable<String?> run@{
val stringLit = stringRef.element ?: return@run null
val modifierList = modifierListRef.element ?: return@run null
val expression = stringLit.constantStringValue?.let(MEExpressionMatchUtil::createExpression)
?: return@run null
val pool = MEExpressionMatchUtil.createIdentifierPoolFactory(module, clazz, modifierList)(method)
for ((virtualInsn, root) in flowGraph.flowMap) {
val node = flowGraph.allNodes.getValue(root)
MEExpressionMatchUtil.findMatchingInstructions(
clazz, method, pool, flowGraph.flowMap, expression, listOf(virtualInsn),
ExpressionContext.Type.MODIFY_EXPRESSION_VALUE, // most permissive
false,
node::reportMatchStatus,
node::reportPartialMatch
) {}
scope.launch(Dispatchers.Default) {
val success = readAction run@{
val stringLit = stringRef.element ?: return@run false
val modifierList = modifierListRef.element ?: return@run false
val expression = stringLit.constantStringValue?.let(MEExpressionMatchUtil::createExpression)
?: return@run false
val pool = MEExpressionMatchUtil.createIdentifierPoolFactory(module, clazz, modifierList)(method)
for ((virtualInsn, root) in flowGraph.flowMap) {
val node = flowGraph.allNodes.getValue(root)
MEExpressionMatchUtil.findMatchingInstructions(
clazz, method, pool, flowGraph.flowMap, expression, listOf(virtualInsn),
ExpressionContext.Type.MODIFY_EXPRESSION_VALUE, // most permissive
false,
node::reportMatchStatus,
node::reportPartialMatch
) {}
}
flowGraph.setExprText(expression.src.toString())
flowGraph.highlightMatches(oldHighlightRoot, false)
true
}
flowGraph.markHasMatchData()
flowGraph.highlightMatches(oldHighlightRoot, false)
StringUtil.escapeStringCharacters(expression.src.toString())
})
.finishOnUiThread(ModalityState.nonModal()) { exprText ->
exprText ?: return@finishOnUiThread
if (success) {
if (jump) {
showBestNode()
}
ui.refresh()
ui.setExprText(exprText)
}
.submit(ApplicationManager.getApplication()::executeOnPooledThread)
ui.refresh()
}
}
this.jumpToExpression = {
ReadAction.run<Nothing> {
val target = stringRef.element
if (target is Navigatable && target.isValid && target.canNavigate()) {
target.navigate(true)
scope.launch {
readAction {
val target = stringRef.element
if (target is Navigatable && target.isValid && target.canNavigate()) {
target.navigate(true)
}
}
}
}
Expand All @@ -161,7 +173,12 @@ class FlowDiagram(
}
}

private suspend fun buildDiagram(flowGraph: FlowGraph, clazz: ClassNode, method: MethodNode): FlowDiagram {
private suspend fun buildDiagram(
scope: CoroutineScope,
flowGraph: FlowGraph,
clazz: ClassNode,
method: MethodNode
): FlowDiagram {
val graph = MxFlowGraph(flowGraph)
setupStyles(graph)
val groupedCells = addGraphContent(graph, flowGraph)
Expand All @@ -171,7 +188,7 @@ private suspend fun buildDiagram(flowGraph: FlowGraph, clazz: ClassNode, method:
val ui = withContext(Dispatchers.EDT) {
FlowDiagramUi(graph, calculateBounds, lineNumberNodes)
}
return FlowDiagram(ui, flowGraph, clazz, method)
return FlowDiagram(scope, ui, flowGraph, clazz, method)
}

private class MxFlowGraph(private val flowGraph: FlowGraph) : mxGraph() {
Expand Down
58 changes: 55 additions & 3 deletions src/main/kotlin/platform/mixin/expression/gui/FlowDiagramUi.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ package com.demonwav.mcdev.platform.mixin.expression.gui

import com.intellij.icons.AllIcons
import com.intellij.openapi.editor.colors.EditorColorsManager
import com.intellij.openapi.util.text.StringUtil
import com.intellij.ui.DocumentAdapter
import com.mxgraph.model.mxCell
import com.mxgraph.swing.mxGraphComponent
Expand Down Expand Up @@ -83,8 +84,8 @@ class FlowDiagramUi(
fixBounds()
}

fun setExprText(text: String) {
matchToolbar.setExprTest(text)
fun showExpr(text: String, highlightRoot: FlowNode?) {
matchToolbar.setExprText("<html>" + makeExprString(text, highlightRoot) + "</html>")
matchToolbar.isVisible = true
}

Expand Down Expand Up @@ -243,7 +244,7 @@ class FlowDiagramUi(
add(buttonPanel, BorderLayout.EAST)
}

fun setExprTest(text: String) {
fun setExprText(text: String) {
exprText.text = text
exprText.toolTipText = text
}
Expand Down Expand Up @@ -277,3 +278,54 @@ private fun makeButton(icon: Icon, tooltip: String): JButton =
toolTipText = tooltip
preferredSize = Dimension(32, 32)
}

private sealed class HighlightChange : Comparable<HighlightChange> {
abstract val pos: Int

data class Start(override val pos: Int, val length: Int, val status: FlowMatchStatus) : HighlightChange()
data class End(override val pos: Int) : HighlightChange()

override fun compareTo(other: HighlightChange): Int =
compareValuesBy(
this, other,
{ it.pos },
{ if (it is Start) 1 else -1 },
{ -((it as? Start)?.length ?: 0) },
)
}

private fun makeExprString(text: String, highlightRoot: FlowNode?): String {
fun escape(str: String) = StringUtil.escapeXmlEntities(StringUtil.escapeStringCharacters(str))

if (highlightRoot == null) {
return escape(text)
}

val changes = mutableListOf<HighlightChange>()
for ((status, src) in highlightRoot.matches) {
if (src == null) {
continue
}
changes.add(HighlightChange.Start(src.startIndex, src.endIndex - src.startIndex, status))
changes.add(HighlightChange.End(src.endIndex + 1))
}
changes.sort()

val result = StringBuilder()
var pos = 0
for (change in changes) {
result.append(escape(text.substring(pos, change.pos)))
pos = change.pos
when (change) {
is HighlightChange.Start -> {
result.append("<span style='color: ${change.status.hexColor}'>")
}
is HighlightChange.End -> {
result.append("</span>")
}
}
}
result.append(escape(text.substring(pos)))

return result.toString()
}
Loading
Loading