Skip to content
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

Introduce ASTHelpers.isSwitchDefault, and use it to burn down uses of CaseTree.getExpression, which is deprecated (with good reason!) #4673

Merged
merged 1 commit into from
Nov 15, 2024
Merged

Introduce ASTHelpers.isSwitchDefault, and use it to burn down uses of CaseTree.getExpression, which is deprecated (with good reason!) #4673

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
25 changes: 13 additions & 12 deletions check_api/src/main/java/com/google/errorprone/util/ASTHelpers.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2714,18 +2714,19 @@ private static boolean hasMatchingMethods(
}

public static Optional<? extends CaseTree> getSwitchDefault(SwitchTree switchTree) {
return switchTree.getCases().stream()
.filter(
(CaseTree c) -> {
if (!c.getExpressions().isEmpty()) {
return false;
}
List<? extends Tree> labels = c.getLabels();
return labels.isEmpty()
|| (labels.size() == 1
&& getOnlyElement(labels).getKind().name().equals("DEFAULT_CASE_LABEL"));
})
.findFirst();
return switchTree.getCases().stream().filter(c -> isSwitchDefault(c)).findFirst();
}

/** Returns whether {@code caseTree} is the default case of a switch statement. */
public static boolean isSwitchDefault(CaseTree caseTree) {
if (!caseTree.getExpressions().isEmpty()) {
return false;
}
List<? extends Tree> labels = caseTree.getLabels();
return labels.isEmpty()
|| (labels.size() == 1
// DEFAULT_CASE_LABEL is in Java 21, so we're stuck stringifying for now.
&& getOnlyElement(labels).getKind().name().equals("DEFAULT_CASE_LABEL"));
}

private static final Supplier<Name> NULL_MARKED_NAME =
Expand Down
3 changes: 2 additions & 1 deletion check_api/src/main/java/com/google/errorprone/util/Reachability.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import static com.google.common.base.MoreObjects.firstNonNull;
import static com.google.common.collect.Iterables.getLast;
import static com.google.errorprone.util.ASTHelpers.getSymbol;
import static com.google.errorprone.util.ASTHelpers.isSwitchDefault;
import static java.util.Objects.requireNonNull;

