From 35aae2a7479d02dbf55bb1d83558ee5880dc72fa Mon Sep 17 00:00:00 2001
From: alonalbert <aalbert@google.com>
Date: Fri, 3 May 2024 09:37:42 -0700
Subject: [PATCH] Support Jump Indicators on OAT View (#26)

Notes:
* DexTextArea & OatTextArea are trivial, but I think it results in a cleaner project.
* The `oat` package currently contains only OatTextArea, but it would make sense to move the `oat` parsing there too.
---
 .../romainguy/kotlin/explorer/CodeTextArea.kt | 130 ++++++++++++++++++
 .../romainguy/kotlin/explorer/DexTextArea.kt  | 128 -----------------
 .../kotlin/explorer/KotlinExplorer.kt         |  14 +-
 .../dev/romainguy/kotlin/explorer/Regex.kt    |  21 +++
 .../kotlin/explorer/dex/DexDumpParser.kt      |   5 +-
 .../kotlin/explorer/dex/DexTextArea.kt        |  29 ++++
 .../kotlin/explorer/oat/OatTextArea.kt        |  27 ++++
 7 files changed, 219 insertions(+), 135 deletions(-)
 create mode 100644 src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/CodeTextArea.kt
 delete mode 100644 src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/DexTextArea.kt
 create mode 100644 src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/Regex.kt
 create mode 100644 src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/dex/DexTextArea.kt
 create mode 100644 src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/oat/OatTextArea.kt

diff --git a/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/CodeTextArea.kt b/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/CodeTextArea.kt
new file mode 100644
index 00000000..20f771a8
--- /dev/null
+++ b/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/CodeTextArea.kt
@@ -0,0 +1,130 @@
+/*
+ * Copyright (C) 2023 Romain Guy
+ *
+ * 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 dev.romainguy.kotlin.explorer
+
+import org.fife.ui.rsyntaxtextarea.RSyntaxTextArea
+import java.awt.Graphics
+import java.awt.Graphics2D
+import javax.swing.event.CaretEvent
+import javax.swing.event.CaretListener
+
+open class CodeTextArea(
+    private val explorerState: ExplorerState,
+    jumpRegex: Regex,
+    addressedRegex: Regex,
+    private val lineNumberRegex: Regex?,
+) : RSyntaxTextArea() {
+    private val jumpDetector = JumpDetector(jumpRegex, addressedRegex)
+    private var jumpOffsets: JumpOffsets? = null
+    private var fullText = ""
+
+
+    init {
+        addCaretListener(::caretUpdate)
+    }
+
+    final override fun addCaretListener(listener: CaretListener?) {
+        super.addCaretListener(listener)
+    }
+
+    override fun setText(text: String) {
+        fullText = text
+        refreshText()
+    }
+
+    fun refreshText() {
+        val saveCaret = caretPosition
+        super.setText(fullText.takeIf { explorerState.showLineNumbers } ?: fullText.removeLineLumbers())
+        caretPosition = saveCaret
+    }
+
+    override fun paintComponent(g: Graphics?) {
+        super.paintComponent(g)
+        jumpOffsets?.let { jump ->
+            val padding = 6
+
+            val bounds1 = modelToView2D(jump.src)
+            val bounds2 = modelToView2D(jump.dst)
+
+            val x1 = bounds1.x.toInt() - padding
+            val y1 = (bounds1.y + lineHeight / 2).toInt()
+
+            val x2 = bounds2.x.toInt() - padding
+            val y2 = (bounds2.y + lineHeight / 2).toInt()
+
+            val x0 = modelToView2D(2).x.toInt()
+            val g2 = g as Graphics2D
+            g2.drawLine(x1, y1, x0, y1)
+            g2.drawLine(x0, y1, x0, y2)
+            g2.drawLine(x0, y2, x2, y2)
+        }
+    }
+
+    private fun caretUpdate(event: CaretEvent) {
+        val oldJumpOffsets = jumpOffsets
+        jumpOffsets = null
+        val srcLine = getLineOfOffset(event.dot)
+        var start = getLineStartOffset(srcLine)
+        var end = getLineEndOffset(srcLine)
+
+        val caretLine = document.getText(start, end - start).trimEnd()
+        val jump = jumpDetector.detectJump(caretLine)
+        if (jump != null) {
+            val srcOffset = start + caretLine.countPadding()
+
+            var dstLine = srcLine + jump.direction
+            while (dstLine in 0..<lineCount) {
+                start = getLineStartOffset(dstLine)
+                end = getLineEndOffset(dstLine)
+                val line = document.getText(start, end - start).trimEnd()
+
+                val addressed = jumpDetector.detectAddressed(line) ?: break
+                if (addressed == jump.address) {
+                    val dstOffset = start + line.countPadding()
+                    jumpOffsets = JumpOffsets(srcOffset, dstOffset)
+                }
+
+                dstLine += jump.direction
+            }
+        }
+
+        if (jumpOffsets != oldJumpOffsets) {
+            repaint()
+        }
+    }
+
+    private fun String.removeLineLumbers() =
+        lineNumberRegex?.replace(this) {
+            val (start, end) = it.groupValues.drop(1)
+            " ".repeat(start.length) + end
+        } ?: this
+
+    private data class JumpOffsets(val src: Int, val dst: Int)
+
+    private class Jump(val address: String, val direction: Int)
+
+    private class JumpDetector(private val jumpRegex: Regex, private val addressedRegex: Regex) {
+        fun detectJump(line: String): Jump? {
+            val match = jumpRegex.matchEntire(line) ?: return null
+            return Jump(match.getValue("address"), if (match.getValue("direction") == "+") 1 else -1)
+        }
+
+        fun detectAddressed(line: String) = addressedRegex.matchEntire(line)?.getValue("address")
+    }
+}
+
+private fun String.countPadding() = indexOfFirst { it != ' ' }
diff --git a/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/DexTextArea.kt b/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/DexTextArea.kt
deleted file mode 100644
index 0d4fd5a2..00000000
--- a/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/DexTextArea.kt
+++ /dev/null
@@ -1,128 +0,0 @@
-/*
- * Copyright (C) 2023 Romain Guy
- *
- * 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 dev.romainguy.kotlin.explorer
-
-import org.fife.ui.rsyntaxtextarea.RSyntaxTextArea
-import java.awt.Graphics
-import java.awt.Graphics2D
-
-private val JumpPattern = Regex(".{9}[0-9a-fA-F]{4}: .+([0-9a-fA-F]{4}) // ([+-])[0-9a-fA-F]{4}[\\n\\r]*")
-private val AddressedPattern = Regex(".{9}([0-9a-fA-F]{4}): .+[\\n\\r]*")
-
-internal fun updateTextArea(textArea: RSyntaxTextArea, text: String) {
-    val position = textArea.caretPosition
-    textArea.text = text
-    textArea.caretPosition = minOf(position, textArea.document.length)
-}
-
-class DexTextArea(private val explorerState: ExplorerState) : RSyntaxTextArea() {
-    private var displayJump = false
-    private var jumpRange = 0 to 0
-    private var horizontalOffsets = 0 to 0
-    private var fullText = ""
-
-    init {
-        addCaretListener { event ->
-            val oldDisplayJump = displayJump
-            val oldJumpRange = jumpRange
-            val oldHorizontalOffsets = horizontalOffsets
-
-            displayJump = false
-
-            val srcLine = getLineOfOffset(event.dot)
-            var start = getLineStartOffset(srcLine)
-            var end = getLineEndOffset(srcLine)
-
-            var line = document.getText(start, end - start)
-            var result = JumpPattern.matchEntire(line)
-            if (result != null) {
-                val srcHorizontalOffset = start + line.countPadding()
-                val targetAddress = result.groupValues[1]
-                val direction = if (result.groupValues[2] == "+") 1 else -1
-
-                var dstLine = srcLine + direction
-                while (dstLine in 0..<lineCount) {
-                    start = getLineStartOffset(dstLine)
-                    end = getLineEndOffset(dstLine)
-                    line = document.getText(start, end - start)
-
-                    result = AddressedPattern.matchEntire(line)
-                    if (result == null) {
-                        break
-                    } else if (result.groupValues[1] == targetAddress) {
-                        val dstHorizontalOffset = start + line.countPadding()
-
-                        displayJump = true
-                        jumpRange = srcLine to dstLine
-                        horizontalOffsets = srcHorizontalOffset to dstHorizontalOffset
-                    }
-
-                    dstLine += direction
-                }
-            }
-
-            if (displayJump != oldDisplayJump ||
-                jumpRange != oldJumpRange ||
-                horizontalOffsets != oldHorizontalOffsets) {
-                repaint()
-            }
-        }
-    }
-
-    override fun setText(text: String) {
-        fullText = text
-        refreshText()
-    }
-
-    fun refreshText() {
-        val saveCaret = caretPosition
-        super.setText(fullText.takeIf { explorerState.showLineNumbers } ?: fullText.removeLineLumbers())
-        caretPosition = saveCaret
-    }
-
-    override fun paintComponent(g: Graphics?) {
-        super.paintComponent(g)
-
-        if (displayJump) {
-            val padding = 6
-
-            val bounds1 = modelToView2D(horizontalOffsets.first)
-            val bounds2 = modelToView2D(horizontalOffsets.second)
-
-            val x1 = bounds1.x.toInt() - padding
-            val y1 = (bounds1.y + lineHeight / 2).toInt()
-
-            val x2 = bounds2.x.toInt() - padding
-            val y2 = (bounds2.y + lineHeight / 2).toInt()
-
-            val x0 = modelToView2D(2).x.toInt()
-            val g2 = g as Graphics2D
-            g2.drawLine(x1, y1, x0, y1)
-            g2.drawLine(x0, y1, x0, y2)
-            g2.drawLine(x0, y2, x2, y2)
-        }
-    }
-}
-
-private val LineNumber = Regex("^( +\\d+: )([0-9a-f]{4}: )", RegexOption.MULTILINE)
-
-private fun String.removeLineLumbers() = LineNumber.replace(this) {
-    val (start, end) = it.groupValues.drop(1)
-    " ".repeat(start.length) + end
-}
-
-private fun String.countPadding() = indexOfFirst { it != ' ' }
diff --git a/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/KotlinExplorer.kt b/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/KotlinExplorer.kt
index 65db586a..659bdd3f 100644
--- a/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/KotlinExplorer.kt
+++ b/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/KotlinExplorer.kt
@@ -36,6 +36,8 @@ import androidx.compose.ui.unit.dp
 import androidx.compose.ui.window.*
 import dev.romainguy.kotlin.explorer.Shortcut.Ctrl
 import dev.romainguy.kotlin.explorer.Shortcut.CtrlShift
+import dev.romainguy.kotlin.explorer.dex.DexTextArea
+import dev.romainguy.kotlin.explorer.oat.OatTextArea
 import kotlinx.coroutines.launch
 import org.fife.rsta.ui.search.FindDialog
 import org.fife.rsta.ui.search.SearchEvent
@@ -116,7 +118,7 @@ private fun FrameWindowScope.KotlinExplorer(
 
     val sourceTextArea = remember { sourceTextArea(focusTracker, explorerState) }
     val dexTextArea = remember { dexTextArea(explorerState, focusTracker) }
-    val oatTextArea = remember { oatTextArea(focusTracker) }
+    val oatTextArea = remember { oatTextArea(explorerState, focusTracker) }
 
     val findDialog = remember { FindDialog(window, searchListener).apply { searchContext.searchWrap = true } }
     var showSettings by remember { mutableStateOf(!explorerState.toolPaths.isValid) }
@@ -239,8 +241,8 @@ private fun dexTextArea(explorerState: ExplorerState, focusTracker: FocusListene
     }
 }
 
-private fun oatTextArea(focusTracker: FocusListener): RSyntaxTextArea {
-    return RSyntaxTextArea().apply {
+private fun oatTextArea(explorerState: ExplorerState, focusTracker: FocusListener): RSyntaxTextArea {
+    return OatTextArea(explorerState).apply {
         configureSyntaxTextArea(SyntaxConstants.SYNTAX_STYLE_NONE)
         addFocusListener(focusTracker)
     }
@@ -405,6 +407,12 @@ private fun RSyntaxTextArea.setFont(explorerState: ExplorerState) {
     font = font.deriveFont(if (presentation) FontSizePresentationMode else FontSizeEditingMode)
 }
 
+private fun updateTextArea(textArea: RSyntaxTextArea, text: String) {
+    val position = textArea.caretPosition
+    textArea.text = text
+    textArea.caretPosition = minOf(position, textArea.document.length)
+}
+
 fun main() = application {
     val explorerState = remember { ExplorerState() }
 
diff --git a/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/Regex.kt b/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/Regex.kt
new file mode 100644
index 00000000..62d15896
--- /dev/null
+++ b/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/Regex.kt
@@ -0,0 +1,21 @@
+/*
+ * Copyright (C) 2023 Romain Guy
+ *
+ * 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 dev.romainguy.kotlin.explorer
+
+fun MatchResult.getValue(group: String): String {
+    return groups[group]?.value ?: throw IllegalStateException("Value of $group not found in $value")
+}
diff --git a/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/dex/DexDumpParser.kt b/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/dex/DexDumpParser.kt
index e664630a..73ba6298 100644
--- a/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/dex/DexDumpParser.kt
+++ b/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/dex/DexDumpParser.kt
@@ -18,6 +18,7 @@ package dev.romainguy.kotlin.explorer.dex
 
 import dev.romainguy.kotlin.explorer.BuiltInKotlinClass
 import dev.romainguy.kotlin.explorer.consumeUntil
+import dev.romainguy.kotlin.explorer.getValue
 
 private val PositionRegex = Regex("^\\s*0x(?<address>[0-9a-f]+) line=(?<line>\\d+)$")
 
@@ -103,10 +104,6 @@ internal class DexDumpParser(text: String) {
     private class DexInstruction(val address: String, val code: String)
 }
 
-private fun MatchResult.getValue(group: String): String {
-    return groups[group]?.value ?: throw IllegalStateException("Value of $group not found in $value")
-}
-
 private fun String.getClassName() =
     getValue(ClassName)
         .removePrefix("L")
diff --git a/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/dex/DexTextArea.kt b/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/dex/DexTextArea.kt
new file mode 100644
index 00000000..41dbcb6b
--- /dev/null
+++ b/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/dex/DexTextArea.kt
@@ -0,0 +1,29 @@
+/*
+ * Copyright (C) 2023 Romain Guy
+ *
+ * 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 dev.romainguy.kotlin.explorer.dex
+
+import dev.romainguy.kotlin.explorer.CodeTextArea
+import dev.romainguy.kotlin.explorer.ExplorerState
+
+private val DexJumpRegex =
+    Regex("^.{9}[0-9a-fA-F]{4}: .+(?<address>[0-9a-fA-F]{4}) // (?<direction>[+-])[0-9a-fA-F]{4}$")
+private val DexAddressedRegex = Regex("^.{9}(?<address>[0-9a-fA-F]{4}): .+$")
+private val DexLineNumberRegex = Regex("^(?<lineNumber> +\\d+: )([0-9a-f]{4}: )")
+
+class DexTextArea(explorerState: ExplorerState) :
+    CodeTextArea(explorerState, DexJumpRegex, DexAddressedRegex, DexLineNumberRegex)
+
diff --git a/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/oat/OatTextArea.kt b/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/oat/OatTextArea.kt
new file mode 100644
index 00000000..796cc838
--- /dev/null
+++ b/src/jvmMain/kotlin/dev/romainguy/kotlin/explorer/oat/OatTextArea.kt
@@ -0,0 +1,27 @@
+/*
+ * Copyright (C) 2023 Romain Guy
+ *
+ * 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 dev.romainguy.kotlin.explorer.oat
+
+import dev.romainguy.kotlin.explorer.CodeTextArea
+import dev.romainguy.kotlin.explorer.ExplorerState
+
+private val OatJumpRegex =
+    Regex("^ +0x[0-9a-fA-F]{8}: .+ (?<direction>[+-])\\d+ \\((?<address>0x[0-9a-fA-F]{8})\\)$")
+private val OatAddressedRegex = Regex("^ +(?<address>0x[0-9a-fA-F]{8}): .+$")
+
+class OatTextArea(explorerState: ExplorerState) :
+    CodeTextArea(explorerState, OatJumpRegex, OatAddressedRegex, lineNumberRegex = null)
\ No newline at end of file