-
Notifications
You must be signed in to change notification settings - Fork 93
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
324 additions
and
18 deletions.
There are no files selected for viewing
132 changes: 132 additions & 0 deletions
132
....manipulation/common/org/eclipse/jdt/internal/ui/fix/UnneededSuppressWarningsCleanUp.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2024 Red Hat Inc. and others. | ||
| * | ||
| * This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License 2.0 | ||
| * which accompanies this distribution, and is available at | ||
| * https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Contributors: | ||
| * Red Hat Inc. - initial API and implementation | ||
| *******************************************************************************/ | ||
| package org.eclipse.jdt.internal.ui.fix; | ||
|
|
||
| import java.util.Hashtable; | ||
| import java.util.Map; | ||
|
|
||
| import org.eclipse.core.runtime.CoreException; | ||
|
|
||
| import org.eclipse.jdt.core.ICompilationUnit; | ||
| import org.eclipse.jdt.core.JavaCore; | ||
| import org.eclipse.jdt.core.JavaModelException; | ||
| import org.eclipse.jdt.core.compiler.IProblem; | ||
| import org.eclipse.jdt.core.dom.CompilationUnit; | ||
| import org.eclipse.jdt.core.dom.StringLiteral; | ||
|
|
||
| import org.eclipse.jdt.internal.corext.fix.CleanUpConstants; | ||
| import org.eclipse.jdt.internal.corext.fix.UnneededSuppressWarningsFixCore; | ||
|
|
||
| import org.eclipse.jdt.ui.cleanup.CleanUpRequirements; | ||
| import org.eclipse.jdt.ui.cleanup.ICleanUpFix; | ||
| import org.eclipse.jdt.ui.text.java.IProblemLocation; | ||
|
|
||
| /** | ||
| * Create fix to remove unnecessary SuppressWarnings | ||
| * @see org.eclipse.jdt.internal.corext.fix.UnneededSuppressWarningsFixCore | ||
| */ | ||
| public class UnneededSuppressWarningsCleanUp extends AbstractMultiFix { | ||
|
|
||
| public UnneededSuppressWarningsCleanUp(Map<String, String> options) { | ||
| super(options); | ||
| } | ||
|
|
||
| public UnneededSuppressWarningsCleanUp() { | ||
| super(); | ||
| } | ||
|
|
||
| private StringLiteral fLiteral; | ||
| private CompilationUnit fSavedCompilationUnit= null; | ||
|
|
||
| public void setLiteral(StringLiteral literal) { | ||
| fLiteral= literal; | ||
| } | ||
|
|
||
| @Override | ||
| public CleanUpRequirements getRequirements() { | ||
| boolean requireAST= requireAST(); | ||
| Map<String, String> requiredOptions= requireAST ? getRequiredOptions() : null; | ||
| return new CleanUpRequirements(requireAST, false, false, requiredOptions); | ||
| } | ||
|
|
||
| private boolean requireAST() { | ||
| return isEnabled(CleanUpConstants.REMOVE_UNNECESSARY_SUPPRESS_WARNINGS); | ||
| } | ||
|
|
||
| @Override | ||
| protected ICleanUpFix createFix(CompilationUnit compilationUnit) throws CoreException { | ||
| if (compilationUnit == null) | ||
| return null; | ||
|
|
||
| ICleanUpFix coreFix= UnneededSuppressWarningsFixCore.createFix(fSavedCompilationUnit == null ? compilationUnit : fSavedCompilationUnit, | ||
| fLiteral); | ||
| return coreFix; | ||
| } | ||
|
|
||
| @Override | ||
| protected ICleanUpFix createFix(CompilationUnit compilationUnit, IProblemLocation[] problems) throws CoreException { | ||
| if (compilationUnit == null) | ||
| return null; | ||
|
|
||
| ICleanUpFix coreFix= UnneededSuppressWarningsFixCore.createFix(compilationUnit, fLiteral, problems); | ||
| return coreFix; | ||
| } | ||
|
|
||
| private Map<String, String> getRequiredOptions() { | ||
| Map<String, String> result= new Hashtable<>(); | ||
|
|
||
| if (isEnabled(CleanUpConstants.REMOVE_UNNECESSARY_SUPPRESS_WARNINGS)) | ||
| result.put(JavaCore.COMPILER_PB_SUPPRESS_WARNINGS, JavaCore.WARNING); | ||
|
|
||
| return result; | ||
| } | ||
|
|
||
| @Override | ||
| public String[] getStepDescriptions() { | ||
| return new String[0]; | ||
| } | ||
|
|
||
| @Override | ||
| public String getPreview() { | ||
| // not used as traditional cleanup | ||
| return ""; //$NON-NLS-1$ | ||
| } | ||
|
|
||
| @Override | ||
| public boolean canFix(ICompilationUnit compilationUnit, IProblemLocation problem) { | ||
| if (problem.getProblemId() == IProblem.UnusedWarningToken) | ||
| return isEnabled(CleanUpConstants.REMOVE_UNNECESSARY_SUPPRESS_WARNINGS); | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| @Override | ||
| public int computeNumberOfFixes(CompilationUnit compilationUnit) { | ||
| try { | ||
| ICompilationUnit cu= (ICompilationUnit)compilationUnit.getJavaElement(); | ||
| if (!cu.isStructureKnown()) | ||
| return 0; //[clean up] 'Remove unnecessary $NLS-TAGS$' removes necessary ones in case of syntax errors: https://bugs.eclipse.org/bugs/show_bug.cgi?id=285814 : | ||
| } catch (JavaModelException e) { | ||
| return 0; | ||
| } | ||
|
|
||
| fSavedCompilationUnit= compilationUnit; | ||
| int result= 0; | ||
| IProblem[] problems= compilationUnit.getProblems(); | ||
| if (isEnabled(CleanUpConstants.REMOVE_UNNECESSARY_SUPPRESS_WARNINGS)) | ||
| result+= getNumberOfProblems(problems, IProblem.UnusedWarningToken); | ||
|
|
||
| return result; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
124 changes: 124 additions & 0 deletions
124
...n/core extension/org/eclipse/jdt/internal/corext/fix/UnneededSuppressWarningsFixCore.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2024 Red Hat Inc. and others. | ||
| * | ||
| * This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License 2.0 | ||
| * which accompanies this distribution, and is available at | ||
| * https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Contributors: | ||
| * Red Hat Inc. - initial API and implementation | ||
| *******************************************************************************/ | ||
| package org.eclipse.jdt.internal.corext.fix; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import org.eclipse.core.runtime.CoreException; | ||
|
|
||
| import org.eclipse.jdt.core.ICompilationUnit; | ||
| import org.eclipse.jdt.core.JavaModelException; | ||
| import org.eclipse.jdt.core.compiler.IProblem; | ||
| import org.eclipse.jdt.core.dom.ASTNode; | ||
| import org.eclipse.jdt.core.dom.ArrayInitializer; | ||
| import org.eclipse.jdt.core.dom.CompilationUnit; | ||
| import org.eclipse.jdt.core.dom.MemberValuePair; | ||
| import org.eclipse.jdt.core.dom.NormalAnnotation; | ||
| import org.eclipse.jdt.core.dom.SingleMemberAnnotation; | ||
| import org.eclipse.jdt.core.dom.StringLiteral; | ||
| import org.eclipse.jdt.core.dom.rewrite.ASTRewrite; | ||
|
|
||
| import org.eclipse.jdt.internal.corext.refactoring.structure.CompilationUnitRewrite; | ||
| import org.eclipse.jdt.internal.corext.util.Messages; | ||
|
|
||
| import org.eclipse.jdt.ui.text.java.IProblemLocation; | ||
|
|
||
| import org.eclipse.jdt.internal.ui.text.correction.CorrectionMessages; | ||
| import org.eclipse.jdt.internal.ui.text.correction.ProblemLocation; | ||
|
|
||
| /** | ||
| * Remove unneeded SuppressWarnings annotations. | ||
| */ | ||
| public class UnneededSuppressWarningsFixCore extends CompilationUnitRewriteOperationsFixCore { | ||
|
|
||
| public UnneededSuppressWarningsFixCore(String name, CompilationUnit compilationUnit, CompilationUnitRewriteOperation operation) { | ||
| super(name, compilationUnit, operation); | ||
| } | ||
|
|
||
| public static IProposableFix createFix(CompilationUnit compilationUnit, StringLiteral origLiteral) { | ||
| IProblem[] problems= compilationUnit.getProblems(); | ||
| List<IProblemLocation> locationsList= new ArrayList<>(); | ||
| for (int i= 0; i < problems.length; i++) { | ||
| IProblemLocation location= new ProblemLocation(problems[i]); | ||
| if (location.getProblemId() == IProblem.UnusedWarningToken) { | ||
| ASTNode node= location.getCoveringNode(compilationUnit); | ||
| if (node instanceof StringLiteral literal) { | ||
| if (literal.getLiteralValue() == origLiteral.getLiteralValue()) { | ||
| locationsList.add(location); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| IProblemLocation[] locations= locationsList.toArray(new IProblemLocation[0]); | ||
| return createFix(compilationUnit, origLiteral, locations); | ||
| } | ||
|
|
||
| public static IProposableFix createFix(CompilationUnit compilationUnit, IProblemLocation problem) { | ||
| StringLiteral literal= (StringLiteral)problem.getCoveringNode(compilationUnit); | ||
| return createFix(compilationUnit, literal, new IProblemLocation[] { problem }); | ||
| } | ||
|
|
||
| public static IProposableFix createFix(CompilationUnit compilationUnit, StringLiteral literal, IProblemLocation[] problems) { | ||
| ICompilationUnit cu= (ICompilationUnit)compilationUnit.getJavaElement(); | ||
| try { | ||
| if (!cu.isStructureKnown()) | ||
| return null; | ||
| } catch (JavaModelException e) { | ||
| return null; | ||
| } | ||
| String label= Messages.format(CorrectionMessages.SuppressWarningsSubProcessor_remove_annotation_label, literal.getLiteralValue()); | ||
| return new UnneededSuppressWarningsFixCore(label, compilationUnit, new RemoveUnneededSuppressWarningsOperation(problems)); | ||
| } | ||
|
|
||
| private static class RemoveUnneededSuppressWarningsOperation extends CompilationUnitRewriteOperation { | ||
|
|
||
| private IProblemLocation[] fLocations; | ||
| public RemoveUnneededSuppressWarningsOperation(IProblemLocation[] locations) { | ||
| this.fLocations= locations; | ||
| } | ||
|
|
||
| @Override | ||
| public void rewriteAST(CompilationUnitRewrite cuRewrite, LinkedProposalModelCore linkedModel) throws CoreException { | ||
|
|
||
| for (IProblemLocation location : fLocations) { | ||
| ASTNode coveringNode= location.getCoveringNode(cuRewrite.getRoot()); | ||
| if (!(coveringNode instanceof StringLiteral)) | ||
| continue; | ||
|
|
||
| if (coveringNode.getParent() instanceof MemberValuePair) { | ||
| coveringNode= coveringNode.getParent(); | ||
| } | ||
|
|
||
| ASTNode parent= coveringNode.getParent(); | ||
| ASTRewrite rewrite= cuRewrite.getASTRewrite(); | ||
| if (parent instanceof SingleMemberAnnotation) { | ||
| rewrite.remove(parent, null); | ||
| } else if (parent instanceof NormalAnnotation) { | ||
| NormalAnnotation annot= (NormalAnnotation) parent; | ||
| if (annot.values().size() == 1) { | ||
| rewrite.remove(annot, null); | ||
| } else { | ||
| rewrite.remove(coveringNode, null); | ||
| } | ||
| } else if (parent instanceof ArrayInitializer) { | ||
| rewrite.remove(coveringNode, null); | ||
| } | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.