Extract companion objects from interfaces

tamasvajk · igfoo · commit cd5555a5ddf4 · 2022-05-10T19:51:15.000+01:00
diff --git a/java/kotlin-extractor/src/main/kotlin/KotlinFileExtractor.kt b/java/kotlin-extractor/src/main/kotlin/KotlinFileExtractor.kt
@@ -386,7 +386,7 @@ open class KotlinFileExtractor(
                             tw.writeHasLocation(instance.id, innerLocId)
                             addModifiers(instance.id, "public", "static", "final")
                             @Suppress("UNCHECKED_CAST")
-                            tw.writeClass_companion_object(parentId as Label<DbClass>, instance.id, innerId as Label<DbClass>)
+                            tw.writeType_companion_object(parentId, instance.id, innerId as Label<DbClass>)
                         }
                     }
 
diff --git a/java/ql/lib/config/semmlecode.dbscheme b/java/ql/lib/config/semmlecode.dbscheme
@@ -348,8 +348,8 @@ class_object(
   unique int instance: @field ref
 );
 
-class_companion_object(
-  unique int id: @class ref,
+type_companion_object(
+  unique int id: @classorinterface ref,
   unique int instance: @field ref,
   unique int companion_object: @class ref
 );
diff --git a/java/ql/lib/semmle/code/java/Type.qll b/java/ql/lib/semmle/code/java/Type.qll
@@ -695,11 +695,6 @@ class Class extends ClassOrInterface, @class {
     )
   }
 
-  /** Get the companion object of this class, if any. */
-  ClassCompanionObject getCompanionObject() {
-    class_companion_object(this, _, result)
-  }
-
   override string getAPrimaryQlClass() { result = "Class" }
 }
 
