| package org.eclipse.rephraserengine.core.vpg.refactoring; |
| |
| import java.io.BufferedReader; |
| import java.io.IOException; |
| import java.io.InputStreamReader; |
| import java.io.Reader; |
| import java.util.Collection; |
| import java.util.Collections; |
| |
| import org.eclipse.core.resources.IFile; |
| import org.eclipse.core.runtime.CoreException; |
| import org.eclipse.core.runtime.IProgressMonitor; |
| import org.eclipse.core.runtime.NullProgressMonitor; |
| import org.eclipse.core.runtime.OperationCanceledException; |
| import org.eclipse.jface.text.Region; |
| import org.eclipse.ltk.core.refactoring.Change; |
| import org.eclipse.ltk.core.refactoring.CompositeChange; |
| import org.eclipse.ltk.core.refactoring.FileStatusContext; |
| import org.eclipse.ltk.core.refactoring.Refactoring; |
| import org.eclipse.ltk.core.refactoring.RefactoringStatus; |
| import org.eclipse.ltk.core.refactoring.RefactoringStatusContext; |
| import org.eclipse.ltk.core.refactoring.TextFileChange; |
| import org.eclipse.rephraserengine.core.refactorings.IRefactoring; |
| import org.eclipse.rephraserengine.core.vpg.IVPGNode; |
| import org.eclipse.rephraserengine.core.vpg.VPGLog; |
| import org.eclipse.rephraserengine.core.vpg.eclipse.EclipseVPG; |
| import org.eclipse.text.edits.ReplaceEdit; |
| |
| /** |
| * A refactoring which accesses a VPG. |
| * |
| * @author Jeff Overbey |
| * @author Louis Orenstein (Tech-X Corporation) - fix for bug https://bugs.eclipse.org/bugs/show_bug.cgi?id=400647 |
| * |
| * @param <A> AST type |
| * @param <T> node/token type (i.e., the type returned by {@link IVPGNode#getASTNode()}) |
| * @param <V> VPG |
| */ |
| public abstract class VPGRefactoring<A, T, V extends EclipseVPG<A, T, ? extends IVPGNode<T>>> |
| extends Refactoring |
| implements IRefactoring |
| { |
| /////////////////////////////////////////////////////////////////////////// |
| // Constants |
| /////////////////////////////////////////////////////////////////////////// |
| |
| /** The OS-dependent end-of-line sequence (\n or \r\n) */ |
| protected static final String EOL = System.getProperty("line.separator"); //$NON-NLS-1$ |
| |
| /////////////////////////////////////////////////////////////////////////// |
| // Fields |
| /////////////////////////////////////////////////////////////////////////// |
| |
| protected V vpg; |
| protected CompositeChange allChanges = null; |
| |
| /////////////////////////////////////////////////////////////////////////// |
| // LTK Refactoring Implementation |
| /////////////////////////////////////////////////////////////////////////// |
| |
| @Override |
| public final RefactoringStatus checkInitialConditions(IProgressMonitor pm) { |
| return checkInitialConditions(pm, false); |
| } |
| |
| public final RefactoringStatus checkInitialConditions(IProgressMonitor pm, boolean maskVPGFromPM) |
| { |
| this.vpg = getVPG(); |
| |
| RefactoringStatus status = new RefactoringStatus(); |
| |
| pm.beginTask(Messages.VPGRefactoring_EnsuringIndexIsUpToDate, IProgressMonitor.UNKNOWN); |
| if (maskVPGFromPM) { |
| vpg.ensureVPGIsUpToDate(new NullProgressMonitor()); |
| } else { |
| vpg.ensureVPGIsUpToDate(pm); |
| } |
| pm.done(); |
| |
| try |
| { |
| checkFiles(status); |
| if (!status.hasFatalError()) |
| { |
| preCheckInitialConditions(status, new ForwardingProgressMonitor(pm)); |
| doCheckInitialConditions(status, new ForwardingProgressMonitor(pm)); |
| } |
| } |
| catch (PreconditionFailure f) |
| { |
| status.addFatalError(f.getMessage()); |
| } |
| |
| return status; |
| } |
| |
| protected abstract V getVPG(); |
| |
| protected abstract void checkFiles(RefactoringStatus status) throws PreconditionFailure; |
| |
| protected void preCheckInitialConditions(RefactoringStatus status, IProgressMonitor pm) throws PreconditionFailure |
| { |
| } |
| |
| protected abstract void doCheckInitialConditions(RefactoringStatus status, IProgressMonitor pm) throws PreconditionFailure; |
| |
| protected void logVPGErrors(RefactoringStatus status) |
| { |
| logVPGErrors(status, (Collection<IFile>)null); |
| } |
| |
| protected void logVPGErrors(RefactoringStatus status, IFile file) |
| { |
| logVPGErrors(status, file == null ? null : Collections.singleton(file)); |
| } |
| |
| protected void logVPGErrors(RefactoringStatus status, Collection<IFile> files) |
| { |
| for (VPGLog<T, ? extends IVPGNode<T>>.Entry entry : vpg.getLog().getEntries()) |
| { |
| if (files == null || contains(files, entry.getTokenRef())) |
| { |
| if (entry.isWarning()) |
| status.addWarning(entry.getMessage(), createContext(entry.getTokenRef())); |
| else |
| status.addError(entry.getMessage(), createContext(entry.getTokenRef())); |
| } |
| } |
| } |
| |
| private boolean contains(Collection<IFile> files, IVPGNode<T> tokenRef) |
| { |
| if (files == null || tokenRef == null || tokenRef.getFilename() == null) |
| return false; |
| |
| IFile file = EclipseVPG.getIFileForFilename(tokenRef.getFilename()); |
| if (file == null) |
| return false; |
| |
| return files.contains(file); |
| } |
| |
| @Override |
| public final RefactoringStatus checkFinalConditions(IProgressMonitor pm) |
| { |
| allChanges = new CompositeChange(getName()); |
| |
| RefactoringStatus status = new RefactoringStatus(); |
| //pm.beginTask("Checking final preconditions; please wait...", IProgressMonitor.UNKNOWN); |
| try |
| { |
| preCheckFinalConditions(status, new ForwardingProgressMonitor(pm)); |
| doCheckFinalConditions(status, new ForwardingProgressMonitor(pm)); |
| } |
| catch (PreconditionFailure f) |
| { |
| status.addFatalError(f.getMessage()); |
| } |
| //pm.done(); |
| return status; |
| } |
| |
| protected void preCheckFinalConditions(RefactoringStatus status, IProgressMonitor pm) throws PreconditionFailure |
| { |
| } |
| |
| protected abstract void doCheckFinalConditions(RefactoringStatus status, IProgressMonitor pm) throws PreconditionFailure; |
| |
| /** |
| * To get text to display in the GUI, the precondition checking methods |
| * must call {@link IProgressMonitor#setTaskName(String)} rather than |
| * {@link IProgressMonitor#subTask(String)}. However, the change creation |
| * method <i>can</i> call {@link IProgressMonitor#subTask(String)}. This |
| * "forwards" calls to {@link #subTask(String)} to |
| * {@link #setTaskName(String)}. |
| * |
| * @author Jeff Overbey |
| */ |
| protected static class ForwardingProgressMonitor implements IProgressMonitor |
| { |
| private IProgressMonitor pm; |
| private String prefix = ""; //$NON-NLS-1$ |
| |
| public ForwardingProgressMonitor(IProgressMonitor pm) |
| { |
| this.pm = pm; |
| } |
| |
| public void beginTask(String name, int totalWork) { pm.beginTask(name, totalWork); pm.setTaskName(name); prefix = name + " - "; } //$NON-NLS-1$ |
| public void done() { prefix = ""; pm.setTaskName(""); pm.done(); } //$NON-NLS-1$ //$NON-NLS-2$ |
| public void internalWorked(double work) { pm.internalWorked(work); } |
| public boolean isCanceled() { return pm.isCanceled(); } |
| public void setCanceled(boolean value) { pm.setCanceled(value); } |
| public void setTaskName(String name) { pm.setTaskName(prefix + name); } |
| public void worked(int work) { pm.worked(work); } |
| |
| public void subTask(String name) |
| { |
| pm.setTaskName(prefix + name); |
| } |
| } |
| |
| @Override |
| public final Change createChange(IProgressMonitor pm) throws CoreException, OperationCanceledException |
| { |
| assert pm != null; |
| |
| //pm.beginTask("Constructing workspace transformation; please wait...", IProgressMonitor.UNKNOWN); |
| // allChanges constructed above in #checkFinalConditions |
| doCreateChange(pm); |
| postCreateChange(pm); |
| //pm.done(); |
| return allChanges; |
| } |
| |
| protected abstract void doCreateChange(IProgressMonitor pm) throws CoreException, OperationCanceledException; |
| |
| protected void postCreateChange(IProgressMonitor pm) throws CoreException, OperationCanceledException |
| { |
| } |
| |
| /////////////////////////////////////////////////////////////////////////// |
| // Utilities for Subclasses |
| /////////////////////////////////////////////////////////////////////////// |
| |
| /** |
| * A <code>PreconditionFailure</code> is thrown (e.g., by {@link AbstractFortranRefactoring#fail(String)}) |
| * to indicate an error severe enough that the refactoring cannot be completed. |
| */ |
| protected static class PreconditionFailure extends Exception |
| { |
| private static final long serialVersionUID = 1L; |
| |
| public PreconditionFailure(String message) |
| { |
| super(message); |
| } |
| } |
| |
| /** |
| * Throws a <code>PreconditionFailure</code>, indicating an error severe enough |
| * that the refactoring cannot be completed. |
| * |
| * @param message an error message to display to the user |
| */ |
| protected void fail(String message) throws PreconditionFailure |
| { |
| throw new PreconditionFailure(message); |
| } |
| |
| // REFACTORING STATUS ///////////////////////////////////////////////////// |
| |
| protected RefactoringStatusContext createContext(IVPGNode<T> tokenRef) |
| { |
| if (tokenRef == null) return null; |
| |
| IFile file = EclipseVPG.getIFileForFilename(tokenRef.getFilename()); |
| if (file == null) return null; |
| |
| return new FileStatusContext(file, |
| new Region(tokenRef.getOffset(), tokenRef.getLength())); |
| } |
| |
| // CHANGE CREATION //////////////////////////////////////////////////////// |
| |
| /** |
| * This method should be called from within the <code>doCreateChange</code> method after all |
| * of the changes to a file's AST have been made. |
| * <p> |
| * If calling <code>#toString</code> on the AST does not reproduce the modified |
| * source code for the given file, this method should be overridden. |
| */ |
| protected void addChangeFromModifiedAST(IFile file, IProgressMonitor pm) { |
| try { |
| A ast = vpg.acquireTransientAST(file); |
| TextFileChange changeThisFile = new TextFileChange(getName() + " - " //$NON-NLS-1$ |
| + file.getFullPath().toOSString(), file); |
| changeThisFile.initializeValidationData(pm); |
| changeThisFile.setEdit(new ReplaceEdit(0, countCharsIn(file), getSourceCodeFromAST(ast))); |
| allChanges.add(changeThisFile); |
| } catch (Exception e) { |
| throw new Error(e); |
| } |
| } |
| |
| protected String getSourceCodeFromAST(A ast) |
| { |
| return ast.toString(); |
| } |
| |
| private int countCharsIn(IFile file) throws CoreException, IOException |
| { |
| int size = 0; |
| Reader in = new BufferedReader(new InputStreamReader(file.getContents(true), file.getCharset())); |
| while (in.read() > -1) |
| size++; |
| in.close(); |
| return size; |
| } |
| |
| // PRECONDITIONS ////////////////////////////////////////////////////////// |
| |
| protected void checkIfFileIsAccessibleAndWritable(IFile file) throws PreconditionFailure |
| { |
| if (!file.isAccessible()) |
| fail(Messages.bind(Messages.VPGRefactoring_FileInTheEditorIsNotAccessible, file.getName())); |
| |
| if (file.isReadOnly()) |
| fail(Messages.bind(Messages.VPGRefactoring_FileInTheEditorIsReadOnly, file.getName())); |
| } |
| } |
