Merge pull request #9703 from igfoo/igfoo/generated

Kotlin: Record more kinds of elements as compiler-generated

Author: igfoo

java/kotlin-extractor/src/main/kotlin/KotlinFileExtractor.kt

@@ -595,6 +595,8 @@ open class KotlinFileExtractor(
                 tw.writeMethods(clinitId, "<clinit>", "<clinit>()", returnType.javaResult.id, parentId, clinitId)
                 tw.writeMethodsKotlinType(clinitId, returnType.kotlinResult.id)
 
+                tw.writeCompiler_generated(clinitId, CompilerGeneratedKinds.CLASS_INITIALISATION_METHOD.kind)
+
                 val locId = tw.getWholeFileLocation()
                 tw.writeHasLocation(clinitId, locId)
 
@@ -780,6 +782,14 @@ open class KotlinFileExtractor(
                     val methodId = id.cast<DbMethod>()
                     tw.writeMethods(methodId, shortName.nameInDB, "${shortName.nameInDB}$paramsSignature", returnType.javaResult.id, parentId, sourceDeclaration.cast<DbMethod>())
                     tw.writeMethodsKotlinType(methodId, returnType.kotlinResult.id)
+                    when (f.origin) {
+                        IrDeclarationOrigin.GENERATED_DATA_CLASS_MEMBER ->
+                            tw.writeCompiler_generated(methodId, CompilerGeneratedKinds.GENERATED_DATA_CLASS_MEMBER.kind)
+                        IrDeclarationOrigin.DEFAULT_PROPERTY_ACCESSOR ->
+                            tw.writeCompiler_generated(methodId, CompilerGeneratedKinds.DEFAULT_PROPERTY_ACCESSOR.kind)
+                        IrDeclarationOrigin.ENUM_CLASS_SPECIAL_MEMBER ->
+                            tw.writeCompiler_generated(methodId, CompilerGeneratedKinds.ENUM_CLASS_SPECIAL_MEMBER.kind)
+                    }
 
                     if (extractMethodAndParameterTypeAccesses) {
                         extractTypeAccessRecursive(substReturnType, locId, id, -1)
@@ -1070,7 +1080,7 @@ open class KotlinFileExtractor(
                         tw.writeKtLocalFunction(ids.function)
 
                         if (s.origin == IrDeclarationOrigin.ADAPTER_FOR_CALLABLE_REFERENCE) {
-                            tw.writeCompiler_generated(classId, 1)
+                            tw.writeCompiler_generated(classId, CompilerGeneratedKinds.DECLARING_CLASSES_OF_ADAPTER_FUNCTIONS.kind)
                         }
                     } else {
                         logger.errorElement("Expected to find local function", s)
@@ -4367,4 +4377,12 @@ open class KotlinFileExtractor(
             declarationStack.pop()
         }
     }
+
+    private enum class CompilerGeneratedKinds(val kind: Int) {
+        DECLARING_CLASSES_OF_ADAPTER_FUNCTIONS(1),
+        GENERATED_DATA_CLASS_MEMBER(2),
+        DEFAULT_PROPERTY_ACCESSOR(3),
+        CLASS_INITIALISATION_METHOD(4),
+        ENUM_CLASS_SPECIAL_MEMBER(5)
+    }
 }

java/ql/lib/config/semmlecode.dbscheme

@@ -1211,10 +1211,15 @@ ktPropertyDelegates(
   unique int variableId: @variable ref
 )
 
+/**
+ * If `id` is a compiler generated element, then the kind indicates the
+ * reason that the compiler generated it.
+ * See `Element.compilerGeneratedReason()` for an explanation of what
+ * each `kind` means.
+ */
 compiler_generated(
   unique int id: @element ref,
   int kind: int ref
-  // 1: Declaring classes of adapter functions in Kotlin
 )
 
 ktFunctionOriginalNames(

java/ql/lib/semmle/code/java/Element.qll

@@ -44,6 +44,21 @@ class Element extends @element, Top {
 
   /** Holds if this is an auxiliary program element generated by the compiler. */
   predicate isCompilerGenerated() { compiler_generated(this, _) }
+
+  /** Gets the reason this element was generated by the compiler, if any. */
+  string compilerGeneratedReason() {
+    exists(int i | compiler_generated(this, i) |
+      i = 1 and result = "Declaring classes of adapter functions in Kotlin"
+      or
+      i = 2 and result = "Generated data class member"
+      or
+      i = 3 and result = "Default property accessor"
+      or
+      i = 4 and result = "Class initialisation method <clinit>"
+      or
+      i = 5 and result = "Enum class special member"
+    )
+  }
 }
 
 /**