Name trap files after jvmnames

This should lead to better Java/Kotlin correspondence since the Java extractor will naturally name trap files for JVM names, and avoids a specific bug (tested) where MapsKt.iterator's two overloads (one taking `Map` and one `MutableMap`) are JvmName'd differently since their Java-lowered signatures would be identical. Without this change only one of the iterator overloads would get extracted leaving the other one a dangling reference.
2025-12-22 19:56:32 +01:00 · 2022-06-15 11:47:05 +01:00
parent 483281e00f
commit 90e8d4e1de
6 changed files with 105 additions and 77 deletions
--- a/java/kotlin-extractor/src/main/kotlin/KotlinUsesExtractor.kt
+++ b/java/kotlin-extractor/src/main/kotlin/KotlinUsesExtractor.kt
@@ -66,80 +66,6 @@ open class KotlinUsesExtractor(
        TypeResult(fakeKotlinType(), "", "")
    )

-    private data class MethodKey(val className: FqName, val functionName: Name)
-
-    private fun makeDescription(className: FqName, functionName: String) = MethodKey(className, Name.guessByFirstCharacter(functionName))
-
-    // This essentially mirrors SpecialBridgeMethods.kt, a backend pass which isn't easily available to our extractor.
-    private val specialFunctions = mapOf(
-        makeDescription(StandardNames.FqNames.collection, "<get-size>") to "size",
-        makeDescription(FqName("java.util.Collection"), "<get-size>") to "size",
-        makeDescription(StandardNames.FqNames.map, "<get-size>") to "size",
-        makeDescription(FqName("java.util.Map"), "<get-size>") to "size",
-        makeDescription(StandardNames.FqNames.charSequence.toSafe(), "<get-length>") to "length",
-        makeDescription(FqName("java.lang.CharSequence"), "<get-length>") to "length",
-        makeDescription(StandardNames.FqNames.map, "<get-keys>") to "keySet",
-        makeDescription(FqName("java.util.Map"), "<get-keys>") to "keySet",
-        makeDescription(StandardNames.FqNames.map, "<get-values>") to "values",
-        makeDescription(FqName("java.util.Map"), "<get-values>") to "values",
-        makeDescription(StandardNames.FqNames.map, "<get-entries>") to "entrySet",
-        makeDescription(FqName("java.util.Map"), "<get-entries>") to "entrySet",
-        makeDescription(StandardNames.FqNames.mutableList, "removeAt") to "remove",
-        makeDescription(FqName("java.util.List"), "removeAt") to "remove",
-        makeDescription(StandardNames.FqNames._enum.toSafe(), "<get-ordinal>") to "ordinal",
-        makeDescription(FqName("java.lang.Enum"), "<get-ordinal>") to "ordinal",
-        makeDescription(StandardNames.FqNames._enum.toSafe(), "<get-name>") to "name",
-        makeDescription(FqName("java.lang.Enum"), "<get-name>") to "name",
-        makeDescription(StandardNames.FqNames.number.toSafe(), "toByte") to "byteValue",
-        makeDescription(FqName("java.lang.Number"), "toByte") to "byteValue",
-        makeDescription(StandardNames.FqNames.number.toSafe(), "toShort") to "shortValue",
-        makeDescription(FqName("java.lang.Number"), "toShort") to "shortValue",
-        makeDescription(StandardNames.FqNames.number.toSafe(), "toInt") to "intValue",
-        makeDescription(FqName("java.lang.Number"), "toInt") to "intValue",
-        makeDescription(StandardNames.FqNames.number.toSafe(), "toLong") to "longValue",
-        makeDescription(FqName("java.lang.Number"), "toLong") to "longValue",
-        makeDescription(StandardNames.FqNames.number.toSafe(), "toFloat") to "floatValue",
-        makeDescription(FqName("java.lang.Number"), "toFloat") to "floatValue",
-        makeDescription(StandardNames.FqNames.number.toSafe(), "toDouble") to "doubleValue",
-        makeDescription(FqName("java.lang.Number"), "toDouble") to "doubleValue",
-    )
-
-    private val specialFunctionShortNames = specialFunctions.keys.map { it.functionName }.toSet()
-
-    fun getSpecialJvmName(f: IrFunction): String? {
-        if (specialFunctionShortNames.contains(f.name) && f is IrSimpleFunction) {
-            f.allOverridden(true).forEach { overriddenFunc ->
-                overriddenFunc.parentClassOrNull?.fqNameWhenAvailable?.let { parentFqName ->
-                    specialFunctions[MethodKey(parentFqName, f.name)]?.let {
-                        return it
-                    }
-                }
-            }
-        }
-        return null
-    }
-
-    fun getJvmName(container: IrAnnotationContainer): String? {
-        for(a: IrConstructorCall in container.annotations) {
-            val t = a.type
-            if (t is IrSimpleType && a.valueArgumentsCount == 1) {
-                val owner = t.classifier.owner
-                val v = a.getValueArgument(0)
-                if (owner is IrClass) {
-                    val aPkg = owner.packageFqName?.asString()
-                    val name = owner.name.asString()
-                    if(aPkg == "kotlin.jvm" && name == "JvmName" && v is IrConst<*>) {
-                        val value = v.value
-                        if (value is String) {
-                            return value
-                        }
-                    }
-                }
-            }
-        }
-        return (container as? IrFunction)?.let { getSpecialJvmName(container) }
-    }
-
    @OptIn(kotlin.ExperimentalStdlibApi::class) // Annotation required by kotlin versions < 1.5
    fun extractFileClass(f: IrFile): Label<out DbClass> {
        val fileName = f.fileEntry.name
--- a/java/kotlin-extractor/src/main/kotlin/utils/ClassNames.kt
+++ b/java/kotlin-extractor/src/main/kotlin/utils/ClassNames.kt
@@ -1,5 +1,6 @@
 package com.github.codeql

+import com.github.codeql.utils.getJvmName
 import com.intellij.openapi.vfs.StandardFileSystems
 import org.jetbrains.kotlin.load.java.sources.JavaSourceElement
 import org.jetbrains.kotlin.load.java.structure.impl.classFiles.BinaryJavaClass
@@ -18,17 +19,19 @@ import org.jetbrains.kotlin.load.kotlin.JvmPackagePartSource
 // and declarations within them into the parent class' JLS 13.1 name as
 // specified above, followed by a `$` separator and then the short name
 // for `that`.
+private fun getName(d: IrDeclarationWithName) = (d as? IrAnnotationContainer)?.let { getJvmName(it) } ?: d.name.asString()
+
 fun getIrDeclBinaryName(that: IrDeclaration): String {
  val shortName = when(that) {
-      is IrDeclarationWithName -> that.name.asString()
+      is IrDeclarationWithName -> getName(that)
      else -> "(unknown-name)"
  }
  val internalName = StringBuilder(shortName);
  generateSequence(that.parent) { (it as? IrDeclaration)?.parent }
      .forEach {
          when (it) {
-              is IrClass -> internalName.insert(0, it.name.asString() + "$")
-              is IrPackageFragment -> it.fqName.asString().takeIf { it.isNotEmpty() }?.let { internalName.insert(0, "$it.") }
+              is IrClass -> internalName.insert(0, getName(it) + "$")
+              is IrPackageFragment -> it.fqName.asString().takeIf { fqName -> fqName.isNotEmpty() }?.let { fqName -> internalName.insert(0, "$fqName.") }
          }
      }
  return internalName.toString()
--- a/java/kotlin-extractor/src/main/kotlin/utils/JvmNames.kt
+++ b/java/kotlin-extractor/src/main/kotlin/utils/JvmNames.kt
@@ -0,0 +1,90 @@
+package com.github.codeql.utils
+
+import org.jetbrains.kotlin.backend.common.ir.allOverridden
+import org.jetbrains.kotlin.builtins.StandardNames
+import org.jetbrains.kotlin.ir.declarations.IrAnnotationContainer
+import org.jetbrains.kotlin.ir.declarations.IrClass
+import org.jetbrains.kotlin.ir.declarations.IrFunction
+import org.jetbrains.kotlin.ir.declarations.IrSimpleFunction
+import org.jetbrains.kotlin.ir.expressions.IrConst
+import org.jetbrains.kotlin.ir.expressions.IrConstructorCall
+import org.jetbrains.kotlin.ir.types.IrSimpleType
+import org.jetbrains.kotlin.ir.util.fqNameWhenAvailable
+import org.jetbrains.kotlin.ir.util.packageFqName
+import org.jetbrains.kotlin.ir.util.parentClassOrNull
+import org.jetbrains.kotlin.name.FqName
+import org.jetbrains.kotlin.name.Name
+
+private data class MethodKey(val className: FqName, val functionName: Name)
+
+private fun makeDescription(className: FqName, functionName: String) = MethodKey(className, Name.guessByFirstCharacter(functionName))
+
+// This essentially mirrors SpecialBridgeMethods.kt, a backend pass which isn't easily available to our extractor.
+private val specialFunctions = mapOf(
+    makeDescription(StandardNames.FqNames.collection, "<get-size>") to "size",
+    makeDescription(FqName("java.util.Collection"), "<get-size>") to "size",
+    makeDescription(StandardNames.FqNames.map, "<get-size>") to "size",
+    makeDescription(FqName("java.util.Map"), "<get-size>") to "size",
+    makeDescription(StandardNames.FqNames.charSequence.toSafe(), "<get-length>") to "length",
+    makeDescription(FqName("java.lang.CharSequence"), "<get-length>") to "length",
+    makeDescription(StandardNames.FqNames.map, "<get-keys>") to "keySet",
+    makeDescription(FqName("java.util.Map"), "<get-keys>") to "keySet",
+    makeDescription(StandardNames.FqNames.map, "<get-values>") to "values",
+    makeDescription(FqName("java.util.Map"), "<get-values>") to "values",
+    makeDescription(StandardNames.FqNames.map, "<get-entries>") to "entrySet",
+    makeDescription(FqName("java.util.Map"), "<get-entries>") to "entrySet",
+    makeDescription(StandardNames.FqNames.mutableList, "removeAt") to "remove",
+    makeDescription(FqName("java.util.List"), "removeAt") to "remove",
+    makeDescription(StandardNames.FqNames._enum.toSafe(), "<get-ordinal>") to "ordinal",
+    makeDescription(FqName("java.lang.Enum"), "<get-ordinal>") to "ordinal",
+    makeDescription(StandardNames.FqNames._enum.toSafe(), "<get-name>") to "name",
+    makeDescription(FqName("java.lang.Enum"), "<get-name>") to "name",
+    makeDescription(StandardNames.FqNames.number.toSafe(), "toByte") to "byteValue",
+    makeDescription(FqName("java.lang.Number"), "toByte") to "byteValue",
+    makeDescription(StandardNames.FqNames.number.toSafe(), "toShort") to "shortValue",
+    makeDescription(FqName("java.lang.Number"), "toShort") to "shortValue",
+    makeDescription(StandardNames.FqNames.number.toSafe(), "toInt") to "intValue",
+    makeDescription(FqName("java.lang.Number"), "toInt") to "intValue",
+    makeDescription(StandardNames.FqNames.number.toSafe(), "toLong") to "longValue",
+    makeDescription(FqName("java.lang.Number"), "toLong") to "longValue",
+    makeDescription(StandardNames.FqNames.number.toSafe(), "toFloat") to "floatValue",
+    makeDescription(FqName("java.lang.Number"), "toFloat") to "floatValue",
+    makeDescription(StandardNames.FqNames.number.toSafe(), "toDouble") to "doubleValue",
+    makeDescription(FqName("java.lang.Number"), "toDouble") to "doubleValue",
+)
+
+private val specialFunctionShortNames = specialFunctions.keys.map { it.functionName }.toSet()
+
+fun getSpecialJvmName(f: IrFunction): String? {
+    if (specialFunctionShortNames.contains(f.name) && f is IrSimpleFunction) {
+        f.allOverridden(true).forEach { overriddenFunc ->
+            overriddenFunc.parentClassOrNull?.fqNameWhenAvailable?.let { parentFqName ->
+                specialFunctions[MethodKey(parentFqName, f.name)]?.let {
+                    return it
+                }
+            }
+        }
+    }
+    return null
+}
+
+fun getJvmName(container: IrAnnotationContainer): String? {
+    for(a: IrConstructorCall in container.annotations) {
+        val t = a.type
+        if (t is IrSimpleType && a.valueArgumentsCount == 1) {
+            val owner = t.classifier.owner
+            val v = a.getValueArgument(0)
+            if (owner is IrClass) {
+                val aPkg = owner.packageFqName?.asString()
+                val name = owner.name.asString()
+                if(aPkg == "kotlin.jvm" && name == "JvmName" && v is IrConst<*>) {
+                    val value = v.value
+                    if (value is String) {
+                        return value
+                    }
+                }
+            }
+        }
+    }
+    return (container as? IrFunction)?.let { getSpecialJvmName(container) }
+}