@@ -718,12 +713,12 @@ class ClassObject extends Class {
 /** A Kotlin `companion object`. */
 class ClassCompanionObject extends Class {
   ClassCompanionObject() {
-    class_companion_object(_, _, this)
+    type_companion_object(_, _, this)
   }
 
   /** Gets the instance variable that implements this `companion object`. */
   Field getInstance() {
-    class_companion_object(_, result, this)
+    type_companion_object(_, result, this)
   }
 }
 
@@ -964,6 +959,9 @@ class ClassOrInterface extends RefType, @classorinterface {
 
   /** Holds if this class or interface is explicitly or implicitly a sealed class (Java 17 feature). */
   predicate isSealed() { exists(this.getAPermittedSubtype()) }
+
+  /** Get the companion object of this class or interface, if any. */
+  ClassCompanionObject getCompanionObject() { type_companion_object(this, _, result) }
 }
 
 private string getAPublicObjectMethodSignature() {
diff --git a/java/ql/test/kotlin/library-tests/companion_objects/accesses.expected b/java/ql/test/kotlin/library-tests/companion_objects/accesses.expected
@@ -1 +1,2 @@
-| companion_objects.kt:3:5:5:5 | MyClassCompanion | companion_objects.kt:9:5:9:11 | MyClassCompanion |
+| companion_objects.kt:3:5:5:5 | MyClassCompanion | companion_objects.kt:23:5:23:11 | MyClassCompanion |
+| companion_objects.kt:10:5:12:5 | MyInterfaceCompanion | companion_objects.kt:25:5:25:15 | MyInterfaceCompanion |
diff --git a/java/ql/test/kotlin/library-tests/companion_objects/companion_objects.expected b/java/ql/test/kotlin/library-tests/companion_objects/companion_objects.expected
@@ -1 +1,2 @@
 | companion_objects.kt:1:1:6:1 | MyClass | companion_objects.kt:3:5:5:5 | MyClassCompanion | companion_objects.kt:3:5:5:5 | MyClassCompanion | final,public,static |
+| companion_objects.kt:8:1:13:1 | MyInterface | companion_objects.kt:10:5:12:5 | MyInterfaceCompanion | companion_objects.kt:10:5:12:5 | MyInterfaceCompanion | final,public,static |
diff --git a/java/ql/test/kotlin/library-tests/companion_objects/companion_objects.kt b/java/ql/test/kotlin/library-tests/companion_objects/companion_objects.kt
@@ -5,8 +5,24 @@ class MyClass {
     }
 }
 
+interface MyInterface {
+    fun funInInterface()
+    companion object MyInterfaceCompanion {
+        fun funInCompanion() {}
+    }
+}
+
+class Imp : MyInterface {
+    override fun funInInterface() {
+        TODO("Not yet implemented")
+    }
+
+}
+
 fun user() {
     MyClass.funInCompanion()
     MyClass().funInClass()
+    MyInterface.funInCompanion()
+    Imp().funInInterface()
 }
 
diff --git a/java/ql/test/kotlin/library-tests/companion_objects/companion_objects.ql b/java/ql/test/kotlin/library-tests/companion_objects/companion_objects.ql
@@ -1,6 +1,6 @@
 import java
 
-from Class c, ClassCompanionObject cco, Field f
+from ClassOrInterface c, ClassCompanionObject cco, Field f
 where c.fromSource()
   and cco = c.getCompanionObject()
   and f = cco.getInstance()
diff --git a/java/ql/test/kotlin/library-tests/companion_objects/method_accesses.expected b/java/ql/test/kotlin/library-tests/companion_objects/method_accesses.expected
@@ -1,2 +1,5 @@
-| companion_objects.kt:9:5:9:11 | MyClassCompanion | VarAccess | companion_objects.kt:4:9:4:31 | funInCompanion |
-| companion_objects.kt:10:5:10:13 | new MyClass(...) | ClassInstanceExpr | companion_objects.kt:2:5:2:23 | funInClass |
+| companion_objects.kt:17:9:17:35 | StandardKt | TypeAccess | file:///!unknown-binary-location/kotlin/StandardKt.class:0:0:0:0 | TODO |
+| companion_objects.kt:23:5:23:11 | MyClassCompanion | VarAccess | companion_objects.kt:4:9:4:31 | funInCompanion |
+| companion_objects.kt:24:5:24:13 | new MyClass(...) | ClassInstanceExpr | companion_objects.kt:2:5:2:23 | funInClass |
+| companion_objects.kt:25:5:25:15 | MyInterfaceCompanion | VarAccess | companion_objects.kt:11:9:11:31 | funInCompanion |
+| companion_objects.kt:26:5:26:9 | new Imp(...) | ClassInstanceExpr | companion_objects.kt:16:14:18:5 | funInInterface |

Original file line number	Diff line number	Diff line change
`@@ -386,7 +386,7 @@ open class KotlinFileExtractor(`
`386`	`386`	`tw.writeHasLocation(instance.id, innerLocId)`
`387`	`387`	`addModifiers(instance.id, "public", "static", "final")`
`388`	`388`	`@Suppress("UNCHECKED_CAST")`
`389`		`- tw.writeClass_companion_object(parentId as Label<DbClass>, instance.id, innerId as Label<DbClass>)`
	`389`	`+ tw.writeType_companion_object(parentId, instance.id, innerId as Label<DbClass>)`
`390`	`390`	`}`
`391`	`391`	`}`
`392`	`392`
Original file line number	Diff line number	Diff line change
`@@ -695,11 +695,6 @@ class Class extends ClassOrInterface, @class {`
`695`	`695`	`)`
`696`	`696`	`}`
`697`	`697`
`698`		`- /** Get the companion object of this class, if any. */`
`699`		`- ClassCompanionObject getCompanionObject() {`
`700`		`- class_companion_object(this, _, result)`
`701`		`- }`
`702`		`-`
`703`	`698`	`override string getAPrimaryQlClass() { result = "Class" }`
`704`	`699`	`}`
`705`	`700`
`@@ -718,12 +713,12 @@ class ClassObject extends Class {`
`718`	`713`	/** A Kotlin `companion object`. */
`719`	`714`	`class ClassCompanionObject extends Class {`
`720`	`715`	`ClassCompanionObject() {`
`721`		`- class_companion_object(_, _, this)`
	`716`	`+ type_companion_object(_, _, this)`
`722`	`717`	`}`
`723`	`718`
`724`	`719`	/** Gets the instance variable that implements this `companion object`. */
`725`	`720`	`Field getInstance() {`
`726`		`- class_companion_object(_, result, this)`
	`721`	`+ type_companion_object(_, result, this)`
`727`	`722`	`}`
`728`	`723`	`}`
`729`	`724`
`@@ -964,6 +959,9 @@ class ClassOrInterface extends RefType, @classorinterface {`
`964`	`959`
`965`	`960`	`/** Holds if this class or interface is explicitly or implicitly a sealed class (Java 17 feature). */`
`966`	`961`	`predicate isSealed() { exists(this.getAPermittedSubtype()) }`
	`962`	`+`
	`963`	`+ /** Get the companion object of this class or interface, if any. */`
	`964`	`+ ClassCompanionObject getCompanionObject() { type_companion_object(this, _, result) }`
`967`	`965`	`}`
`968`	`966`
`969`	`967`	`private string getAPublicObjectMethodSignature() {`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`		`-\| companion_objects.kt:3:5:5:5 \| MyClassCompanion \| companion_objects.kt:9:5:9:11 \| MyClassCompanion \|`
	`1`	`+\| companion_objects.kt:3:5:5:5 \| MyClassCompanion \| companion_objects.kt:23:5:23:11 \| MyClassCompanion \|`
	`2`	`+\| companion_objects.kt:10:5:12:5 \| MyInterfaceCompanion \| companion_objects.kt:25:5:25:15 \| MyInterfaceCompanion \|`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`\| companion_objects.kt:1:1:6:1 \| MyClass \| companion_objects.kt:3:5:5:5 \| MyClassCompanion \| companion_objects.kt:3:5:5:5 \| MyClassCompanion \| final,public,static \|`
	`2`	`+\| companion_objects.kt:8:1:13:1 \| MyInterface \| companion_objects.kt:10:5:12:5 \| MyInterfaceCompanion \| companion_objects.kt:10:5:12:5 \| MyInterfaceCompanion \| final,public,static \|`