MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

[java-inspections] AccessStaticViaInstanceFix: mod-command

Browse Source 
IDEA-323888 Replace 'side effect' dialog in Java quick-fixes with chooser

GitOrigin-RevId: 215c1987ee33c6fd14f6fe987bbd491fa3b78343
This commit is contained in:
Tagir Valeev
2023-06-30 09:01:06 +00:00
committed by intellij-monorepo-bot
parent c55dfd035c
commit 3df9a89271
23 changed files with 142 additions and 161 deletions
Download Patch File Download Diff File Expand all files Collapse all files
java/java-analysis-impl/src/messages/QuickFixBundle.properties
+1
View File
@@ -3,6 +3,7 @@ class.to.import.chooser.title=Class to Import
method.to.import.chooser.title=Method to Import
field.to.import.chooser.title=Field to Import
access.static.via.class.reference.family=Access static via class reference
access.static.via.class.reference.title=Access Static via Class Reference
access.static.via.class.reference.text=Access static ''{1}.{0}'' via class ''{2}'' reference
add.default.constructor.family=Add Default Constructor
add.default.constructor.text=Add {0} no-args constructor to {1}
java/java-impl-inspections/src/com/intellij/codeInspection/accessStaticViaInstance/AccessStaticViaInstance.java
+6 -19
View File
@@ -1,29 +1,16 @@
/*
* Copyright 2000-2009 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
package com.intellij.codeInspection.accessStaticViaInstance;
import com.intellij.codeInsight.daemon.impl.quickfix.AccessStaticViaInstanceFix;
import com.intellij.codeInspection.LocalQuickFix;
import com.intellij.psi.JavaResolveResult;
import com.intellij.psi.PsiReferenceExpression;
public class AccessStaticViaInstance extends AccessStaticViaInstanceBase {
@Override
protected AccessStaticViaInstanceFix createAccessStaticViaInstanceFix(PsiReferenceExpression expr,
boolean onTheFly,
JavaResolveResult result) {
return new AccessStaticViaInstanceFix(expr, result, onTheFly);
protected LocalQuickFix createAccessStaticViaInstanceFix(PsiReferenceExpression expr,
boolean onTheFly,
JavaResolveResult result) {
return new AccessStaticViaInstanceFix(expr, result).asQuickFix();
}
}
java/java-impl/src/com/intellij/codeInsight/daemon/impl/quickfix/AccessStaticViaInstanceFix.java
+98 -120
View File
@@ -2,46 +2,70 @@
package com.intellij.codeInsight.daemon.impl.quickfix;
import com.intellij.codeInsight.BlockUtils;
import com.intellij.codeInsight.FileModificationService;
import com.intellij.codeInsight.daemon.QuickFixBundle;
import com.intellij.codeInsight.daemon.impl.analysis.HighlightMessageUtil;
import com.intellij.codeInsight.daemon.impl.analysis.HighlightUtil;
import com.intellij.codeInsight.highlighting.HighlightManager;
import com.intellij.codeInspection.LocalQuickFixAndIntentionActionOnPsiElement;
import com.intellij.codeInspection.ModCommands;
import com.intellij.codeInspection.util.IntentionName;
import com.intellij.java.JavaBundle;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.application.WriteAction;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.editor.colors.EditorColors;
import com.intellij.modcommand.ModChooseAction;
import com.intellij.modcommand.ModCommand;
import com.intellij.modcommand.PsiBasedModCommandAction;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.TextRange;
import com.intellij.psi.*;
import com.intellij.psi.util.*;
import com.intellij.util.IncorrectOperationException;
import com.intellij.psi.util.PsiFormatUtilBase;
import com.intellij.psi.util.PsiTreeUtil;
import com.intellij.util.ThreeState;
import com.intellij.util.containers.ContainerUtil;
import com.siyeh.ig.psiutils.CodeBlockSurrounder;
import com.siyeh.ig.psiutils.SideEffectChecker;
import com.siyeh.ig.psiutils.StatementExtractor;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
public class AccessStaticViaInstanceFix extends LocalQuickFixAndIntentionActionOnPsiElement {
private static final Logger LOG = Logger.getInstance(AccessStaticViaInstanceFix.class);
private final boolean myOnTheFly;
public class AccessStaticViaInstanceFix extends PsiBasedModCommandAction<PsiReferenceExpression> {
private final @IntentionName String myText;
private final @NotNull ThreeState myKeepSideEffects;
public AccessStaticViaInstanceFix(@NotNull PsiReferenceExpression expression, @NotNull JavaResolveResult result, boolean onTheFly) {
/**
* @deprecated onTheFly parameter is ignored. Use another constructor.
*/
@Deprecated
public AccessStaticViaInstanceFix(@NotNull PsiReferenceExpression expression,
@NotNull JavaResolveResult result,
@SuppressWarnings("unused") boolean onTheFly) {
this(expression, result);
}
public AccessStaticViaInstanceFix(@NotNull PsiReferenceExpression expression, @NotNull JavaResolveResult result) {
super(expression);
myOnTheFly = onTheFly;
PsiMember member = (PsiMember)result.getElement();
myText = calcText(member, result.getSubstitutor());
myText = calcText((PsiMember)Objects.requireNonNull(result.getElement()), result.getSubstitutor());
myKeepSideEffects = ThreeState.UNSURE;
}
private AccessStaticViaInstanceFix(@NotNull PsiReferenceExpression expression, boolean keepSideEffects) {
super(expression);
myText = "";
myKeepSideEffects = ThreeState.fromBoolean(keepSideEffects);
}
@NotNull
@Override
public String getText() {
return myText;
protected @Nullable Presentation getPresentation(@NotNull ActionContext context, @NotNull PsiReferenceExpression ref) {
return switch (myKeepSideEffects) {
case YES -> {
final PsiExpression qualifierExpression = ref.getQualifierExpression();
List<PsiExpression> sideEffects = qualifierExpression == null ?
List.of() : SideEffectChecker.extractSideEffectExpressions(qualifierExpression);
yield Presentation.of(JavaBundle.message("intention.family.name.extract.possible.side.effects"))
.withHighlighting(ContainerUtil.map2Array(sideEffects, TextRange.EMPTY_ARRAY, expression -> expression.getTextRange()));
}
case NO -> Presentation.of(JavaBundle.message("intention.family.name.delete.possible.side.effects"));
case UNSURE -> Presentation.of(myText);
};
}
private static @IntentionName String calcText(PsiMember member, PsiSubstitutor substitutor) {
@@ -60,110 +84,64 @@ public class AccessStaticViaInstanceFix extends LocalQuickFixAndIntentionActionO
}
@Override
public void invoke(@NotNull Project project,
@NotNull PsiFile file,
@Nullable Editor editor,
@NotNull PsiElement startElement,
@NotNull PsiElement endElement) {
final PsiReferenceExpression myExpression = (PsiReferenceExpression)startElement;
protected @NotNull ModCommand perform(@NotNull ActionContext context, @NotNull PsiReferenceExpression ref) {
final PsiExpression qualifierExpression = ref.getQualifierExpression();
List<PsiExpression> sideEffects = myKeepSideEffects == ThreeState.NO || qualifierExpression == null ?
List.of() : SideEffectChecker.extractSideEffectExpressions(qualifierExpression);
if (sideEffects.isEmpty()) {
return ModCommands.psiUpdate(ref, r -> invoke(r, List.of()));
} else {
if (myKeepSideEffects == ThreeState.UNSURE) {
if (!CodeBlockSurrounder.canSurround(ref)) {
return ModCommands.psiUpdate(ref, r -> invoke(r, List.of()));
}
return new ModChooseAction(QuickFixBundle.message("access.static.via.class.reference.title"), List.of(
new AccessStaticViaInstanceFix(ref, true),
new AccessStaticViaInstanceFix(ref, false)
));
}
return ModCommands.psiUpdate(ref, (r, updater) -> invoke(r, ContainerUtil.map(sideEffects, updater::getWritable)));
}
}
private static void invoke(@NotNull PsiReferenceExpression ref, @NotNull List<PsiExpression> sideEffects) {
PsiElement element = ref.resolve();
if (!(element instanceof PsiMember member)) return;
if (!myExpression.isValid()) return;
if (!FileModificationService.getInstance().prepareFileForWrite(myExpression.getContainingFile())) return;
PsiElement element = myExpression.resolve();
if (!(element instanceof PsiMember myMember)) return;
if (!myMember.isValid()) return;
PsiClass containingClass = myMember.getContainingClass();
PsiClass containingClass = member.getContainingClass();
if (containingClass == null || containingClass instanceof PsiAnonymousClass) return;
final PsiExpression qualifierExpression = myExpression.getQualifierExpression();
Project project = member.getProject();
PsiElementFactory factory = JavaPsiFacade.getElementFactory(project);
if (qualifierExpression != null && !checkSideEffects(project, containingClass, qualifierExpression, factory, myExpression,editor)) return;
WriteAction.run(() -> {
try {
PsiElement newQualifier = factory.createReferenceExpression(containingClass);
if (qualifierExpression != null) {
newQualifier = qualifierExpression.replace(newQualifier);
}
else {
myExpression.setQualifierExpression((PsiExpression)newQualifier);
newQualifier = myExpression.getQualifierExpression();
}
PsiElement qualifiedWithClassName = myExpression.copy();
if (myExpression.getTypeParameters().length == 0 && !(containingClass.isInterface() && !containingClass.equals(PsiTreeUtil.getParentOfType(myExpression, PsiClass.class)))) {
newQualifier.delete();
if (myExpression.resolve() != myMember) {
myExpression.replace(qualifiedWithClassName);
}
PsiExpression qualifierExpression = ref.getQualifierExpression();
if (!sideEffects.isEmpty()) {
Objects.requireNonNull(qualifierExpression);
CodeBlockSurrounder surrounder = CodeBlockSurrounder.forExpression(ref);
if (surrounder != null) {
PsiStatement[] statements = StatementExtractor.generateStatements(sideEffects, qualifierExpression);
CodeBlockSurrounder.SurroundResult result = surrounder.surround();
ref = (PsiReferenceExpression)result.getExpression();
qualifierExpression = ref.getQualifierExpression();
PsiStatement anchor = result.getAnchor();
if (statements.length > 0) {
BlockUtils.addBefore(anchor, statements);
}
}
catch (IncorrectOperationException e) {
LOG.error(e);
}
PsiElement newQualifier = factory.createReferenceExpression(containingClass);
if (qualifierExpression != null) {
newQualifier = qualifierExpression.replace(newQualifier);
}
else {
ref.setQualifierExpression((PsiExpression)newQualifier);
newQualifier = Objects.requireNonNull(ref.getQualifierExpression());
}
PsiElement qualifiedWithClassName = ref.copy();
if (ref.getTypeParameters().length == 0 &&
!(containingClass.isInterface() && !containingClass.equals(PsiTreeUtil.getParentOfType(ref, PsiClass.class)))) {
newQualifier.delete();
if (ref.resolve() != member) {
ref.replace(qualifiedWithClassName);
}
});
}
@Override
public boolean startInWriteAction() {
return false;
}
private boolean checkSideEffects(final Project project,
PsiClass containingClass,
final PsiExpression qualifierExpression,
PsiElementFactory factory,
final PsiElement myExpression,
Editor editor) {
final List<PsiElement> sideEffects = new ArrayList<>();
boolean hasSideEffects = RemoveUnusedVariableUtil.checkSideEffects(qualifierExpression, null, sideEffects);
if (hasSideEffects && !myOnTheFly) return false;
if (!hasSideEffects || ApplicationManager.getApplication().isUnitTestMode()) {
return true;
}
if (editor == null) {
return false;
}
HighlightManager.getInstance(project).addOccurrenceHighlights(editor, PsiUtilCore.toPsiElementArray(sideEffects),
EditorColors.SEARCH_RESULT_ATTRIBUTES, true, null);
try {
hasSideEffects = PsiUtil.isStatement(factory.createStatementFromText(qualifierExpression.getText(), qualifierExpression));
}
catch (IncorrectOperationException e) {
hasSideEffects = false;
}
final PsiReferenceExpression qualifiedWithClassName = (PsiReferenceExpression)myExpression.copy();
qualifiedWithClassName.setQualifierExpression(factory.createReferenceExpression(containingClass));
final PsiStatement statement = PsiTreeUtil.getParentOfType(myExpression, PsiStatement.class);
final boolean canCopeWithSideEffects = hasSideEffects && statement != null;
final SideEffectWarningDialog dialog =
new SideEffectWarningDialog(project, false, null, sideEffects.get(0).getText(), PsiExpressionTrimRenderer.render(qualifierExpression),
canCopeWithSideEffects){
@Override
protected String sideEffectsDescription() {
if (canCopeWithSideEffects) {
return MessageFormat.format(getFormatString(),
JavaBundle.message("side.effects.expression.presentation", qualifierExpression.getText()),
myExpression.getText(), //before text
qualifierExpression.getText() + ";" + "<br>" + qualifiedWithClassName.getText());//after text
}
return JavaBundle.message("side.effects.non.fixable.message", qualifierExpression.getText());
}
};
dialog.show();
int res = dialog.getExitCode();
if (res == RemoveUnusedVariableUtil.RemoveMode.CANCEL.ordinal()) return false;
if (res == RemoveUnusedVariableUtil.RemoveMode.MAKE_STATEMENT.ordinal()) {
final PsiStatement statementFromText = factory.createStatementFromText(qualifierExpression.getText() + ";", null);
LOG.assertTrue(statement != null);
WriteAction.run(() -> {
try {
PsiElement parent = statement.getParent();
BlockUtils.addBefore(parent instanceof PsiForStatement ? (PsiStatement)parent : statement, statementFromText);
}
catch (IncorrectOperationException e) {
LOG.error(e);
}
});
}
return true;
}
}
java/java-impl/src/com/intellij/codeInsight/intention/impl/config/QuickFixFactoryImpl.java
+1 -1
View File
@@ -917,7 +917,7 @@ public final class QuickFixFactoryImpl extends QuickFixFactory {
@Override
public LocalQuickFixAndIntentionActionOnPsiElement createAccessStaticViaInstanceFix(@NotNull PsiReferenceExpression methodRef,
@NotNull JavaResolveResult result) {
return new AccessStaticViaInstanceFix(methodRef, result, true);
return LocalQuickFixAndIntentionActionOnPsiElement.from(new AccessStaticViaInstanceFix(methodRef, result), methodRef);
}
@NotNull
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/after1.java → java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/after1SideEffect.java
+3 -2
View File
@@ -1,4 +1,4 @@
// "Access static 'AClass.fff' via class 'AClass' reference" "true"
// "Access static 'AClass.fff' via class 'AClass' reference" "true-preview"
class AClass
{
@@ -11,6 +11,7 @@ class AClass
class acc {
int f() {
AClass a = null;
return <caret>AClass.fff;
a.getA();
return AClass.fff;
}
}
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/after2.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Access static 'AClass.fff' via class 'AClass' reference" "true"
// "Access static 'AClass.fff' via class 'AClass' reference" "true-preview"
class AClass
{
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/after3.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Access static 'AClass.getA()' via class 'AClass' reference" "true"
// "Access static 'AClass.getA()' via class 'AClass' reference" "true-preview"
class AClass
{
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/after5.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Access static 'AClass.stat' via class 'AClass' reference" "true"
// "Access static 'AClass.stat' via class 'AClass' reference" "true-preview"
class AClass {
static boolean stat;
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/after6.java → java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/after6SideEffect.java
+3 -2
View File
@@ -1,4 +1,4 @@
// "Access static 'R.rr' via class 'R' reference" "true"
// "Access static 'R.rr' via class 'R' reference" "true-preview"
class AClass
{
@@ -11,7 +11,8 @@ class AClass
}
class ss {
void f(AClass d){
int i = <caret>AClass.R.rr;
d.getR();
int i = AClass.R.rr;
}
}
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/afterAccessForStaticMethodInInterface.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Access static 'I.m()' via class 'I' reference" "true"
// "Access static 'I.m()' via class 'I' reference" "true-preview"
interface I {
static void m() {}
}
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/afterAccessForStaticMethodInInterface1.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Access static 'I.m()' via class 'I' reference" "true"
// "Access static 'I.m()' via class 'I' reference" "true-preview"
interface I {
static void m() {}
}
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/afterAccessForStaticMethodInInterfaceNoQualifier.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Access static 'I.m()' via class 'I' reference" "true"
// "Access static 'I.m()' via class 'I' reference" "true-preview"
interface I {
static void m() {}
}
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/afterPreserveTypeArgs.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Access static 'Bug.right(B)' via class 'Bug' reference" "true"
// "Access static 'Bug.right(B)' via class 'Bug' reference" "true-preview"
class Bug<A, B> {
public A getLeft() {
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/before1.java → java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/before1SideEffect.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Access static 'AClass.fff' via class 'AClass' reference" "true"
// "Access static 'AClass.fff' via class 'AClass' reference" "true-preview"
class AClass
{
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/before2.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Access static 'AClass.fff' via class 'AClass' reference" "true"
// "Access static 'AClass.fff' via class 'AClass' reference" "true-preview"
class AClass
{
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/before3.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Access static 'AClass.getA()' via class 'AClass' reference" "true"
// "Access static 'AClass.getA()' via class 'AClass' reference" "true-preview"
class AClass
{
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/before5.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Access static 'AClass.stat' via class 'AClass' reference" "true"
// "Access static 'AClass.stat' via class 'AClass' reference" "true-preview"
class AClass {
static boolean stat;
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/before6.java → java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/before6SideEffect.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Access static 'R.rr' via class 'R' reference" "true"
// "Access static 'R.rr' via class 'R' reference" "true-preview"
class AClass
{
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/beforeAccessForStaticMethodInInterface.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Access static 'I.m()' via class 'I' reference" "true"
// "Access static 'I.m()' via class 'I' reference" "true-preview"
interface I {
static void m() {}
}
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/beforeAccessForStaticMethodInInterface1.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Access static 'I.m()' via class 'I' reference" "true"
// "Access static 'I.m()' via class 'I' reference" "true-preview"
interface I {
static void m() {}
}
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/beforeAccessForStaticMethodInInterfaceNoQualifier.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Access static 'I.m()' via class 'I' reference" "true"
// "Access static 'I.m()' via class 'I' reference" "true-preview"
interface I {
static void m() {}
}
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/accessStaticViaInstance/beforePreserveTypeArgs.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Access static 'Bug.right(B)' via class 'Bug' reference" "true"
// "Access static 'Bug.right(B)' via class 'Bug' reference" "true-preview"
class Bug<A, B> {
public A getLeft() {
java/java-tests/testSrc/com/intellij/codeInsight/daemon/impl/quickfix/AccessStaticViaInstanceTest.java
+14 -1
View File
@@ -1,12 +1,25 @@
// Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
package com.intellij.codeInsight.daemon.impl.quickfix;
import com.intellij.codeInsight.daemon.quickFix.LightQuickFixParameterizedTestCase;
import com.intellij.codeInspection.LocalInspectionTool;
import com.intellij.codeInspection.accessStaticViaInstance.AccessStaticViaInstance;
import com.intellij.ui.ChooserInterceptor;
import com.intellij.ui.UiInterceptors;
import org.jetbrains.annotations.NotNull;
import java.util.List;
public class AccessStaticViaInstanceTest extends LightQuickFixParameterizedTestCase {
@Override
protected void setUp() throws Exception {
super.setUp();
if (getTestName(false).endsWith("SideEffect.java")) {
UiInterceptors.register(new ChooserInterceptor(List.of("Delete possible side effects", "Extract possible side effects"),
"Extract possible side effects"));
}
}
@Override
protected LocalInspectionTool @NotNull [] configureLocalInspectionTools() {
return new LocalInspectionTool[] {new AccessStaticViaInstance()};