Merge pull request #7548 from Achal1607/javavscode-96

Implement suppress warnings on for Unused hint and codeAction for suppress warnings annotations

Author: mbien

ide/spi.editor.hints/src/org/netbeans/spi/editor/hints/Fix.java

@@ -19,6 +19,8 @@
 
 package org.netbeans.spi.editor.hints;
 
+import org.netbeans.modules.editor.hints.HintsControllerImpl;
+
 /**
  * Allows to perform a change when the user selects the hint.
  * @author Jan Lahoda
@@ -39,4 +41,8 @@ public interface Fix {
      *  determined.
      */
     public abstract ChangeInfo implement() throws Exception;
+    
+    default Iterable<? extends Fix> getSubfixes() {
+        return HintsControllerImpl.getSubfixes(this);
+    }
 }

java/java.hints/nbproject/project.properties

@@ -17,7 +17,7 @@
 
 spec.version.base=1.108.0
 
-javac.source=1.8
+javac.release=17
 
 nbroot=../..
 jbrowse.external=${nbroot}/retouche

java/java.hints/src/org/netbeans/modules/java/hints/bugs/Unused.java

@@ -19,7 +19,6 @@
 package org.netbeans.modules.java.hints.bugs;
 
 import com.sun.source.tree.Tree.Kind;
-import java.util.ArrayList;
 import java.util.List;
 import javax.lang.model.element.ElementKind;
 import org.netbeans.modules.java.editor.base.semantic.UnusedDetector;
@@ -34,6 +33,8 @@
 import org.netbeans.spi.java.hints.TriggerTreeKind;
 import org.openide.util.NbBundle.Messages;
 
