| /******************************************************************************* |
| * Copyright (c) 2000, 2003 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Common Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/cpl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.debug.internal.core; |
| |
| |
| import java.io.ByteArrayInputStream; |
| import java.io.IOException; |
| import java.text.MessageFormat; |
| import java.util.ArrayList; |
| import java.util.HashMap; |
| import java.util.Iterator; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Vector; |
| |
| import javax.xml.parsers.DocumentBuilder; |
| import javax.xml.parsers.DocumentBuilderFactory; |
| import javax.xml.parsers.ParserConfigurationException; |
| import javax.xml.transform.TransformerException; |
| |
| import org.eclipse.core.runtime.CoreException; |
| import org.eclipse.core.runtime.IConfigurationElement; |
| import org.eclipse.core.runtime.IExtensionPoint; |
| import org.eclipse.core.runtime.ISafeRunnable; |
| import org.eclipse.core.runtime.IStatus; |
| import org.eclipse.core.runtime.Platform; |
| import org.eclipse.core.runtime.Preferences; |
| import org.eclipse.core.runtime.Status; |
| import org.eclipse.debug.core.DebugEvent; |
| import org.eclipse.debug.core.DebugPlugin; |
| import org.eclipse.debug.core.IDebugEventSetListener; |
| import org.eclipse.debug.core.IExpressionListener; |
| import org.eclipse.debug.core.IExpressionManager; |
| import org.eclipse.debug.core.IExpressionsListener; |
| import org.eclipse.debug.core.model.IExpression; |
| import org.eclipse.debug.core.model.IWatchExpression; |
| import org.eclipse.debug.core.model.IWatchExpressionDelegate; |
| import org.w3c.dom.Document; |
| import org.w3c.dom.Element; |
| import org.w3c.dom.Node; |
| import org.w3c.dom.NodeList; |
| |
| /** |
| * The expression manager manages all registered expressions |
| * for the debug plugin. It is instantiated by the debug plugin |
| * at startup. |
| * |
| * @see IExpressionManager |
| */ |
| public class ExpressionManager implements IExpressionManager, IDebugEventSetListener { |
| |
| /** |
| * Collection of registered expressions. |
| */ |
| private Vector fExpressions = null; |
| |
| /** |
| * List of expression listeners |
| */ |
| private ListenerList fListeners = null; |
| |
| /** |
| * List of (multi) expressions listeners |
| */ |
| private ListenerList fExpressionsListeners = null; |
| |
| /** |
| * Mapping of debug model identifiers (String) to |
| * expression delegate extensions (IConfigurationElement) |
| */ |
| private Map fWatchExpressionDelegates= new HashMap(); |
| |
| // Constants for add/remove/change notification |
| private static final int ADDED = 1; |
| private static final int CHANGED = 2; |
| private static final int REMOVED = 3; |
| |
| // Preference for persisted watch expressions |
| private static final String PREF_WATCH_EXPRESSIONS= "prefWatchExpressions"; //$NON-NLS-1$ |
| // Persisted watch expression XML tags |
| private static final String WATCH_EXPRESSIONS_TAG= "watchExpressions"; //$NON-NLS-1$ |
| private static final String EXPRESSION_TAG= "expression"; //$NON-NLS-1$ |
| private static final String TEXT_TAG= "text"; //$NON-NLS-1$ |
| private static final String ENABLED_TAG= "enabled"; //$NON-NLS-1$ |
| // XML values |
| private static final String TRUE_VALUE= "true"; //$NON-NLS-1$ |
| private static final String FALSE_VALUE= "false"; //$NON-NLS-1$ |
| |
| public ExpressionManager() { |
| loadPersistedExpressions(); |
| loadWatchExpressionDelegates(); |
| } |
| |
| /** |
| * Loads the mapping of debug models to watch expression delegates |
| * from the org.eclipse.debug.core.watchExpressionDelegates |
| * extension point. |
| */ |
| private void loadWatchExpressionDelegates() { |
| IExtensionPoint extensionPoint = Platform.getPluginRegistry().getExtensionPoint("org.eclipse.debug.core.watchExpressionDelegates"); //$NON-NLS-1$ |
| IConfigurationElement[] configurationElements = extensionPoint.getConfigurationElements(); |
| for (int i = 0; i < configurationElements.length; i++) { |
| IConfigurationElement element = configurationElements[i]; |
| if (element.getName().equals("watchExpressionDelegate")) { //$NON-NLS-1$ |
| String debugModel = element.getAttribute("debugModel"); //$NON-NLS-1$ |
| if (debugModel == null || debugModel.length() == 0) { |
| continue; |
| } |
| fWatchExpressionDelegates.put(debugModel, element); |
| } |
| } |
| } |
| |
| /** |
| * @see IExpressionManager#newWatchExpressionDelegate(String) |
| */ |
| public IWatchExpressionDelegate newWatchExpressionDelegate(String debugModel) { |
| try { |
| IConfigurationElement element= (IConfigurationElement) fWatchExpressionDelegates.get(debugModel); |
| return (IWatchExpressionDelegate) element.createExecutableExtension("delegateClass"); //$NON-NLS-1$ |
| } catch (CoreException e) { |
| DebugPlugin.log(e); |
| return null; |
| } |
| } |
| |
| /** |
| * Loads any persisted watch expresions from the preferences. |
| * NOTE: It's important that no setter methods are called on |
| * the watchpoints which will fire change events as this |
| * will cause an infinite loop (see Bug 27281). |
| */ |
| private void loadPersistedExpressions() { |
| String expressionsString= DebugPlugin.getDefault().getPluginPreferences().getString(PREF_WATCH_EXPRESSIONS); |
| if (expressionsString.length() == 0) { |
| return; |
| } |
| Element root= null; |
| try { |
| ByteArrayInputStream stream= new ByteArrayInputStream(expressionsString.getBytes("UTF-8")); //$NON-NLS-1$ |
| DocumentBuilder parser = DocumentBuilderFactory.newInstance().newDocumentBuilder(); |
| root = parser.parse(stream).getDocumentElement(); |
| } catch (Throwable throwable) { |
| DebugPlugin.logMessage("An exception occurred while loading watch expressions.", throwable); //$NON-NLS-1$ |
| return; |
| } |
| if (!root.getNodeName().equals(WATCH_EXPRESSIONS_TAG)) { |
| DebugPlugin.logMessage("Invalid format encountered while loading watch expressions.", null); //$NON-NLS-1$ |
| return; |
| } |
| NodeList list= root.getChildNodes(); |
| boolean expressionsAdded= false; |
| for (int i= 0, numItems= list.getLength(); i < numItems; i++) { |
| Node node= list.item(i); |
| if (node.getNodeType() == Node.ELEMENT_NODE) { |
| Element element= (Element) node; |
| if (!element.getNodeName().equals(EXPRESSION_TAG)) { |
| DebugPlugin.logMessage(MessageFormat.format("Invalid XML element encountered while loading watch expressions: {0}", new String[] {node.getNodeName()}), null); //$NON-NLS-1$ |
| continue; |
| } |
| String expressionText= element.getAttribute(TEXT_TAG); |
| if (expressionText.length() > 0) { |
| boolean enabled= TRUE_VALUE.equals(element.getAttribute(ENABLED_TAG)); |
| IWatchExpression expression= newWatchExpression(expressionText, enabled); |
| if (fExpressions == null) { |
| fExpressions= new Vector(list.getLength()); |
| } |
| fExpressions.add(expression); |
| expressionsAdded= true; |
| } else { |
| DebugPlugin.logMessage("Invalid expression entry encountered while loading watch expressions. Expression text is empty.", null); //$NON-NLS-1$ |
| } |
| } |
| } |
| if (expressionsAdded) { |
| DebugPlugin.getDefault().addDebugEventListener(this); |
| } |
| } |
| |
| /** |
| * Creates a new watch expression with the given expression |
| * and the given enablement; |
| * |
| * @param expressionText the text of the expression to be evaluated |
| * @param enabled whether or not the new expression should be enabled |
| * @return the new watch expression |
| */ |
| private IWatchExpression newWatchExpression(String expressionText, boolean enabled) { |
| return new WatchExpression(expressionText, enabled); |
| } |
| |
| /** |
| * @see IExpressionManager#newWatchExpression(String) |
| */ |
| public IWatchExpression newWatchExpression(String expressionText) { |
| return new WatchExpression(expressionText); |
| } |
| |
| /** |
| * Persists this manager's watch expressions as XML in the |
| * preference store. |
| */ |
| public void storeWatchExpressions() { |
| Preferences prefs= DebugPlugin.getDefault().getPluginPreferences(); |
| String expressionString= ""; //$NON-NLS-1$ |
| try { |
| expressionString= getWatchExpressionsAsXML(); |
| } catch (IOException e) { |
| DebugPlugin.log(e); |
| } catch (ParserConfigurationException e) { |
| DebugPlugin.log(e); |
| } catch (TransformerException e) { |
| DebugPlugin.log(e); |
| } |
| prefs.setValue(PREF_WATCH_EXPRESSIONS, expressionString); |
| DebugPlugin.getDefault().savePluginPreferences(); |
| } |
| |
| /** |
| * Returns this manager's watch expressions as XML. |
| * @return this manager's watch expressions as XML |
| * @throws IOException if an exception occurs while creating |
| * the XML document. |
| * @throws ParserConfigurationException if an exception occurs while creating |
| * the XML document. |
| * @throws TransformerException if an exception occurs while creating |
| * the XML document. |
| */ |
| private String getWatchExpressionsAsXML() throws IOException, ParserConfigurationException, TransformerException { |
| IExpression[] expressions= getExpressions(); |
| Document document= LaunchManager.getDocument(); |
| Element rootElement= document.createElement(WATCH_EXPRESSIONS_TAG); |
| document.appendChild(rootElement); |
| for (int i = 0; i < expressions.length; i++) { |
| IExpression expression= expressions[i]; |
| if (expression instanceof IWatchExpression) { |
| Element element= document.createElement(EXPRESSION_TAG); |
| element.setAttribute(TEXT_TAG, expression.getExpressionText()); |
| element.setAttribute(ENABLED_TAG, ((IWatchExpression) expression).isEnabled() ? TRUE_VALUE : FALSE_VALUE); |
| rootElement.appendChild(element); |
| } |
| } |
| return LaunchManager.serializeDocument(document); |
| } |
| |
| /** |
| * @see IExpressionManager#addExpression(IExpression) |
| */ |
| public void addExpression(IExpression expression) { |
| addExpressions(new IExpression[]{expression}); |
| } |
| |
| /** |
| * @see IExpressionManager#addExpressions(IExpression[]) |
| */ |
| public void addExpressions(IExpression[] expressions) { |
| if (fExpressions == null) { |
| fExpressions = new Vector(expressions.length); |
| } |
| boolean addedWatchExpression= false; |
| boolean wasEmpty = fExpressions.isEmpty(); |
| List added = new ArrayList(expressions.length); |
| for (int i = 0; i < expressions.length; i++) { |
| IExpression expression = expressions[i]; |
| if (fExpressions.indexOf(expression) == -1) { |
| added.add(expression); |
| fExpressions.add(expression); |
| if (expression instanceof IWatchExpression) { |
| addedWatchExpression= true; |
| } |
| } |
| } |
| if (wasEmpty) { |
| DebugPlugin.getDefault().addDebugEventListener(this); |
| } |
| if (!added.isEmpty()) { |
| fireUpdate((IExpression[])added.toArray(new IExpression[added.size()]), ADDED); |
| } |
| if (addedWatchExpression) { |
| storeWatchExpressions(); |
| } |
| } |
| |
| /** |
| * @see IExpressionManager#getExpressions() |
| */ |
| public IExpression[] getExpressions() { |
| if (fExpressions == null) { |
| return new IExpression[0]; |
| } |
| IExpression[] temp= new IExpression[fExpressions.size()]; |
| fExpressions.copyInto(temp); |
| return temp; |
| } |
| |
| /** |
| * @see IExpressionManager#getExpressions(String) |
| */ |
| public IExpression[] getExpressions(String modelIdentifier) { |
| if (fExpressions == null) { |
| return new IExpression[0]; |
| } |
| ArrayList temp= new ArrayList(fExpressions.size()); |
| Iterator iter= fExpressions.iterator(); |
| while (iter.hasNext()) { |
| IExpression expression= (IExpression) iter.next(); |
| String id= expression.getModelIdentifier(); |
| if (id != null && id.equals(modelIdentifier)) { |
| temp.add(expression); |
| } |
| } |
| return (IExpression[]) temp.toArray(new IExpression[temp.size()]); |
| } |
| |
| /** |
| * @see IExpressionManager#removeExpression(IExpression) |
| */ |
| public void removeExpression(IExpression expression) { |
| removeExpressions(new IExpression[] {expression}); |
| } |
| |
| /** |
| * @see IExpressionManager#removeExpressions(IExpression[]) |
| */ |
| public void removeExpressions(IExpression[] expressions) { |
| if (fExpressions == null) { |
| return; |
| } |
| List removed = new ArrayList(expressions.length); |
| for (int i = 0; i < expressions.length; i++) { |
| IExpression expression = expressions[i]; |
| if (fExpressions.remove(expression)) { |
| removed.add(expression); |
| expression.dispose(); |
| } |
| } |
| if (fExpressions.isEmpty()) { |
| DebugPlugin.getDefault().removeDebugEventListener(this); |
| } |
| if (!removed.isEmpty()) { |
| fireUpdate((IExpression[])removed.toArray(new IExpression[removed.size()]), REMOVED); |
| storeWatchExpressions(); |
| } |
| } |
| |
| /** |
| * @see IExpressionManager#addExpressionListener(IExpressionListener) |
| */ |
| public void addExpressionListener(IExpressionListener listener) { |
| if (fListeners == null) { |
| fListeners = new ListenerList(2); |
| } |
| fListeners.add(listener); |
| } |
| |
| /** |
| * @see IExpressionManager#removeExpressionListener(IExpressionListener) |
| */ |
| public void removeExpressionListener(IExpressionListener listener) { |
| if (fListeners == null) { |
| return; |
| } |
| fListeners.remove(listener); |
| } |
| |
| /** |
| * @see IDebugEventSetListener#handleDebugEvent(DebugEvent) |
| */ |
| public void handleDebugEvents(DebugEvent[] events) { |
| for (int i = 0; i < events.length; i++) { |
| List changed = null; |
| DebugEvent event = events[i]; |
| if (event.getSource() instanceof IExpression) { |
| switch (event.getKind()) { |
| case DebugEvent.CHANGE: |
| if (changed == null) { |
| changed = new ArrayList(1); |
| } |
| changed.add(event.getSource()); |
| break; |
| default: |
| break; |
| } |
| } |
| if (changed != null) { |
| IExpression[] array = (IExpression[])changed.toArray(new IExpression[changed.size()]); |
| fireUpdate(array, CHANGED); |
| } |
| } |
| } |
| |
| /** |
| * The given watch expression has changed. Update the persisted |
| * expressions to store this change. |
| * |
| * @param expression the changed expression |
| */ |
| protected void watchExpressionChanged(IWatchExpression expression) { |
| if (fExpressions != null && fExpressions.contains(expression)) { |
| storeWatchExpressions(); |
| } |
| } |
| |
| /** |
| * Notifies listeners of the adds/removes/changes |
| * |
| * @param breakpoints associated breakpoints |
| * @param deltas or <code>null</code> |
| * @param update type of change |
| */ |
| private void fireUpdate(IExpression[] expressions, int update) { |
| // single listeners |
| getExpressionNotifier().notify(expressions, update); |
| |
| // multi listeners |
| getExpressionsNotifier().notify(expressions, update); |
| } |
| |
| /** |
| * @see IExpressionManager#hasExpressions() |
| */ |
| public boolean hasExpressions() { |
| return fExpressions != null; |
| } |
| |
| /** |
| * @see org.eclipse.debug.core.IExpressionManager#addExpressionListener(org.eclipse.debug.core.IExpressionsListener) |
| */ |
| public void addExpressionListener(IExpressionsListener listener) { |
| if (fExpressionsListeners == null) { |
| fExpressionsListeners = new ListenerList(2); |
| } |
| fExpressionsListeners.add(listener); |
| } |
| |
| /** |
| * @see org.eclipse.debug.core.IExpressionManager#removeExpressionListener(org.eclipse.debug.core.IExpressionsListener) |
| */ |
| public void removeExpressionListener(IExpressionsListener listener) { |
| if (fExpressionsListeners == null) { |
| return; |
| } |
| fExpressionsListeners.remove(listener); |
| } |
| |
| private ExpressionNotifier getExpressionNotifier() { |
| return new ExpressionNotifier(); |
| } |
| |
| /** |
| * Notifies an expression listener (single expression) in a safe runnable to |
| * handle exceptions. |
| */ |
| class ExpressionNotifier implements ISafeRunnable { |
| |
| private IExpressionListener fListener; |
| private int fType; |
| private IExpression fExpression; |
| |
| /** |
| * @see org.eclipse.core.runtime.ISafeRunnable#handleException(java.lang.Throwable) |
| */ |
| public void handleException(Throwable exception) { |
| IStatus status = new Status(IStatus.ERROR, DebugPlugin.getUniqueIdentifier(), DebugPlugin.INTERNAL_ERROR, DebugCoreMessages.getString("ExpressionManager.An_exception_occurred_during_expression_change_notification._1"), exception); //$NON-NLS-1$ |
| DebugPlugin.log(status); |
| } |
| |
| /** |
| * @see org.eclipse.core.runtime.ISafeRunnable#run() |
| */ |
| public void run() throws Exception { |
| switch (fType) { |
| case ADDED: |
| fListener.expressionAdded(fExpression); |
| break; |
| case REMOVED: |
| fListener.expressionRemoved(fExpression); |
| break; |
| case CHANGED: |
| fListener.expressionChanged(fExpression); |
| break; |
| } |
| } |
| |
| /** |
| * Notifies listeners of the add/change/remove |
| * |
| * @param expression the expression that has changed |
| * @param update the type of change |
| */ |
| public void notify(IExpression[] expressions, int update) { |
| if (fListeners != null) { |
| fType = update; |
| Object[] copiedListeners= fListeners.getListeners(); |
| for (int i= 0; i < copiedListeners.length; i++) { |
| fListener = (IExpressionListener)copiedListeners[i]; |
| for (int j = 0; j < expressions.length; j++) { |
| fExpression = expressions[j]; |
| Platform.run(this); |
| } |
| } |
| } |
| fListener = null; |
| fExpression = null; |
| } |
| } |
| |
| private ExpressionsNotifier getExpressionsNotifier() { |
| return new ExpressionsNotifier(); |
| } |
| |
| /** |
| * Notifies an expression listener (multiple expressions) in a safe runnable |
| * to handle exceptions. |
| */ |
| class ExpressionsNotifier implements ISafeRunnable { |
| |
| private IExpressionsListener fListener; |
| private int fType; |
| private IExpression[] fNotifierExpressions; |
| |
| /** |
| * @see org.eclipse.core.runtime.ISafeRunnable#handleException(java.lang.Throwable) |
| */ |
| public void handleException(Throwable exception) { |
| IStatus status = new Status(IStatus.ERROR, DebugPlugin.getUniqueIdentifier(), DebugPlugin.INTERNAL_ERROR, DebugCoreMessages.getString("ExpressionManager.An_exception_occurred_during_expression_change_notification._1"), exception); //$NON-NLS-1$ |
| DebugPlugin.log(status); |
| } |
| |
| /** |
| * @see org.eclipse.core.runtime.ISafeRunnable#run() |
| */ |
| public void run() throws Exception { |
| switch (fType) { |
| case ADDED: |
| fListener.expressionsAdded(fNotifierExpressions); |
| break; |
| case REMOVED: |
| fListener.expressionsRemoved(fNotifierExpressions); |
| break; |
| case CHANGED: |
| fListener.expressionsChanged(fNotifierExpressions); |
| break; |
| } |
| } |
| |
| /** |
| * Notifies listeners of the adds/changes/removes |
| * |
| * @param expressions the expressions that changed |
| * @param update the type of change |
| */ |
| public void notify(IExpression[] expressions, int update) { |
| if (fExpressionsListeners != null) { |
| fNotifierExpressions = expressions; |
| fType = update; |
| Object[] copiedListeners = fExpressionsListeners.getListeners(); |
| for (int i= 0; i < copiedListeners.length; i++) { |
| fListener = (IExpressionsListener)copiedListeners[i]; |
| Platform.run(this); |
| } |
| } |
| fNotifierExpressions = null; |
| fListener = null; |
| } |
| } |
| } |