Merge pull request github#10696 from tamasvajk/kotlin-lateinit

tamasvajk · web-flow · commit 8523d21f8c30 · 2022-10-11T15:03:10.000+02:00
Kotlin: Extract `lateinit` modifier
diff --git a/java/kotlin-extractor/src/main/kotlin/KotlinFileExtractor.kt b/java/kotlin-extractor/src/main/kotlin/KotlinFileExtractor.kt
@@ -1251,6 +1251,10 @@ open class KotlinFileExtractor(
                 }
 
                 extractVisibility(p, id, p.visibility)
+
+                if (p.isLateinit) {
+                    addModifiers(id, "lateinit")
+                }
             }
         }
     }
@@ -1406,6 +1410,9 @@ open class KotlinFileExtractor(
             if (!v.isVar) {
                 addModifiers(varId, "final")
             }
+            if (v.isLateinit) {
+                addModifiers(varId, "lateinit")
+            }
         }
     }
 
diff --git a/java/ql/lib/semmle/code/java/Modifier.qll b/java/ql/lib/semmle/code/java/Modifier.qll
@@ -67,10 +67,10 @@ abstract class Modifiable extends Element {
   /** Holds if this element has an `inline` modifier. */
   predicate isInline() { this.hasModifier("inline") }
 
-  /** Holds if this element has an `noinline` modifier. */
+  /** Holds if this element has a `noinline` modifier. */
   predicate isNoinline() { this.hasModifier("noinline") }
 
-  /** Holds if this element has an `crossinline` modifier. */
+  /** Holds if this element has a `crossinline` modifier. */
   predicate isCrossinline() { this.hasModifier("crossinline") }
 
   /** Holds if this element has a `suspend` modifier. */
@@ -93,4 +93,7 @@ abstract class Modifiable extends Element {
 
   /** Holds if this element has a `strictfp` modifier. */
   predicate isStrictfp() { this.hasModifier("strictfp") }
+
+  /** Holds if this element has a `lateinit` modifier. */
+  predicate isLateinit() { this.hasModifier("lateinit") }
 }
diff --git a/java/ql/test/kotlin/library-tests/lateinit/PrintAst.expected b/java/ql/test/kotlin/library-tests/lateinit/PrintAst.expected
@@ -0,0 +1,94 @@
+test.kt:
+#    0| [CompilationUnit] test
+#    1|   1: [Class] LateInit
+#    1|     1: [Constructor] LateInit
+#    1|       5: [BlockStmt] { ... }
+#    1|         0: [SuperConstructorInvocationStmt] super(...)
+#    1|         1: [BlockStmt] { ... }
+#    2|     2: [FieldDeclaration] LateInit test0;
+#    2|       -1: [TypeAccess] LateInit
+#    2|     3: [Method] getTest0$private
+#    2|       3: [TypeAccess] LateInit
+#    2|       5: [BlockStmt] { ... }
+#    2|         0: [ReturnStmt] return ...
+#    2|           0: [VarAccess] this.test0
+#    2|             -1: [ThisAccess] this
+#    2|     4: [Method] setTest0$private
+#    2|       3: [TypeAccess] Unit
+#-----|       4: (Parameters)
+#    2|         0: [Parameter] <set-?>
+#    2|           0: [TypeAccess] LateInit
+#    2|       5: [BlockStmt] { ... }
+#    2|         0: [ExprStmt] <Expr>;
+#    2|           0: [AssignExpr] ...=...
+#    2|             0: [VarAccess] this.test0
+#    2|               -1: [ThisAccess] this
+#    2|             1: [VarAccess] <set-?>
+#    4|     5: [Method] f
+#    4|       3: [TypeAccess] Unit
+#    4|       5: [BlockStmt] { ... }
+#    4|         0: [ReturnStmt] return ...
+#    4|           0: [MethodAccess] println(...)
+#    4|             -1: [TypeAccess] ConsoleKt
+#    4|             0: [StringLiteral] a
+#    6|     6: [Method] init
+#    6|       3: [TypeAccess] LateInit
+#    6|       5: [BlockStmt] { ... }
+#    6|         0: [ReturnStmt] return ...
+#    6|           0: [ClassInstanceExpr] new LateInit(...)
+#    6|             -3: [TypeAccess] LateInit
+#    8|     7: [Method] fn
+#    8|       3: [TypeAccess] Unit
+#    8|       5: [BlockStmt] { ... }
+#    9|         0: [ExprStmt] <Expr>;
+#    9|           0: [MethodAccess] f(...)
+#    9|             -1: [MethodAccess] getTest0$private(...)
+#    9|               -1: [ThisAccess] this
+#   10|         1: [ExprStmt] <Expr>;
+#   10|           0: [WhenExpr] when ...
+#   10|             0: [WhenBranch] ... -> ...
+#   10|               0: [MethodAccess] isInitialized(...)
+#   10|                 -1: [TypeAccess] LateinitKt
+#   10|                 0: [PropertyRefExpr] ...::...
+#   10|                   -4: [AnonymousClass] new KMutableProperty0<LateInit>(...) { ... }
+#   10|                     1: [Constructor] 
+#-----|                       4: (Parameters)
+#   10|                         0: [Parameter] <dispatchReceiver>
+#   10|                       5: [BlockStmt] { ... }
+#   10|                         0: [SuperConstructorInvocationStmt] super(...)
+#   10|                         1: [ExprStmt] <Expr>;
+#   10|                           0: [AssignExpr] ...=...
+#   10|                             0: [VarAccess] this.<dispatchReceiver>
+#   10|                               -1: [ThisAccess] this
+#   10|                             1: [VarAccess] <dispatchReceiver>
+#   10|                     2: [FieldDeclaration] LateInit <dispatchReceiver>;
+#   10|                       -1: [TypeAccess] LateInit
+#   10|                     3: [Method] get
+#   10|                       5: [BlockStmt] { ... }
+#   10|                         0: [ReturnStmt] return ...
+#   10|                           0: [MethodAccess] getTest0$private(...)
+#   10|                             -1: [VarAccess] this.<dispatchReceiver>
+#   10|                               -1: [ThisAccess] this
+#   10|                     4: [Method] invoke
+#   10|                       5: [BlockStmt] { ... }
+#   10|                         0: [ReturnStmt] return ...
+#   10|                           0: [MethodAccess] get(...)
+#   10|                             -1: [ThisAccess] this
+#   10|                     5: [Method] set
+#-----|                       4: (Parameters)
+#   10|                         0: [Parameter] a0
+#   10|                       5: [BlockStmt] { ... }
+#   10|                         0: [ReturnStmt] return ...
+#   10|                           0: [MethodAccess] setTest0$private(...)
+#   10|                             -1: [VarAccess] this.<dispatchReceiver>
+#   10|                               -1: [ThisAccess] this
+#   10|                             0: [VarAccess] a0
+#   10|                   -3: [TypeAccess] KMutableProperty0<LateInit>
+#   10|                     0: [TypeAccess] LateInit
+#   10|                   0: [ThisAccess] this
+#   10|               1: [BlockStmt] { ... }
+#   13|         2: [LocalVariableDeclStmt] var ...;
+#   13|           1: [LocalVariableDeclExpr] test1
+#   14|         3: [ExprStmt] <Expr>;
+#   14|           0: [MethodAccess] f(...)
+#   14|             -1: [VarAccess] test1
diff --git a/java/ql/test/kotlin/library-tests/lateinit/PrintAst.qlref b/java/ql/test/kotlin/library-tests/lateinit/PrintAst.qlref
@@ -0,0 +1 @@
+semmle/code/java/PrintAst.ql
diff --git a/java/ql/test/kotlin/library-tests/lateinit/test.expected b/java/ql/test/kotlin/library-tests/lateinit/test.expected
@@ -0,0 +1,8 @@
+| test.kt:4:15:4:26 | println(...) | file://<external>/ConsoleKt.class:0:0:0:0 | println |
+| test.kt:9:9:9:13 | getTest0$private(...) | test.kt:2:22:2:40 | getTest0$private |
+| test.kt:9:15:9:17 | f(...) | test.kt:4:5:4:26 | f |
+| test.kt:10:13:10:23 | get(...) | test.kt:10:13:10:23 | get |
+| test.kt:10:13:10:23 | getTest0$private(...) | test.kt:2:22:2:40 | getTest0$private |
+| test.kt:10:13:10:23 | setTest0$private(...) | test.kt:2:22:2:40 | setTest0$private |
+| test.kt:10:25:10:37 | isInitialized(...) | file://<external>/LateinitKt.class:0:0:0:0 | isInitialized |
+| test.kt:14:15:14:17 | f(...) | test.kt:4:5:4:26 | f |
diff --git a/java/ql/test/kotlin/library-tests/lateinit/test.kt b/java/ql/test/kotlin/library-tests/lateinit/test.kt
@@ -0,0 +1,16 @@
+public class LateInit {
+    private lateinit var test0: LateInit
+
+    fun f() = println("a")
+
+    fun init() = LateInit()
+
+    fun fn() {
+        test0.f()                           // This is preceded by a null-check and a throw in bytecode, in IR it's a simple call
+        if (this::test0.isInitialized) {    // This is converted to a null-check in bytecode, in IR it's a call to `LateinitKt.isInitialized`
+        }
+
+        lateinit var test1: LateInit
+        test1.f()                           // This is replaced by `Intrinsics.throwUninitializedPropertyAccessException` in bytecode, in IR it's a simple call
+    }
+}
diff --git a/java/ql/test/kotlin/library-tests/lateinit/test.ql b/java/ql/test/kotlin/library-tests/lateinit/test.ql
@@ -0,0 +1,13 @@
+import java
+
+class MethodLocation extends Method {
+  override predicate hasLocationInfo(string path, int sl, int sc, int el, int ec) {
+    exists(string fullPath | super.hasLocationInfo(fullPath, sl, sc, el, ec) |
+      if exists(this.getFile().getRelativePath())
+      then path = fullPath
+      else path = fullPath.regexpReplaceAll(".*/", "<external>/")
+    )
+  }
+}
+
+query predicate calls(MethodAccess ma, Method m) { ma.getMethod() = m }
diff --git a/java/ql/test/kotlin/library-tests/modifiers/modifiers.expected b/java/ql/test/kotlin/library-tests/modifiers/modifiers.expected
@@ -45,3 +45,13 @@
 | modifiers.kt:27:12:27:49 | fn5 | Method | inline |
 | modifiers.kt:27:12:27:49 | fn5 | Method | public |
 | modifiers.kt:27:20:27:44 | f | Parameter | crossinline |
+| modifiers.kt:30:1:36:1 | LateInit | Class | final |
+| modifiers.kt:30:1:36:1 | LateInit | Class | public |
+| modifiers.kt:30:8:36:1 | LateInit | Constructor | public |
+| modifiers.kt:31:5:31:40 | test0 | Field | private |
+| modifiers.kt:31:5:31:40 | test0 | Property | lateinit |
+| modifiers.kt:31:5:31:40 | test0 | Property | private |
+| modifiers.kt:31:22:31:40 | getTest0$private | Method | private |
+| modifiers.kt:31:22:31:40 | setTest0$private | Method | private |
+| modifiers.kt:33:5:35:5 | fn | Method | public |
+| modifiers.kt:34:9:34:36 | LateInit test1 | LocalVariableDecl | lateinit |
diff --git a/java/ql/test/kotlin/library-tests/modifiers/modifiers.kt b/java/ql/test/kotlin/library-tests/modifiers/modifiers.kt
@@ -26,3 +26,11 @@ open class X {
     inline fun fn4(noinline f: () -> Unit) { }
     inline fun fn5(crossinline f: () -> Unit) { }
 }
+
+public class LateInit {
+    private lateinit var test0: LateInit
+
+    fun fn() {
+        lateinit var test1: LateInit
+    }
+}
diff --git a/java/ql/test/kotlin/library-tests/properties/properties.expected b/java/ql/test/kotlin/library-tests/properties/properties.expected
@@ -41,7 +41,7 @@ fieldDeclarations
 | properties.kt:28:5:29:22 | overrideGetter | properties.kt:29:13:29:22 | getOverrideGetter | properties.kt:28:5:29:22 | setOverrideGetter | properties.kt:28:5:29:22 | overrideGetter | public |
 | properties.kt:30:5:31:29 | overrideGetterUseField | properties.kt:31:13:31:29 | getOverrideGetterUseField | properties.kt:30:5:31:29 | setOverrideGetterUseField | properties.kt:30:5:31:29 | overrideGetterUseField | public |
 | properties.kt:32:5:33:29 | useField | properties.kt:33:13:33:29 | getUseField | file://:0:0:0:0 | <none> | properties.kt:32:5:33:29 | useField | public |
-| properties.kt:34:5:34:36 | lateInitVar | properties.kt:34:14:34:36 | getLateInitVar | properties.kt:34:14:34:36 | setLateInitVar | properties.kt:34:5:34:36 | lateInitVar | public |
+| properties.kt:34:5:34:36 | lateInitVar | properties.kt:34:14:34:36 | getLateInitVar | properties.kt:34:14:34:36 | setLateInitVar | properties.kt:34:5:34:36 | lateInitVar | lateinit, public |
 | properties.kt:35:5:35:32 | privateProp | properties.kt:35:13:35:32 | getPrivateProp$private | file://:0:0:0:0 | <none> | properties.kt:35:5:35:32 | privateProp | private |
 | properties.kt:36:5:36:36 | protectedProp | properties.kt:36:15:36:36 | getProtectedProp | file://:0:0:0:0 | <none> | properties.kt:36:5:36:36 | protectedProp | protected |
 | properties.kt:37:5:37:30 | publicProp | properties.kt:37:12:37:30 | getPublicProp | file://:0:0:0:0 | <none> | properties.kt:37:5:37:30 | publicProp | public |

Original file line number	Diff line number	Diff line change
`@@ -1251,6 +1251,10 @@ open class KotlinFileExtractor(`
`1251`	`1251`	`}`
`1252`	`1252`
`1253`	`1253`	`extractVisibility(p, id, p.visibility)`
	`1254`	`+`
	`1255`	`+ if (p.isLateinit) {`
	`1256`	`+ addModifiers(id, "lateinit")`
	`1257`	`+ }`
`1254`	`1258`	`}`
`1255`	`1259`	`}`
`1256`	`1260`	`}`
`@@ -1406,6 +1410,9 @@ open class KotlinFileExtractor(`
`1406`	`1410`	`if (!v.isVar) {`
`1407`	`1411`	`addModifiers(varId, "final")`
`1408`	`1412`	`}`
	`1413`	`+ if (v.isLateinit) {`
	`1414`	`+ addModifiers(varId, "lateinit")`
	`1415`	`+ }`
`1409`	`1416`	`}`
`1410`	`1417`	`}`
`1411`	`1418`