Skip to content

Commit b5e88fe

Browse files
snjezasnjeza
committed
Improve code actions
Signed-off-by: Snjezana Peco <[email protected]>
1 parent ecd3b61 commit b5e88fe

File tree

8 files changed

+329
-86
lines changed

8 files changed

+329
-86
lines changed

‎org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/corrections/RefactorProcessor.java

+109-19
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import java.util.Map;
2323

2424
import org.eclipse.core.runtime.CoreException;
25+
import org.eclipse.core.runtime.IProgressMonitor;
2526
import org.eclipse.core.runtime.NullProgressMonitor;
2627
import org.eclipse.jdt.core.ICompilationUnit;
2728
import org.eclipse.jdt.core.IField;
@@ -110,8 +111,10 @@
110111
import org.eclipse.jdt.ui.text.java.IProblemLocation;
111112
import org.eclipse.lsp4j.CodeActionKind;
112113
import org.eclipse.lsp4j.CodeActionParams;
114+
import org.eclipse.ltk.core.refactoring.Change;
113115
import org.eclipse.ltk.core.refactoring.CheckConditionsOperation;
114116
import org.eclipse.ltk.core.refactoring.CreateChangeOperation;
117+
import org.eclipse.ltk.core.refactoring.NullChange;
115118
import org.eclipse.ltk.core.refactoring.RefactoringStatus;
116119

