[core] Kotlin script compiler fails to resolve JADX script plugin runtime/receiver

[Dev4Mod]

Issue details

When attempting to execute a Kotlin script (.kts) in JADX to create a ScriptOrderedDecompilePass, the compiler fails to recognize the plugin's base classes and the script receiver. This prevents the use of essential functions such as getJadxInstance() and the implementation of custom visitors.

Relevant log output or stacktrace

ERROR: Cannot access implicit script receiver class 'jadx.plugins.script.kotlin.runtime.JadxScriptTemplate'. Check your module classpath for missing or conflicting dependencies.
ERROR: Unresolved reference: script (deobf_from_tostring.jadx.kts:13:21)
ERROR: Unresolved reference: getJadxInstance (deobf_from_tostring.jadx.kts:15:12)
ERROR: Unresolved reference: ScriptOrderedDecompilePass (deobf_from_tostring.jadx.kts:17:23)
ERROR: 'visit' overrides nothing (deobf_from_tostring.jadx.kts:22:2)

code

import jadx.core.deobf.NameMapper
import jadx.core.dex.attributes.AFlag
import jadx.core.dex.attributes.nodes.RenameReasonAttr
import jadx.core.dex.info.FieldInfo
import jadx.core.dex.instructions.ConstStringNode
import jadx.core.dex.instructions.IndexInsnNode
import jadx.core.dex.instructions.InsnType
import jadx.core.dex.instructions.InvokeNode
import jadx.core.dex.instructions.args.InsnArg
import jadx.core.dex.instructions.args.InsnWrapArg
import jadx.core.dex.nodes.InsnNode
import jadx.core.dex.nodes.MethodNode
import jadx.plugins.script.runtime.data.ScriptOrderedDecompilePass

val jadx = getJadxInstance()

jadx.addPass(object : ScriptOrderedDecompilePass(
    jadx,
    "DeobfFromToString",
    runAfter = listOf("SimplifyVisitor"),
) {
    override fun visit(mth: MethodNode) {
        // Target: only toString() methods
        if (mth.methodInfo.shortId == "toString()Ljava/lang/String;") {
            val returnBlock = mth.exitBlock.predecessors.firstOrNull { it.contains(AFlag.RETURN) }
            val lastInsn = returnBlock?.instructions?.lastOrNull()
            
            // Check if last instruction is a return of a string
            if (lastInsn != null && lastInsn.type == InsnType.RETURN) {
                val arg = lastInsn.getArg(0)
                if (arg is InsnWrapArg) {
                    val wrappedInsn = arg.wrapInsn
                    if (wrappedInsn is ConstStringNode) {
                          // code
                    }
                }
            }
        }
    }
})

Jadx version

1.5.4

[skylot]

First issue here: package for ScriptOrderedDecompilePass was changed, use this import line:

import jadx.plugins.script.kotlin.runtime.data.ScriptOrderedDecompilePass

Actually, all classes from script plugin was moved into jadx.plugins.script.kotlin.
I agree, it was a bad change, but it is already done, sorry for that 😭

Another issue is similar to #2758, but now it also affects imports from plugin module itself 🤦
This issue is a regression somewhere in Kotlin scripting library and appear only for autocomplete and checks (i.e. usage of KJvmReplCompilerWithIdeServices), but Run button also run checks before actual script execution.

As a workaround for now: instead Run button, use reload button on toolbar or F5 shortcut.

[Dev4Mod]

I understand. This change ended up breaking the existing scripts, since you need to update the imports for it to work. Another thing is that you will need to update the example scripts that continue to use the old import.