core/plugins/org.eclipse.dltk.debug.ui/src/org/eclipse/dltk/internal/debug/ui/ScriptEvaluationContextManager.java - dltk/org.eclipse.dltk.core - Git at Google

 /*******************************************************************************
  * Copyright (c) 2000, 2017 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
  *
  *******************************************************************************/
 package org.eclipse.dltk.internal.debug.ui;

 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;

 import org.eclipse.core.runtime.IAdaptable;
 import org.eclipse.debug.ui.DebugUITools;
 import org.eclipse.debug.ui.contexts.DebugContextEvent;
 import org.eclipse.debug.ui.contexts.IDebugContextListener;
 import org.eclipse.dltk.debug.core.model.IScriptStackFrame;
 import org.eclipse.dltk.debug.ui.DLTKDebugUIPlugin;
 import org.eclipse.jface.viewers.ISelection;
 import org.eclipse.jface.viewers.IStructuredSelection;
 import org.eclipse.ui.IWindowListener;
 import org.eclipse.ui.IWorkbench;
 import org.eclipse.ui.IWorkbenchPage;
 import org.eclipse.ui.IWorkbenchPart;
 import org.eclipse.ui.IWorkbenchWindow;
 import org.eclipse.ui.PlatformUI;

 /**
  * Manages the current evaluation context (stack frame) for evaluation actions.
  * In each page, the selection is tracked in each debug view (if any). When a
  * stack frame selection exists, the "debuggerActive" System property is set to
  * true.
  */
 public class ScriptEvaluationContextManager
 		implements IWindowListener, IDebugContextListener {

 	/**
 	 * System property indicating a stack frame is selected in the debug view
 	 * with an <code>IScriptStackFrame</code> adapter.
 	 */
 	private static final String DEBUGGER_ACTIVE = DLTKDebugUIPlugin.PLUGIN_ID
 			+ ".debuggerActive"; //$NON-NLS-1$

 	private static ScriptEvaluationContextManager manager;

 	private Map<IWorkbenchPage, IScriptStackFrame> pageToContextMap;

 	private IWorkbenchWindow activeWindow;

 	protected ScriptEvaluationContextManager() {
 		DebugUITools.getDebugContextManager().addDebugContextListener(this);
 		pageToContextMap = new HashMap<>();
 	}

 	public static void startup() {
 		Runnable r = () -> {
 			if (manager == null) {
 				manager = new ScriptEvaluationContextManager();

 				IWorkbench workbench = PlatformUI.getWorkbench();
 				IWorkbenchWindow[] windows = workbench.getWorkbenchWindows();
 				for (int i = 0; i < windows.length; i++) {
 					manager.windowOpened(windows[i]);
 				}
 				workbench.addWindowListener(manager);
 				manager.activeWindow = workbench.getActiveWorkbenchWindow();
 			}
 		};
 		DLTKDebugUIPlugin.getStandardDisplay().asyncExec(r);
 	}

 	@Override
 	public void windowActivated(IWorkbenchWindow window) {
 		activeWindow = window;
 	}

 	@Override
 	public void windowClosed(IWorkbenchWindow window) {
 	}

 	@Override
 	public void windowDeactivated(IWorkbenchWindow window) {
 	}

 	@Override
 	public void windowOpened(IWorkbenchWindow window) {
 	}

 	/**
 	 * Sets the evaluation context for the given page, and notes that a valid
 	 * execution context exists.
 	 *
 	 * @param page
 	 * @param frame
 	 */
 	private void setContext(IWorkbenchPage page, IScriptStackFrame frame) {
 		pageToContextMap.put(page, frame);
 		System.setProperty(DEBUGGER_ACTIVE, "true"); //$NON-NLS-1$

 		/*
 		 * if (frame.canForceReturn()) {
 		 * System.setProperty(SUPPORTS_FORCE_RETURN, "true"); //$NON-NLS-1$ }
 		 * else { System.setProperty(SUPPORTS_FORCE_RETURN, "false");
 		 * //$NON-NLS-1$ } if (((IScriptStackFrame)frame.getDebugTarget()).
 		 * supportsInstanceRetrieval()){
 		 * System.setProperty(SUPPORTS_INSTANCE_RETRIEVAL, "true");
 		 * //$NON-NLS-1$ } else {
 		 * System.setProperty(SUPPORTS_INSTANCE_RETRIEVAL, "false");
 		 * //$NON-NLS-1$ } if (instOf) {
 		 * System.setProperty(INSTANCE_OF_IJAVA_STACK_FRAME, "true");
 		 * //$NON-NLS-1$ } else {
 		 * System.setProperty(INSTANCE_OF_IJAVA_STACK_FRAME, "false");
 		 * //$NON-NLS-1$ }
 		 */
 	}

 	/**
 	 * Removes an evaluation context for the given page, and determines if any
 	 * valid execution context remain.
 	 *
 	 * @param page
 	 */
 	private void removeContext(IWorkbenchPage page) {
 		pageToContextMap.remove(page);
 		if (pageToContextMap.isEmpty()) {
 			System.setProperty(DEBUGGER_ACTIVE, "false"); //$NON-NLS-1$
 			// System.setProperty(INSTANCE_OF_IJAVA_STACK_FRAME, "false");
 			// //$NON-NLS-1$
 			// System.setProperty(SUPPORTS_FORCE_RETURN, "false"); //$NON-NLS-1$
 			// System.setProperty(SUPPORTS_INSTANCE_RETRIEVAL, "false");
 			// //$NON-NLS-1$
 		}
 	}

 	private static IScriptStackFrame getContext(IWorkbenchPage page) {
 		if (manager != null) {
 			if (manager.pageToContextMap != null) {
 				return manager.pageToContextMap.get(page);
 			}
 		}
 		return null;
 	}

 	/**
 	 * Returns the evaluation context for the given part, or <code>null</code>
 	 * if none. The evaluation context corresponds to the selected stack frame
 	 * in the following priority order:
 	 * <ol>
 	 * <li>stack frame in the same page</li>
 	 * <li>stack frame in the same window</li>
 	 * <li>stack frame in active page of other window</li>
 	 * <li>stack frame in page of other windows</li>
 	 * </ol>
 	 *
 	 * @param part
 	 *            the part that the evaluation action was invoked from
 	 * @return the stack frame that supplies an evaluation context, or
 	 *         <code>null</code> if none
 	 */
 	public static IScriptStackFrame getEvaluationContext(IWorkbenchPart part) {
 		IWorkbenchPage page = part.getSite().getPage();
 		IScriptStackFrame frame = getContext(page);
 		if (frame == null) {
 			return getEvaluationContext(page.getWorkbenchWindow());
 		}
 		return frame;
 	}

 	/**
 	 * Returns the evaluation context for the given window, or <code>null</code>
 	 * if none. The evaluation context corresponds to the selected stack frame
 	 * in the following priority order:
 	 * <ol>
 	 * <li>stack frame in active page of the window</li>
 	 * <li>stack frame in another page of the window</li>
 	 * <li>stack frame in active page of another window</li>
 	 * <li>stack frame in a page of another window</li>
 	 * </ol>
 	 *
 	 * @param window
 	 *            the window that the evaluation action was invoked from, or
 	 *            <code>null</code> if the current window should be consulted
 	 * @return the stack frame that supplies an evaluation context, or
 	 *         <code>null</code> if none
 	 * @return IJavaStackFrame
 	 */
 	public static IScriptStackFrame getEvaluationContext(
 			IWorkbenchWindow window) {
 		List<IWorkbenchWindow> alreadyVisited = new ArrayList<>();
 		if (window == null) {
 			window = manager.activeWindow;
 		}
 		return getEvaluationContext(window, alreadyVisited);
 	}

 	private static IScriptStackFrame getEvaluationContext(
 			IWorkbenchWindow window, List<IWorkbenchWindow> alreadyVisited) {
 		IWorkbenchPage activePage = window.getActivePage();
 		IScriptStackFrame frame = null;
 		if (activePage != null) {
 			frame = getContext(activePage);
 		}
 		if (frame == null) {
 			IWorkbenchPage[] pages = window.getPages();
 			for (int i = 0; i < pages.length; i++) {
 				if (activePage != pages[i]) {
 					frame = getContext(pages[i]);
 					if (frame != null) {
 						return frame;
 					}
 				}
 			}

 			alreadyVisited.add(window);

 			IWorkbenchWindow[] windows = PlatformUI.getWorkbench()
 					.getWorkbenchWindows();
 			for (int i = 0; i < windows.length; i++) {
 				if (!alreadyVisited.contains(windows[i])) {
 					frame = getEvaluationContext(windows[i], alreadyVisited);
 					if (frame != null) {
 						return frame;
 					}
 				}
 			}
 			return null;
 		}
 		return frame;
 	}

 	@Override
 	public void debugContextChanged(DebugContextEvent event) {
 		if ((event.getFlags() & DebugContextEvent.ACTIVATED) > 0) {
 			IWorkbenchPart part = event.getDebugContextProvider().getPart();
 			if (part != null) {
 				IWorkbenchPage page = part.getSite().getPage();
 				ISelection selection = event.getContext();
 				if (selection instanceof IStructuredSelection) {
 					IStructuredSelection ss = (IStructuredSelection) selection;
 					if (ss.size() == 1) {
 						Object element = ss.getFirstElement();
 						if (element instanceof IAdaptable) {
 							IScriptStackFrame frame = ((IAdaptable) element)
 									.getAdapter(IScriptStackFrame.class);
 							if (frame != null) {
 								setContext(page, frame);
 								return;
 							}
 						}
 					}
 				}

 				// no context in the given view
 				removeContext(page);
 			}
 		}
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2000, 2017 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
	*
	*******************************************************************************/
	package org.eclipse.dltk.internal.debug.ui;

	import java.util.ArrayList;
	import java.util.HashMap;
	import java.util.List;
	import java.util.Map;

	import org.eclipse.core.runtime.IAdaptable;
	import org.eclipse.debug.ui.DebugUITools;
	import org.eclipse.debug.ui.contexts.DebugContextEvent;
	import org.eclipse.debug.ui.contexts.IDebugContextListener;
	import org.eclipse.dltk.debug.core.model.IScriptStackFrame;
	import org.eclipse.dltk.debug.ui.DLTKDebugUIPlugin;
	import org.eclipse.jface.viewers.ISelection;
	import org.eclipse.jface.viewers.IStructuredSelection;
	import org.eclipse.ui.IWindowListener;
	import org.eclipse.ui.IWorkbench;
	import org.eclipse.ui.IWorkbenchPage;
	import org.eclipse.ui.IWorkbenchPart;
	import org.eclipse.ui.IWorkbenchWindow;
	import org.eclipse.ui.PlatformUI;

	/**
	* Manages the current evaluation context (stack frame) for evaluation actions.
	* In each page, the selection is tracked in each debug view (if any). When a
	* stack frame selection exists, the "debuggerActive" System property is set to
	* true.
	*/
	public class ScriptEvaluationContextManager
	implements IWindowListener, IDebugContextListener {

	/**
	* System property indicating a stack frame is selected in the debug view
	* with an <code>IScriptStackFrame</code> adapter.
	*/
	private static final String DEBUGGER_ACTIVE = DLTKDebugUIPlugin.PLUGIN_ID
	+ ".debuggerActive"; //$NON-NLS-1$

	private static ScriptEvaluationContextManager manager;

	private Map<IWorkbenchPage, IScriptStackFrame> pageToContextMap;

	private IWorkbenchWindow activeWindow;

	protected ScriptEvaluationContextManager() {
	DebugUITools.getDebugContextManager().addDebugContextListener(this);
	pageToContextMap = new HashMap<>();
	}

	public static void startup() {
	Runnable r = () -> {
	if (manager == null) {
	manager = new ScriptEvaluationContextManager();

	IWorkbench workbench = PlatformUI.getWorkbench();
	IWorkbenchWindow[] windows = workbench.getWorkbenchWindows();
	for (int i = 0; i < windows.length; i++) {
	manager.windowOpened(windows[i]);
	}
	workbench.addWindowListener(manager);
	manager.activeWindow = workbench.getActiveWorkbenchWindow();
	}
	};
	DLTKDebugUIPlugin.getStandardDisplay().asyncExec(r);
	}

	@Override
	public void windowActivated(IWorkbenchWindow window) {
	activeWindow = window;
	}

	@Override
	public void windowClosed(IWorkbenchWindow window) {
	}

	@Override
	public void windowDeactivated(IWorkbenchWindow window) {
	}

	@Override
	public void windowOpened(IWorkbenchWindow window) {
	}

	/**
	* Sets the evaluation context for the given page, and notes that a valid
	* execution context exists.
	*
	* @param page
	* @param frame
	*/
	private void setContext(IWorkbenchPage page, IScriptStackFrame frame) {
	pageToContextMap.put(page, frame);
	System.setProperty(DEBUGGER_ACTIVE, "true"); //$NON-NLS-1$

	/*
	* if (frame.canForceReturn()) {
	* System.setProperty(SUPPORTS_FORCE_RETURN, "true"); //$NON-NLS-1$ }
	* else { System.setProperty(SUPPORTS_FORCE_RETURN, "false");
	* //$NON-NLS-1$ } if (((IScriptStackFrame)frame.getDebugTarget()).
	* supportsInstanceRetrieval()){
	* System.setProperty(SUPPORTS_INSTANCE_RETRIEVAL, "true");
	* //$NON-NLS-1$ } else {
	* System.setProperty(SUPPORTS_INSTANCE_RETRIEVAL, "false");
	* //$NON-NLS-1$ } if (instOf) {
	* System.setProperty(INSTANCE_OF_IJAVA_STACK_FRAME, "true");
	* //$NON-NLS-1$ } else {
	* System.setProperty(INSTANCE_OF_IJAVA_STACK_FRAME, "false");
	* //$NON-NLS-1$ }
	*/
	}

	/**
	* Removes an evaluation context for the given page, and determines if any
	* valid execution context remain.
	*
	* @param page
	*/
	private void removeContext(IWorkbenchPage page) {
	pageToContextMap.remove(page);
	if (pageToContextMap.isEmpty()) {
	System.setProperty(DEBUGGER_ACTIVE, "false"); //$NON-NLS-1$
	// System.setProperty(INSTANCE_OF_IJAVA_STACK_FRAME, "false");
	// //$NON-NLS-1$
	// System.setProperty(SUPPORTS_FORCE_RETURN, "false"); //$NON-NLS-1$
	// System.setProperty(SUPPORTS_INSTANCE_RETRIEVAL, "false");
	// //$NON-NLS-1$
	}
	}

	private static IScriptStackFrame getContext(IWorkbenchPage page) {
	if (manager != null) {
	if (manager.pageToContextMap != null) {
	return manager.pageToContextMap.get(page);
	}
	}
	return null;
	}

	/**
	* Returns the evaluation context for the given part, or <code>null</code>
	* if none. The evaluation context corresponds to the selected stack frame
	* in the following priority order:
	* <ol>
	* <li>stack frame in the same page</li>
	* <li>stack frame in the same window</li>
	* <li>stack frame in active page of other window</li>
	* <li>stack frame in page of other windows</li>
	* </ol>
	*
	* @param part
	* the part that the evaluation action was invoked from
	* @return the stack frame that supplies an evaluation context, or
	* <code>null</code> if none
	*/
	public static IScriptStackFrame getEvaluationContext(IWorkbenchPart part) {
	IWorkbenchPage page = part.getSite().getPage();
	IScriptStackFrame frame = getContext(page);
	if (frame == null) {
	return getEvaluationContext(page.getWorkbenchWindow());
	}
	return frame;
	}

	/**
	* Returns the evaluation context for the given window, or <code>null</code>
	* if none. The evaluation context corresponds to the selected stack frame
	* in the following priority order:
	* <ol>
	* <li>stack frame in active page of the window</li>
	* <li>stack frame in another page of the window</li>
	* <li>stack frame in active page of another window</li>
	* <li>stack frame in a page of another window</li>
	* </ol>
	*
	* @param window
	* the window that the evaluation action was invoked from, or
	* <code>null</code> if the current window should be consulted
	* @return the stack frame that supplies an evaluation context, or
	* <code>null</code> if none
	* @return IJavaStackFrame
	*/
	public static IScriptStackFrame getEvaluationContext(
	IWorkbenchWindow window) {
	List<IWorkbenchWindow> alreadyVisited = new ArrayList<>();
	if (window == null) {
	window = manager.activeWindow;
	}
	return getEvaluationContext(window, alreadyVisited);
	}

	private static IScriptStackFrame getEvaluationContext(
	IWorkbenchWindow window, List<IWorkbenchWindow> alreadyVisited) {
	IWorkbenchPage activePage = window.getActivePage();
	IScriptStackFrame frame = null;
	if (activePage != null) {
	frame = getContext(activePage);
	}
	if (frame == null) {
	IWorkbenchPage[] pages = window.getPages();
	for (int i = 0; i < pages.length; i++) {
	if (activePage != pages[i]) {
	frame = getContext(pages[i]);
	if (frame != null) {
	return frame;
	}
	}
	}

	alreadyVisited.add(window);

	IWorkbenchWindow[] windows = PlatformUI.getWorkbench()
	.getWorkbenchWindows();
	for (int i = 0; i < windows.length; i++) {
	if (!alreadyVisited.contains(windows[i])) {
	frame = getEvaluationContext(windows[i], alreadyVisited);
	if (frame != null) {
	return frame;
	}
	}
	}
	return null;
	}
	return frame;
	}

	@Override
	public void debugContextChanged(DebugContextEvent event) {
	if ((event.getFlags() & DebugContextEvent.ACTIVATED) > 0) {
	IWorkbenchPart part = event.getDebugContextProvider().getPart();
	if (part != null) {
	IWorkbenchPage page = part.getSite().getPage();
	ISelection selection = event.getContext();
	if (selection instanceof IStructuredSelection) {
	IStructuredSelection ss = (IStructuredSelection) selection;
	if (ss.size() == 1) {
	Object element = ss.getFirstElement();
	if (element instanceof IAdaptable) {
	IScriptStackFrame frame = ((IAdaptable) element)
	.getAdapter(IScriptStackFrame.class);
	if (frame != null) {
	setContext(page, frame);
	return;
	}
	}
	}
	}

	// no context in the given view
	removeContext(page);
	}
	}
	}
	}