Skip to content

CFG: Rename ForeachStmt to ForEachStmt. #22489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aschackmull merged 1 commit into from
Sep 2, 2026
Merged

CFG: Rename ForeachStmt to ForEachStmt. #22489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion csharp/ql/lib/semmle/code/csharp/controlflow/internal/ControlFlowGraph.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@

final private class FinalForeachStmt = CS::ForeachStmt;

@owen-mc owen-mc Sep 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth renaming FinalForeachStmt and similar at the same time?

@aschackmull aschackmull Sep 2, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll do C# in a follow-up.


class ForeachStmt extends FinalForeachStmt {
class ForEachStmt extends FinalForeachStmt {
Expr getVariable() {
result = this.getVariableDeclExpr() or result = this.getVariableDeclTuple()
}
Expand Down
2 changes: 1 addition & 1 deletion java/ql/lib/semmle/code/java/ControlFlowGraph.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ private module Ast implements AstSig<Location> {

final private class FinalEnhancedForStmt = J::EnhancedForStmt;

class ForeachStmt extends FinalEnhancedForStmt {
class ForEachStmt extends FinalEnhancedForStmt {
Expr getVariable() { result = super.getVariable() }

Expr getCollection() { result = super.getExpr() }
Expand Down
6 changes: 3 additions & 3 deletions python/ql/lib/semmle/python/controlflow/internal/AstNodeImpl.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -657,10 +657,10 @@ module Ast implements AstSig<Py::Location> {
}

/** A for-each loop (`for x in iterable:`). */
class ForeachStmt extends LoopStmtImpl {
class ForEachStmt extends LoopStmtImpl {
private Py::For forStmt;

ForeachStmt() { this = TPyStmt(forStmt) }
ForEachStmt() { this = TPyStmt(forStmt) }

/** Gets the loop variable. */
Expr getVariable() { result.asExpr() = forStmt.getTarget() }
Expand Down Expand Up @@ -898,7 +898,7 @@ module Ast implements AstSig<Py::Location> {
AstNode getLoopElse(LoopStmt loop) {
result = loop.(WhileStmt).getElse()
or
result = loop.(ForeachStmt).getElse()
result = loop.(ForEachStmt).getElse()
}

/** An exception handler (`except` or `except*`). */
Expand Down
6 changes: 3 additions & 3 deletions ruby/ql/lib/codeql/ruby/controlflow/ControlFlowGraph.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,9 +295,9 @@ private module Ast implements AstSig<Location> {
AstNode getUpdate(int index) { none() }
}

// `ForExpr` would be a match for `ForeachStmt`, but it is desugared.
class ForeachStmt extends LoopStmt {
ForeachStmt() { none() }
// `ForExpr` would be a match for `ForEachStmt`, but it is desugared.
class ForEachStmt extends LoopStmt {
ForEachStmt() { none() }

Expr getVariable() { none() }

Expand Down
8 changes: 4 additions & 4 deletions shared/controlflow/codeql/controlflow/ControlFlowGraph.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ signature module AstSig<LocationSig Location> {
}

/** A for-loop that iterates over the elements of a collection. */
class ForeachStmt extends LoopStmt {
class ForEachStmt extends LoopStmt {
/** Gets the variable declaration of this `foreach` loop. */
Expr getVariable();

Expand Down Expand Up @@ -650,7 +650,7 @@ module Make0<LocationSig Location, AstSig<Location> Ast> {
any(Case case).getGuard() = n
)
or
any(ForeachStmt foreachstmt).getCollection() = n and kind.isEmptiness()
any(ForEachStmt foreachstmt).getCollection() = n and kind.isEmptiness()
or
kind.isMatching() and
(
Expand Down Expand Up @@ -1656,7 +1656,7 @@ module Make0<LocationSig Location, AstSig<Location> Ast> {
n2.isAfter(loopstmt)
)
or
exists(ForeachStmt foreachstmt |
exists(ForEachStmt foreachstmt |
n1.isBefore(foreachstmt) and
n2.isBefore(foreachstmt.getCollection())
or
Expand Down Expand Up @@ -2401,7 +2401,7 @@ module Make0<LocationSig Location, AstSig<Location> Ast> {
// allow for loop headers in foreach loops (they're checking emptiness on the iterator, not the collection)
not (
t instanceof DirectSuccessor and
node.isAdditional(any(ForeachStmt foreach), loopHeaderTag())
node.isAdditional(any(ForEachStmt foreach), loopHeaderTag())
) and
// allow for functions with multiple bodies
not exists(Callable c |
Expand Down
2 changes: 1 addition & 1 deletion unified/ql/lib/codeql/unified/internal/ControlFlowGraph.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ private module Ast implements AstSig<Location> {
AstNode getUpdate(int index) { none() }
}

class ForeachStmt extends LoopStmt instanceof U::ForEachStmt {
class ForEachStmt extends LoopStmt instanceof U::ForEachStmt {
override Stmt getBody() { result = U::ForEachStmt.super.getBody() }

// TODO support foreach guard
Expand Down
Loading