+import static org.netbeans.api.java.source.CompilationInfo.CacheClearPolicy.ON_TASK_END;
+
 /**
  *
  * @author lahvac
@@ -52,24 +53,46 @@ public class Unused {
     @BooleanOption(displayName="#LBL_UnusedPackagePrivate", tooltip="#TP_UnusedPackagePrivate", defaultValue=DETECT_UNUSED_PACKAGE_PRIVATE_DEFAULT)
     public static final String DETECT_UNUSED_PACKAGE_PRIVATE = "detect.unused.package.private";
 
-    @TriggerTreeKind(Kind.COMPILATION_UNIT)
+    @TriggerTreeKind({
+        //class-like kinds:
+        Kind.ANNOTATION_TYPE, Kind.CLASS, Kind.ENUM, Kind.INTERFACE, Kind.RECORD,
+        Kind.VARIABLE,
+        Kind.METHOD
+    })
     public static List<ErrorDescription> unused(HintContext ctx) {
         List<UnusedDescription> unused = UnusedDetector.findUnused(ctx.getInfo(), () -> ctx.isCanceled());
-        List<ErrorDescription> result = new ArrayList<>(unused.size());
-        boolean detectUnusedPackagePrivate = ctx.getPreferences().getBoolean(DETECT_UNUSED_PACKAGE_PRIVATE, DETECT_UNUSED_PACKAGE_PRIVATE_DEFAULT);
+        if (unused.isEmpty()) {
+            return null;
+        }
+        boolean detectUnusedPackagePrivate = getTaskCachedBoolean(ctx, DETECT_UNUSED_PACKAGE_PRIVATE, DETECT_UNUSED_PACKAGE_PRIVATE_DEFAULT);
         for (UnusedDescription ud : unused) {
             if (ctx.isCanceled()) {
                 break;
             }
+            if (ud.unusedElementPath.getLeaf() != ctx.getPath().getLeaf()) {
+                continue;
+            }
             if (!detectUnusedPackagePrivate && ud.packagePrivate) {
                 continue;
             }
             ErrorDescription err = convertUnused(ctx, ud);
             if (err != null) {
-                result.add(err);
+                return List.of(err);
             }
+            break;
+        }
+        return null;
+    }
+
+    // reading from AuxiliaryConfigBasedPreferences in inner loops is not cheap since it needs a mutex
+    private static boolean getTaskCachedBoolean(HintContext ctx, String key, boolean defaultVal) {
+        Object cached = ctx.getInfo().getCachedValue(key);
+        if (cached instanceof Boolean val) {
+            return val;
         }
-        return result;
+        boolean fromPrefs = ctx.getPreferences().getBoolean(key, defaultVal);
+        ctx.getInfo().putCachedValue(key, fromPrefs, ON_TASK_END);
+        return fromPrefs;
     }
 
     @Messages({

java/java.hints/src/org/netbeans/modules/java/hints/infrastructure/JavaErrorProvider.java

@@ -80,6 +80,7 @@
 import org.openide.filesystems.FileObject;
 import org.openide.text.PositionBounds;
 import org.openide.util.Exceptions;
+import org.openide.util.Pair;
 import org.openide.util.Union2;
 
 /** Provides errors and hints for VSCode. This class is abstract to
@@ -116,15 +117,15 @@ public void run(ResultIterator it) throws Exception {
                                     AtomicBoolean cancel = new AtomicBoolean();
                                     context.registerCancelCallback(() -> cancel.set(true));
                                     HintsSettings settings;
-                                    
+
                                     if (context.getHintsConfigFile() != null) {
                                         Preferences hintSettings = ToolPreferences.from(context.getHintsConfigFile().toURI()).getPreferences(HINTS_TOOL_ID, "text/x-java");
                                         settings = HintsSettings.createPreferencesBasedHintsSettings(hintSettings, true, null);
                                     } else {
                                         settings = HintsSettings.getGlobalSettings();
                                     }
                                     result.addAll(convert2Diagnostic(context.errorKind(), new HintsInvoker(settings, context.getOffset(), cancel).computeHints(cc), ed -> !disabled.contains(ed.getSeverity())));
-                                    
+
                                 }
                                 break;
                         }
@@ -200,24 +201,42 @@ private static List<CodeAction> convertFixes(ErrorDescription err, Consumer<Exce
         }
 
         List<Fix> fixes = sortFixes(lfl.getFixes());
-        List<CodeAction> result = new ArrayList<>();
+
+        List<Pair<Fix, Boolean>> fixesAndSubfixes = new ArrayList<>(); // true if main fix
 
         for (Fix f : fixes) {
+            fixesAndSubfixes.add(Pair.of(f, true));
+            for (Fix subFix : f.getSubfixes()) {
+                fixesAndSubfixes.add(Pair.of(subFix, false));
+            }
+        }
+
+        List<CodeAction> result = new ArrayList<>();
+        boolean printSubFixes = false;
+
+        for (Pair<Fix, Boolean> textAndFix : fixesAndSubfixes) {
+            if (!printSubFixes && !textAndFix.second()) {
+                continue;
+            }
+
+            Fix f = textAndFix.first();
+            int startResultSize = result.size();
+            String text = textAndFix.second() ? f.getText() : " -> " + f.getText();
+
             if (f instanceof IncompleteClassPath.ResolveFix) {
                 // We know that this is a project problem and that the problems reported by ProjectProblemsProvider should be resolved
-                CodeAction action = new CodeAction(f.getText(), new Command(f.getText(), "nbls.project.resolveProjectProblems"));
+                CodeAction action = new CodeAction(text, new Command(text, "nbls.project.resolveProjectProblems"));
                 result.add(action);
             }
             if (f instanceof org.netbeans.modules.java.hints.errors.EnablePreview.ResolveFix) {
                 org.netbeans.modules.java.hints.errors.EnablePreview.ResolveFix rf = (org.netbeans.modules.java.hints.errors.EnablePreview.ResolveFix) f;
                 List<Object> params = rf.getNewSourceLevel() != null ? Arrays.asList(rf.getNewSourceLevel())
-                                                                     : Collections.emptyList();
-                CodeAction action = new CodeAction(f.getText(), new Command(f.getText(), "nbls.java.project.enable.preview", params));
+                        : Collections.emptyList();
+                CodeAction action = new CodeAction(text, new Command(text, "nbls.java.project.enable.preview", params));
                 result.add(action);
             }
             if (f instanceof ImportClass.FixImport) {
                 //TODO: FixImport is not a JavaFix, create one. Is there a better solution?
-                String text = f.getText();
                 CharSequence sortText = ((ImportClass.FixImport) f).getSortText();
                 ElementHandle<Element> toImport = ((ImportClass.FixImport) f).getToImport();
                 f = new JavaFix(topLevelHandle[0], sortText != null ? sortText.toString() : null) {
@@ -233,16 +252,16 @@ protected void performRewrite(JavaFix.TransformationContext ctx) throws Exceptio
                         }
                         WorkingCopy copy = ctx.getWorkingCopy();
                         CompilationUnitTree cut = GeneratorUtilities.get(copy).addImports(
-                            copy.getCompilationUnit(),
-                            Collections.singleton(resolved)
+                                copy.getCompilationUnit(),
+                                Collections.singleton(resolved)
                         );
                         copy.rewrite(copy.getCompilationUnit(), cut);
                     }
                 }.toEditorFix();
             }
             if (f instanceof JavaFixImpl) {
                 JavaFix jf = ((JavaFixImpl) f).jf;
-                CodeAction action = new LazyCodeAction(f.getText(), () -> {
+                CodeAction action = new LazyCodeAction(text, () -> {
                     try {
                         List<TextEdit> edits = modify2TextEdits(js, wc -> {
                             wc.toPhase(JavaSource.Phase.RESOLVED);
@@ -261,7 +280,7 @@ protected void performRewrite(JavaFix.TransformationContext ctx) throws Exceptio
             }
             if (f instanceof ModificationResultBasedFix) {
                 ModificationResultBasedFix cf = (ModificationResultBasedFix) f;
-                CodeAction codeAction = new LazyCodeAction(f.getText(), () -> {
+                CodeAction codeAction = new LazyCodeAction(text, () -> {
                     try {
                         List<Union2<TextDocumentEdit, ResourceOperation>> documentChanges = new ArrayList<>();
                         for (ModificationResult changes : cf.getModificationResults()) {
@@ -289,8 +308,8 @@ protected void performRewrite(JavaFix.TransformationContext ctx) throws Exceptio
                                             continue outer;
                                         } else {
                                             edits.add(new TextEdit(diff.getStartPosition().getOffset(),
-                                                                   diff.getEndPosition().getOffset(),
-                                                                   newText != null ? newText : ""));
+                                                    diff.getEndPosition().getOffset(),
+                                                    newText != null ? newText : ""));
                                         }
                                     }
                                     documentChanges.add(Union2.createFirst(new TextDocumentEdit(fileObject.toURI().toString(), edits))); //XXX: toURI
@@ -305,6 +324,9 @@ protected void performRewrite(JavaFix.TransformationContext ctx) throws Exceptio
                 });
                 result.add(codeAction);
             }
+            if (textAndFix.second()) {
+                printSubFixes = startResultSize != result.size();
+            }
         }
 
         return result;
@@ -369,8 +391,8 @@ private static List<TextEdit> fileModifications(ModificationResult changes, File
         for (ModificationResult.Difference diff : diffs) {
             String newText = diff.getNewText();
             edits.add(new TextEdit(diff.getStartPosition().getOffset(),
-                                   diff.getEndPosition().getOffset(),
-                                   newText != null ? newText : ""));
+                    diff.getEndPosition().getOffset(),
+                    newText != null ? newText : ""));
         }
         return edits;
     }