117120
/**
@@ -127,38 +130,99 @@ public RefactorProcessor(PreferenceManager preferenceManager) {
127130
}
128131

129132
public List<ProposalKindWrapper> getProposals(CodeActionParams params, IInvocationContext context, IProblemLocation[] locations) throws CoreException {
133+
return getProposals(params, context, locations, new NullProgressMonitor());
134+
}
135+
136+
public List<ProposalKindWrapper> getProposals(CodeActionParams params, IInvocationContext context, IProblemLocation[] locations, IProgressMonitor monitor) throws CoreException {
130137
ASTNode coveringNode = context.getCoveringNode();
138+
if (monitor != null && monitor.isCanceled()) {
139+
return Collections.emptyList();
140+
}
131141
if (coveringNode != null) {
132142
ArrayList<ProposalKindWrapper> proposals = new ArrayList<>();
133143

134144
InvertBooleanUtility.getInverseConditionProposals(params, context, coveringNode, proposals);
145+
if (monitor != null && monitor.isCanceled()) {
146+
return Collections.emptyList();
147+
}
135148
getInverseLocalVariableProposals(params, context, coveringNode, proposals);
136-
149+
if (monitor != null && monitor.isCanceled()) {
150+
return Collections.emptyList();
151+
}
137152
getMoveRefactoringProposals(params, context, coveringNode, proposals);
138-
153+
if (monitor != null && monitor.isCanceled()) {
154+
return Collections.emptyList();
155+
}
139156
boolean noErrorsAtLocation = noErrorsAtLocation(locations, coveringNode);
140157
if (noErrorsAtLocation) {
141158
boolean problemsAtLocation = locations.length != 0;
142159
getExtractVariableProposal(params, context, problemsAtLocation, proposals);
160+
if (monitor != null && monitor.isCanceled()) {
161+
return Collections.emptyList();
162+
}
143163
getExtractMethodProposal(params, context, coveringNode, problemsAtLocation, proposals);
164+
if (monitor != null && monitor.isCanceled()) {
165+
return Collections.emptyList();
166+
}
144167
getExtractFieldProposal(params, context, problemsAtLocation, proposals);
145-
getInlineProposal(context, coveringNode, proposals);
146-
168+
if (monitor != null && monitor.isCanceled()) {
169+
return Collections.emptyList();
170+
}
147171
getConvertAnonymousToNestedProposals(params, context, coveringNode, proposals);
172+
if (monitor != null && monitor.isCanceled()) {
173+
return Collections.emptyList();
174+
}
148175
getConvertAnonymousClassCreationsToLambdaProposals(context, coveringNode, proposals);
176+
if (monitor != null && monitor.isCanceled()) {
177+
return Collections.emptyList();
178+
}
149179
getConvertLambdaToAnonymousClassCreationsProposals(context, coveringNode, proposals);
180+
if (monitor != null && monitor.isCanceled()) {
181+
return Collections.emptyList();
182+
}
150183

151184
getConvertVarTypeToResolvedTypeProposal(context, coveringNode, proposals);
185+
if (monitor != null && monitor.isCanceled()) {
186+
return Collections.emptyList();
187+
}
152188
getConvertResolvedTypeToVarTypeProposal(context, coveringNode, proposals);
189+
if (monitor != null && monitor.isCanceled()) {
190+
return Collections.emptyList();
191+
}
153192

154193
getAddStaticImportProposals(context, coveringNode, proposals);
194+
if (monitor != null && monitor.isCanceled()) {
195+
return Collections.emptyList();
196+
}
155197

156198
getConvertForLoopProposal(context, coveringNode, proposals);
199+
if (monitor != null && monitor.isCanceled()) {
200+
return Collections.emptyList();
201+
}
157202
getAssignToVariableProposals(context, coveringNode, locations, proposals, params);
158-
getIntroduceParameterProposals(params, context, coveringNode, locations, proposals);
203+
if (monitor != null && monitor.isCanceled()) {
204+
return Collections.emptyList();
205+
}
159206
getExtractInterfaceProposal(params, context, proposals);
160-
getChangeSignatureProposal(params, context, proposals);
207+
if (monitor != null && monitor.isCanceled()) {
208+
return Collections.emptyList();
209+
}
161210
getSurroundWithTryCatchProposal(context, proposals);
211+
if (monitor != null && monitor.isCanceled()) {
212+
return Collections.emptyList();
213+
}
214+
getChangeSignatureProposal(params, context, proposals);
215+
if (monitor != null && monitor.isCanceled()) {
216+
return Collections.emptyList();
217+
}
218+
getIntroduceParameterProposals(params, context, coveringNode, locations, proposals);
219+
if (monitor != null && monitor.isCanceled()) {
220+
return Collections.emptyList();
221+
}
222+
getInlineProposal(context, coveringNode, proposals);
223+
if (monitor != null && monitor.isCanceled()) {
224+
return Collections.emptyList();
225+
}
162226
}
163227
return proposals;
164228
}
@@ -334,15 +398,27 @@ private boolean getInlineProposal(IInvocationContext context, ASTNode node, Coll
334398
// Inline Constant (static final field)
335399
if (RefactoringAvailabilityTesterCore.isInlineConstantAvailable((IField) varBinding.getJavaElement())) {
336400
InlineConstantRefactoring refactoring = new InlineConstantRefactoring(context.getCompilationUnit(), context.getASTRoot(), context.getSelectionOffset(), context.getSelectionLength());
337-
if (refactoring != null && refactoring.checkInitialConditions(new NullProgressMonitor()).isOK() && refactoring.getReferences(new NullProgressMonitor(), new RefactoringStatus()).length > 0) {
338-
refactoring.setRemoveDeclaration(refactoring.isDeclarationSelected());
339-
refactoring.setReplaceAllReferences(refactoring.isDeclarationSelected());
340-
CheckConditionsOperation check = new CheckConditionsOperation(refactoring, CheckConditionsOperation.FINAL_CONDITIONS);
341-
final CreateChangeOperation create = new CreateChangeOperation(check, RefactoringStatus.FATAL);
342-
create.run(new NullProgressMonitor());
401+
if (refactoring != null) {
343402
String label = ActionMessages.InlineConstantRefactoringAction_label;
344403
int relevance = IProposalRelevance.INLINE_LOCAL;
345-
ChangeCorrectionProposalCore proposal = new ChangeCorrectionProposalCore(label, create.getChange(), relevance);
404+
ChangeCorrectionProposalCore proposal = new ChangeCorrectionProposalCore(label, null /*create.getChange()*/, relevance) {
405+
@Override
406+
public Change getChange() throws CoreException {
407+
if (refactoring.checkInitialConditions(new NullProgressMonitor()).isOK() && refactoring.getReferences(new NullProgressMonitor(), new RefactoringStatus()).length > 0) {
408+
refactoring.setRemoveDeclaration(refactoring.isDeclarationSelected());
409+
refactoring.setReplaceAllReferences(refactoring.isDeclarationSelected());
410+
CheckConditionsOperation check = new CheckConditionsOperation(refactoring, CheckConditionsOperation.FINAL_CONDITIONS);
411+
final CreateChangeOperation create = new CreateChangeOperation(check, RefactoringStatus.FATAL);
412+
try {
413+
create.run(new NullProgressMonitor());
414+
return create.getChange();
415+
} catch (CoreException e) {
416+
JavaLanguageServerPlugin.log(e);
417+
}
418+
}
419+
return new NullChange();
420+
}
421+
};
346422
resultingCollections.add(CodeActionHandler.wrap(proposal, CodeActionKind.RefactorInline));
347423
return true;
348424
}
@@ -357,8 +433,10 @@ private boolean getInlineProposal(IInvocationContext context, ASTNode node, Coll
357433
}
358434

