UnifiedSourceHyperlink.java

/**
 * This file Copyright (c) 2005-2008 Aptana, Inc. This program is
 * dual-licensed under both the Aptana Public License and the GNU General
 * Public license. You may elect to use one or the other of these licenses.
 * 
 * This program is distributed in the hope that it will be useful, but
 * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
 * NONINFRINGEMENT. Redistribution, except as permitted by whichever of
 * the GPL or APL you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or modify this
 * program under the terms of the GNU General Public License,
 * Version 3, as published by the Free Software Foundation.  You should
 * have received a copy of the GNU General Public License, Version 3 along
 * with this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Aptana provides a special exception to allow redistribution of this file
 * with certain other free and open source software ("FOSS") code and certain additional terms
 * pursuant to Section 7 of the GPL. You may view the exception and these
 * terms on the web at http://www.aptana.com/legal/gpl/.
 * 
 * 2. For the Aptana Public License (APL), this program and the
 * accompanying materials are made available under the terms of the APL
 * v1.0 which accompanies this distribution, and is available at
 * http://www.aptana.com/legal/apl/.
 * 
 * You may view the GPL, Aptana's exception and additional terms, and the
 * APL in the file titled license.html at the root of the corresponding
 * plugin containing this source file.
 * 
 * Any modifications to this file must keep this entire header intact.
 */
package com.aptana.ide.editors.unified.hyperlinks;

import java.io.File;

import org.eclipse.jface.text.IRegion;
import org.eclipse.jface.text.hyperlink.IHyperlink;
import org.eclipse.ui.IEditorPart;

import com.aptana.ide.core.ui.CoreUIUtils;
import com.aptana.ide.editors.managers.EnvironmentManager;
import com.aptana.ide.editors.unified.IFileLanguageService;
import com.aptana.ide.editors.unified.UnifiedEditor;
import com.aptana.ide.editors.unified.utils.EditorHelper;
import com.aptana.ide.lexer.Lexeme;
import com.aptana.ide.parsing.CodeLocation;
import com.aptana.ide.parsing.IOffsetMapper;
import com.aptana.ide.parsing.IRuntimeEnvironment;

/**
 * @author Kevin Sawicki (ksawicki@aptana.com)
 */
public class UnifiedSourceHyperlink implements IHyperlink
{

	private IFileLanguageService service;
	private String text;
	private IRegion region;
	private Lexeme lexeme;

	/**
	 * Creates a new source hyperlink
	 * 
	 * @param service -
	 *            service to find code locations
	 * @param lexeme -
	 *            lexeme of underlying hyperlink
	 * @param region -
	 *            region of hyperlink
	 * @param text -
	 *            text of hyperlink
	 */
	public UnifiedSourceHyperlink(IFileLanguageService service, Lexeme lexeme, IRegion region, String text)
	{
		this.service = service;
		this.text = text;
		this.region = region;
		this.lexeme = lexeme;
	}

	/**
	 * @see org.eclipse.jface.text.hyperlink.IHyperlink#getHyperlinkRegion()
	 */
	public IRegion getHyperlinkRegion()
	{
		return region;
	}

	/**
	 * @see org.eclipse.jface.text.hyperlink.IHyperlink#getHyperlinkText()
	 */
	public String getHyperlinkText()
	{
		return text;
	}

	/**
	 * @see org.eclipse.jface.text.hyperlink.IHyperlink#getTypeLabel()
	 */
	public String getTypeLabel()
	{
		return null;
	}

	/**
	 * @see org.eclipse.jface.text.hyperlink.IHyperlink#open()
	 */
	public void open()
	{
		if (this.service == null || lexeme == null)
		{
			return;
		}
		String mimetype = lexeme.getLanguage();

		IRuntimeEnvironment env = EnvironmentManager.getEnvironment(mimetype);

		IFileLanguageService langService = this.service.getFileContext().getLanguageService(mimetype);
		if (langService == null || env == null)
		{
			return;
		}

		IOffsetMapper langMapper = langService.getOffsetMapper();
		if (langMapper == null)
		{
			return;
		}

		CodeLocation loc = (CodeLocation) langMapper.findTarget(lexeme);
		if (loc != null)
		{
			openInEditor(CoreUIUtils.getPathFromURI(loc.getFullPath()), loc.getStartLexeme());
		}

	}

	private void openInEditor(String fileName, Lexeme lexeme)
	{
		File file = new File(fileName);
		if (file.exists())
		{
			IEditorPart part = EditorHelper.openInEditor(file);
			if (part instanceof UnifiedEditor)
			{
				UnifiedEditor jsEditor = (UnifiedEditor) part;
				jsEditor.selectAndReveal(lexeme.offset, lexeme.getEndingOffset() - lexeme.offset);
			}
		}
	}

}