Bug 285907, create a new shared abstract launch delegate.

dsf-gdb/org.eclipse.cdt.dsf.gdb.ui/META-INF/MANIFEST.MF

@@ -22,7 +22,8 @@ Require-Bundle: org.eclipse.ui,
  org.eclipse.ui.console,
  org.eclipse.jface.text;bundle-version="3.4.0",
  org.eclipse.ui.editors;bundle-version="3.4.0",
- org.eclipse.core.filesystem;bundle-version="1.2.0"
+ org.eclipse.core.filesystem;bundle-version="1.2.0",
+ org.eclipse.cdt.launch;bundle-version="6.1.0"
 Bundle-ActivationPolicy: lazy
 Bundle-RequiredExecutionEnvironment: J2SE-1.5
 Export-Package: org.eclipse.cdt.dsf.gdb.internal.ui.actions;x-internal:=true,

dsf-gdb/org.eclipse.cdt.dsf.gdb.ui/plugin.xml

@@ -9,7 +9,7 @@
             id="org.eclipse.cdt.dsf.gdb.launch.localApplicationLaunch.mainTab"
             group="org.eclipse.cdt.launch.applicationLaunchTabGroup"
             name="%launchTab.main.name"
-            class="org.eclipse.cdt.dsf.gdb.internal.ui.launching.CMainTab">
+            class="org.eclipse.cdt.launch.ui.CMainTab">
         <associatedDelegate delegate="org.eclipse.cdt.dsf.gdb.launch.localCLaunch"/>
       </tab>
       <tab id="org.eclipse.cdt.dsf.gdb.launch.localApplicationLaunch.argumentsTab"

dsf-gdb/org.eclipse.cdt.dsf.gdb/META-INF/MANIFEST.MF

@@ -12,7 +12,8 @@ Require-Bundle: org.eclipse.core.runtime,
  org.eclipse.cdt.core,
  org.eclipse.cdt.debug.core,
  org.eclipse.core.variables,
- org.eclipse.jface
+ org.eclipse.jface,
+ org.eclipse.cdt.launch;bundle-version="6.1.0"
 Bundle-ActivationPolicy: lazy
 Bundle-RequiredExecutionEnvironment: J2SE-1.5
 Export-Package: org.eclipse.cdt.dsf.gdb,

dsf-gdb/org.eclipse.cdt.dsf.gdb/src/org/eclipse/cdt/dsf/gdb/launching/GdbLaunchDelegate.java

@@ -13,11 +13,8 @@
  *******************************************************************************/
 package org.eclipse.cdt.dsf.gdb.launching; 
 
-import java.util.ArrayList;
-import java.util.HashSet;
 import java.util.concurrent.ExecutionException;
 
-import org.eclipse.cdt.core.model.ICModelMarker;
 import org.eclipse.cdt.core.model.ICProject;
 import org.eclipse.cdt.dsf.concurrent.DataRequestMonitor;
 import org.eclipse.cdt.dsf.concurrent.DsfExecutor;
@@ -33,10 +30,7 @@ import org.eclipse.cdt.dsf.gdb.service.GdbDebugServicesFactoryNS;
 import org.eclipse.cdt.dsf.gdb.service.SessionType;
 import org.eclipse.cdt.dsf.gdb.service.macos.MacOSGdbDebugServicesFactory;
 import org.eclipse.cdt.dsf.service.DsfSession;
-import org.eclipse.core.resources.IMarker;
+import org.eclipse.cdt.launch.AbstractCLaunchDelegate2;
-import org.eclipse.core.resources.IProject;
-import org.eclipse.core.resources.IResource;
-import org.eclipse.core.resources.ResourcesPlugin;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.IProgressMonitor;
@@ -49,17 +43,14 @@ import org.eclipse.debug.core.DebugException;
 import org.eclipse.debug.core.ILaunch;
 import org.eclipse.debug.core.ILaunchConfiguration;
 import org.eclipse.debug.core.ILaunchManager;
