/* FeatureIDE - An IDE to support feature-oriented software development
 * Copyright (C) 2005-2009  FeatureIDE Team, University of Magdeburg
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * 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
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see http://www.gnu.org/licenses/.
 *
 * See http://www.fosd.de/featureide/ for further information.
 */
package de.ovgu.featureide.ui.plugin;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.ui.IFileEditorInput;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.part.FileEditorInput;
import org.osgi.framework.BundleContext;

/**
 * A default implementation for UI plug-ins within FeatureIDE.
 * 
 * @author Thomas Thuem
 */
abstract public class AbstractUIPlugin extends org.eclipse.ui.plugin.AbstractUIPlugin {

	/**
	 * Returns the plug-in ID as specified at the plug-in manifest.
	 * 
	 * @return the plug-in id
	 */
	abstract public String getID();

	/*
	 * (non-Javadoc)
	 * @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext)
	 */
	public void start(BundleContext context) throws Exception {
		super.start(context);
		logInfo("Starting FeatureIDE plug-in '" + getID() + "'");
	}

	/*
	 * (non-Javadoc)
	 * @see org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext)
	 */
	public void stop(BundleContext context) throws Exception {
		logInfo("Stopping FeatureIDE plug-in '" + getID() + "'");
		super.stop(context);
	}

	/**
	 * Returns an image descriptor for the image file at the given plug-in
	 * relative path.
	 * 
	 * @param path
	 *            the path
	 * @return the image descriptor
	 */
	public ImageDescriptor getImageDescriptor(String path) {
		return imageDescriptorFromPlugin(getID(), path);
	}

	/**
	 * Opens a file in the specified editor.
	 * 
	 * @param editorID ID of the editor
	 * @param file file to open
	 */
	public void openEditor(String editorID, IFile file) {
		IFileEditorInput editorInput = new FileEditorInput(file);
		IWorkbenchWindow window = PlatformUI.getWorkbench()
				.getActiveWorkbenchWindow();
		IWorkbenchPage page = window.getActivePage();

		try {
			page.openEditor(editorInput, editorID);
		} catch (PartInitException e) {
			logError("Unable to open file " + file + " in editor " + editorID, e);
		}
	}

	/**
	 * Convenience method for easy and clean logging. All messages collected by
	 * this method will be written to the eclipse log file.
	 * 
	 * Messages are only written to the error log, if the debug option is set
	 * for this plug-in
	 * 
	 * @param message
	 *            A message that should be written to the eclipse log file
	 */
	public void logInfo(String message) {
		log(IStatus.INFO, message, new Exception());
	}

	/**
	 * Convenience method for easy and clean logging of warnings. All messages
	 * collected by this method will be written to the eclipse log file.
	 * 
	 * @param message
	 *            A message that should be written to the eclipse log file
	 */
	public void logWarning(String message) {
		log(IStatus.WARNING, message, new Exception());
	}

	/**
	 * Convenience method for easy and clean logging of exceptions. All messages
	 * collected by this method will be written to the eclipse log file. The
	 * exception's stack trace is added to the log as well.
	 * 
	 * @param message
	 *            A message that should be written to the eclipse log file
	 * @param exception
	 *            Exception containing the stack trace
	 */
	public void logError(String message, Throwable exception) {
		log(IStatus.ERROR, message, exception);
	}

	/**
	 * Convenience method for easy and clean logging of exceptions. All messages
	 * collected by this method will be written to the eclipse log file. The
	 * exception's stack trace is added to the log as well.
	 * 
	 * @param exception
	 *            Exception containing the stack trace
	 */
	public void logError(Throwable exception) {
		if (exception != null)
			logError(exception.getMessage(), exception);
	}

	/**
	 * Logging any kind of message.
	 * 
	 * @param severity
	 * @param message
	 * @param exception
	 */
	private void log(int severity, String message, Throwable exception) {
		if (isDebugging())
			getLog().log(new Status(severity, getID(), message, exception));
	}

}