Swift: extract variables as children of ForEachStmt

Author: Paolo Tranquilli

Diff for: swift/extractor/translators/StmtTranslator.cpp

@@ -77,6 +77,17 @@ codeql::ForEachStmt StmtTranslator::translateForEachStmt(const swift::ForEachStm
   entry.iteratorVar = dispatcher.fetchLabel(stmt.getIteratorVar());
   entry.where = dispatcher.fetchOptionalLabel(stmt.getWhere());
   entry.nextCall = dispatcher.fetchOptionalLabel(stmt.getNextCall());
+  auto add_variable = [&](swift::VarDecl* var) {
+    entry.variables.push_back(dispatcher.fetchLabel(var));
+  };
+  if (auto pattern = stmt.getPattern()) {
+    pattern->forEachVariable(add_variable);
+  }
+  if (auto iteratorVar = stmt.getIteratorVar()) {
+    for (auto i = 0u; i < iteratorVar->getNumPatternEntries(); ++i) {
+      iteratorVar->getPattern(i)->forEachVariable(add_variable);
+    }
+  }
   return entry;
 }
 

Diff for: swift/ql/.generated.list

@@ -0,0 +1,3 @@
+| for.swift:4:5:6:5 | for ... in ... where ... { ... } | hasLabel: | no | getNumberOfVariables: | 2 | getPattern: | for.swift:4:9:4:9 | x | hasWhere: | yes | hasIteratorVar: | yes | hasNextCall: | yes | getBody: | for.swift:4:32:6:5 | { ... } |
+| for.swift:7:5:9:5 | for ... in ... { ... } | hasLabel: | no | getNumberOfVariables: | 2 | getPattern: | for.swift:7:9:7:9 | s | hasWhere: | no | hasIteratorVar: | yes | hasNextCall: | yes | getBody: | for.swift:7:23:9:5 | { ... } |
+| for.swift:13:5:17:5 | for ... in ... { ... } | hasLabel: | no | getNumberOfVariables: | 1 | getPattern: | for.swift:13:9:13:9 | x | hasWhere: | no | hasIteratorVar: | no | hasNextCall: | no | getBody: | for.swift:13:32:17:5 | { ... } |

Diff for: swift/ql/.gitattributes

@@ -0,0 +1,2 @@
+| for.swift:4:5:6:5 | for ... in ... where ... { ... } | file://:0:0:0:0 | var ... = ... |
+| for.swift:7:5:9:5 | for ... in ... { ... } | file://:0:0:0:0 | var ... = ... |

Diff for: swift/ql/lib/codeql/swift/elements/stmt/ForEachStmt.qll

@@ -0,0 +1,2 @@
+| for.swift:4:5:6:5 | for ... in ... where ... { ... } | for.swift:4:5:4:5 | call to next() |
+| for.swift:7:5:9:5 | for ... in ... { ... } | for.swift:7:5:7:5 | call to next() |

Diff for: swift/ql/lib/codeql/swift/generated/ParentChild.qll

@@ -0,0 +1,5 @@
+| for.swift:4:5:6:5 | for ... in ... where ... { ... } | 0 | for.swift:4:9:4:9 | x |
+| for.swift:4:5:6:5 | for ... in ... where ... { ... } | 1 | for.swift:4:14:4:14 | $x$generator |
+| for.swift:7:5:9:5 | for ... in ... { ... } | 0 | for.swift:7:9:7:9 | s |
+| for.swift:7:5:9:5 | for ... in ... { ... } | 1 | for.swift:7:14:7:14 | $s$generator |
+| for.swift:13:5:17:5 | for ... in ... { ... } | 0 | for.swift:13:9:13:9 | x |

Diff for: swift/ql/lib/codeql/swift/generated/Raw.qll

@@ -0,0 +1 @@
+| for.swift:4:5:6:5 | for ... in ... where ... { ... } | for.swift:4:25:4:30 | ... .!=(_:_:) ... |

Diff for: swift/ql/lib/codeql/swift/generated/stmt/ForEachStmt.qll

@@ -0,0 +1,19 @@
+struct S {}
+
+func test_sequence(_ ints: [Int], _ elements: [S]) {
+    for x in ints where x != 0 {
+        print(x)
+    }
+    for s in elements {
+      print(s)
+    }
+}
+
+func test_variadic_pack<each T>(_ array: repeat [each T]) -> Bool {
+    for x in repeat each array {
+        if !x.isEmpty {
+            return false
+        }
+    }
+    return true
+}

Diff for: swift/ql/lib/swift.dbscheme

@@ -187,6 +187,7 @@ methodlookup.swift:
 #   40|                 getBase(): [TypeExpr] Bar.Type
 #   40|                   getTypeRepr(): [TypeRepr] Bar
 #   40|                 getMethodRef(): [DeclRefExpr] staticMethod()
+#   33|         getExpr().getFullyConverted(): [FunctionConversionExpr] (@isolated(any) () async -> ()) ...
 #   33| [NilLiteralExpr] nil
 #   38| [Comment] // Bar.instanceMethod(bar2)() // error: actor-isolated instance method 'instanceMethod()' can not be referenced from a non-isolated context
 #   38| 
@@ -262,6 +263,7 @@ methodlookup.swift:
 #   51|                 getMethodRef(): [DeclRefExpr] staticMethod()
 #   51|                 getMethodRef().getFullyConverted(): [FunctionConversionExpr] ((Baz.Type) -> @MainActor () -> ()) ...
 #   51|             getElement(5).getFullyConverted(): [AwaitExpr] await ...
+#   43|         getExpr().getFullyConverted(): [FunctionConversionExpr] (@isolated(any) () async -> ()) ...
 #   43| [NilLiteralExpr] nil
 #   47| [Comment] // DotSyntaxCallExpr
 #   47| 

Diff for: swift/ql/test/extractor-tests/generated/stmt/ForEachStmt/ForEachStmt.expected

@@ -1016,6 +1016,7 @@ class DoStmt(LabeledStmt):
     body: BraceStmt | child
 
 class ForEachStmt(LabeledStmt):
+    variables: list[VarDecl] | child
     pattern: Pattern | child
     where: optional[Expr] | child
     iteratorVar: optional[PatternBindingDecl] | child