Open-source Java21 matchers.

PiperOrigin-RevId: 830636119

Author: graememorgan

check_api/src/main/java/com/google/errorprone/bugpatterns/BugChecker.java

@@ -51,7 +51,10 @@
 import com.sun.source.tree.CompilationUnitTree;
 import com.sun.source.tree.CompoundAssignmentTree;
 import com.sun.source.tree.ConditionalExpressionTree;
+import com.sun.source.tree.ConstantCaseLabelTree;
 import com.sun.source.tree.ContinueTree;
+import com.sun.source.tree.DeconstructionPatternTree;
+import com.sun.source.tree.DefaultCaseLabelTree;
 import com.sun.source.tree.DoWhileLoopTree;
 import com.sun.source.tree.EmptyStatementTree;
 import com.sun.source.tree.EnhancedForLoopTree;
@@ -78,6 +81,7 @@
 import com.sun.source.tree.PackageTree;
 import com.sun.source.tree.ParameterizedTypeTree;
 import com.sun.source.tree.ParenthesizedTree;
+import com.sun.source.tree.PatternCaseLabelTree;
 import com.sun.source.tree.PrimitiveTypeTree;
 import com.sun.source.tree.ProvidesTree;
 import com.sun.source.tree.RequiresTree;
@@ -385,10 +389,22 @@ public interface ConditionalExpressionTreeMatcher extends Suppressible {
     Description matchConditionalExpression(ConditionalExpressionTree tree, VisitorState state);
   }
 
+  public interface ConstantCaseLabelTreeMatcher extends Suppressible {
+    Description matchConstantCaseLabel(ConstantCaseLabelTree tree, VisitorState state);
+  }
+
   public interface ContinueTreeMatcher extends Suppressible {
     Description matchContinue(ContinueTree tree, VisitorState state);
   }
 
+  public interface DeconstructionPatternTreeMatcher extends Suppressible {
+    Description matchDeconstructionPattern(DeconstructionPatternTree tree, VisitorState state);
+  }
+
+  public interface DefaultCaseLabelTreeMatcher extends Suppressible {
+    Description matchDefaultCaseLabel(DefaultCaseLabelTree tree, VisitorState state);
+  }
+
   public interface DoWhileLoopTreeMatcher extends Suppressible {
     Description matchDoWhileLoop(DoWhileLoopTree tree, VisitorState state);
   }
@@ -498,6 +514,10 @@ public interface ParenthesizedTreeMatcher extends Suppressible {
     Description matchParenthesized(ParenthesizedTree tree, VisitorState state);
   }
 
+  public interface PatternCaseLabelTreeMatcher extends Suppressible {
+    Description matchPatternCaseLabel(PatternCaseLabelTree tree, VisitorState state);
+  }
+
   public interface PrimitiveTypeTreeMatcher extends Suppressible {
     Description matchPrimitiveType(PrimitiveTypeTree tree, VisitorState state);
   }

core/src/main/java/com/google/errorprone/bugpatterns/argumentselectiondefects/ArgumentSelectionDefectChecker.java

@@ -22,12 +22,14 @@
 import com.google.errorprone.BugPattern;
 import com.google.errorprone.VisitorState;
 import com.google.errorprone.bugpatterns.BugChecker;
+import com.google.errorprone.bugpatterns.BugChecker.DeconstructionPatternTreeMatcher;
 import com.google.errorprone.bugpatterns.BugChecker.MethodInvocationTreeMatcher;
 import com.google.errorprone.bugpatterns.BugChecker.NewClassTreeMatcher;
 import com.google.errorprone.matchers.Description;
 import com.google.errorprone.names.NamingConventions;
 import com.google.errorprone.names.NeedlemanWunschEditDistance;
 import com.google.errorprone.util.ASTHelpers;
+import com.sun.source.tree.DeconstructionPatternTree;
 import com.sun.source.tree.MethodInvocationTree;
 import com.sun.source.tree.NewClassTree;
 import com.sun.tools.javac.code.Symbol.MethodSymbol;
@@ -54,7 +56,7 @@
     summary = "Arguments are in the wrong order or could be commented for clarity.",
     severity = WARNING)
 public class ArgumentSelectionDefectChecker extends BugChecker