-import org.eclipse.debug.core.model.ILaunchConfigurationDelegate2;
 import org.eclipse.debug.core.model.ISourceLocator;
-import org.eclipse.debug.core.model.LaunchConfigurationDelegate;
  
 /**
  * The shared launch configuration delegate for the DSF/GDB debugger.
  * This delegate supports all configuration types (local, remote, attach, etc)
  */
 @ThreadSafe
-public class GdbLaunchDelegate extends LaunchConfigurationDelegate 
+public class GdbLaunchDelegate extends AbstractCLaunchDelegate2
-    implements ILaunchConfigurationDelegate2
 {
     public final static String GDB_DEBUG_MODEL_ID = "org.eclipse.cdt.dsf.gdb"; //$NON-NLS-1$
 
@@ -288,100 +279,6 @@ public class GdbLaunchDelegate extends LaunchConfigurationDelegate
         }
         return locator;
     }
-    
-	/**
-	 * Recursively creates a set of projects referenced by the current project
-	 * 
-	 * @param proj
-	 *            The current project
-	 * @param referencedProjSet
-	 *            A set of referenced projects
-	 * @throws CoreException
-	 *             if an error occurs while getting referenced projects from the
-	 *             current project
-	 */
-	private HashSet<IProject> getReferencedProjectSet(IProject proj, HashSet<IProject> referencedProjSet) throws CoreException {
-		// The top project is a reference too and it must be added at the top to avoid cycles
-		referencedProjSet.add(proj);
-
-		IProject[] projects = proj.getReferencedProjects();
-		for (IProject refProject : projects) {
-			if (refProject.exists() && !referencedProjSet.contains(refProject)) {
-				getReferencedProjectSet(refProject, referencedProjSet);
-			}
-		}
-		return referencedProjSet;
-	}
-	
-	/**
-	 * Returns the order list of projects to build before launching.
-	 *  Used in buildForLaunch() 
-	 */
-	@Override
-	protected IProject[] getBuildOrder(ILaunchConfiguration configuration, String mode) throws CoreException {
-		IProject[] orderedProjects = null;
-		ArrayList<IProject> orderedProjList = null;
-
-		ICProject cProject = LaunchUtils.verifyCProject(configuration);
-		if (cProject != null) {
-			HashSet<IProject> projectSet = getReferencedProjectSet(cProject.getProject(), new HashSet<IProject>());
-
-			String[] orderedNames = ResourcesPlugin.getWorkspace().getDescription().getBuildOrder();
-			if (orderedNames != null) {
-				//Projects may not be in the build order but should still be built if selected
-				ArrayList<IProject> unorderedProjects = new ArrayList<IProject>(projectSet.size());
-				unorderedProjects.addAll(projectSet);
-				orderedProjList = new ArrayList<IProject>(projectSet.size());
-
-				for (String projectName : orderedNames) {
-					for (IProject proj : unorderedProjects) {
-						if (proj.getName().equals(projectName)) {
-							orderedProjList.add(proj);
-							unorderedProjects.remove(proj);
-							break;
-						}
-					}
-				}
-
-				// Add any remaining projects to the end of the list
-				orderedProjList.addAll(unorderedProjects);
-
-				orderedProjects = orderedProjList.toArray(new IProject[orderedProjList.size()]);
-			} else {
-				// Try the project prerequisite order then
-				IProject[] projects = projectSet.toArray(new IProject[projectSet.size()]);
-				orderedProjects = ResourcesPlugin.getWorkspace().computeProjectOrder(projects).projects;
-			}
-		}
-		return orderedProjects;
-	}
-
-	/* Used in finalLaunchCheck() */
-	@Override
-	protected IProject[] getProjectsForProblemSearch(ILaunchConfiguration configuration, String mode) throws CoreException {
-		return getBuildOrder(configuration, mode);
-	}
-
-	/**
-	 * Searches for compile errors in the specified project
-	 * Used in finalLaunchCheck() 
-	 * @param proj
-	 *            The project to search
-	 * @return true if compile errors exist, otherwise false
-	 */
-	@Override
-	protected boolean existsProblems(IProject proj) throws CoreException {
-		IMarker[] markers = proj.findMarkers(ICModelMarker.C_MODEL_PROBLEM_MARKER, true, IResource.DEPTH_INFINITE);
-		if (markers.length > 0) {
-			for (IMarker marker : markers) {
-				Integer severity = (Integer)marker.getAttribute(IMarker.SEVERITY);
-				if (severity != null) {
-					return severity.intValue() >= IMarker.SEVERITY_ERROR;
-				}
-			}
-		}
-		return false;
-	}
 	
 	private boolean isNonStopSupported(String version) {
 		if (version.contains(LaunchUtils.MACOS_GDB_MARKER)) {
@@ -413,4 +310,9 @@ public class GdbLaunchDelegate extends LaunchConfigurationDelegate
 
 		return new GdbDebugServicesFactory(version);
 	}
+
+	@Override
+	protected String getPluginID() {
+		return GdbPlugin.PLUGIN_ID;
+	}
 }

