| /******************************************************************************* |
| * Copyright (c) 2000, 2012 IBM Corporation 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: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| |
| package org.eclipse.jdt.internal.ui.text.correction; |
| |
| import java.util.ArrayList; |
| import java.util.Collection; |
| |
| import org.eclipse.core.commands.AbstractHandler; |
| import org.eclipse.core.commands.ExecutionEvent; |
| import org.eclipse.core.commands.ExecutionException; |
| |
| import org.eclipse.jface.bindings.TriggerSequence; |
| import org.eclipse.jface.viewers.ISelection; |
| |
| import org.eclipse.jface.text.BadLocationException; |
| import org.eclipse.jface.text.IDocument; |
| import org.eclipse.jface.text.ITextSelection; |
| import org.eclipse.jface.text.ITextViewer; |
| import org.eclipse.jface.text.contentassist.ICompletionProposal; |
| import org.eclipse.jface.text.contentassist.ICompletionProposalExtension; |
| import org.eclipse.jface.text.contentassist.ICompletionProposalExtension2; |
| import org.eclipse.jface.text.source.Annotation; |
| import org.eclipse.jface.text.source.IAnnotationModel; |
| |
| import org.eclipse.ui.PlatformUI; |
| import org.eclipse.ui.keys.IBindingService; |
| |
| import org.eclipse.jdt.core.ICompilationUnit; |
| import org.eclipse.jdt.core.dom.ASTNode; |
| import org.eclipse.jdt.core.dom.SimpleName; |
| |
| import org.eclipse.jdt.ui.JavaUI; |
| import org.eclipse.jdt.ui.text.java.IInvocationContext; |
| import org.eclipse.jdt.ui.text.java.IJavaCompletionProposal; |
| import org.eclipse.jdt.ui.text.java.correction.ICommandAccess; |
| |
| import org.eclipse.jdt.internal.ui.actions.ActionUtil; |
| import org.eclipse.jdt.internal.ui.javaeditor.JavaEditor; |
| import org.eclipse.jdt.internal.ui.text.correction.proposals.LinkedNamesAssistProposal; |
| import org.eclipse.jdt.internal.ui.util.ASTHelper; |
| |
| /** |
| * Handler to be used to run a quick fix or assist by keyboard shortcut |
| */ |
| public class CorrectionCommandHandler extends AbstractHandler { |
| |
| private final JavaEditor fEditor; |
| private final String fId; |
| private final boolean fIsAssist; |
| |
| public CorrectionCommandHandler(JavaEditor editor, String id, boolean isAssist) { |
| fEditor= editor; |
| fId= id; |
| fIsAssist= isAssist; |
| } |
| |
| @Override |
| public Object execute(ExecutionEvent event) throws ExecutionException { |
| doExecute(); |
| return null; |
| } |
| |
| /** |
| * Try to execute the correction command. |
| * |
| * @return <code>true</code> iff the correction could be started |
| * @since 3.6 |
| */ |
| public boolean doExecute() { |
| ISelection selection= fEditor.getSelectionProvider().getSelection(); |
| ICompilationUnit cu= JavaUI.getWorkingCopyManager().getWorkingCopy(fEditor.getEditorInput()); |
| IAnnotationModel model= JavaUI.getDocumentProvider().getAnnotationModel(fEditor.getEditorInput()); |
| if (selection instanceof ITextSelection && cu != null && model != null) { |
| if (! ActionUtil.isEditable(fEditor)) { |
| return false; |
| } |
| ICompletionProposal proposal= findCorrection(fId, fIsAssist, (ITextSelection) selection, cu, model); |
| if (proposal != null) { |
| invokeProposal(proposal, ((ITextSelection) selection).getOffset()); |
| return true; |
| } |
| } |
| return false; |
| } |
| |
| private ICompletionProposal findCorrection(String id, boolean isAssist, ITextSelection selection, ICompilationUnit cu, IAnnotationModel model) { |
| AssistContext context= new AssistContext(cu, fEditor.getViewer(), fEditor, selection.getOffset(), selection.getLength()); |
| Collection<IJavaCompletionProposal> proposals= new ArrayList<>(10); |
| if (isAssist) { |
| if (id.equals(LinkedNamesAssistProposal.ASSIST_ID)) { |
| return getLocalRenameProposal(context); // shortcut for local rename |
| } |
| JavaCorrectionProcessor.collectAssists(context, new ProblemLocation[0], proposals); |
| } else { |
| try { |
| boolean goToClosest= selection.getLength() == 0; |
| Annotation[] annotations= getAnnotations(selection.getOffset(), goToClosest); |
| JavaCorrectionProcessor.collectProposals(context, model, annotations, true, false, proposals); |
| } catch (BadLocationException e) { |
| return null; |
| } |
| } |
| for (IJavaCompletionProposal curr : proposals) { |
| if (curr instanceof ICommandAccess) { |
| if (id.equals(((ICommandAccess) curr).getCommandId())) { |
| return curr; |
| } |
| } |
| } |
| return null; |
| } |
| |
| private Annotation[] getAnnotations(int offset, boolean goToClosest) throws BadLocationException { |
| ArrayList<Annotation> resultingAnnotations= new ArrayList<>(); |
| JavaCorrectionAssistant.collectQuickFixableAnnotations(fEditor, offset, goToClosest, resultingAnnotations); |
| return resultingAnnotations.toArray(new Annotation[resultingAnnotations.size()]); |
| } |
| |
| private ICompletionProposal getLocalRenameProposal(IInvocationContext context) { |
| ASTNode node= context.getCoveringNode(); |
| if (node instanceof SimpleName) { |
| SimpleName name= (SimpleName) node; |
| if (name.getAST().apiLevel() >= ASTHelper.JLS10 && name.isVar()) { |
| return null; |
| } |
| return new LinkedNamesAssistProposal(context, name); |
| } |
| return null; |
| } |
| |
| private IDocument getDocument() { |
| return JavaUI.getDocumentProvider().getDocument(fEditor.getEditorInput()); |
| } |
| |
| |
| private void invokeProposal(ICompletionProposal proposal, int offset) { |
| if (proposal instanceof ICompletionProposalExtension2) { |
| ITextViewer viewer= fEditor.getViewer(); |
| if (viewer != null) { |
| ((ICompletionProposalExtension2) proposal).apply(viewer, (char) 0, 0, offset); |
| return; |
| } |
| } else if (proposal instanceof ICompletionProposalExtension) { |
| IDocument document= getDocument(); |
| if (document != null) { |
| ((ICompletionProposalExtension) proposal).apply(document, (char) 0, offset); |
| return; |
| } |
| } |
| IDocument document= getDocument(); |
| if (document != null) { |
| proposal.apply(document); |
| } |
| } |
| |
| public static String getShortCutString(String proposalId) { |
| if (proposalId != null) { |
| IBindingService bindingService= PlatformUI.getWorkbench().getAdapter(IBindingService.class); |
| if (bindingService != null) { |
| TriggerSequence[] activeBindingsFor= bindingService.getActiveBindingsFor(proposalId); |
| if (activeBindingsFor.length > 0) { |
| return activeBindingsFor[0].format(); |
| } |
| } |
| } |
| return null; |
| } |
| |
| } |