ComponentLaunch.java

/*******************************************************************************
 * This file is protected by Copyright. 
 * Please refer to the COPYRIGHT file distributed with this source distribution.
 *
 * This file is part of REDHAWK IDE.
 *
 * 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 gov.redhawk.ide.debug.internal;

import org.eclipse.debug.core.DebugException;
import org.eclipse.debug.core.ILaunch;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.debug.core.Launch;
import org.eclipse.debug.core.model.IProcess;
import org.eclipse.debug.core.model.ISourceLocator;

import gov.redhawk.ide.debug.ScaDebugPlugin;
import gov.redhawk.ide.debug.variables.LaunchVariables;

/**
 * This class allows us to customize some aspects of our launches. Such as:
 * <ul>
 * <li>Setting a custom process label (the name shown in the console view)</li>
 * <li>Displaying information about the process exit code in the console after termination</li>
 * <li>Allows control over components contained within a component host</li>
 * </ul>
 */
public class ComponentLaunch extends Launch {

	private IProcess parent;
	private ILaunch parentLaunch;

	public ComponentLaunch(ILaunchConfiguration launchConfiguration, String mode, ISourceLocator locator) {
		super(launchConfiguration, mode, locator);
		setAttribute(ScaDebugPlugin.LAUNCH_ATTRIBUTE_REDHAWK_EXIT_STATUS, "true");
	}

	@Override
	public void addProcess(IProcess process) {
		super.addProcess(process);
		setProcessLabel(process);
	}

	@Override
	public boolean canTerminate() {
		// Contained components defer to ComponentHost state
		if (parentLaunch != null) {
			return parentLaunch.canTerminate();
		}

		return super.canTerminate();
	}

	@Override
	public boolean isTerminated() {
		// Contained components defer to ComponentHost state
		if (parentLaunch != null) {
			return parentLaunch.isTerminated();
		}

		return super.isTerminated();
	}

	@Override
	public void terminate() throws DebugException {
		// If a contained component is terminated, terminate the ComponentHost instead.
		if (parentLaunch != null) {
			parentLaunch.terminate();
			return;
		}
		super.terminate();
	}

	/**
	 * Sends terminate event notification to allow component to be cleaned up in the ScaModel
	 */
	protected void terminateContainedComponent() {
		fireTerminate();
	}

	private void setProcessLabel(IProcess process) {
		// Ideally, the console should be labeled with the usage name of the component/device
		String label = getAttribute(LaunchVariables.DEVICE_LABEL);
		if (label == null) {
			label = getAttribute(LaunchVariables.NAME_BINDING);
		}
		if (label == null) {
			label = getLaunchConfiguration().getName();
		}
		process.setAttribute(IProcess.ATTR_PROCESS_LABEL, label + getParentName() + process.getLabel());
	}

	private String getParentName() {
		if (parent == null) {
			return " [Sandbox Component] ";
		}
		return " [" + parent.getLabel() + "] ";
	}

	public void setParent(IProcess parentProcess) {
		parent = parentProcess;
		for (IProcess process : this.getProcesses()) {
			setProcessLabel(process);
		}
	}

	/**
	 * Associates contained components with their component host. </br>
	 * Setting this implicitly marks this component as a shared-address component.
	 * @param parentLaunch
	 */
	public void setParent(ILaunch parentLaunch) {
		this.parentLaunch = parentLaunch;
		((ComponentHostLaunch) this.parentLaunch).getChildLaunchList().add(this);
	}
}