Merge pull request github#24 from github/kotlin-expressions-1

tamasvajk · web-flow · commit f52b1e45cf47 · 2021-09-22T09:28:23.000+02:00
Extract break/continue/throw
diff --git a/java/kotlin-extractor/src/main/kotlin/KotlinExtractorExtension.kt b/java/kotlin-extractor/src/main/kotlin/KotlinExtractorExtension.kt
@@ -634,6 +634,8 @@ class KotlinFileExtractor(val logger: FileLogger, val tw: FileTrapWriter, val fi
         }
     }
 
+    private val loopIdMap: MutableMap<IrLoop, Label<out DbKtloopstmt>> = mutableMapOf()
+
     fun extractExpression(e: IrExpression, callable: Label<out DbCallable>, parent: Label<out DbExprparent>, idx: Int) {
         when(e) {
             is IrCall -> extractCall(e, callable, parent, idx)
@@ -716,22 +718,42 @@ class KotlinFileExtractor(val logger: FileLogger, val tw: FileTrapWriter, val fi
 
                 extractExpression(e.value, callable, id, 1)
             }
+            is IrThrow -> {
+                val id = tw.getFreshIdLabel<DbThrowstmt>()
+                val locId = tw.getLocation(e)
+                tw.writeStmts_throwstmt(id, parent, idx, callable)
+                tw.writeHasLocation(id, locId)
+                extractExpression(e.value, callable, id, 0)
+            }
+            is IrBreak -> {
+                val id = tw.getFreshIdLabel<DbBreakstmt>()
+                tw.writeStmts_breakstmt(id, parent, idx, callable)
+                extractBreakContinue(e, id)
+            }
+            is IrContinue -> {
+                val id = tw.getFreshIdLabel<DbContinuestmt>()
+                tw.writeStmts_continuestmt(id, parent, idx, callable)
+                extractBreakContinue(e, id)
+            }
             is IrReturn -> {
                 val id = tw.getFreshIdLabel<DbReturnstmt>()
                 val locId = tw.getLocation(e)
                 tw.writeStmts_returnstmt(id, parent, idx, callable)
                 tw.writeHasLocation(id, locId)
                 extractExpression(e.value, callable, id, 0)
-            } is IrContainerExpression -> {
+            }
+            is IrContainerExpression -> {
                 val id = tw.getFreshIdLabel<DbBlock>()
                 val locId = tw.getLocation(e)
                 tw.writeStmts_block(id, parent, idx, callable)
                 tw.writeHasLocation(id, locId)
                 e.statements.forEachIndexed { i, s ->
                     extractStatement(s, callable, id, i)
                 }
-            } is IrWhileLoop -> {
+            }
+            is IrWhileLoop -> {
                 val id = tw.getFreshIdLabel<DbWhilestmt>()
+                loopIdMap[e] = id
                 val locId = tw.getLocation(e)
                 tw.writeStmts_whilestmt(id, parent, idx, callable)
                 tw.writeHasLocation(id, locId)
@@ -740,8 +762,11 @@ class KotlinFileExtractor(val logger: FileLogger, val tw: FileTrapWriter, val fi
                 if(body != null) {
                     extractExpression(body, callable, id, 1)
                 }
-            } is IrDoWhileLoop -> {
+                loopIdMap.remove(e)
+            }
+            is IrDoWhileLoop -> {
                 val id = tw.getFreshIdLabel<DbDostmt>()
+                loopIdMap[e] = id
                 val locId = tw.getLocation(e)
                 tw.writeStmts_dostmt(id, parent, idx, callable)
                 tw.writeHasLocation(id, locId)
@@ -750,7 +775,9 @@ class KotlinFileExtractor(val logger: FileLogger, val tw: FileTrapWriter, val fi
                 if(body != null) {
                     extractExpression(body, callable, id, 1)
                 }
-            } is IrWhen -> {
+                loopIdMap.remove(e)
+            }
+            is IrWhen -> {
                 val id = tw.getFreshIdLabel<DbWhenexpr>()
                 val typeId = useType(e.type)
                 val locId = tw.getLocation(e)
@@ -784,5 +811,27 @@ class KotlinFileExtractor(val logger: FileLogger, val tw: FileTrapWriter, val fi
             }
         }
     }
+
+    private fun extractBreakContinue(
+        e: IrBreakContinue,
+        id: Label<out DbBreakcontinuestmt>
+    ) {
+        val locId = tw.getLocation(e)
+        @Suppress("UNCHECKED_CAST")
+        tw.writeHasLocation(id as Label<out DbLocatable>, locId)
+        val label = e.label
+        if (label != null) {
+            @Suppress("UNCHECKED_CAST")
+            tw.writeNamestrings(label, "", id as Label<out DbNamedexprorstmt>)
+        }
+
+        val loopId = loopIdMap[e.loop]
+        if (loopId == null) {
+            logger.warnElement(Severity.ErrorSevere, "Missing break/continue target", e)
+            return
+        }
+
+        tw.writeKtBreakContinueTarget(id, loopId)
+    }
 }
 
diff --git a/java/ql/lib/config/semmlecode.dbscheme b/java/ql/lib/config/semmlecode.dbscheme
@@ -1046,4 +1046,15 @@ ktCommentSectionSubjectNames(
 ktCommentOwner(
   int id: @ktcomment ref,
   int owner: @top ref
+)
+
+@breakcontinuestmt = @breakstmt
+                   | @continuestmt;
+
+@ktloopstmt = @whilestmt
+            | @dostmt;
+
+ktBreakContinueTarget(
+  unique int id: @breakcontinuestmt ref,
+  int target: @ktloopstmt ref
 )
diff --git a/java/ql/lib/semmle/code/java/Statement.qll b/java/ql/lib/semmle/code/java/Statement.qll
@@ -898,3 +898,27 @@ class SuperConstructorInvocationStmt extends Stmt, ConstructorCall, @superconstr
 
   override string getAPrimaryQlClass() { result = "SuperConstructorInvocationStmt" }
 }
+
+/** A Kotlin loop statement. */
+class KtLoopStmt extends Stmt, @ktloopstmt {
+  KtLoopStmt() {
+    this instanceof WhileStmt or
+    this instanceof DoStmt
+  }
+}
+
+/** A Kotlin `break` or `continue` statement. */
+abstract class KtBreakContinueStmt extends Stmt, @breakcontinuestmt {
+  KtLoopStmt loop;
+
+  KtBreakContinueStmt() { ktBreakContinueTarget(this, loop) }
+
+  /** Gets the target loop statement of this `break`. */
+  KtLoopStmt getLoopStmt() { result = loop }
+}
+
+/** A Kotlin `break` statement. */
+class KtBreakStmt extends BreakStmt, KtBreakContinueStmt { }
+
+/** A Kotlin `continue` statement. */
+class KtContinueStmt extends ContinueStmt, KtBreakContinueStmt { }
diff --git a/java/ql/test/kotlin/library-tests/stmts/exprs.expected b/java/ql/test/kotlin/library-tests/stmts/exprs.expected
@@ -43,3 +43,16 @@
 | stmts.kt:19:12:19:12 | x | VarAccess |
 | stmts.kt:19:12:19:16 | ... + ... | AddExpr |
 | stmts.kt:19:16:19:16 | y | VarAccess |
+| stmts.kt:23:18:23:18 | x | VarAccess |
+| stmts.kt:23:18:23:24 | ... < ... | LTExpr |
+| stmts.kt:23:22:23:24 | 100 | IntegerLiteral |
+| stmts.kt:25:13:25:33 | when ... | WhenExpr |
+| stmts.kt:25:17:25:17 | x | VarAccess |
+| stmts.kt:25:17:25:21 | ... > ... | GTExpr |
+| stmts.kt:25:21:25:21 | y | VarAccess |
+| stmts.kt:26:18:26:18 | y | VarAccess |
+| stmts.kt:26:18:26:24 | ... > ... | GTExpr |
+| stmts.kt:26:22:26:24 | 100 | IntegerLiteral |
+| stmts.kt:28:11:28:11 | x | VarAccess |
+| stmts.kt:28:11:28:15 | ... > ... | GTExpr |
+| stmts.kt:28:15:28:15 | y | VarAccess |
diff --git a/java/ql/test/kotlin/library-tests/stmts/loops.expected b/java/ql/test/kotlin/library-tests/stmts/loops.expected
@@ -0,0 +1,7 @@
+breakLabel
+| stmts.kt:25:24:25:33 | break | loop |
+continueLabel
+breakTarget
+| stmts.kt:25:24:25:33 | break | stmts.kt:23:11:27:5 | while (...) |
+continueTarget
+| stmts.kt:29:9:29:16 | continue | stmts.kt:28:5:29:16 | while (...) |
diff --git a/java/ql/test/kotlin/library-tests/stmts/loops.ql b/java/ql/test/kotlin/library-tests/stmts/loops.ql
@@ -0,0 +1,9 @@
+import java
+
+query predicate breakLabel(BreakStmt s, string label) { s.getLabel() = label }
+
+query predicate continueLabel(ContinueStmt s, string label) { s.getLabel() = label }
+
+query predicate breakTarget(KtBreakStmt s, KtLoopStmt l) { s.getLoopStmt() = l }
+
+query predicate continueTarget(KtContinueStmt s, KtLoopStmt l) { s.getLoopStmt() = l }
diff --git a/java/ql/test/kotlin/library-tests/stmts/stmts.expected b/java/ql/test/kotlin/library-tests/stmts/stmts.expected
@@ -14,3 +14,12 @@
 | stmts.kt:17:35:17:43 | { ... } | BlockStmt |
 | stmts.kt:17:50:17:58 | { ... } | BlockStmt |
 | stmts.kt:19:5:19:16 | return ... | ReturnStmt |
+| stmts.kt:22:27:30:1 | { ... } | BlockStmt |
+| stmts.kt:23:11:27:5 | while (...) | WhileStmt |
+| stmts.kt:23:27:27:5 | { ... } | BlockStmt |
+| stmts.kt:24:9:26:25 | do ... while (...) | DoStmt |
+| stmts.kt:24:9:26:25 | { ... } | BlockStmt |
+| stmts.kt:24:13:26:9 | { ... } | BlockStmt |
+| stmts.kt:25:24:25:33 | break | BreakStmt |
+| stmts.kt:28:5:29:16 | while (...) | WhileStmt |
+| stmts.kt:29:9:29:16 | continue | ContinueStmt |
diff --git a/java/ql/test/kotlin/library-tests/stmts/stmts.kt b/java/ql/test/kotlin/library-tests/stmts/stmts.kt
@@ -19,3 +19,12 @@ fun topLevelMethod(x: Int, y: Int): Int {
     return x + y
 }
 
+fun loops(x: Int, y: Int) {
+    loop@ while (x < 100) {
+        do  {
+            if (x > y) break@loop
+        } while (y > 100)
+    }
+    while(x > y)
+        continue
+}
