examples/org.eclipse.ocl.examples.debug.vm.ui/src/org/eclipse/ocl/examples/debug/vm/ui/DebugVMUIPlugin.java - ocl/org.eclipse.ocl - Git at Google

 /*******************************************************************************
  * Copyright (c) 2014, 2018 Willink Transformations and others.
  * All rights reserved.   This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v20.html
  *
  * Contributors:
  *   E.D.Willink - Initial API and implementation
  *******************************************************************************/
 package org.eclipse.ocl.examples.debug.vm.ui;

 import java.net.URL;
 import java.util.Collections;

 import org.apache.log4j.Logger;
 import org.eclipse.core.runtime.FileLocator;
 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.Path;
 import org.eclipse.core.runtime.Status;
 import org.eclipse.emf.common.util.BasicDiagnostic;
 import org.eclipse.emf.common.util.Diagnostic;
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jface.dialogs.ErrorDialog;
 import org.eclipse.jface.dialogs.MessageDialog;
 import org.eclipse.jface.resource.ImageDescriptor;
 import org.eclipse.jface.resource.ImageRegistry;
 import org.eclipse.ocl.examples.debug.vm.ui.actions.DebugVMImages;
 import org.eclipse.ocl.examples.debug.vm.ui.messages.DebugVMUIMessages;
 import org.eclipse.swt.graphics.Image;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Shell;
 import org.eclipse.ui.IWorkbenchWindow;
 import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.plugin.AbstractUIPlugin;
 import org.osgi.framework.BundleContext;

 /**
  * The activator class controls the plug-in life cycle
  */
 public class DebugVMUIPlugin extends AbstractUIPlugin {

 	// The plug-in ID
 	public static final String PLUGIN_ID = "org.eclipse.ocl.examples.debug.vm.ui"; //$NON-NLS-1$

 	// The shared instance
 	private static DebugVMUIPlugin plugin;

 	private static final Logger logger = Logger.getLogger(DebugVMUIPlugin.class);

 	protected ImageRegistry imageDescriptorRegistry;

 	/**
 	 * The constructor
 	 */
 	public DebugVMUIPlugin() {
 	}

 	/*
 	 * (non-Javadoc)
 	 * @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext)
 	 */
 	@Override
 	public void start(BundleContext context) throws Exception {
 		super.start(context);
 		plugin = this;
 	}

 	/*
 	 * (non-Javadoc)
 	 * @see org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext)
 	 */
 	@Override
 	public void stop(BundleContext context) throws Exception {
 		plugin = null;
 		if (imageDescriptorRegistry != null) {
 			imageDescriptorRegistry.dispose();
 			imageDescriptorRegistry = null;
 		}
 		super.stop(context);
 	}

 	/**
 	 * Returns the shared instance
 	 *
 	 * @return the shared instance
 	 */
 	public static DebugVMUIPlugin getDefault() {
 		return plugin;
 	}


 	public Image createImage(String path) {

 		Image image = getImageRegistry().get(path);

 		if (image == null) {
 			try {
 				ImageDescriptor imageDescriptor = getImageDescriptor(path);
 				if (imageDescriptor != null) {
 					image = getImageDescriptor(path).createImage();
 					if (image != null) { getImageRegistry().put(path, image); }
 				}
 			}
 			catch(Exception e) { logger.error("Failed to createImage '" + path + "'", e); }
 		}

 		return image;
 	}

 	public ImageDescriptor getImageDescriptor(String path) {

 		ImageDescriptor imageDescriptor = getImageDescriptorRegistry().getDescriptor(path);

 		if (imageDescriptor == null) {
 			URL url = FileLocator.find(getBundle(), new Path(path), Collections.<String, String>emptyMap());
 			if (url != null) {
 				imageDescriptor = ImageDescriptor.createFromURL(url);
 				if (imageDescriptor != null) getImageDescriptorRegistry().put(path, imageDescriptor);
 			}
 		}

 		return imageDescriptor;
 	}

 	protected ImageRegistry getImageDescriptorRegistry() {
 		if (imageDescriptorRegistry == null) {
 			imageDescriptorRegistry = createImageRegistry();
 		}
 		return imageDescriptorRegistry;
 	}

 	public static BasicDiagnostic createDiagnostic(String message) {
 		return new BasicDiagnostic(Diagnostic.OK, PLUGIN_ID, 0, message, null);
 	}

 	public static Diagnostic createErrorDiagnostic(String message, Throwable throwable) {
 		Object[] data = (throwable == null) ? null : new Object [] { throwable };
 		return new BasicDiagnostic(Diagnostic.ERROR,  PLUGIN_ID, 0, message, data);
 	}

 	public static Diagnostic createWarnDiagnostic(String message) {
 		return new BasicDiagnostic(Diagnostic.ERROR,  PLUGIN_ID, 0, message, null);
 	}

 	/**
 	 * Indicates that the given diagnostic is neither error or canceled.
 	 *
 	 * @param diagnostic
 	 *            the diagnostic to test
 	 * @return <code>true</code> in case of success, <code>false</code>
 	 *         otherwise
 	 */
 	public static boolean isSuccess(Diagnostic diagnostic) {
 		int severity = diagnostic.getSeverity();
 		return severity != Diagnostic.ERROR && severity != Diagnostic.CANCEL;
 	}

 	public static void log(int severity, int code, String message, Throwable throwable) {
 		//
 		// Status ctor requires a non-null message
 		String msg = message == null
 				? "" //$NON-NLS-1$
 						: message;

 		try {
 			if (getDefault() != null) {
 				// Eclipse environment
 				log(new Status(severity, PLUGIN_ID, code, msg, throwable));
 			} else {
 				// not in the Eclipse environment
 				//if (shouldTrace()) {
 				switch (code) {
 				case Diagnostic.WARNING :
 					System.err.print("WARNING "); //$NON-NLS-1$
 					break;
 				case Diagnostic.ERROR :
 				case Diagnostic.CANCEL :
 					System.err.print("ERROR "); //$NON-NLS-1$
 					break;
 				default :
 					// don't output INFO or OK messages
 					return;
 				}

 				System.err.print(code);
 				System.err.print(": "); //$NON-NLS-1$
 				System.err.println(message);

 				if (throwable != null) {
 					throwable.printStackTrace(System.err);
 				}
 				//}
 			}
 		} catch (IllegalArgumentException iae) {
 			iae.printStackTrace();
 		}
 	}

 	public static void log(IStatus status) {
 		DebugVMUIPlugin debugPlugin = getDefault();
 		if(debugPlugin != null) {
 			debugPlugin.getLog().log(status);
 		}
 	}

 	public static void log(Throwable e) {
 		log(new Status(IStatus.ERROR, PLUGIN_ID, "Exception caught", e)); //$NON-NLS-1$
 	}

 	public static final Display getStandardDisplay() {
 		Display display = Display.getCurrent();
 		if (display == null) {
 			display = Display.getDefault();
 		}
 		return display;
 	}

 	/**
 	 * Returns the active workbench window
 	 *
 	 * @return the active workbench window
 	 */
 	public static IWorkbenchWindow getActiveWorkbenchWindow() {
 		return PlatformUI.getWorkbench().getActiveWorkbenchWindow();
 	}

 	/**
 	 * Utility method with conventions
 	 * @param shell the shell to open the dialog on
 	 * @param title the title of the dialog
 	 * @param message the message to display in the dialog
 	 * @param s the underlying {@link IStatus} to display
 	 */
 	public static void errorDialog(Shell shell, String title, String message, IStatus s) {
 		// if the 'message' resource string and the IStatus' message are the same,
 		// don't show both in the dialog
 		if (s != null && message.equals(s.getMessage())) {
 			message= null;
 		}
 		ErrorDialog.openError(shell, title, message, s);
 	}

 	/**
 	 * Returns the active workbench shell or <code>null</code> if none
 	 *
 	 * @return the active workbench shell or <code>null</code> if none
 	 */
 	public static Shell getActiveWorkbenchShell() {
 		IWorkbenchWindow window = getActiveWorkbenchWindow();
 		if (window != null) {
 			return window.getShell();
 		}
 		return null;
 	}

 	public static @NonNull IStatus createStatus(int severity, String message) {
 		return new Status(severity, PLUGIN_ID, 0, message, null);
 	}

 	public static @NonNull IStatus createErrorStatus(String message) {
 		return createStatus(IStatus.ERROR, message);
 	}

 	public static void statusDialog(IStatus status) {
 		switch (status.getSeverity()) {
 		case IStatus.ERROR:
 			statusDialog(DebugVMUIMessages.StatusDialog_Error, status);
 			break;
 		case IStatus.WARNING:
 			statusDialog(DebugVMUIMessages.StatusDialog_Warning, status);
 			break;
 		case IStatus.INFO:
 			statusDialog(DebugVMUIMessages.StatusDialog_Information,
 					status);
 			break;
 		}
 	}

 	public static void statusDialog(String title, IStatus status) {
 		Shell shell = getActiveWorkbenchShell();
 		if (shell != null) {
 			switch (status.getSeverity()) {
 			case IStatus.ERROR:
 				ErrorDialog.openError(shell, title, null, status);
 				break;
 			case IStatus.WARNING:
 				MessageDialog.openWarning(shell, title, status.getMessage());
 				break;
 			case IStatus.INFO:
 				MessageDialog
 				.openInformation(shell, title, status.getMessage());
 				break;
 			}
 		}
 	}

 	@Override
 	protected ImageRegistry createImageRegistry() {
 		ImageRegistry imageRegistry = super.createImageRegistry();
 		imageRegistry.put(DebugVMImages.LOCAL_VARIABLE, imageDescriptor("localvar_obj.gif")); //$NON-NLS-1$
 		imageRegistry.put(DebugVMImages.THIS_VARIABLE, imageDescriptor("thisvar_obj.gif")); //$NON-NLS-1$
 		imageRegistry.put(DebugVMImages.PREDEFINED_VARIABLE, imageDescriptor("predefvar_obj.gif")); //$NON-NLS-1$
 		imageRegistry.put(DebugVMImages.MODEL_PARAMETER, imageDescriptor("modelpar_obj.gif")); //$NON-NLS-1$
 		imageRegistry.put(DebugVMImages.ATTRIBUTE, imageDescriptor("attribute_obj.gif")); //$NON-NLS-1$
 		imageRegistry.put(DebugVMImages.REFERENCE, imageDescriptor("reference_obj.gif")); //$NON-NLS-1$
 		imageRegistry.put(DebugVMImages.COLLECTION_ELEMENT, imageDescriptor("index_element_obj.gif")); //$NON-NLS-1$
 		imageRegistry.put(DebugVMImages.EXPRESSION_IN_OCL, imageDescriptor("ExpressionInOCL.gif")); //$NON-NLS-1$

 		/*		imageRegistry.put(OCLDebugImages.INTERM_PROPERTY,
 				overlayImage("intermprop_ovr.gif", //$NON-NLS-1$
 						imageRegistry.get(OCLDebugImages.ATTRIBUTE),
 						IDecoration.BOTTOM_RIGHT));

 		imageRegistry.put(OCLDebugImages.CONDITIONAL_BPNT_ENABLED,
 				overlayImage("conditional_ovr.gif", //$NON-NLS-1$
 						DebugUITools.getImage(IDebugUIConstants.IMG_OBJS_BREAKPOINT),
 						IDecoration.TOP_LEFT));
 		imageRegistry.put(OCLDebugImages.CONDITIONAL_BPNT_DISABLED,
 				overlayImage(
 						"conditional_ovr_disabled.gif", //$NON-NLS-1$
 						DebugUITools.getImage(IDebugUIConstants.IMG_OBJS_BREAKPOINT_DISABLED),
 						IDecoration.TOP_LEFT));
 		 */
 		return imageRegistry;
 	}

 	private ImageDescriptor imageDescriptor(String imagePath) {
 		return imageDescriptorFromPlugin(PLUGIN_ID, "icons/" + imagePath); //$NON-NLS-1$
 	}

 	/*    private final ImageDescriptor overlayImage(String overImagePath, Image base, int quadrant) {
         ImageDescriptor decorator = imageDescriptor(overImagePath);
         return new DecorationOverlayIcon(base, decorator, quadrant);
     } */
 }
	/*******************************************************************************
	* Copyright (c) 2014, 2018 Willink Transformations and others.
	* All rights reserved. This program and the accompanying materials
	* are made available under the terms of the Eclipse Public License v2.0
	* which accompanies this distribution, and is available at
	* http://www.eclipse.org/legal/epl-v20.html
	*
	* Contributors:
	* E.D.Willink - Initial API and implementation
	*******************************************************************************/
	package org.eclipse.ocl.examples.debug.vm.ui;

	import java.net.URL;
	import java.util.Collections;

	import org.apache.log4j.Logger;
	import org.eclipse.core.runtime.FileLocator;
	import org.eclipse.core.runtime.IStatus;
	import org.eclipse.core.runtime.Path;
	import org.eclipse.core.runtime.Status;
	import org.eclipse.emf.common.util.BasicDiagnostic;
	import org.eclipse.emf.common.util.Diagnostic;
	import org.eclipse.jdt.annotation.NonNull;
	import org.eclipse.jface.dialogs.ErrorDialog;
	import org.eclipse.jface.dialogs.MessageDialog;
	import org.eclipse.jface.resource.ImageDescriptor;
	import org.eclipse.jface.resource.ImageRegistry;
	import org.eclipse.ocl.examples.debug.vm.ui.actions.DebugVMImages;
	import org.eclipse.ocl.examples.debug.vm.ui.messages.DebugVMUIMessages;
	import org.eclipse.swt.graphics.Image;
	import org.eclipse.swt.widgets.Display;
	import org.eclipse.swt.widgets.Shell;
	import org.eclipse.ui.IWorkbenchWindow;
	import org.eclipse.ui.PlatformUI;
	import org.eclipse.ui.plugin.AbstractUIPlugin;
	import org.osgi.framework.BundleContext;

	/**
	* The activator class controls the plug-in life cycle
	*/
	public class DebugVMUIPlugin extends AbstractUIPlugin {

	// The plug-in ID
	public static final String PLUGIN_ID = "org.eclipse.ocl.examples.debug.vm.ui"; //$NON-NLS-1$

	// The shared instance
	private static DebugVMUIPlugin plugin;

	private static final Logger logger = Logger.getLogger(DebugVMUIPlugin.class);

	protected ImageRegistry imageDescriptorRegistry;

	/**
	* The constructor
	*/
	public DebugVMUIPlugin() {
	}

	/*
	* (non-Javadoc)
	* @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext)
	*/
	@Override
	public void start(BundleContext context) throws Exception {
	super.start(context);
	plugin = this;
	}

	/*
	* (non-Javadoc)
	* @see org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext)
	*/
	@Override
	public void stop(BundleContext context) throws Exception {
	plugin = null;
	if (imageDescriptorRegistry != null) {
	imageDescriptorRegistry.dispose();
	imageDescriptorRegistry = null;
	}
	super.stop(context);
	}

	/**
	* Returns the shared instance
	*
	* @return the shared instance
	*/
	public static DebugVMUIPlugin getDefault() {
	return plugin;
	}


	public Image createImage(String path) {

	Image image = getImageRegistry().get(path);

	if (image == null) {
	try {
	ImageDescriptor imageDescriptor = getImageDescriptor(path);
	if (imageDescriptor != null) {
	image = getImageDescriptor(path).createImage();
	if (image != null) { getImageRegistry().put(path, image); }
	}
	}
	catch(Exception e) { logger.error("Failed to createImage '" + path + "'", e); }
	}

	return image;
	}

	public ImageDescriptor getImageDescriptor(String path) {

	ImageDescriptor imageDescriptor = getImageDescriptorRegistry().getDescriptor(path);

	if (imageDescriptor == null) {
	URL url = FileLocator.find(getBundle(), new Path(path), Collections.<String, String>emptyMap());
	if (url != null) {
	imageDescriptor = ImageDescriptor.createFromURL(url);
	if (imageDescriptor != null) getImageDescriptorRegistry().put(path, imageDescriptor);
	}
	}

	return imageDescriptor;
	}

	protected ImageRegistry getImageDescriptorRegistry() {
	if (imageDescriptorRegistry == null) {
	imageDescriptorRegistry = createImageRegistry();
	}
	return imageDescriptorRegistry;
	}

	public static BasicDiagnostic createDiagnostic(String message) {
	return new BasicDiagnostic(Diagnostic.OK, PLUGIN_ID, 0, message, null);
	}

	public static Diagnostic createErrorDiagnostic(String message, Throwable throwable) {
	Object[] data = (throwable == null) ? null : new Object [] { throwable };
	return new BasicDiagnostic(Diagnostic.ERROR, PLUGIN_ID, 0, message, data);
	}

	public static Diagnostic createWarnDiagnostic(String message) {
	return new BasicDiagnostic(Diagnostic.ERROR, PLUGIN_ID, 0, message, null);
	}

	/**
	* Indicates that the given diagnostic is neither error or canceled.
	*
	* @param diagnostic
	* the diagnostic to test
	* @return <code>true</code> in case of success, <code>false</code>
	* otherwise
	*/
	public static boolean isSuccess(Diagnostic diagnostic) {
	int severity = diagnostic.getSeverity();
	return severity != Diagnostic.ERROR && severity != Diagnostic.CANCEL;
	}

	public static void log(int severity, int code, String message, Throwable throwable) {
	//
	// Status ctor requires a non-null message
	String msg = message == null
	? "" //$NON-NLS-1$
	: message;

	try {
	if (getDefault() != null) {
	// Eclipse environment
	log(new Status(severity, PLUGIN_ID, code, msg, throwable));
	} else {
	// not in the Eclipse environment
	//if (shouldTrace()) {
	switch (code) {
	case Diagnostic.WARNING :
	System.err.print("WARNING "); //$NON-NLS-1$
	break;
	case Diagnostic.ERROR :
	case Diagnostic.CANCEL :
	System.err.print("ERROR "); //$NON-NLS-1$
	break;
	default :
	// don't output INFO or OK messages
	return;
	}

	System.err.print(code);
	System.err.print(": "); //$NON-NLS-1$
	System.err.println(message);

	if (throwable != null) {
	throwable.printStackTrace(System.err);
	}
	//}
	}
	} catch (IllegalArgumentException iae) {
	iae.printStackTrace();
	}
	}

	public static void log(IStatus status) {
	DebugVMUIPlugin debugPlugin = getDefault();
	if(debugPlugin != null) {
	debugPlugin.getLog().log(status);
	}
	}

	public static void log(Throwable e) {
	log(new Status(IStatus.ERROR, PLUGIN_ID, "Exception caught", e)); //$NON-NLS-1$
	}

	public static final Display getStandardDisplay() {
	Display display = Display.getCurrent();
	if (display == null) {
	display = Display.getDefault();
	}
	return display;
	}

	/**
	* Returns the active workbench window
	*
	* @return the active workbench window
	*/
	public static IWorkbenchWindow getActiveWorkbenchWindow() {
	return PlatformUI.getWorkbench().getActiveWorkbenchWindow();
	}

	/**
	* Utility method with conventions
	* @param shell the shell to open the dialog on
	* @param title the title of the dialog
	* @param message the message to display in the dialog
	* @param s the underlying {@link IStatus} to display
	*/
	public static void errorDialog(Shell shell, String title, String message, IStatus s) {
	// if the 'message' resource string and the IStatus' message are the same,
	// don't show both in the dialog
	if (s != null && message.equals(s.getMessage())) {
	message= null;
	}
	ErrorDialog.openError(shell, title, message, s);
	}

	/**
	* Returns the active workbench shell or <code>null</code> if none
	*
	* @return the active workbench shell or <code>null</code> if none
	*/
	public static Shell getActiveWorkbenchShell() {
	IWorkbenchWindow window = getActiveWorkbenchWindow();
	if (window != null) {
	return window.getShell();
	}
	return null;
	}

	public static @NonNull IStatus createStatus(int severity, String message) {
	return new Status(severity, PLUGIN_ID, 0, message, null);
	}

	public static @NonNull IStatus createErrorStatus(String message) {
	return createStatus(IStatus.ERROR, message);
	}

	public static void statusDialog(IStatus status) {
	switch (status.getSeverity()) {
	case IStatus.ERROR:
	statusDialog(DebugVMUIMessages.StatusDialog_Error, status);
	break;
	case IStatus.WARNING:
	statusDialog(DebugVMUIMessages.StatusDialog_Warning, status);
	break;
	case IStatus.INFO:
	statusDialog(DebugVMUIMessages.StatusDialog_Information,
	status);
	break;
	}
	}

	public static void statusDialog(String title, IStatus status) {
	Shell shell = getActiveWorkbenchShell();
	if (shell != null) {
	switch (status.getSeverity()) {
	case IStatus.ERROR:
	ErrorDialog.openError(shell, title, null, status);
	break;
	case IStatus.WARNING:
	MessageDialog.openWarning(shell, title, status.getMessage());
	break;
	case IStatus.INFO:
	MessageDialog
	.openInformation(shell, title, status.getMessage());
	break;
	}
	}
	}

	@Override
	protected ImageRegistry createImageRegistry() {
	ImageRegistry imageRegistry = super.createImageRegistry();
	imageRegistry.put(DebugVMImages.LOCAL_VARIABLE, imageDescriptor("localvar_obj.gif")); //$NON-NLS-1$
	imageRegistry.put(DebugVMImages.THIS_VARIABLE, imageDescriptor("thisvar_obj.gif")); //$NON-NLS-1$
	imageRegistry.put(DebugVMImages.PREDEFINED_VARIABLE, imageDescriptor("predefvar_obj.gif")); //$NON-NLS-1$
	imageRegistry.put(DebugVMImages.MODEL_PARAMETER, imageDescriptor("modelpar_obj.gif")); //$NON-NLS-1$
	imageRegistry.put(DebugVMImages.ATTRIBUTE, imageDescriptor("attribute_obj.gif")); //$NON-NLS-1$
	imageRegistry.put(DebugVMImages.REFERENCE, imageDescriptor("reference_obj.gif")); //$NON-NLS-1$
	imageRegistry.put(DebugVMImages.COLLECTION_ELEMENT, imageDescriptor("index_element_obj.gif")); //$NON-NLS-1$
	imageRegistry.put(DebugVMImages.EXPRESSION_IN_OCL, imageDescriptor("ExpressionInOCL.gif")); //$NON-NLS-1$

	/* imageRegistry.put(OCLDebugImages.INTERM_PROPERTY,
	overlayImage("intermprop_ovr.gif", //$NON-NLS-1$
	imageRegistry.get(OCLDebugImages.ATTRIBUTE),
	IDecoration.BOTTOM_RIGHT));

	imageRegistry.put(OCLDebugImages.CONDITIONAL_BPNT_ENABLED,
	overlayImage("conditional_ovr.gif", //$NON-NLS-1$
	DebugUITools.getImage(IDebugUIConstants.IMG_OBJS_BREAKPOINT),
	IDecoration.TOP_LEFT));
	imageRegistry.put(OCLDebugImages.CONDITIONAL_BPNT_DISABLED,
	overlayImage(
	"conditional_ovr_disabled.gif", //$NON-NLS-1$
	DebugUITools.getImage(IDebugUIConstants.IMG_OBJS_BREAKPOINT_DISABLED),
	IDecoration.TOP_LEFT));
	*/
	return imageRegistry;
	}

	private ImageDescriptor imageDescriptor(String imagePath) {
	return imageDescriptorFromPlugin(PLUGIN_ID, "icons/" + imagePath); //$NON-NLS-1$
	}

	/* private final ImageDescriptor overlayImage(String overImagePath, Image base, int quadrant) {
	ImageDescriptor decorator = imageDescriptor(overImagePath);
	return new DecorationOverlayIcon(base, decorator, quadrant);
	} */
	}