import com.google.errorprone.annotations.CanIgnoreReturnValue;
Expand Down Expand Up @@ -241,7 +242,7 @@ public Boolean visitSwitch(SwitchTree tree, Void unused) {
return true;
}
// (4)
if (tree.getCases().stream().noneMatch(c -> c.getExpression() == null)) {
if (tree.getCases().stream().noneMatch(c -> isSwitchDefault(c))) {
return true;
}
// (5)
Expand Down
3 changes: 2 additions & 1 deletion core/src/main/java/com/google/errorprone/bugpatterns/MissingCasesInEnumSwitch.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

import static com.google.common.collect.ImmutableSet.toImmutableSet;
import static com.google.errorprone.BugPattern.SeverityLevel.WARNING;
import static com.google.errorprone.util.ASTHelpers.isSwitchDefault;

import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;
Expand Down Expand Up @@ -48,7 +49,7 @@ public Description matchSwitch(SwitchTree tree, VisitorState state) {
return Description.NO_MATCH;
}
// default case is present
if (tree.getCases().stream().anyMatch(c -> c.getExpression() == null)) {
if (tree.getCases().stream().anyMatch(c -> isSwitchDefault(c))) {
return Description.NO_MATCH;
}
ImmutableSet<String> handled =
Expand Down
7 changes: 4 additions & 3 deletions core/src/main/java/com/google/errorprone/bugpatterns/StatementSwitchToExpressionSwitch.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import static com.google.errorprone.matchers.Description.NO_MATCH;
import static com.google.errorprone.util.ASTHelpers.getStartPosition;
import static com.google.errorprone.util.ASTHelpers.getSymbol;
import static com.google.errorprone.util.ASTHelpers.isSwitchDefault;
import static com.sun.source.tree.Tree.Kind.BLOCK;
import static com.sun.source.tree.Tree.Kind.BREAK;
import static com.sun.source.tree.Tree.Kind.EXPRESSION_STATEMENT;
Expand Down Expand Up @@ -536,7 +537,7 @@ private static SuggestedFix convertDirectlyToExpressionSwitch(
boolean firstCaseInGroup = true;
for (int caseIndex = 0; caseIndex < cases.size(); caseIndex++) {
CaseTree caseTree = cases.get(caseIndex);
boolean isDefaultCase = caseTree.getExpression() == null;
boolean isDefaultCase = isSwitchDefault(caseTree);

// For readability, filter out trailing unlabelled break statement because these become a
// No-Op when used inside expression switches
Expand Down Expand Up @@ -656,7 +657,7 @@ private static SuggestedFix convertToReturnSwitch(
boolean firstCaseInGroup = true;
for (int caseIndex = 0; caseIndex < cases.size(); caseIndex++) {
CaseTree caseTree = cases.get(caseIndex);
boolean isDefaultCase = caseTree.getExpression() == null;
boolean isDefaultCase = isSwitchDefault(caseTree);

String transformedBlockSource =
transformReturnOrThrowBlock(caseTree, state, getStatements(caseTree));
Expand Down Expand Up @@ -825,7 +826,7 @@ private static SuggestedFix convertToAssignmentSwitch(
boolean firstCaseInGroup = true;
for (int caseIndex = 0; caseIndex < cases.size(); caseIndex++) {
CaseTree caseTree = cases.get(caseIndex);
boolean isDefaultCase = caseTree.getExpression() == null;
boolean isDefaultCase = isSwitchDefault(caseTree);
ImmutableList<StatementTree> filteredStatements = filterOutRedundantBreak(caseTree);

String transformedBlockSource =
Expand Down
5 changes: 3 additions & 2 deletions core/src/main/java/com/google/errorprone/bugpatterns/SwitchDefault.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import static com.google.errorprone.matchers.Description.NO_MATCH;
import static com.google.errorprone.util.ASTHelpers.getStartPosition;
import static com.google.errorprone.util.ASTHelpers.getSwitchDefault;
import static com.google.errorprone.util.ASTHelpers.isSwitchDefault;

import com.google.errorprone.BugPattern;
import com.google.errorprone.VisitorState;
Expand Down Expand Up @@ -55,7 +56,7 @@ public Description matchSwitch(SwitchTree tree, VisitorState state) {
while (it.hasNext()) {
CaseTree caseTree = it.next();
defaultStatementGroup.add(caseTree);
if (caseTree.getExpression() == null) {
if (isSwitchDefault(caseTree)) {
while (it.hasNext() && isNullOrEmpty(caseTree.getStatements())) {
caseTree = it.next();
defaultStatementGroup.add(caseTree);
Expand Down Expand Up @@ -96,7 +97,7 @@ public Description matchSwitch(SwitchTree tree, VisitorState state) {
// If the last statement group falls out of the switch, add a `break;` before moving
// the default to the end.
CaseTree last = getLast(tree.getCases());
if (last.getExpression() == null || Reachability.canCompleteNormally(last)) {
if (isSwitchDefault(last) || Reachability.canCompleteNormally(last)) {
replacement = "break;\n" + replacement;
}
fix.replace(start, end, "").postfixWith(getLast(tree.getCases()), replacement);
Expand Down
3 changes: 2 additions & 1 deletion core/src/main/java/com/google/errorprone/bugpatterns/UnnecessaryDefaultInEnumSwitch.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import static com.google.errorprone.BugPattern.SeverityLevel.WARNING;
import static com.google.errorprone.matchers.Description.NO_MATCH;
import static com.google.errorprone.util.ASTHelpers.getStartPosition;
import static com.google.errorprone.util.ASTHelpers.isSwitchDefault;
import static com.google.errorprone.util.Reachability.canCompleteNormally;

import com.google.common.collect.ImmutableSet;
Expand Down Expand Up @@ -79,7 +80,7 @@ public Description matchSwitch(SwitchTree switchTree, VisitorState state) {
CaseTree caseBeforeDefault = null;
CaseTree defaultCase = null;
for (CaseTree caseTree : switchTree.getCases()) {
if (caseTree.getExpression() == null) {
if (isSwitchDefault(caseTree)) {
defaultCase = caseTree;
break;
} else {
Expand Down
3 changes: 2 additions & 1 deletion core/src/main/java/com/google/errorprone/refaster/ControlFlowVisitor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import static com.google.errorprone.refaster.ControlFlowVisitor.Result.ALWAYS_RETURNS;
import static com.google.errorprone.refaster.ControlFlowVisitor.Result.MAY_BREAK_OR_RETURN;
import static com.google.errorprone.refaster.ControlFlowVisitor.Result.NEVER_EXITS;
import static com.google.errorprone.util.ASTHelpers.isSwitchDefault;

import com.google.errorprone.refaster.ControlFlowVisitor.BreakContext;
import com.google.errorprone.refaster.ControlFlowVisitor.Result;
Expand Down Expand Up @@ -221,7 +222,7 @@ public Result visitSwitch(SwitchTree node, BreakContext cxt) {
cxt.loopDepth++;
try {
for (CaseTree caseTree : node.getCases()) {
if (caseTree.getExpression() == null) {
if (isSwitchDefault(caseTree)) {
seenDefault = true;
}

Expand Down
Loading