359435
// Inline Local Variable
436+
// https://github.com/eclipse-jdtls/eclipse.jdt.ls/issues/3321
437+
// I haven't enhanced it because InlineVariableTest.testInlineLocalVariableWithNoReferences() fails; can be enhanced
360438
if (binding.getJavaElement() instanceof ILocalVariable localVar && RefactoringAvailabilityTesterCore.isInlineTempAvailable(localVar)) {
361-
InlineTempRefactoring refactoring= new InlineTempRefactoring((VariableDeclaration) decl);
439+
InlineTempRefactoring refactoring = new InlineTempRefactoring((VariableDeclaration) decl);
362440
boolean status;
363441
try {
364442
status = refactoring.checkAllConditions(new NullProgressMonitor()).isOK();
@@ -382,13 +460,25 @@ private boolean getInlineProposal(IInvocationContext context, ASTNode node, Coll
382460
// Inline Method
383461
if (RefactoringAvailabilityTesterCore.isInlineMethodAvailable((IMethod) binding.getJavaElement())) {
384462
InlineMethodRefactoring refactoring = InlineMethodRefactoring.create(context.getCompilationUnit(), context.getASTRoot(), context.getSelectionOffset(), context.getSelectionLength());
385-
if (refactoring != null && refactoring.checkInitialConditions(new NullProgressMonitor()).isOK()) {
386-
CheckConditionsOperation check = new CheckConditionsOperation(refactoring, CheckConditionsOperation.FINAL_CONDITIONS);
387-
final CreateChangeOperation create = new CreateChangeOperation(check, RefactoringStatus.FATAL);
388-
create.run(new NullProgressMonitor());
463+
if (refactoring != null) {
389464
String label = ActionMessages.InlineMethodRefactoringAction_label;
390465
int relevance = IProposalRelevance.INLINE_LOCAL;
391-
ChangeCorrectionProposalCore proposal = new ChangeCorrectionProposalCore(label, create.getChange(), relevance);
466+
ChangeCorrectionProposalCore proposal = new ChangeCorrectionProposalCore(label, null /*create.getChange()*/, relevance) {
467+
@Override
468+
public Change getChange() throws CoreException {
469+
if (refactoring.checkInitialConditions(new NullProgressMonitor()).isOK()) {
470+
CheckConditionsOperation check = new CheckConditionsOperation(refactoring, CheckConditionsOperation.FINAL_CONDITIONS);
471+
final CreateChangeOperation create = new CreateChangeOperation(check, RefactoringStatus.FATAL);
472+
try {
473+
create.run(new NullProgressMonitor());
474+
return create.getChange();
475+
} catch (CoreException e) {
476+
JavaLanguageServerPlugin.log(e);
477+
}
478+
}
479+
return new NullChange();
480+
}
481+
};
392482
resultingCollections.add(CodeActionHandler.wrap(proposal, CodeActionKind.RefactorInline));
393483
return true;
394484
}

‎org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/ChangeSignatureInfoHandler.java

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
/*******************************************************************************
2+
* Copyright (c) 2016-2024 Red Hat Inc. and others.
3+
* All rights reserved. This program and the accompanying materials
4+
* are made available under the terms of the Eclipse Public License 2.0
5+
* which accompanies this distribution, and is available at
6+
* https://www.eclipse.org/legal/epl-2.0/
7+
*
8+
* SPDX-License-Identifier: EPL-2.0
9+
*
10+
* Contributors:
11+
* Red Hat Inc. - initial API and implementation
12+
*******************************************************************************/
13+
package org.eclipse.jdt.ls.core.internal.handlers;
14+
15+
import java.util.ArrayList;
16+
import java.util.List;
17+
18+
import org.eclipse.core.runtime.CoreException;
19+
import org.eclipse.core.runtime.IProgressMonitor;
20+
import org.eclipse.core.runtime.NullProgressMonitor;
21+
import org.eclipse.jdt.core.ICompilationUnit;
22+
import org.eclipse.jdt.core.IJavaElement;
23+
import org.eclipse.jdt.core.IMethod;
24+
import org.eclipse.jdt.core.dom.ASTNode;
25+
import org.eclipse.jdt.core.dom.CompilationUnit;
26+
import org.eclipse.jdt.core.dom.IMethodBinding;
27+
import org.eclipse.jdt.core.dom.MethodDeclaration;
28+
import org.eclipse.jdt.core.manipulation.CoreASTProvider;
29+
import org.eclipse.jdt.internal.corext.refactoring.ExceptionInfo;
30+
import org.eclipse.jdt.internal.corext.refactoring.ParameterInfo;
31+
import org.eclipse.jdt.internal.corext.refactoring.RefactoringAvailabilityTesterCore;
32+
import org.eclipse.jdt.internal.corext.refactoring.structure.ChangeSignatureProcessor;
33+
import org.eclipse.jdt.internal.corext.util.JdtFlags;
34+
import org.eclipse.jdt.ls.core.internal.JDTUtils;
35+
import org.eclipse.jdt.ls.core.internal.JavaLanguageServerPlugin;
36+
import org.eclipse.jdt.ls.core.internal.handlers.ChangeSignatureHandler.MethodException;
37+
import org.eclipse.jdt.ls.core.internal.handlers.ChangeSignatureHandler.MethodParameter;
38+
import org.eclipse.jdt.ls.core.internal.text.correction.ChangeSignatureInfo;
39+
import org.eclipse.jdt.ls.core.internal.text.correction.CodeActionUtility;
40+
import org.eclipse.jdt.ui.text.java.IInvocationContext;
41+
import org.eclipse.lsp4j.CodeActionParams;
42+
import org.eclipse.ltk.core.refactoring.RefactoringStatus;
43+
44+
public class ChangeSignatureInfoHandler {
45+
46+
/**
47+
*
48+
*/
49+
private static final String CANNOT_CHANGE_SIGNATURE = "Cannot change signature.";
50+
51+
public static ChangeSignatureInfo getChangeSignatureInfo(CodeActionParams params, IProgressMonitor monitor) {
52+
if (monitor.isCanceled()) {
53+
return null;
54+
}
55+
final ICompilationUnit unit = JDTUtils.resolveCompilationUnit(params.getTextDocument().getUri());
56+
if (unit == null || monitor.isCanceled()) {
57+
return null;
58+
}
59+
CompilationUnit astRoot = CoreASTProvider.getInstance().getAST(unit, CoreASTProvider.WAIT_YES, monitor);
60+
if (astRoot == null || monitor.isCanceled()) {
61+
return null;
62+
}
63+
IInvocationContext context = CodeActionHandler.getContext(unit, astRoot, params.getRange());
64+
ASTNode methodNode = CodeActionUtility.inferASTNode(context.getCoveringNode(), MethodDeclaration.class);
65+
if (methodNode == null) {
66+
return null;
67+
}
68+
IMethodBinding methodBinding = ((MethodDeclaration) methodNode).resolveBinding();
69+
if (methodBinding == null) {
70+
return null;
71+
}
72+
IJavaElement element = methodBinding.getJavaElement();
73+
if (element instanceof IMethod method) {
74+
try {
75+
ChangeSignatureProcessor processor = new ChangeSignatureProcessor(method);
76+
if (RefactoringAvailabilityTesterCore.isChangeSignatureAvailable(method)) {
77+
RefactoringStatus status = processor.checkInitialConditions(new NullProgressMonitor());
78+
if (status.isOK()) {
79+
List<MethodParameter> parameters = new ArrayList<>();
80+
for (ParameterInfo info : processor.getParameterInfos()) {
81+
parameters.add(new MethodParameter(info.getOldTypeName(), info.getOldName(), info.getDefaultValue() == null ? "null" : info.getDefaultValue(), info.getOldIndex()));
82+
}
83+
List<MethodException> exceptions = new ArrayList<>();
84+
for (ExceptionInfo info : processor.getExceptionInfos()) {
85+
exceptions.add(new MethodException(info.getFullyQualifiedName(), info.getElement().getHandleIdentifier()));
86+
}
87+
return new ChangeSignatureInfo(method.getHandleIdentifier(), JdtFlags.getVisibilityString(processor.getVisibility()), processor.getReturnTypeString(), method.getElementName(),
88+
parameters.toArray(MethodParameter[]::new), exceptions.toArray(MethodException[]::new));
89+
} else {
90+
return new ChangeSignatureInfo(CANNOT_CHANGE_SIGNATURE + status.getMessageMatchingSeverity(status.getSeverity()));
91+
}
92+
}
93+
} catch (CoreException e) {
94+
JavaLanguageServerPlugin.logException(e);
95+
}
96+
}
97+
return new ChangeSignatureInfo(CANNOT_CHANGE_SIGNATURE);
98+
}
99+
100+
}

‎org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/CodeActionHandler.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ public List<Either<Command, CodeAction>> getCodeActionCommands(CodeActionParams
202202

203203
if (containsKind(codeActionKinds, CodeActionKind.Refactor)) {
204204
try {
205-
List<ProposalKindWrapper> refactorProposals = this.refactorProcessor.getProposals(params, context, locations);
205+
List<ProposalKindWrapper> refactorProposals = this.refactorProcessor.getProposals(params, context, locations, monitor);
206206
refactorProposals.sort(comparator);
207207
proposals.addAll(refactorProposals);
208208
} catch (CoreException e) {

‎org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/JDTLanguageServer.java

+7
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@
8484
import org.eclipse.jdt.ls.core.internal.managers.TelemetryManager;
8585
import org.eclipse.jdt.ls.core.internal.preferences.PreferenceManager;
8686
import org.eclipse.jdt.ls.core.internal.preferences.Preferences;
87+
import org.eclipse.jdt.ls.core.internal.text.correction.ChangeSignatureInfo;
8788
import org.eclipse.lsp4j.CallHierarchyIncomingCall;
8889
import org.eclipse.lsp4j.CallHierarchyIncomingCallsParams;
8990
import org.eclipse.lsp4j.CallHierarchyItem;
@@ -1134,6 +1135,12 @@ public CompletableFuture<RefactorWorkspaceEdit> getRefactorEdit(GetRefactorEditP
11341135
return computeAsync((monitor) -> GetRefactorEditHandler.getEditsForRefactor(params));
11351136
}
11361137

1138+
@Override
1139+
public CompletableFuture<ChangeSignatureInfo> getChangeSignatureInfo(CodeActionParams params) {
1140+
debugTrace(">> java/getChangeSignatureInfo");
1141+
return computeAsync((monitor) -> ChangeSignatureInfoHandler.getChangeSignatureInfo(params, monitor));
1142+
}
1143+
11371144
@Override
11381145
public CompletableFuture<List<SelectionInfo>> inferSelection(InferSelectionParams params) {
11391146
debugTrace(">> java/inferSelection");

0 commit comments

Comments
 (0)