dsf-gdb/org.eclipse.cdt.tests.dsf.gdb/META-INF/MANIFEST.MF

@@ -12,7 +12,8 @@ Require-Bundle: org.eclipse.core.runtime,
  org.junit4,
  org.eclipse.debug.core,
  org.eclipse.swt,
- org.eclipse.cdt.dsf.gdb
+ org.eclipse.cdt.dsf.gdb,
+ org.eclipse.cdt.launch;bundle-version="6.1.0"
 Bundle-ActivationPolicy: lazy
 Bundle-RequiredExecutionEnvironment: J2SE-1.5
 Bundle-ClassPath: .

launch/org.eclipse.cdt.launch/src/org/eclipse/cdt/launch/AbstractCLaunchDelegate2.java

@@ -0,0 +1,319 @@
+/*******************************************************************************
+ * Copyright (c) 2010 Nokia 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
+ *
+ * Contributors:
+ *     Ken Ryall (Nokia)
+ *******************************************************************************/
+package org.eclipse.cdt.launch;
+
+import java.util.ArrayList;
+import java.util.HashSet;
+
+import org.eclipse.cdt.core.model.ICModelMarker;
+import org.eclipse.cdt.core.model.ICProject;
+import org.eclipse.cdt.core.settings.model.ICConfigurationDescription;
+import org.eclipse.cdt.core.settings.model.ICProjectDescription;
+import org.eclipse.cdt.debug.core.CDebugUtils;
+import org.eclipse.cdt.debug.core.ICDTLaunchConfigurationConstants;
+import org.eclipse.cdt.launch.internal.ui.LaunchMessages;
+import org.eclipse.cdt.ui.newui.CDTPropertyManager;
+import org.eclipse.core.resources.IMarker;
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.resources.IResource;
+import org.eclipse.core.resources.IncrementalProjectBuilder;
+import org.eclipse.core.resources.ResourcesPlugin;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.MultiStatus;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.core.runtime.SubProgressMonitor;
+import org.eclipse.debug.core.ILaunch;
+import org.eclipse.debug.core.ILaunchConfiguration;
+import org.eclipse.debug.core.model.LaunchConfigurationDelegate;
+
+/**
+ * @author Ken Ryall
+ * @since 6.1
+ *
+ */
+public abstract class AbstractCLaunchDelegate2 extends LaunchConfigurationDelegate {
+
+	private boolean workspaceBuildBeforeLaunch;
+	private IProject project;
+	private String preLaunchBuildConfiguration;
+
+	/**
+	 * Recursively creates a set of projects referenced by the current project
+	 * 
+	 * @param proj
+	 *            The current project
+	 * @param referencedProjSet
+	 *            A set of referenced projects
+	 * @throws CoreException
+	 *             if an error occurs while getting referenced projects from the
+	 *             current project
+	 */
+	private HashSet<IProject> getReferencedProjectSet(IProject proj, HashSet<IProject> referencedProjSet) throws CoreException {
+		// The top project is a reference too and it must be added at the top to avoid cycles
+		referencedProjSet.add(proj);
+
+		IProject[] projects = proj.getReferencedProjects();
+		for (IProject refProject : projects) {
+			if (refProject.exists() && !referencedProjSet.contains(refProject)) {
+				getReferencedProjectSet(refProject, referencedProjSet);
+			}
+		}
+		return referencedProjSet;
+	}
+	
+	/**
+	 * Returns the order list of projects to build before launching.
+	 *  Used in buildForLaunch() 
+	 */
+	@Override
+	protected IProject[] getBuildOrder(ILaunchConfiguration configuration, String mode) throws CoreException {
+		IProject[] orderedProjects = null;
+		ArrayList<IProject> orderedProjList = null;
+
+		ICProject cProject = verifyCProject(configuration);
+		if (cProject != null) {
+			HashSet<IProject> projectSet = getReferencedProjectSet(cProject.getProject(), new HashSet<IProject>());
+
+			String[] orderedNames = ResourcesPlugin.getWorkspace().getDescription().getBuildOrder();
+			if (orderedNames != null) {
+				//Projects may not be in the build order but should still be built if selected
+				ArrayList<IProject> unorderedProjects = new ArrayList<IProject>(projectSet.size());
+				unorderedProjects.addAll(projectSet);
+				orderedProjList = new ArrayList<IProject>(projectSet.size());
+
+				for (String projectName : orderedNames) {
+					for (IProject proj : unorderedProjects) {
+						if (proj.getName().equals(projectName)) {
+							orderedProjList.add(proj);
+							unorderedProjects.remove(proj);
+							break;
+						}
+					}
+				}
+
+				// Add any remaining projects to the end of the list
+				orderedProjList.addAll(unorderedProjects);
+
+				orderedProjects = orderedProjList.toArray(new IProject[orderedProjList.size()]);
+			} else {
+				// Try the project prerequisite order then
+				IProject[] projects = projectSet.toArray(new IProject[projectSet.size()]);
+				orderedProjects = ResourcesPlugin.getWorkspace().computeProjectOrder(projects).projects;
+			}
+		}
+		return orderedProjects;
+	}
+
+	/* Used in finalLaunchCheck() */
+	@Override
+	protected IProject[] getProjectsForProblemSearch(ILaunchConfiguration configuration, String mode) throws CoreException {
+		return getBuildOrder(configuration, mode);
+	}
+
+	/**
+	 * Searches for compile errors in the specified project
+	 * Used in finalLaunchCheck() 
+	 * @param proj
+	 *            The project to search
+	 * @return true if compile errors exist, otherwise false
+	 */
+	@Override
+	protected boolean existsProblems(IProject proj) throws CoreException {
+		IMarker[] markers = proj.findMarkers(ICModelMarker.C_MODEL_PROBLEM_MARKER, true, IResource.DEPTH_INFINITE);
+		if (markers.length > 0) {
+			for (IMarker marker : markers) {
+				Integer severity = (Integer)marker.getAttribute(IMarker.SEVERITY);
+				if (severity != null) {
+					return severity.intValue() >= IMarker.SEVERITY_ERROR;
+				}
+			}
+		}
+		return false;
+	}
+
+	/**
+	 * Throws a core exception with an error status object built from the given
+	 * message, lower level exception, and error code.
+	 * 
+	 * @param message
+	 *            the status message
+	 * @param exception
+	 *            lower level exception associated with the error, or
+	 *            <code>null</code> if none
+	 * @param code
+	 *            error code
+	 */
+	protected void abort(String message, Throwable exception, int code) throws CoreException {
+		IStatus status;
+		if (exception != null) {
+			MultiStatus multiStatus = new MultiStatus(getPluginID(), code, message, exception);
+			multiStatus.add(new Status(IStatus.ERROR, getPluginID(), code, exception.getLocalizedMessage(), exception));
+			status= multiStatus;
+		} else {
+			status= new Status(IStatus.ERROR, getPluginID(), code, message, null);
+		}
+		throw new CoreException(status);
+	}
+
+	public void launch(ILaunchConfiguration configuration, String mode, ILaunch launch, IProgressMonitor monitor) throws CoreException {
+		// TODO Auto-generated method stub
+		
+	}
+
+	/**
+	 * Builds the current project and all of it's prerequisite projects if
+	 * necessary. Respects specified build order if any exists.
+	 * 
+	 * @param configuration
+	 *            the configuration being launched
+	 * @param mode
+	 *            the mode the configuration is being launched in
+	 * @param monitor
+	 *            progress monitor
+	 * @return whether the debug platform should perform an incremental
+	 *         workspace build before the launch
+	 * @throws CoreException
+	 *             if an exception occurs while building
+	 */
+	@Override
+	public boolean buildForLaunch(ILaunchConfiguration configuration, String mode, IProgressMonitor monitor) throws CoreException {
+
+		workspaceBuildBeforeLaunch = true;
+		
+		// check the build before launch setting and honor it
+		int buildBeforeLaunchValue = configuration.getAttribute(ICDTLaunchConfigurationConstants.ATTR_BUILD_BEFORE_LAUNCH,
+				ICDTLaunchConfigurationConstants.BUILD_BEFORE_LAUNCH_USE_WORKSPACE_SETTING);
+
+		// we shouldn't be getting called if the workspace setting is disabled, so assume we need to
+		// build unless the user explicitly disabled it in the main tab of the launch.
+		if (buildBeforeLaunchValue == ICDTLaunchConfigurationConstants.BUILD_BEFORE_LAUNCH_DISABLED) {
+			return false;
+		}
+
+		setBuildConfiguration(configuration, project);
+
+		return super.buildForLaunch(configuration, mode, monitor);
+	}
+
+	@Override
+	public boolean preLaunchCheck(ILaunchConfiguration configuration, String mode, IProgressMonitor monitor) throws CoreException {
+		ICProject cProject = CDebugUtils.getCProject(configuration);
+		if (cProject != null) {
+			project = cProject.getProject();
+		}
+		return super.preLaunchCheck(configuration, mode, monitor);
+	}
+
+	@Override
+	public boolean finalLaunchCheck(ILaunchConfiguration configuration, String mode, IProgressMonitor monitor) throws CoreException {
+		if (!workspaceBuildBeforeLaunch) {
+			// buildForLaunch was not called which means that the workspace pref is disabled.  see if the user enabled the
+			// launch specific setting in the main tab.  if so, we do call buildBeforeLaunch here.
+			if (ICDTLaunchConfigurationConstants.BUILD_BEFORE_LAUNCH_ENABLED == configuration.getAttribute(ICDTLaunchConfigurationConstants.ATTR_BUILD_BEFORE_LAUNCH,
+					ICDTLaunchConfigurationConstants.BUILD_BEFORE_LAUNCH_USE_WORKSPACE_SETTING)) {
+				
+				IProgressMonitor buildMonitor = new SubProgressMonitor(monitor, 10, SubProgressMonitor.PREPEND_MAIN_LABEL_TO_SUBTASK);
+				buildMonitor.beginTask(LaunchMessages.getString("AbstractCLaunchDelegate.BuildBeforeLaunch"), 10); //$NON-NLS-1$	
+				buildMonitor.subTask(LaunchMessages.getString("AbstractCLaunchDelegate.PerformingBuild")); //$NON-NLS-1$
+				if (buildForLaunch(configuration, mode, new SubProgressMonitor(buildMonitor, 7))) {
+					buildMonitor.subTask(LaunchMessages.getString("AbstractCLaunchDelegate.PerformingIncrementalBuild")); //$NON-NLS-1$
+					ResourcesPlugin.getWorkspace().build(IncrementalProjectBuilder.INCREMENTAL_BUILD, new SubProgressMonitor(buildMonitor, 3));				
+				}
+				else {
+					buildMonitor.worked(3); /* No incremental build required */
+				}
+			}
+		}
+		boolean continueLaunch = super.finalLaunchCheck(configuration, mode, monitor);
+
+		if (continueLaunch) // If no problems then restore the previous build configuration. Otherwise leave it so the user can fix the build issues.
+			resetBuildConfiguration(project);
+		
+		return continueLaunch;
+}
+
+	protected ICProject verifyCProject(ILaunchConfiguration config) throws CoreException {
+		String name = CDebugUtils.getProjectName(config);
+		if (name == null) {
+			abort(LaunchMessages.getString("AbstractCLaunchDelegate.C_Project_not_specified"), null, //$NON-NLS-1$
+					ICDTLaunchConfigurationConstants.ERR_UNSPECIFIED_PROJECT);
+		}
+		ICProject cproject = CDebugUtils.getCProject(config);
+		if (cproject == null) {
+			IProject proj = ResourcesPlugin.getWorkspace().getRoot().getProject(name);
+			if (!proj.exists()) {
+				abort(
+						LaunchMessages.getFormattedString("AbstractCLaunchDelegate.Project_NAME_does_not_exist", name), null, //$NON-NLS-1$
+						ICDTLaunchConfigurationConstants.ERR_NOT_A_C_PROJECT);
+			} else if (!proj.isOpen()) {
+				abort(LaunchMessages.getFormattedString("AbstractCLaunchDelegate.Project_NAME_is_closed", name), null, //$NON-NLS-1$
+						ICDTLaunchConfigurationConstants.ERR_NOT_A_C_PROJECT);
+			}
+			abort(LaunchMessages.getString("AbstractCLaunchDelegate.Not_a_C_CPP_project"), null, //$NON-NLS-1$
+					ICDTLaunchConfigurationConstants.ERR_NOT_A_C_PROJECT);
+		}
+		return cproject;
+	}
+
+	/**
+	 * Sets up a project for building by making sure the active configuration is the one used
+	 * when the launch was created.
+	 * @param configuration
+	 * @param buildProject
+	 */
+	private void setBuildConfiguration(ILaunchConfiguration configuration, IProject buildProject) {
+		
+		try {
+			if (buildProject != null)
+			{
+				String buildConfigID = configuration.getAttribute(ICDTLaunchConfigurationConstants.ATTR_PROJECT_BUILD_CONFIG_ID, ""); //$NON-NLS-1$
+				ICProjectDescription projDes = CDTPropertyManager.getProjectDescription(buildProject);
+				
+				if (buildConfigID.length() > 0 && projDes != null)
+				{
+					ICConfigurationDescription buildConfiguration = projDes.getConfigurationById(buildConfigID);
+					if (buildConfiguration != null) {
+						preLaunchBuildConfiguration = projDes.getActiveConfiguration().getId();
+						buildConfiguration.setActive();
+						CDTPropertyManager.performOk(null);
+					}
+				}
+			}
+			
+		} catch (CoreException e) {}
+	}
+
+	private void resetBuildConfiguration(IProject buildProject) {
+		// Restore the active configuration if it was changed for the launch
+		if (preLaunchBuildConfiguration != null) {
+			ICProjectDescription projDes = CDTPropertyManager.getProjectDescription(buildProject);
+			
+			if (preLaunchBuildConfiguration.length() > 0 && projDes != null)
+			{
+				ICConfigurationDescription buildConfiguration = projDes.getConfigurationById(preLaunchBuildConfiguration);
+				if (buildConfiguration != null) {
+					buildConfiguration.setActive();
+					CDTPropertyManager.performOk(null);
+				}
+			}
+
+		}
+		preLaunchBuildConfiguration = null;
+	}
+
+	/**
+	 * @return the ID of the plugin hosting the launch delegate. It's used to
+	 *         create {@link IStatus} objects.
+	 */
+	abstract protected String getPluginID();
+}