PathLink.java

/*  Copyright (C) 2009 Mobile Sorcery AB

    This program is free software; you can redistribute it and/or modify it
    under the terms of the Eclipse Public License v1.0.

    This program is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE. See the Eclipse Public License v1.0 for
    more details.

    You should have received a copy of the Eclipse Public License v1.0 along
    with this program. It is also available at http://www.eclipse.org/legal/epl-v10.html
*/
/*******************************************************************************
 * Copyright (c) 2000, 2008 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 com.mobilesorcery.sdk.ui.internal.console;


import org.eclipse.core.filesystem.EFS;
import org.eclipse.core.filesystem.IFileStore;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.content.IContentDescription;
import org.eclipse.core.runtime.content.IContentType;
import org.eclipse.debug.internal.ui.DebugUIPlugin;
import org.eclipse.debug.ui.console.IConsoleHyperlink;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.IRegion;
import org.eclipse.ui.IEditorDescriptor;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IEditorRegistry;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.ide.FileStoreEditorInput;
import org.eclipse.ui.part.FileEditorInput;
import org.eclipse.ui.texteditor.IDocumentProvider;
import org.eclipse.ui.texteditor.ITextEditor;

/**
 * <emph>Copied and modified from Eclipse "FileLink" class, which does not
 * support external files (of course it doesn't...)</emph>
 * A hyperlink that opens a file in a text editor and selects a range of text.
 * This hyperlink action will un-zoom the workbench as needed to show the editor
 * for the associated link.
 * <p>
 * Clients may instantiate this class.
 * </p>
 * @since 2.1
 * @noextend This class is not intended to be subclassed by clients.
 */
public class PathLink implements IConsoleHyperlink {

    private IFile fFile;
    private IPath fPath;
    private IEditorInput fFileEditorInput;
    private int fFileOffset;
    private int fFileLength;
    private int fFileLineNumber;
    private String fEditorId;
    
    /**
     * Constructs a hyperlink to the specified file.
     * 
     * @param file the file to open when activated
     * @param editorId the identifier of the editor to open the file in, or
     * <code>null</code> if the default editor should be used
     * @param fileOffset the offset in the file to select when activated, or -1
     * @param fileLength the length of text to select in the file when activated
     * or -1
     * @param fileLineNumber the line number to select in the file when
     * activated, or -1
     */
    public PathLink(IFile file, String editorId, int fileOffset, int fileLength, int fileLineNumber) {
        fFile = file;
        fFileEditorInput = new FileEditorInput(file);
        fFileOffset = fileOffset;
        fFileLength = fileLength;
        fFileLineNumber = fileLineNumber;
        fEditorId = editorId;
    }

    // Added
    public PathLink(IPath path, String editorId, int fileOffset, int fileLength, int fileLineNumber) {
        fPath = path;
        IFileStore fileStore = EFS.getLocalFileSystem().getStore(path);
        fFileEditorInput = new FileStoreEditorInput(fileStore);
        fFileOffset = fileOffset;
        fFileLength = fileLength;
        fFileLineNumber = fileLineNumber;
        fEditorId = editorId;
    }

    /* (non-Javadoc)
     * @see org.eclipse.debug.ui.console.IConsoleHyperlink#linkActivated()
     */
    public void linkActivated() {
        IWorkbenchWindow window = DebugUIPlugin.getActiveWorkbenchWindow();
        if (window != null) {
            IWorkbenchPage page = window.getActivePage();
            if (page != null) {
                try {
                    IEditorPart editorPart = page.openEditor(fFileEditorInput, getEditorId() , true);
                    if (fFileLineNumber > 0) {
                        ITextEditor textEditor = null;
                        if (editorPart instanceof ITextEditor) {
                            textEditor = (ITextEditor) editorPart;
                        } else {
                            textEditor = (ITextEditor) editorPart.getAdapter(ITextEditor.class);
                        }
                        if (textEditor != null) {
                            IEditorInput input = editorPart.getEditorInput();
                            if (fFileOffset < 0) {
                                IDocumentProvider provider = textEditor.getDocumentProvider();
                                try {
                                    provider.connect(input);
                                } catch (CoreException e) {
                                    // unable to link
                                    DebugUIPlugin.log(e);
                                    return;
                                }
                                IDocument document = provider.getDocument(input);
                                try {
                                    IRegion region= document.getLineInformation(fFileLineNumber - 1);
                                    fFileOffset = region.getOffset();
                                    fFileLength = region.getLength();
                                } catch (BadLocationException e) {
                                    // unable to link
                                    DebugUIPlugin.log(e);
                                }
                                provider.disconnect(input);
                            }
                            if (fFileOffset >= 0 && fFileLength >=0) {
                                textEditor.selectAndReveal(fFileOffset, fFileLength);
                            }
                        }
                    }
                } catch (PartInitException e) {
                    DebugUIPlugin.log(e);
                }   
            }
        }
    }

    /* (non-Javadoc)
     * @see org.eclipse.debug.ui.console.IConsoleHyperlink#linkEntered()
     */
    public void linkEntered() {
    }

    /* (non-Javadoc)
     * @see org.eclipse.debug.ui.console.IConsoleHyperlink#linkExited()
     */
    public void linkExited() {
    }
    
    private String getEditorId() {
        if (fEditorId == null) {
            IWorkbench workbench= DebugUIPlugin.getDefault().getWorkbench();
            // If there is a registered editor for the file use it.
            IEditorDescriptor desc = workbench.getEditorRegistry().getDefaultEditor(getFileName(), getFileContentType());
            if (desc == null) {
                //default editor
                desc= workbench.getEditorRegistry().findEditor(IEditorRegistry.SYSTEM_EXTERNAL_EDITOR_ID);
            }
            fEditorId= desc.getId();
        }
        return fEditorId;
    }

    private String getFileName() {
        return fFile == null ? fPath.lastSegment() : fFile.getName();
    }

    private IContentType getFileContentType() {
        try {
            if (fFile == null) {
                return Platform.getContentTypeManager().findContentTypeFor(getFileName());
            } else {
            IContentDescription description= fFile.getContentDescription();
            if (description != null) {
                return description.getContentType();
            }
            }
        } catch (CoreException e) {
        }
        return null;
    }
}