package rocks.inspectit.ui.rcp.model;

import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.resource.ResourceManager;
import org.eclipse.jface.viewers.DecorationOverlayIcon;
import org.eclipse.jface.viewers.IDecoration;
import org.eclipse.swt.graphics.Image;

import rocks.inspectit.shared.all.communication.ExceptionEvent;
import rocks.inspectit.shared.all.communication.data.ExceptionSensorData;
import rocks.inspectit.ui.rcp.InspectIT;
import rocks.inspectit.ui.rcp.InspectITImages;

/**
 * Factory currently used for the overlay icons which can be placed on arbitrary images being
 * passed.
 *
 * @author Patrice Bouillet
 *
 */
public final class ExceptionImageFactory {

	/**
	 * The image descriptor for the error overlay.
	 */
	private static final ImageDescriptor OVERLAY_ERROR = InspectIT.getDefault().getImageDescriptor(InspectITImages.IMG_OVERLAY_ERROR);

	/**
	 * The image descriptor for the priority overlay.
	 */
	private static final ImageDescriptor OVERLAY_PRIORITY = InspectIT.getDefault().getImageDescriptor(InspectITImages.IMG_OVERLAY_PRIORITY);

	/**
	 * The image descriptor for the up overlay.
	 */
	private static final ImageDescriptor OVERLAY_UP = InspectIT.getDefault().getImageDescriptor(InspectITImages.IMG_OVERLAY_UP);

	/**
	 * Private constructor.
	 */
	private ExceptionImageFactory() {
	}

	/**
	 * Returns the image descriptor for the given modifiers.
	 *
	 * @param data
	 *            The {@link ExceptionSensorData} data object where to check for the exception event
	 *            type.
	 * @return The image descriptor.
	 */
	public static ImageDescriptor getImageDescriptor(ExceptionSensorData data) {
		if (null != data) {
			ExceptionEvent event = data.getExceptionEvent();
			if (ExceptionEvent.CREATED.equals(event)) {
				return OVERLAY_ERROR;
			} else if (ExceptionEvent.HANDLED.equals(event)) {
				return OVERLAY_PRIORITY;
			} else if (ExceptionEvent.PASSED.equals(event)) {
				return OVERLAY_UP;
			} else if (ExceptionEvent.RETHROWN.equals(event)) {
				return OVERLAY_ERROR;
			} else if (ExceptionEvent.UNREGISTERED_PASSED.equals(event)) {
				return OVERLAY_UP;
			}
		}
		return ImageDescriptor.getMissingImageDescriptor();
	}

	/**
	 * The passed image will be decorated with an overlay which is defined on the event type of the
	 * exception transparently.
	 *
	 * @param image
	 *            the image that will be decorated with the overlay.
	 * @param data
	 *            the exception data from which the event will be extracted.
	 * @param resourceManager
	 *            Resource manager that image will be created with. It is responsibility of a caller
	 *            to provide {@link ResourceManager} for correct image disposing.
	 * @return the resulting image
	 */
	public static Image decorateImageWithException(Image image, ExceptionSensorData data, ResourceManager resourceManager) {
		ImageDescriptor exceptionDesc = getImageDescriptor(data);
		DecorationOverlayIcon icon = new DecorationOverlayIcon(image, exceptionDesc, IDecoration.BOTTOM_RIGHT);
		Image createdImage = resourceManager.createImage(icon);
		return createdImage;
	}

}