/*=============================================================================#
# Copyright (c) 2008-2016 Stephan Wahlbrink (WalWare.de) 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:
# Stephan Wahlbrink - initial API and implementation
#=============================================================================*/
package de.walware.statet.r.launching;
import java.lang.reflect.InvocationTargetException;
import java.net.URI;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import org.eclipse.core.filesystem.EFS;
import org.eclipse.core.filesystem.IFileStore;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IMarker;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.variables.IDynamicVariable;
import org.eclipse.core.variables.IStringVariable;
import org.eclipse.debug.core.DebugPlugin;
import org.eclipse.debug.core.IStatusHandler;
import org.eclipse.debug.ui.IDebugUIConstants;
import org.eclipse.jface.text.AbstractDocument;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.ui.ISharedImages;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.statushandlers.StatusManager;
import de.walware.jcommons.collections.ImCollections;
import de.walware.ecommons.ltk.core.model.ISourceUnit;
import de.walware.ecommons.ltk.core.model.IWorkspaceSourceUnit;
import de.walware.ecommons.preferences.PreferencesUtil;
import de.walware.ecommons.preferences.core.Preference.BooleanPref;
import de.walware.ecommons.text.TextUtil;
import de.walware.ecommons.ts.IToolRunnable;
import de.walware.ecommons.variables.core.DynamicVariable;
import de.walware.ecommons.variables.core.StringVariable;
import de.walware.ecommons.variables.core.VariableText;
import de.walware.ecommons.variables.core.VariableText.LocationProcessor;
import de.walware.statet.nico.core.runtime.ToolController;
import de.walware.statet.nico.core.runtime.ToolWorkspace;
import de.walware.statet.r.console.core.AbstractRController;
import de.walware.statet.r.core.RUtil;
import de.walware.statet.r.core.model.IRLangSourceElement;
import de.walware.statet.r.core.model.IRSourceUnit;
import de.walware.statet.r.core.model.IRWorkspaceSourceUnit;
import de.walware.statet.r.core.rsource.ast.GenericVisitor;
import de.walware.statet.r.core.rsource.ast.RAstNode;
import de.walware.statet.r.internal.debug.ui.RControllerCodeLaunchConnector;
import de.walware.statet.r.internal.debug.ui.RLaunchingMessages;
import de.walware.statet.r.internal.debug.ui.launcher.RCodeLaunchRegistry;
import de.walware.statet.r.internal.debug.ui.launcher.RCodeLaunchRegistry.ContentHandler.FileCommand;
import de.walware.statet.r.nico.IRModelSrcref;
import de.walware.statet.r.ui.RUI;
/**
* Provides methods to submit code to R
*
* The methods use the code launch connector selected in the preferences
* and therefore it supports external consoles too
* (in contrast to direct usage of new {@link AbstractRController}).
*/
public final class RCodeLaunching {
public static final String SUBMIT_SELECTION_COMMAND_ID = "de.walware.statet.r.commands.SubmitSelectionToR"; //$NON-NLS-1$
public static final String SUBMIT_SELECTION_GOTOCONSOLE_COMMAND_ID = "de.walware.statet.r.commands.SubmitSelectionToR_GotoConsole"; //$NON-NLS-1$
public static final String SUBMIT_SELECTION_PASTEOUTPUT_COMMAND_ID = "de.walware.statet.r.commands.SubmitSelectionToR_PasteOutput"; //$NON-NLS-1$
public static final String SUBMIT_UPTO_SELECTION_COMMAND_ID = "de.walware.statet.r.commands.SubmitUptoSelectionToR"; //$NON-NLS-1$
public static final String SUBMIT_FILEVIACOMMAND_COMMAND_ID = "de.walware.statet.r.commands.SubmitFileToRViaCommand"; //$NON-NLS-1$
public static final String SUBMIT_FILEVIACOMMAND_GOTOCONSOLE_COMMAND_ID = "de.walware.statet.r.commands.SubmitFileToRViaCommand_GotoConsole"; //$NON-NLS-1$
public static final String FILE_COMMAND_ID_PARAMTER_ID = "fileCommandId"; //$NON-NLS-1$
private static final IStringVariable FILE_NAME_VARIABLE = new StringVariable("resource_loc", "The complete path of the source file"); //$NON-NLS-1$
private static final IStringVariable FILE_ENCODING_VARIABLE = new StringVariable("resource_encoding", "The encoding of the source file"); //$NON-NLS-1$
private static final IStringVariable ECHO_ENABLED_VARIABLE = new StringVariable("echo", "If echo is enabled"); //$NON-NLS-1$
private static final IStatus STATUS_PROMPTER = new Status(IStatus.INFO, IDebugUIConstants.PLUGIN_ID, 200, "", null); //$NON-NLS-1$
private static final IStatus STATUS_SAVE = new Status(IStatus.INFO, DebugPlugin.getUniqueIdentifier(), 222, "", null); //$NON-NLS-1$
public static class SourceRegion implements IRModelSrcref, IAdaptable {
private static final String MARKER_TYPE = "org.eclipse.core.resources.marker";
private static class ElementSearcher extends GenericVisitor {
private List<IRLangSourceElement> fList;
@Override
public void visitNode(final RAstNode node) throws InvocationTargetException {
final List<Object> attachments= node.getAttachments();
for (final Object attachment : attachments) {
if (attachment instanceof IRLangSourceElement) {
if (fList == null) {
fList= new ArrayList<>();
}
fList.add((IRLangSourceElement) attachment);
}
}
if (fList == null) {
super.visitNode(node);
}
}
}
private final IRSourceUnit fSourceUnit;
private RAstNode fNode;
private List<IRLangSourceElement> fElements;
private final AbstractDocument fDocument;
private int fBeginOffset = -1;
private int fBeginLine = -1;
private int fBeginColumn = -1;
private int fEndOffset = -1;
private int fEndLine = -1;
private int fEndColumn = -1;
private String fCode;
private IMarker fMarker;
public SourceRegion(final IRSourceUnit file, final AbstractDocument document) {
fSourceUnit = file;
fDocument = document;
}
@Override
public IRSourceUnit getFile() {
return fSourceUnit;
}
public void setNode(final RAstNode node) {
fNode = node;
}
@Override
public List<IRLangSourceElement> getElements() {
if (fElements == null) {
if (fNode != null) {
final ElementSearcher searcher = new ElementSearcher();
try {
searcher.visitNode(fNode);
fElements = searcher.fList;
}
catch (final InvocationTargetException e) {}
}
if (fElements == null) {
fElements = Collections.emptyList();
}
}
return fElements;
}
public void setCode(final String code) {
fCode = code;
}
public void setBegin(final int offset) throws BadLocationException {
fBeginOffset = offset;
fBeginLine = fDocument.getLineOfOffset(fBeginOffset);
fBeginColumn = TextUtil.getColumn(fDocument, fBeginOffset, fBeginLine, 8);
}
@Override
public boolean hasBeginDetail() {
return (fBeginLine >= 0 && fBeginColumn >= 0);
}
@Override
public int getOffset() {
return fBeginOffset;
}
@Override
public int getFirstLine() {
return fBeginLine;
}
@Override
public int getFirstColumn() {
return fBeginColumn;
}
public void setEnd(final int offset) throws BadLocationException {
fEndOffset = offset;
fEndLine = fDocument.getLineOfOffset(fEndOffset);
fEndColumn = TextUtil.getColumn(fDocument, fEndOffset-1, fEndLine, 8);
}
@Override
public boolean hasEndDetail() {
return (fEndLine >= 0 && fEndColumn >= 0);
}
@Override
public int getLength() {
return fEndOffset-fBeginOffset;
}
@Override
public int getLastLine() {
return fEndLine;
}
@Override
public int getLastColumn() {
return fEndColumn;
}
void installMarker() {
if (fSourceUnit instanceof IRWorkspaceSourceUnit) {
final IResource resource = ((IRWorkspaceSourceUnit) fSourceUnit).getResource();
try {
fMarker = resource.createMarker(MARKER_TYPE);
fMarker.setAttribute(IMarker.CHAR_START, fBeginOffset);
fMarker.setAttribute(IMarker.CHAR_END, fEndOffset);
}
catch (final CoreException e) {
StatusManager.getManager().handle(new Status(IStatus.ERROR, RUI.PLUGIN_ID, 0,
"An error occurred when creating code position marker.", e));
}
}
}
void disposeMarker() {
if (this.fMarker != null) {
try {
this.fMarker.delete();
this.fMarker = null;
}
catch (final CoreException e) {
StatusManager.getManager().handle(new Status(IStatus.ERROR, RUI.PLUGIN_ID, 0,
"An error occurred when removing code position marker.", e));
}
}
}
@Override
public Object getAdapter(final Class required) {
if (IMarker.class.equals(required)) {
return fMarker;
}
return null;
}
}
public static void gotoRConsole() throws CoreException {
final IRCodeSubmitConnector connector = RCodeLaunchRegistry.getDefault().getConnector();
connector.gotoConsole();
}
public static String getFileCommand(final String id) {
final FileCommand fileCommand = RCodeLaunchRegistry.getDefault().getFileCommand(id);
if (fileCommand != null) {
return fileCommand.getCurrentCommand();
}
return null;
}
public static String getPreferredFileCommand(final String contentType) {
final FileCommand fileCommand = RCodeLaunchRegistry.getDefault().getContentFileCommand(contentType);
return fileCommand.getCurrentCommand();
}
public static ICodeSubmitContentHandler getCodeSubmitContentHandler(final String contentType) {
return RCodeLaunchRegistry.getDefault().getContentHandler(contentType);
}
/**
* Runs a file related command in R.
* Use this method only, if you don't have an IFile or IPath object for your file
* (e.g. file on webserver).
* <p>
* The pattern ${file} in command string is replaced by the path of
* the specified file.</p>
*
* @param command the command, (at moment) should be single line.
* @param file the file.
* @throws CoreException if running failed.
*/
public static void runFileUsingCommand(final String command, final URI fileURI,
final ISourceUnit su, final String encoding, final boolean gotoConsole) throws CoreException {
if (su instanceof IWorkspaceSourceUnit && su.getResource() instanceof IFile) {
final IFile file = (IFile) ((IWorkspaceSourceUnit) su).getResource();
// save files
final IProject project = file.getProject();
if (project != null) {
final IProject[] referencedProjects = project.getReferencedProjects();
final IProject[] allProjects = new IProject[referencedProjects.length+1];
allProjects[0] = project;
System.arraycopy(referencedProjects, 0, allProjects, 1, referencedProjects.length);
if (!saveBeforeLaunch(allProjects)) {
return;
}
}
}
final IRCodeSubmitConnector connector = RCodeLaunchRegistry.getDefault().getConnector();
IFileStore fileStore = null;
try {
fileStore = EFS.getStore(fileURI);
}
catch (final CoreException e) {
fileStore = null;
}
if (fileStore != null && connector instanceof RControllerCodeLaunchConnector) {
final IFileStore store = fileStore;
((RControllerCodeLaunchConnector) connector).submit(new RControllerCodeLaunchConnector.CommandsCreator() {
@Override
public IStatus submitTo(final ToolController controller) {
final ToolWorkspace workspace = controller.getWorkspaceData();
try {
final String path = workspace.toToolPath(store);
final String code = resolveVariables(command, path, encoding);
final IToolRunnable runnable = new SubmitFileViaCommandRunnable(
PlatformUI.getWorkbench().getSharedImages().getImage(ISharedImages.IMG_OBJ_FILE),
"Run '" + store.toString() + "'", // TODO custom image and label
code, su );
final IStatus status = controller.getTool().getQueue().add(runnable);
if (!status.isOK()) {
runnable.changed(IToolRunnable.BEING_ABANDONED, null);
}
return status;
}
catch (final CoreException e) {
return e.getStatus();
}
}
}, gotoConsole);
}
else {
String path = null;
try {
if (EFS.getLocalFileSystem().equals(EFS.getFileSystem(fileURI.getScheme()))) {
path = EFS.getLocalFileSystem().getStore(fileURI).toString();
}
} catch (final CoreException e) {
}
if (path == null) {
path = fileURI.toString();
}
final String code = resolveVariables(command, path, encoding);
connector.submit(Collections.singletonList(code), gotoConsole);
}
}
private static String resolveVariables(final String command, final String path, final String encoding)
throws CoreException {
final List<IDynamicVariable> variables = new ArrayList<>();
variables.add(new DynamicVariable(FILE_NAME_VARIABLE) {
@Override
public String getValue(final String argument) throws CoreException {
return RUtil.escapeCompletely(path);
}
});
variables.add(new DynamicVariable(FILE_ENCODING_VARIABLE) {
@Override
public String getValue(final String argument) throws CoreException {
return encoding != null ? RUtil.escapeCompletely(encoding) : "unknown";
}
});
variables.add(new DynamicVariable(ECHO_ENABLED_VARIABLE) {
@Override
public String getValue(final String argument) throws CoreException {
final Boolean echo = PreferencesUtil.getInstancePrefs().getPreferenceValue(
RCodeLaunching.ECHO_ENABLED_PREF);
return (echo != null && echo.booleanValue()) ?
"TRUE" : "FALSE"; //$NON-NLS-1$ //$NON-NLS-2$
}
});
final VariableText text = new VariableText(command, variables, true);
text.performFinalStringSubstitution(new LocationProcessor() {
@Override
public String process(final String path) throws CoreException {
return RUtil.escapeCompletely(path);
}
});
return text.getText();
}
private static boolean saveBeforeLaunch(final IProject[] projects) throws CoreException {
IStatusHandler prompter = null;
prompter = DebugPlugin.getDefault().getStatusHandler(STATUS_PROMPTER);
if (prompter != null) {
return ((Boolean) prompter.handleStatus(STATUS_SAVE,
new Object[] { null, projects } )).booleanValue();
}
return true;
}
public static boolean runRCodeDirect(final List<String> lines, final boolean gotoConsole,
final IProgressMonitor monitor) throws CoreException {
if (monitor != null) {
monitor.subTask(RLaunchingMessages.RCodeLaunch_SubmitCode_task);
}
final IRCodeSubmitConnector connector = RCodeLaunchRegistry.getDefault().getConnector();
return connector.submit(lines, gotoConsole);
}
public static boolean runRCodeDirect(final List<SourceRegion> codeRegions,
final boolean gotoConsole) throws CoreException {
final IRCodeSubmitConnector connector = RCodeLaunchRegistry.getDefault().getConnector();
if (connector instanceof RControllerCodeLaunchConnector) {
return ((RControllerCodeLaunchConnector) connector).submit(
new RControllerCodeLaunchConnector.CommandsCreator() {
@Override
public IStatus submitTo(final ToolController controller) {
final IToolRunnable[] runnables = new IToolRunnable[codeRegions.size()];
final List<String> lines = new ArrayList<>();
for (int i = 0; i < runnables.length; i++) {
final SourceRegion region = codeRegions.get(i);
lines.clear();
TextUtil.addLines(region.fCode, lines);
runnables[i] = new SubmitEntireCommandRunnable(
lines.toArray(new String[lines.size()]), region);
}
final IStatus status = controller.getTool().getQueue().add(
ImCollections.newList(runnables) );
if (!status.isOK()) {
for (int i = 0; i < runnables.length; i++) {
runnables[i].changed(IToolRunnable.BEING_ABANDONED, null);
}
}
return status;
}
}, gotoConsole);
}
final List<String> lines = new ArrayList<>(codeRegions.size()*2);
for (int i = 0; i < codeRegions.size(); i++) {
TextUtil.addLines(codeRegions.get(i).fCode, lines);
}
return runRCodeDirect(lines, gotoConsole, null);
}
public static final BooleanPref ECHO_ENABLED_PREF = new BooleanPref(
RRunDebugPreferenceConstants.ROOT_QUALIFIER + "/codelaunch", "echo.enabled" );
}