| /******************************************************************************* |
| * Copyright (c) 2000, 2006 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/epl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| |
| package org.eclipse.jdt.internal.ui.text.correction; |
| |
| import org.eclipse.text.edits.MultiTextEdit; |
| import org.eclipse.text.edits.TextEdit; |
| |
| import org.eclipse.core.runtime.CoreException; |
| import org.eclipse.core.runtime.IStatus; |
| import org.eclipse.core.runtime.NullProgressMonitor; |
| |
| import org.eclipse.swt.graphics.Image; |
| |
| import org.eclipse.jface.dialogs.ErrorDialog; |
| |
| import org.eclipse.jface.text.BadLocationException; |
| import org.eclipse.jface.text.Document; |
| import org.eclipse.jface.text.IDocument; |
| import org.eclipse.jface.text.IRegion; |
| |
| import org.eclipse.ui.IEditorPart; |
| import org.eclipse.ui.IWorkbenchPage; |
| |
| import org.eclipse.compare.rangedifferencer.IRangeComparator; |
| import org.eclipse.compare.rangedifferencer.RangeDifference; |
| import org.eclipse.compare.rangedifferencer.RangeDifferencer; |
| |
| import org.eclipse.ltk.core.refactoring.Change; |
| import org.eclipse.ltk.core.refactoring.DocumentChange; |
| import org.eclipse.ltk.core.refactoring.TextChange; |
| import org.eclipse.ltk.core.refactoring.TextFileChange; |
| |
| import org.eclipse.jdt.core.ICompilationUnit; |
| import org.eclipse.jdt.core.JavaModelException; |
| |
| import org.eclipse.jdt.internal.corext.codemanipulation.StubUtility; |
| import org.eclipse.jdt.internal.corext.refactoring.changes.CompilationUnitChange; |
| import org.eclipse.jdt.internal.corext.util.Resources; |
| import org.eclipse.jdt.internal.corext.util.Strings; |
| |
| import org.eclipse.jdt.ui.JavaUI; |
| |
| import org.eclipse.jdt.internal.ui.JavaPlugin; |
| import org.eclipse.jdt.internal.ui.JavaUIStatus; |
| import org.eclipse.jdt.internal.ui.compare.JavaTokenComparator; |
| import org.eclipse.jdt.internal.ui.javaeditor.EditorUtility; |
| import org.eclipse.jdt.internal.ui.util.ExceptionHandler; |
| |
| /** |
| * A proposal for quick fixes and quick assist that work on a single compilation unit. |
| * Either a {@link TextChange text change} is directly passed in the constructor or method |
| * {@link #addEdits(IDocument, TextEdit)} is overridden to provide the text edits that are |
| * applied to the document when the proposal is evaluated. |
| * <p> |
| * The proposal takes care of the preview of the changes as proposal information. |
| * </p> |
| * @since 3.2 |
| */ |
| public class CUCorrectionProposal extends ChangeCorrectionProposal { |
| |
| private ICompilationUnit fCompilationUnit; |
| |
| /** |
| * Constructs a correction proposal working on a compilation unit with a given text change |
| * |
| * @param name the name that is displayed in the proposal selection dialog. |
| * @param cu the compilation unit on that the change works. |
| * @param change the change that is executed when the proposal is applied or <code>null</code> |
| * if implementors override {@link #addEdits(IDocument, TextEdit)} to provide |
| * the text edits or {@link #createTextChange()} to provide a text change. |
| * @param relevance the relevance of this proposal. |
| * @param image the image that is displayed for this proposal or <code>null</code> if no |
| * image is desired. |
| */ |
| public CUCorrectionProposal(String name, ICompilationUnit cu, TextChange change, int relevance, Image image) { |
| super(name, change, relevance, image); |
| if (cu == null) { |
| throw new IllegalArgumentException("Compilation unit must not be null"); //$NON-NLS-1$ |
| } |
| fCompilationUnit= cu; |
| } |
| |
| /** |
| * Constructs a correction proposal working on a compilation unit. |
| * <p>Users have to override {@link #addEdits(IDocument, TextEdit)} to provide |
| * the text edits or {@link #createTextChange()} to provide a text change. |
| * </p> |
| * |
| * @param name The name that is displayed in the proposal selection dialog. |
| * @param cu The compilation unit on that the change works. |
| * @param relevance The relevance of this proposal. |
| * @param image The image that is displayed for this proposal or <code>null</code> if no |
| * image is desired. |
| */ |
| protected CUCorrectionProposal(String name, ICompilationUnit cu, int relevance, Image image) { |
| this(name, cu, null, relevance, image); |
| } |
| |
| /** |
| * Called when the {@link CompilationUnitChange} is initialized. Subclasses can override to |
| * add text edits to the root edit of the change. Implementors must not access the proposal, |
| * e.g getting the change. |
| * <p>The default implementation does not add any edits</p> |
| * |
| * @param document content of the underlying compilation unit. To be accessed read only. |
| * @param editRoot The root edit to add all edits to |
| * @throws CoreException can be thrown if adding the edits is failing. |
| */ |
| protected void addEdits(IDocument document, TextEdit editRoot) throws CoreException { |
| if (false) { |
| throw new CoreException(JavaUIStatus.createError(IStatus.ERROR, "Implementors can throw an exception", null)); //$NON-NLS-1$ |
| } |
| } |
| |
| /* |
| * @see ICompletionProposal#getAdditionalProposalInfo() |
| */ |
| public String getAdditionalProposalInfo() { |
| StringBuffer buf= new StringBuffer(); |
| |
| try { |
| TextChange change= getTextChange(); |
| |
| IDocument previewContent= change.getPreviewDocument(new NullProgressMonitor()); |
| String currentConentString= change.getCurrentContent(new NullProgressMonitor()); |
| |
| /* |
| * Do not change the type of those local variables. We use Object |
| * here in order to prevent loading of the Compare plug-in at load |
| * time of this class. |
| */ |
| Object leftSide= new JavaTokenComparator(previewContent.get(), true); |
| Object rightSide= new JavaTokenComparator(currentConentString, true); |
| |
| RangeDifference[] differences= RangeDifferencer.findRanges((IRangeComparator)leftSide, (IRangeComparator)rightSide); |
| for (int i= 0; i < differences.length; i++) { |
| RangeDifference curr= differences[i]; |
| int start= ((JavaTokenComparator)leftSide).getTokenStart(curr.leftStart()); |
| int end= ((JavaTokenComparator)leftSide).getTokenStart(curr.leftEnd()); |
| if (curr.kind() == RangeDifference.CHANGE && curr.leftLength() > 0) { |
| buf.append("<b>"); //$NON-NLS-1$ |
| appendContent(previewContent, start, end, buf, false); |
| buf.append("</b>"); //$NON-NLS-1$ |
| } else if (curr.kind() == RangeDifference.NOCHANGE) { |
| appendContent(previewContent, start, end, buf, true); |
| } |
| } |
| } catch (CoreException e) { |
| JavaPlugin.log(e); |
| } catch (BadLocationException e) { |
| JavaPlugin.log(e); |
| } |
| return buf.toString(); |
| } |
| |
| private final int surroundLines= 1; |
| |
| private void appendContent(IDocument text, int startOffset, int endOffset, StringBuffer buf, boolean surroundLinesOnly) throws BadLocationException { |
| int startLine= text.getLineOfOffset(startOffset); |
| int endLine= text.getLineOfOffset(endOffset); |
| |
| boolean dotsAdded= false; |
| if (surroundLinesOnly && startOffset == 0) { // no surround lines for the top no-change range |
| startLine= Math.max(endLine - surroundLines, 0); |
| buf.append("...<br>"); //$NON-NLS-1$ |
| dotsAdded= true; |
| } |
| |
| for (int i= startLine; i <= endLine; i++) { |
| if (surroundLinesOnly) { |
| if ((i - startLine > surroundLines) && (endLine - i > surroundLines)) { |
| if (!dotsAdded) { |
| buf.append("...<br>"); //$NON-NLS-1$ |
| dotsAdded= true; |
| } else if (endOffset == text.getLength()) { |
| return; // no surround lines for the bottom no-change range |
| } |
| continue; |
| } |
| } |
| |
| IRegion lineInfo= text.getLineInformation(i); |
| int start= lineInfo.getOffset(); |
| int end= start + lineInfo.getLength(); |
| |
| int from= Math.max(start, startOffset); |
| int to= Math.min(end, endOffset); |
| String content= text.get(from, to - from); |
| if (surroundLinesOnly && (from == start) && Strings.containsOnlyWhitespaces(content)) { |
| continue; // ignore empty lines except when range started in the middle of a line |
| } |
| for (int k= 0; k < content.length(); k++) { |
| char ch= content.charAt(k); |
| if (ch == '<') { |
| buf.append("<"); //$NON-NLS-1$ |
| } else if (ch == '>') { |
| buf.append(">"); //$NON-NLS-1$ |
| } else { |
| buf.append(ch); |
| } |
| } |
| if (to == end && to != endOffset) { // new line when at the end of the line, and not end of range |
| buf.append("<br>"); //$NON-NLS-1$ |
| } |
| } |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.jface.text.contentassist.ICompletionProposal#apply(org.eclipse.jface.text.IDocument) |
| */ |
| public void apply(IDocument document) { |
| try { |
| ICompilationUnit unit= getCompilationUnit(); |
| IEditorPart part= null; |
| if (unit.getResource().exists()) { |
| boolean canEdit= performValidateEdit(unit); |
| if (!canEdit) { |
| return; |
| } |
| part= EditorUtility.isOpenInEditor(unit); |
| if (part == null) { |
| part= EditorUtility.openInEditor(unit, true); |
| if (part != null) { |
| document= JavaUI.getDocumentProvider().getDocument(part.getEditorInput()); |
| } |
| } |
| IWorkbenchPage page= JavaPlugin.getActivePage(); |
| if (page != null && part != null) { |
| page.bringToTop(part); |
| } |
| if (part != null) { |
| part.setFocus(); |
| } |
| } |
| performChange(part, document); |
| } catch (CoreException e) { |
| ExceptionHandler.handle(e, CorrectionMessages.CUCorrectionProposal_error_title, CorrectionMessages.CUCorrectionProposal_error_message); |
| } |
| } |
| |
| private boolean performValidateEdit(ICompilationUnit unit) { |
| IStatus status= Resources.makeCommittable(unit.getResource(), JavaPlugin.getActiveWorkbenchShell()); |
| if (!status.isOK()) { |
| String label= CorrectionMessages.CUCorrectionProposal_error_title; |
| String message= CorrectionMessages.CUCorrectionProposal_error_message; |
| ErrorDialog.openError(JavaPlugin.getActiveWorkbenchShell(), label, message, status); |
| return false; |
| } |
| return true; |
| } |
| |
| /** |
| * Creates the text change for this proposal. |
| * This method is only called once and only when no text change has been passed in |
| * {@link #CUCorrectionProposal(String, ICompilationUnit, TextChange, int, Image)}. |
| * |
| * @return returns the created text change. |
| * @throws CoreException thrown if the creation of the text change failed. |
| */ |
| protected TextChange createTextChange() throws CoreException { |
| ICompilationUnit cu= getCompilationUnit(); |
| String name= getDisplayString(); |
| TextChange change; |
| if (!cu.getResource().exists()) { |
| String source; |
| try { |
| source= cu.getSource(); |
| } catch (JavaModelException e) { |
| JavaPlugin.log(e); |
| source= new String(); // empty |
| } |
| Document document= new Document(source); |
| document.setInitialLineDelimiter(StubUtility.getLineDelimiterUsed(cu)); |
| change= new DocumentChange(name, document); |
| } else { |
| CompilationUnitChange cuChange = new CompilationUnitChange(name, cu); |
| cuChange.setSaveMode(TextFileChange.LEAVE_DIRTY); |
| change= cuChange; |
| } |
| TextEdit rootEdit= new MultiTextEdit(); |
| change.setEdit(rootEdit); |
| |
| // initialize text change |
| IDocument document= change.getCurrentDocument(new NullProgressMonitor()); |
| addEdits(document, rootEdit); |
| return change; |
| } |
| |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.jdt.internal.ui.text.correction.ChangeCorrectionProposal#createChange() |
| */ |
| protected final Change createChange() throws CoreException { |
| return createTextChange(); // make sure that only text changes are allowed here |
| } |
| |
| /** |
| * Gets the text change that is invoked when the change is applied. |
| * |
| * @return returns the text change that is invoked when the change is applied. |
| * @throws CoreException throws an exception if accessing the change failed |
| */ |
| public final TextChange getTextChange() throws CoreException { |
| return (TextChange) getChange(); |
| } |
| |
| /** |
| * The compilation unit on that the change works. |
| * |
| * @return the compilation unit on that the change works. |
| */ |
| public final ICompilationUnit getCompilationUnit() { |
| return fCompilationUnit; |
| } |
| |
| /** |
| * Creates a preview of the content of the compilation unit after applying the change. |
| * |
| * @return returns the preview of the changed compilation unit. |
| * @throws CoreException thrown if the creation of the change failed. |
| */ |
| public String getPreviewContent() throws CoreException { |
| return getTextChange().getPreviewContent(new NullProgressMonitor()); |
| } |
| |
| /* (non-Javadoc) |
| * @see java.lang.Object#toString() |
| */ |
| public String toString() { |
| try { |
| return getPreviewContent(); |
| } catch (CoreException e) { |
| } |
| return super.toString(); |
| } |
| } |