-    implements MethodInvocationTreeMatcher, NewClassTreeMatcher {
+    implements DeconstructionPatternTreeMatcher, MethodInvocationTreeMatcher, NewClassTreeMatcher {
 
   private final ArgumentChangeFinder argumentChangeFinder;
 
@@ -99,6 +101,13 @@ public Description matchNewClass(NewClassTree tree, VisitorState state) {
     return visit(InvocationInfo.createFromNewClass(tree, symbol, state));
   }
 
+  @Override
+  public Description matchDeconstructionPattern(
+      DeconstructionPatternTree tree, VisitorState state) {
+    var deconstructor = InvocationInfo.createFromDeconstructionPattern(tree, state);
+    return deconstructor == null ? Description.NO_MATCH : visit(deconstructor);
+  }
+
   private Description visit(InvocationInfo invocationInfo) {
     Changes changes = argumentChangeFinder.findChanges(invocationInfo);
 

core/src/main/java/com/google/errorprone/bugpatterns/argumentselectiondefects/InvocationInfo.java

@@ -16,15 +16,22 @@
 
 package com.google.errorprone.bugpatterns.argumentselectiondefects;
 
+import static com.google.errorprone.util.ASTHelpers.canonicalConstructor;
+import static com.google.errorprone.util.ASTHelpers.getSymbol;
+
 import com.google.auto.value.AutoValue;
 import com.google.common.collect.ImmutableList;
 import com.google.errorprone.VisitorState;
+import com.sun.source.tree.BindingPatternTree;
+import com.sun.source.tree.DeconstructionPatternTree;
 import com.sun.source.tree.MethodInvocationTree;
 import com.sun.source.tree.NewClassTree;
 import com.sun.source.tree.Tree;
+import com.sun.tools.javac.code.Symbol.ClassSymbol;
 import com.sun.tools.javac.code.Symbol.MethodSymbol;
 import com.sun.tools.javac.code.Symbol.VarSymbol;
 import java.util.List;
+import org.jspecify.annotations.Nullable;
 
 /**
  * Holds information about the method invocation (or new class construction) that we are processing.
@@ -64,6 +71,26 @@ static InvocationInfo createFromNewClass(
         state);
   }
 
+  static @Nullable InvocationInfo createFromDeconstructionPattern(
+      DeconstructionPatternTree tree, VisitorState state) {
+    var symbol = getSymbol(tree.getDeconstructor());
+    if (!(symbol instanceof ClassSymbol cs)) {
+      return null;
+    }
+
+    var constructor = canonicalConstructor(cs, state);
+    ImmutableList.Builder<Tree> actuals = ImmutableList.builder();
+    ImmutableList.Builder<VarSymbol> formals = ImmutableList.builder();
+    for (int i = 0; i < constructor.getParameters().size(); ++i) {
+      // Skip over anything that isn't binding. There might be nested patterns here, or "_"s.
+      if (tree.getNestedPatterns().get(i) instanceof BindingPatternTree) {
+        actuals.add(((BindingPatternTree) tree.getNestedPatterns().get(i)).getVariable());
+        formals.add(constructor.getParameters().get(i));
+      }
+    }
+    return new AutoValue_InvocationInfo(tree, constructor, actuals.build(), formals.build(), state);
+  }
+
   private static ImmutableList<VarSymbol> getFormalParametersWithoutVarArgs(
       MethodSymbol invokedMethodSymbol) {
     List<VarSymbol> formalParameters = invokedMethodSymbol.getParameters();

core/src/test/java/com/google/errorprone/bugpatterns/argumentselectiondefects/ArgumentSelectionDefectCheckerTest.java

@@ -400,6 +400,40 @@ record Foo(String first, String second) {}
         .doTest();
   }
 
+  @Test
+  public void recordDeconstruction() {
+    testHelper
+        .addSourceLines(
+            "Test.java",
+"""
+class Test {
+  void test(Foo foo) {
+    switch (foo) {
+      // BUG: Diagnostic contains: may have been swapped
+      case Foo(String second, String first, _) -> {}
+      default -> {}
+    }
+  }
+
+  void test2(Foo foo) {
+    switch (foo) {
+      // BUG: Diagnostic contains: may have been swapped
+      case Foo(_, _, Foo(String second, String first, _)) -> {}
+      default -> {}
+    }
+  }
+}
+
+record Foo(String first, String second, Foo foo) {}
+""")
+        .setArgs(
+            "-parameters",
+            "--enable-preview",
+            "--release",
+            Integer.toString(Runtime.version().feature()))
+        .doTest();
+  }
+
   public record Foo(String first, String second) {}
 
   @Test