core/plugins/org.eclipse.dltk.debug.ui/src/org/eclipse/dltk/internal/debug/ui/ScriptDebugOptionsManager.java

/*******************************************************************************
 * Copyright (c) 2005, 2018 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.List;
import java.util.StringTokenizer;

import org.eclipse.core.resources.IMarkerDelta;
import org.eclipse.core.resources.IWorkspaceRunnable;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.debug.core.DebugEvent;
import org.eclipse.debug.core.DebugPlugin;
import org.eclipse.debug.core.IBreakpointsListener;
import org.eclipse.debug.core.IDebugEventSetListener;
import org.eclipse.debug.core.ILaunch;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.debug.core.ILaunchListener;
import org.eclipse.debug.core.model.IBreakpoint;
import org.eclipse.debug.ui.DebugUITools;
import org.eclipse.dltk.core.DLTKCore;
import org.eclipse.dltk.core.IScriptProject;
import org.eclipse.dltk.dbgp.breakpoints.IDbgpBreakpoint;
import org.eclipse.dltk.debug.core.model.IScriptBreakpoint;
import org.eclipse.dltk.debug.core.model.IScriptBreakpointListener;
import org.eclipse.dltk.debug.core.model.IScriptDebugTarget;
import org.eclipse.dltk.debug.core.model.IScriptMethodEntryBreakpoint;
import org.eclipse.dltk.debug.core.model.IScriptSpawnpoint;
import org.eclipse.dltk.debug.core.model.IScriptThread;
import org.eclipse.dltk.debug.ui.DLTKDebugUIPlugin;
import org.eclipse.dltk.debug.ui.preferences.StepFilterManager;
import org.eclipse.dltk.launching.AbstractScriptLaunchConfigurationDelegate;
import org.eclipse.dltk.ui.DLTKUIPlugin;
import org.eclipse.jface.util.IPropertyChangeListener;
import org.eclipse.jface.viewers.ILabelProvider;

public class ScriptDebugOptionsManager
		implements IDebugEventSetListener, IPropertyChangeListener,
		IScriptBreakpointListener, ILaunchListener, IBreakpointsListener {

	private static ScriptDebugOptionsManager instance;

	private static ILabelProvider fLabelProvider = DebugUITools
			.newDebugModelPresentation();

	private static interface IBreakpointUpdater {
		void update(IScriptBreakpoint breakpoint) throws CoreException;
	}

	protected void updateBreakpoints(final IBreakpoint[] breakpoints,
			final IBreakpointUpdater updater) {
		IWorkspaceRunnable runnable = monitor -> {
			for (int i = 0; i < breakpoints.length; i++) {
				IBreakpoint breakpoint = breakpoints[i];
				if (breakpoint instanceof IScriptBreakpoint) {
					try {
						updater.update((IScriptBreakpoint) breakpoint);
					} catch (CoreException e) {
						DLTKDebugUIPlugin.log(e);
					}
				}
			}
		};

		try {
			ResourcesPlugin.getWorkspace().run(runnable, null);
		} catch (CoreException e) {
			DLTKUIPlugin.log(e);
		}
	}

	private void updateBreakpointMessages(final IBreakpoint[] breakpoints) {
		updateBreakpoints(breakpoints, breakpoint -> {
			final String message = fLabelProvider.getText(breakpoint);
			breakpoint.setMessage(message);
		});
	}

	protected void updateBreakpointHitCounts(final IBreakpoint[] breakpoints,
			final IScriptThread thread) {
		updateBreakpoints(breakpoints, breakpoint -> {

			IDbgpBreakpoint br = null;

			if (breakpoint instanceof IScriptMethodEntryBreakpoint) {
				IScriptMethodEntryBreakpoint entryBreakpoint = (IScriptMethodEntryBreakpoint) breakpoint;

				final String entryId = entryBreakpoint.getEntryBreakpointId();
				if (entryId != null) {
					br = thread.getDbgpBreakpoint(entryId);
				}

				final String exitId = entryBreakpoint.getExitBreakpointId();
				if (exitId != null) {
					br = thread.getDbgpBreakpoint(exitId);
				}
			} else if (breakpoint instanceof IScriptSpawnpoint) {
				// NOP
			} else {
				String id = breakpoint.getId(thread.getDbgpSession());
				if (id != null && id.length() != 0) {
					br = thread.getDbgpBreakpoint(id);
				}
			}
			if (br != null) {
				breakpoint.setHitCount(thread.getDbgpSession(),
						br.getHitCount());
			}
		});
	}

	protected void updateBreakpoinInfoToDefault(IBreakpoint[] breakpoints) {
		updateBreakpoints(breakpoints,
				breakpoint -> breakpoint.clearSessionInfo());
	}

	@Override
	public void handleDebugEvents(DebugEvent[] events) {
		for (int i = 0; i < events.length; ++i) {
			DebugEvent event = events[i];
			final int kind = event.getKind();
			final Object source = event.getSource();

			if (kind == DebugEvent.SUSPEND) {
				if (source instanceof IScriptThread) {
					final IScriptThread thread = (IScriptThread) source;
					final IBreakpoint[] breakpoints = thread.getBreakpoints();

					updateBreakpointHitCounts(breakpoints, thread);
					updateBreakpointMessages(breakpoints);
				}
			} else if (kind == DebugEvent.TERMINATE) {
				if (source instanceof IScriptDebugTarget) {
					final String debugModelId = ((IScriptDebugTarget) source)
							.getModelIdentifier();

					final IBreakpoint[] breakpoints = DebugPlugin.getDefault()
							.getBreakpointManager()
							.getBreakpoints(debugModelId);

					updateBreakpoinInfoToDefault(breakpoints);
					updateBreakpointMessages(breakpoints);
				}
			} else if (kind == DebugEvent.CREATE) {
				if (source instanceof IScriptDebugTarget) {
					try {
						final IScriptDebugTarget target = (IScriptDebugTarget) source;
						final ILaunchConfiguration configuration = target
								.getLaunch().getLaunchConfiguration();
						if (configuration != null) {
							final IScriptProject project = AbstractScriptLaunchConfigurationDelegate
									.getScriptProject(configuration);
							if (project != null) {
								final String[] activeFilters = StepFilterManager
										.getActiveFilters(project);
								target.setFilters(activeFilters);
							}
						}
						// target.setUseStepFilters(StepFilterManager
						// .isUseStepFilters(scriptProject));
					} catch (CoreException e) {
						if (DLTKCore.DEBUG) {
							e.printStackTrace();
						}
					}
				}
			}
		}
	}

	@Override
	public void launchAdded(ILaunch launch) {
		// TODO Auto-generated method stub
	}

	@Override
	public void launchChanged(ILaunch launch) {
		// TODO Auto-generated method stub
	}

	@Override
	public void launchRemoved(ILaunch launch) {
		// TODO Auto-generated method stub
	}

	@Override
	public void breakpointsAdded(IBreakpoint[] breakpoints) {
		List<IBreakpoint> list = new ArrayList<>();
		for (int i = 0; i < breakpoints.length; i++) {
			try {
				IBreakpoint breakpoint = breakpoints[i];
				if (breakpoint instanceof IScriptBreakpoint
						&& ((IScriptBreakpoint) breakpoint)
								.getMessage() == null) {
					list.add(breakpoint);
				}
			} catch (CoreException e) {
				DLTKDebugUIPlugin.log(e);
			}
		}

		if (!list.isEmpty()) {
			updateBreakpointMessages(
					list.toArray(new IBreakpoint[list.size()]));
		}
	}

	@Override
	public void breakpointsChanged(IBreakpoint[] breakpoints,
			IMarkerDelta[] deltas) {
		updateBreakpointMessages(breakpoints);
	}

	@Override
	public void breakpointsRemoved(IBreakpoint[] breakpoints,
			IMarkerDelta[] deltas) {
	}

	public static ScriptDebugOptionsManager getDefault() {
		if (instance == null) {
			instance = new ScriptDebugOptionsManager();
		}

		return instance;
	}

	public void startup() {
		// lazy initialization will occur on the first launch
		DebugPlugin debugPlugin = DebugPlugin.getDefault();
		debugPlugin.addDebugEventListener(this);
		debugPlugin.getLaunchManager().addLaunchListener(this);
		debugPlugin.getBreakpointManager().addBreakpointListener(this);

		ScriptEvaluationContextManager.startup();
	}

	public void shutdown() {
		DebugPlugin debugPlugin = DebugPlugin.getDefault();
		debugPlugin.removeDebugEventListener(this);
		debugPlugin.getLaunchManager().removeLaunchListener(this);
		debugPlugin.getBreakpointManager().removeBreakpointListener(this);
		if (!DLTKDebugUIPlugin.getDefault().isShuttingDown()) {
			// avert restoring the preference store at shutdown
			DLTKDebugUIPlugin.getDefault().getPreferenceStore()
					.removePropertyChangeListener(this);
		}
		// ScriptDebugModel.removeJavaBreakpointListener(this);
		System.getProperties().remove(
				DLTKDebugUIPlugin.getUniqueIdentifier() + ".debuggerActive"); //$NON-NLS-1$
	}

	@Override
	public void propertyChange(
			org.eclipse.jface.util.PropertyChangeEvent event) {
		// TODO:
	}

	public static String serializeList(String[] list) {
		if (list == null) {
			return ""; //$NON-NLS-1$
		}
		StringBuffer buffer = new StringBuffer();
		for (int i = 0; i < list.length; i++) {
			if (i > 0) {
				buffer.append(',');
			}
			buffer.append(list[i]);
		}
		return buffer.toString();
	}

	public static String[] parseList(String listString) {
		List<String> list = new ArrayList<>(10);
		StringTokenizer tokenizer = new StringTokenizer(listString, ","); //$NON-NLS-1$
		while (tokenizer.hasMoreTokens()) {
			String token = tokenizer.nextToken();
			list.add(token);
		}
		return list.toArray(new String[list.size()]);
	}
}