Kotlin: Keep our own stack of extractor contexts

igfoo · igfoo · commit aad9e5601a0e · 2022-05-10T19:51:21.000+01:00
For now we only use its length, but in the future we might use this to
give more informatino about the cause of warnings.
diff --git a/java/kotlin-extractor/src/main/kotlin/KotlinExtractorExtension.kt b/java/kotlin-extractor/src/main/kotlin/KotlinExtractorExtension.kt
@@ -4,10 +4,12 @@ import org.jetbrains.kotlin.backend.common.extensions.IrGenerationExtension
 import org.jetbrains.kotlin.backend.common.extensions.IrPluginContext
 import org.jetbrains.kotlin.ir.declarations.*
 import org.jetbrains.kotlin.ir.util.*
+import org.jetbrains.kotlin.ir.IrElement
 import java.io.File
 import java.io.FileOutputStream
 import java.nio.file.Files
 import java.nio.file.Paths
+import java.util.Stack
 import com.semmle.util.files.FileUtil
 import kotlin.system.exitProcess
 
@@ -116,6 +118,8 @@ class KotlinExtractorExtension(
     }
 }
 
+data class ExtractorContext(val kind: String, val element: IrElement)
+
 class KotlinExtractorGlobalState {
     val genericSpecialisationsExtracted = HashSet<String>()
     // These three record mappings of classes, functions and fields that should be replaced wherever they are found.
@@ -125,6 +129,7 @@ class KotlinExtractorGlobalState {
     val syntheticToRealClassMap = HashMap<IrClass, IrClass?>()
     val syntheticToRealFunctionMap = HashMap<IrSimpleFunction, IrSimpleFunction?>()
     val syntheticToRealFieldMap = HashMap<IrField, IrField?>()
+    val context = Stack<ExtractorContext>()
 }
 
 /*
diff --git a/java/kotlin-extractor/src/main/kotlin/KotlinFileExtractor.kt b/java/kotlin-extractor/src/main/kotlin/KotlinFileExtractor.kt
@@ -43,14 +43,19 @@ open class KotlinFileExtractor(
 
     inline fun <T> with(kind: String, element: IrElement, f: () -> T): T {
         val loc = tw.getLocationString(element)
+        globalExtensionState.context.push(ExtractorContext(kind, element))
         try {
+            val depth = globalExtensionState.context.size
+            val depthDescription = "${"-".repeat(depth)} (${depth.toString()})"
             val name = (element as? IrDeclarationWithName)?.name?.asString() ?: "<no name>"
-            logger.trace("Starting a $kind ($name) at $loc")
+            logger.trace("$depthDescription: Starting a $kind ($name) at $loc")
             val result = f()
-            logger.trace("Finished a $kind ($name) at $loc")
+            logger.trace("$depthDescription: Finished a $kind ($name) at $loc")
             return result
         } catch(exception: Exception) {
             throw Exception("While extracting a $kind at $loc", exception)
+        } finally {
+            globalExtensionState.context.pop()
         }
     }
 
