Merge pull request #22492 from aschackmull/csharp/foreach-rename

C#: Rename ForeachStmt to ForEachStmt.

Author: aschackmull

csharp/ql/consistency-queries/SsaConsistency.ql

@@ -10,7 +10,7 @@ query predicate localDeclWithSsaDef(LocalVariableDeclExpr d) {
   exists(SsaExplicitWrite def |
     d = def.getDefinition().(AssignableDefinitions::LocalVariableDefinition).getDeclaration()
   |
-    not d = any(ForeachStmt fs).getVariableDeclExpr() and
+    not d = any(ForEachStmt fs).getVariableDeclExpr() and
     not d = any(SpecificCatchClause scc).getVariableDeclExpr() and
     not d.getVariable().getType() instanceof Struct and
     not d instanceof PatternExpr and

csharp/ql/lib/Linq/Helpers.qll

@@ -8,13 +8,13 @@ private import semmle.code.csharp.frameworks.system.collections.Generic as Gener
 private import semmle.code.csharp.frameworks.system.Collections as Collections
 
 //#################### PREDICATES ####################
-private Stmt firstStmt(ForeachStmt fes) {
+private Stmt firstStmt(ForEachStmt fes) {
   if fes.getBody() instanceof BlockStmt
   then result = fes.getBody().(BlockStmt).getStmt(0)
   else result = fes.getBody()
 }
 
-private int numStmts(ForeachStmt fes) {
+private int numStmts(ForEachStmt fes) {
   if fes.getBody() instanceof BlockStmt
   then result = count(fes.getBody().(BlockStmt).getAStmt())
   else result = 1
@@ -53,12 +53,15 @@ predicate isIEnumerableType(ValueOrRefType t) {
   )
 }
 
+/** DEPRECATED: Use `ForEachStmtGenericEnumerable` instead. */
+deprecated class ForeachStmtGenericEnumerable = ForEachStmtGenericEnumerable;
+
 /**
  * A class of foreach statements where the iterable expression
  * supports the use of the LINQ extension methods on `IEnumerable<T>`.
  */
-class ForeachStmtGenericEnumerable extends ForeachStmt {
-  ForeachStmtGenericEnumerable() {
+class ForEachStmtGenericEnumerable extends ForEachStmt {
+  ForEachStmtGenericEnumerable() {
     exists(ValueOrRefType t | t = this.getIterableExpr().getType() |
       t.getABaseType*().getUnboundDeclaration() instanceof
         GenericCollections::SystemCollectionsGenericIEnumerableTInterface or
@@ -67,12 +70,15 @@ class ForeachStmtGenericEnumerable extends ForeachStmt {
   }
 }
 
+/** DEPRECATED: Use `ForEachStmtEnumerable` instead. */
+deprecated class ForeachStmtEnumerable = ForEachStmtEnumerable;
+
 /**
  * A class of foreach statements where the iterable expression
  * supports the use of the LINQ extension methods on `IEnumerable`.
  */
-class ForeachStmtEnumerable extends ForeachStmt {
-  ForeachStmtEnumerable() {
+class ForEachStmtEnumerable extends ForEachStmt {
+  ForEachStmtEnumerable() {
     exists(ValueOrRefType t | t = this.getIterableExpr().getType() |
       t.getABaseType*() instanceof Collections::SystemCollectionsIEnumerableInterface or
       t.(ArrayType).getRank() = 1
@@ -82,11 +88,11 @@ class ForeachStmtEnumerable extends ForeachStmt {
 
 /**
  * Holds if `foreach` statement `fes` could be converted to a `.All()` call.
- * That is, the `ForeachStmt` contains a single `if` with a condition that
+ * That is, the `ForEachStmt` contains a single `if` with a condition that
  * accesses the loop variable and with a body that assigns `false` to a variable
  * and `break`s out of the `foreach`.
  */
-predicate missedAllOpportunity(ForeachStmtGenericEnumerable fes) {
+predicate missedAllOpportunity(ForEachStmtGenericEnumerable fes) {
   exists(IfStmt is |
     // The loop contains an if statement with no else case, and nothing else.
     is = firstStmt(fes) and
@@ -110,7 +116,7 @@ predicate missedAllOpportunity(ForeachStmtGenericEnumerable fes) {
  * block, the access is a cast, and the first statement is a
  * local variable declaration statement `s`.
  */
-predicate missedCastOpportunity(ForeachStmtEnumerable fes, LocalVariableDeclStmt s) {
+predicate missedCastOpportunity(ForEachStmtEnumerable fes, LocalVariableDeclStmt s) {
   s = firstStmt(fes) and
   forex(VariableAccess va | va = fes.getVariable().getAnAccess() |
     va = s.getAVariableDeclExpr().getAChildExpr*()
@@ -127,7 +133,7 @@ predicate missedCastOpportunity(ForeachStmtEnumerable fes, LocalVariableDeclStmt
  * block, the access is a cast with the `as` operator, and the first statement
  * is a local variable declaration statement `s`.
  */
-predicate missedOfTypeOpportunity(ForeachStmtEnumerable fes, LocalVariableDeclStmt s) {
+predicate missedOfTypeOpportunity(ForEachStmtEnumerable fes, LocalVariableDeclStmt s) {
   s = firstStmt(fes) and
   forex(VariableAccess va | va = fes.getVariable().getAnAccess() |
     va = s.getAVariableDeclExpr().getAChildExpr*()
@@ -145,7 +151,7 @@ predicate missedOfTypeOpportunity(ForeachStmtEnumerable fes, LocalVariableDeclSt
  * local variable declaration statement `s`, and the initializer does not
  * contain an `await` expression (since `Select` does not support async lambdas).
  */
-predicate missedSelectOpportunity(ForeachStmtGenericEnumerable fes, LocalVariableDeclStmt s) {
+predicate missedSelectOpportunity(ForEachStmtGenericEnumerable fes, LocalVariableDeclStmt s) {
   s = firstStmt(fes) and
   forex(VariableAccess va | va = fes.getVariable().getAnAccess() |
     va = s.getAVariableDeclExpr().getAChildExpr*()
@@ -160,7 +166,7 @@ predicate missedSelectOpportunity(ForeachStmtGenericEnumerable fes, LocalVariabl
  * variable, and the body of the `if` is either a `continue` or there's nothing
  * else in the loop than the `if`.
  */
-predicate missedWhereOpportunity(ForeachStmtGenericEnumerable fes, IfStmt is) {
+predicate missedWhereOpportunity(ForEachStmtGenericEnumerable fes, IfStmt is) {
   // The very first thing the foreach loop does is test its iteration variable.
   is = firstStmt(fes) and
   exists(VariableAccess va |

csharp/ql/lib/semmle/code/csharp/Stmt.qll

@@ -305,7 +305,7 @@ class DefaultCase extends CaseStmt, LabeledStmt {
  *
  * Either a `while` statement (`WhileStmt`), a `do`-`while` statement
  * (`DoStmt`), a `for` statement (`ForStmt`), or a `foreach` statement
- * (`ForeachStmt`).
+ * (`ForEachStmt`).
  */
 class LoopStmt extends Stmt, @loop_stmt {
   /** Gets the body of this loop statement. */
@@ -422,6 +422,9 @@ class ForStmt extends LoopStmt, @for_stmt {
   override string getAPrimaryQlClass() { result = "ForStmt" }
 }
 
+/** DEPRECATED: Use `ForEachStmt` instead. */
+deprecated class ForeachStmt = ForEachStmt;
+
 /**
  * A `foreach` loop, for example
  *
@@ -431,7 +434,7 @@ class ForStmt extends LoopStmt, @for_stmt {
  * }
  * ```
  */
-class ForeachStmt extends LoopStmt, @foreach_stmt {
+class ForEachStmt extends LoopStmt, @foreach_stmt {
   /**
    * Gets the local variable of this `foreach` loop, if any.
    *
@@ -564,7 +567,7 @@ class ForeachStmt extends LoopStmt, @foreach_stmt {
 
   override string toString() { result = "foreach (... ... in ...) ..." }
 
-  override string getAPrimaryQlClass() { result = "ForeachStmt" }
+  override string getAPrimaryQlClass() { result = "ForEachStmt" }
 }
 
 /**

csharp/ql/lib/semmle/code/csharp/controlflow/internal/ControlFlowGraph.qll

@@ -188,9 +188,9 @@ module Ast implements AstSig<Location> {
     AstNode getUpdate(int index) { result = super.getUpdate(index) }
   }
 
-  final private class FinalForeachStmt = CS::ForeachStmt;
+  final private class FinalForEachStmt = CS::ForEachStmt;
 
-  class ForEachStmt extends FinalForeachStmt {
+  class ForEachStmt extends FinalForEachStmt {
     Expr getVariable() {
       result = this.getVariableDeclExpr() or result = this.getVariableDeclTuple()
     }

csharp/ql/lib/semmle/code/csharp/dataflow/Nullness.qll

@@ -116,7 +116,7 @@ private predicate nonNullDef(SsaExplicitWrite def) {
       any(AssignableDefinitions::LocalVariableDefinition d |
         d.getExpr() = any(SpecificCatchClause scc).getVariableDeclExpr()
         or
-        d.getExpr() = any(ForeachStmt fs).getAVariableDeclExpr()
+        d.getExpr() = any(ForEachStmt fs).getAVariableDeclExpr()
       )
   )
 }
@@ -306,7 +306,7 @@ class Dereference extends G::DereferenceableExpr {
       or
       this = any(LockStmt stmt).getExpr()
       or
-      this = any(ForeachStmt stmt).getIterableExpr()
+      this = any(ForEachStmt stmt).getIterableExpr()
       or
       exists(ExtensionMethodCall emc, Parameter p |
         this = emc.getArgumentForParameter(p) and

csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowPrivate.qll

@@ -2207,7 +2207,7 @@ private predicate readContentStep(Node node1, Content c, Node node2) {
   c instanceof ElementContent
   or
   exists(
-    ForeachStmt fs, SsaExplicitWrite def, AssignableDefinitions::LocalVariableDefinition defTo
+    ForEachStmt fs, SsaExplicitWrite def, AssignableDefinitions::LocalVariableDefinition defTo
   |
     node1.asExpr() = fs.getIterableExpr() and
     defTo.getDeclaration() = fs.getVariableDeclExpr() and

csharp/ql/lib/semmle/code/csharp/exprs/Expr.qll

@@ -1107,7 +1107,7 @@ class QualifiableExpr extends Expr, @qualifiable_expr {
 private Expr getAnAssignOrForeachChild() {
   result = any(AssignExpr e).getLeftOperand()
   or
-  result = any(ForeachStmt fs).getVariableDeclTuple()
+  result = any(ForEachStmt fs).getVariableDeclTuple()
   or
   result = getAnAssignOrForeachChild().getAChildExpr()
 }

csharp/ql/src/API Abuse/NoDisposeCallOnLocalIDisposable.ql

@@ -59,7 +59,7 @@ module DisposeCallOnLocalIDisposableConfig implements DataFlow::ConfigSig {
       exists(UsingStmt us | us.getAnExpr() = e)
       or
       // Foreach calls Dispose
-      exists(ForeachStmt fs | fs.getIterableExpr() = e)
+      exists(ForEachStmt fs | fs.getIterableExpr() = e)
       or
       // As are disposables on which the Dispose method is called explicitly
       exists(MethodCall mc |

csharp/ql/src/Dead Code/DeadStoreOfLocal.ql

@@ -31,7 +31,7 @@ class RelevantDefinition extends AssignableDefinition {
       any(LocalVariableDeclExpr lvde |
         lvde = any(SpecificCatchClause scc).getVariableDeclExpr()
         or
-        lvde = any(ForeachStmt fs).getVariableDeclExpr() and
+        lvde = any(ForEachStmt fs).getVariableDeclExpr() and
         not lvde.getName() = "_"
       )
     or

csharp/ql/src/Language Abuse/ForeachCapture.ql

@@ -23,17 +23,17 @@ predicate lambdaCaptures(AnonymousFunctionExpr lambda, Variable v) {
   exists(VariableAccess va | va.getEnclosingCallable() = lambda | va.getTarget() = v)
 }
 
-predicate lambdaCapturesLoopVariable(AnonymousFunctionExpr lambda, ForeachStmt loop, Variable v) {
+predicate lambdaCapturesLoopVariable(AnonymousFunctionExpr lambda, ForEachStmt loop, Variable v) {
   lambdaCaptures(lambda, v) and
-  inForeachStmtBody(loop, lambda) and
+  inForEachStmtBody(loop, lambda) and
   loop.getVariable() = v
 }
 
-predicate inForeachStmtBody(ForeachStmt loop, Element e) {
+predicate inForEachStmtBody(ForEachStmt loop, Element e) {
   e = loop.getBody()
   or
   exists(Element mid |
-    inForeachStmtBody(loop, mid) and
+    inForEachStmtBody(loop, mid) and
     e = mid.getAChild()
   )
 }
@@ -53,7 +53,7 @@ module LambdaDataFlow {
     exists(DataFlow::Node sink | flow(DataFlow::exprNode(lambda), sink) |
       storage = getAssignmentTarget(sink.asExpr())
     ) and
-    exists(ForeachStmt loop | lambdaCapturesLoopVariable(lambda, loop, loopVar) |
+    exists(ForEachStmt loop | lambdaCapturesLoopVariable(lambda, loop, loopVar) |
       not declaredInsideLoop(loop, storage)
     )
   }
@@ -103,9 +103,9 @@ Element getCollectionAssignmentTarget(Expr e) {
 }
 
 // Variable v is declared inside the loop body
-predicate declaredInsideLoop(ForeachStmt loop, LocalVariable v) {
+predicate declaredInsideLoop(ForEachStmt loop, LocalVariable v) {
   exists(LocalVariableDeclStmt decl | decl.getVariableDeclExpr(_).getVariable() = v |
-    inForeachStmtBody(loop, decl)
+    inForEachStmtBody(loop, decl)
   )
 }