/*******************************************************************************
* Copyright (c) 2009 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
* Zend Technologies
*******************************************************************************/
package org.eclipse.php.internal.ui.text.correction.proposals;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.dltk.core.ISourceModule;
import org.eclipse.dltk.core.ModelException;
import org.eclipse.dltk.core.manipulation.SourceModuleChange;
import org.eclipse.dltk.internal.corext.util.Resources;
import org.eclipse.dltk.internal.corext.util.Strings;
import org.eclipse.dltk.internal.ui.DLTKUIStatus;
import org.eclipse.dltk.internal.ui.editor.EditorUtility;
import org.eclipse.dltk.ui.DLTKUIPlugin;
import org.eclipse.jface.dialogs.ErrorDialog;
import org.eclipse.jface.text.*;
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.php.internal.ui.PHPUiPlugin;
import org.eclipse.php.internal.ui.corext.codemanipulation.StubUtility;
import org.eclipse.php.internal.ui.corext.fix.LinkedProposalModel;
import org.eclipse.php.internal.ui.corext.fix.LinkedProposalPositionGroup;
import org.eclipse.php.internal.ui.editor.PHPStructuredEditor;
import org.eclipse.php.internal.ui.text.correction.CorrectionMessages;
import org.eclipse.php.internal.ui.util.ExceptionHandler;
import org.eclipse.php.internal.ui.viewsupport.LinkedProposalModelPresenter;
import org.eclipse.swt.graphics.Image;
import org.eclipse.text.edits.*;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.texteditor.ITextEditor;
import org.eclipse.wst.jsdt.internal.corext.refactoring.changes.CompilationUnitChange;
/**
* 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 ISourceModule fCompilationUnit;
private LinkedProposalModel fLinkedProposalModel;
/**
* 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, ISourceModule cu,
TextChange change, int relevance, Image image) {
super(name, change, relevance, image);
if (cu == null) {
throw new IllegalArgumentException(
CorrectionMessages.CUCorrectionProposal_0);
}
fCompilationUnit = cu;
fLinkedProposalModel = null;
}
/**
* 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, ISourceModule 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 {
}
protected LinkedProposalModel getLinkedProposalModel() {
if (fLinkedProposalModel == null) {
fLinkedProposalModel = new LinkedProposalModel();
}
return fLinkedProposalModel;
}
public void setLinkedProposalModel(LinkedProposalModel model) {
fLinkedProposalModel = model;
}
public Object getAdditionalProposalInfo(IProgressMonitor monitor) {
final StringBuffer buf = new StringBuffer();
try {
final TextChange change = getTextChange();
change.setKeepPreviewEdits(true);
final IDocument previewContent = change.getPreviewDocument(monitor);
final TextEdit rootEdit = change.getPreviewEdit(change.getEdit());
class EditAnnotator extends TextEditVisitor {
private int fWrittenToPos = 0;
public void unchangedUntil(int pos) {
if (pos > fWrittenToPos) {
appendContent(previewContent, fWrittenToPos, pos, buf,
true);
fWrittenToPos = pos;
}
}
public boolean visit(MoveTargetEdit edit) {
return true; // rangeAdded(edit);
}
public boolean visit(CopyTargetEdit edit) {
return true; // return rangeAdded(edit);
}
public boolean visit(InsertEdit edit) {
return rangeAdded(edit);
}
public boolean visit(ReplaceEdit edit) {
if (edit.getLength() > 0)
return rangeAdded(edit);
return rangeRemoved(edit);
}
public boolean visit(MoveSourceEdit edit) {
return rangeRemoved(edit);
}
public boolean visit(DeleteEdit edit) {
return rangeRemoved(edit);
}
private boolean rangeRemoved(TextEdit edit) {
unchangedUntil(edit.getOffset());
return false;
}
private boolean rangeAdded(TextEdit edit) {
unchangedUntil(edit.getOffset());
buf.append("<b>"); //$NON-NLS-1$
appendContent(previewContent, edit.getOffset(), edit
.getExclusiveEnd(), buf, false);
buf.append("</b>"); //$NON-NLS-1$
fWrittenToPos = edit.getExclusiveEnd();
return false;
}
}
EditAnnotator ea = new EditAnnotator();
rootEdit.accept(ea);
// Final pre-existing region
ea.unchangedUntil(previewContent.getLength());
} catch (CoreException e) {
PHPUiPlugin.log(e);
}
return buf.toString();
}
private final int surroundLines = 1;
private void appendContent(IDocument text, int startOffset, int endOffset,
StringBuffer buf, boolean surroundLinesOnly) {
try {
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$
}
}
} catch (BadLocationException e) {
// ignore
}
}
/*
* (non-Javadoc)
*
* @see
* org.eclipse.jface.text.contentassist.ICompletionProposal#apply(org.eclipse
* .jface.text.IDocument)
*/
public void apply(IDocument document) {
try {
ISourceModule unit = getCompilationUnit();
IEditorPart part = null;
if (unit.getResource().exists()) {
boolean canEdit = performValidateEdit(unit);
if (!canEdit) {
return;
}
part = EditorUtility.isOpenInEditor(unit);
if (part == null) {
part = DLTKUIPlugin.openInEditor(unit);
if (part != null) {
document = DLTKUIPlugin.getDocumentProvider()
.getDocument(part.getEditorInput());
}
}
IWorkbenchPage page = DLTKUIPlugin.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(ISourceModule unit) {
IStatus status = Resources.makeCommittable(unit.getResource(),
DLTKUIPlugin.getActiveWorkbenchShell());
if (!status.isOK()) {
String label = CorrectionMessages.CUCorrectionProposal_error_title;
String message = CorrectionMessages.CUCorrectionProposal_error_message;
ErrorDialog.openError(DLTKUIPlugin.getActiveWorkbenchShell(),
label, message, status);
return false;
}
return true;
}
/*
* (non-Javadoc)
*
* @see
* org.eclipse.jdt.internal.ui.text.correction.ChangeCorrectionProposal#
* performChange(org.eclipse.jface.text.IDocument,
* org.eclipse.ui.IEditorPart)
*/
protected void performChange(IEditorPart part, IDocument document)
throws CoreException {
try {
super.performChange(part, document);
if (part == null) {
return;
}
if (fLinkedProposalModel != null) {
if (fLinkedProposalModel.hasLinkedPositions()
&& part instanceof PHPStructuredEditor) {
// enter linked mode
ITextViewer viewer = ((PHPStructuredEditor) part)
.getViewer();
new LinkedProposalModelPresenter().enterLinkedMode(viewer,
part, fLinkedProposalModel);
} else if (part instanceof ITextEditor) {
LinkedProposalPositionGroup.PositionInformation endPosition = fLinkedProposalModel
.getEndPosition();
if (endPosition != null) {
// select a result
int pos = endPosition.getOffset()
+ endPosition.getLength();
((ITextEditor) part).selectAndReveal(pos, 0);
}
}
}
} catch (BadLocationException e) {
throw new CoreException(DLTKUIStatus.createError(IStatus.ERROR, e));
}
}
/**
* 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, ISourceModule, 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 {
ISourceModule cu = getCompilationUnit();
String name = getName();
TextChange change;
if (!cu.getResource().exists()) {
String source;
try {
source = cu.getSource();
} catch (ModelException e) {
PHPUiPlugin.log(e);
source = new String(); // empty
}
Document document = new Document(source);
document.setInitialLineDelimiter(StubUtility
.getLineDelimiterUsed(cu.getScriptProject()));
change = new DocumentChange(name, document);
} else {
SourceModuleChange cuChange = new SourceModuleChange(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 ISourceModule 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();
}
}