/*******************************************************************************
* Copyright (c) 2000, 2017 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
*
*******************************************************************************/
package org.eclipse.dltk.tcl.internal.debug.ui.console;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Status;
import org.eclipse.debug.core.ILaunch;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.debug.core.model.IProcess;
import org.eclipse.dltk.debug.ui.DLTKDebugUIPlugin;
import org.eclipse.dltk.internal.launching.LaunchConfigurationUtils;
import org.eclipse.dltk.internal.ui.editor.EditorUtility;
import org.eclipse.dltk.launching.sourcelookup.IProjectLookupResult;
import org.eclipse.dltk.launching.sourcelookup.ProjectSourceLookup;
import org.eclipse.jface.dialogs.ErrorDialog;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.IRegion;
import org.eclipse.osgi.util.NLS;
import org.eclipse.ui.IEditorDescriptor;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.console.IHyperlink;
import org.eclipse.ui.console.TextConsole;
import org.eclipse.ui.ide.IDE;
import org.eclipse.ui.texteditor.IDocumentProvider;
import org.eclipse.ui.texteditor.ITextEditor;
/**
* A hyperlink from a stack trace line of the form "(file "*.*")"
*/
public class TclFileHyperlink implements IHyperlink {
private TextConsole fConsole;
public TclFileHyperlink(TextConsole console) {
fConsole = console;
}
@Override
public void linkEntered() {
}
@Override
public void linkExited() {
}
@Override
public void linkActivated() {
try {
String fileName;
int lineNumber;
try {
String linkText = getLinkText();
fileName = getFileName(linkText);
lineNumber = getLineNumber(linkText);
} catch (CoreException e1) {
ErrorDialog.openError(DLTKDebugUIPlugin.getActiveWorkbenchShell(),
ConsoleMessages.TclFileHyperlink_Error, ConsoleMessages.TclFileHyperlink_Error, e1.getStatus());
return;
}
// documents start at 0
if (lineNumber > 0) {
lineNumber--;
}
Object sourceElement = getSourceModule(fileName);
if (sourceElement != null) {
IEditorPart part = EditorUtility.openInEditor(sourceElement);
IEditorPart editorPart = EditorUtility.openInEditor(sourceElement);
if (editorPart instanceof ITextEditor && lineNumber >= 0) {
ITextEditor textEditor = (ITextEditor) editorPart;
IDocumentProvider provider = textEditor.getDocumentProvider();
IEditorInput input = part.getEditorInput();
provider.connect(input);
IDocument document = provider.getDocument(input);
try {
IRegion line = document.getLineInformation(lineNumber);
textEditor.selectAndReveal(line.getOffset(), line.getLength());
} catch (BadLocationException e) {
}
provider.disconnect(input);
}
return;
}
// did not find source
MessageDialog.openInformation(DLTKDebugUIPlugin.getActiveWorkbenchShell(),
ConsoleMessages.TclFileHyperlink_Information_1,
NLS.bind(ConsoleMessages.TclFileHyperlink_Source_not_found_for__0__2, new String[] { fileName }));
} catch (CoreException e) {
DLTKDebugUIPlugin
.errorDialog(ConsoleMessages.TclFileHyperlink_An_exception_occurred_while_following_link__3, e);
return;
}
}
public String getEditorId(IEditorInput input, Object inputObject) {
try {
IEditorDescriptor descriptor = IDE.getEditorDescriptor(input.getName(), true, false);
return descriptor.getId();
} catch (PartInitException e) {
return null;
}
}
protected Object getSourceModule(String fileName) throws CoreException {
if (fConsole instanceof org.eclipse.debug.ui.console.IConsole) {
final IProcess process = ((org.eclipse.debug.ui.console.IConsole) fConsole).getProcess();
if (process != null) {
final ILaunch launch = process.getLaunch();
if (launch != null) {
final ILaunchConfiguration configuration = launch.getLaunchConfiguration();
if (configuration != null) {
final IProject project = LaunchConfigurationUtils.getProject(configuration);
if (project != null) {
final ProjectSourceLookup lookup = new ProjectSourceLookup(project);
final IProjectLookupResult result = lookup.find(new Path(fileName));
if (result != null) {
return result.toArray()[0];
}
}
}
}
}
}
// compatibility: search local workspace files
IFile f = ResourcesPlugin.getWorkspace().getRoot().getFileForLocation(new Path(fileName));
return f;
}
/**
* Returns the fully qualified name of the type to open
*
* @return fully qualified type name
* @exception CoreException
* if unable to parse the type name
*/
protected String getFileName(String linkText) throws CoreException {
Pattern p = Pattern.compile("\\(file \"(.*)\"");
Matcher m = p.matcher(linkText);
if (m.find()) {
String name = m.group(1);
return name;
}
IStatus status = new Status(IStatus.ERROR, DLTKDebugUIPlugin.getUniqueIdentifier(), 0,
ConsoleMessages.TclFileHyperlink_Unable_to_parse_type_name_from_hyperlink__5, null);
throw new CoreException(status);
}
/**
* Returns the line number associated with the stack trace or -1 if none.
*
* @exception CoreException
* if unable to parse the number
*/
protected int getLineNumber(String linkText) throws CoreException {
Pattern p = Pattern.compile("line (\\d*)");
Matcher m = p.matcher(linkText);
if (m.find()) {
String lineText = m.group(1);
try {
return Integer.parseInt(lineText);
} catch (NumberFormatException e) {
IStatus status = new Status(IStatus.ERROR, DLTKDebugUIPlugin.getUniqueIdentifier(), 0,
ConsoleMessages.TclFileHyperlink_Unable_to_parse_line_number_from_hyperlink__6, e);
throw new CoreException(status);
}
}
IStatus status = new Status(IStatus.ERROR, DLTKDebugUIPlugin.getUniqueIdentifier(), 0,
ConsoleMessages.TclFileHyperlink_Unable_to_parse_line_number_from_hyperlink__7, null);
throw new CoreException(status);
}
/**
* Returns the console this link is contained in.
*
* @return console
*/
protected TextConsole getConsole() {
return fConsole;
}
/**
* Returns this link's text
*
* @exception CoreException
* if unable to retrieve the text
*/
protected String getLinkText() throws CoreException {
try {
IDocument document = getConsole().getDocument();
IRegion region = getConsole().getRegion(this);
int regionOffset = region.getOffset();
int lineNumber = document.getLineOfOffset(regionOffset);
IRegion lineInformation = document.getLineInformation(lineNumber);
int lineOffset = lineInformation.getOffset();
String line = document.get(lineOffset, lineInformation.getLength());
int regionOffsetInLine = regionOffset - lineOffset;
int linkEnd = line.indexOf(')', regionOffsetInLine);
int linkStart = line.lastIndexOf(' ', regionOffsetInLine);
return line.substring(linkStart == -1 ? 0 : linkStart + 1, linkEnd + 1);
} catch (BadLocationException e) {
IStatus status = new Status(IStatus.ERROR, DLTKDebugUIPlugin.getUniqueIdentifier(), 0,
ConsoleMessages.TclFileHyperlink_Unable_to_retrieve_hyperlink_text__8, e);
throw new CoreException(status);
}
}
}