ArcLaunchDelegate.java

/*******************************************************************************
 * 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:
 *     Synopsys, Inc. - ARC GNU Toolchain support
 *******************************************************************************/

package com.arc.embeddedcdt.dsf;

import org.eclipse.cdt.dsf.debug.service.IDsfDebugServicesFactory;
import org.eclipse.cdt.dsf.gdb.launching.GdbLaunch;
import org.eclipse.cdt.dsf.gdb.launching.GdbLaunchDelegate;
import org.eclipse.cdt.dsf.gdb.launching.LaunchMessages;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.debug.core.DebugPlugin;
import org.eclipse.debug.core.ILaunch;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.debug.core.ILaunchManager;
import org.eclipse.debug.core.model.ISourceLocator;

import com.arc.embeddedcdt.dsf.utils.DebugUtils;
import com.arc.embeddedcdt.launch.LaunchTerminator;
import com.arc.embeddedcdt.common.LaunchFileFormatVersionChecker;

/**
 * Launch delegate for DSF/GDB debugger.
 */
public class ArcLaunchDelegate extends GdbLaunchDelegate {

    @Override
    protected IDsfDebugServicesFactory newServiceFactory(ILaunchConfiguration config,
            String version) {
        return new ArcDebugServicesFactory(version);
    }

    /*
     * This method is called first when starting a debug session. If there already is a debug
     * session running with the same launch configuration, do not start another one.
     */
    @Override
    protected GdbLaunch createGdbLaunch(ILaunchConfiguration configuration, String mode,
            ISourceLocator locator) throws CoreException {
        DebugUtils.checkLaunchConfigurationStarted(configuration);
        /*
         * Add debug event listener for the case when GDB process has terminated. GDB back-end
         * monitors the GDB process and in case it exited the debug session will be terminated.
         * 
         * However, GDB server back-end does not have a way to track if process is terminated or
         * not, so we need to listen to the process termination events and stop the debug session
         * manually.
         */
        DebugPlugin.getDefault().addDebugEventListener(new LaunchTerminator());
        return super.createGdbLaunch(configuration, mode, locator);
    }

    // We need to launch debugger not only if the mode is DEBUG_MODE, but also in RUN_MODE, so
    // overriding the method.
    @Override
    public void launch(ILaunchConfiguration config, String mode, ILaunch launch,
            IProgressMonitor monitor) throws CoreException {

        LaunchFileFormatVersionChecker.getInstance().check(config);
        if (monitor == null) {
            monitor = new NullProgressMonitor();
        }
        if (mode.equals(ILaunchManager.DEBUG_MODE) || mode.equals(ILaunchManager.RUN_MODE)) {
            launchDebugger(config, launch, monitor);
        }
    }

    // Just the copy of super.launchDebugger() method, which we can't use since it's private.
    private void launchDebugger(ILaunchConfiguration config, ILaunch launch,
            IProgressMonitor monitor) throws CoreException {

        monitor.beginTask(LaunchMessages.getString("GdbLaunchDelegate.0"), 10);
        if (monitor.isCanceled()) {
            cleanupLaunch();
            return;
        }
        try {
            launchDebugSession(config, launch, monitor);
        } finally {
            monitor.done();
        }
    }

}