org.eclipse.ui.externaltools/External Tools Base/org/eclipse/ui/externaltools/internal/model/ExternalToolBuilder.java - gerrit/platform/eclipse.platform.debug - Git at Google

 /*******************************************************************************
  * 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.ui.externaltools.internal.model;


 import java.text.MessageFormat;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 import java.util.StringTokenizer;

 import org.eclipse.core.resources.ICommand;
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.resources.IResource;
 import org.eclipse.core.resources.IResourceDelta;
 import org.eclipse.core.resources.IncrementalProjectBuilder;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.debug.core.ILaunchConfiguration;
 import org.eclipse.debug.core.ILaunchManager;
 import org.eclipse.ui.externaltools.internal.launchConfigurations.ExternalToolsUtil;
 import org.eclipse.ui.externaltools.internal.registry.ExternalToolMigration;

 /**
  * This project builder implementation will run an external tool or tools during the
  * build process.
  * <p>
  * Note that there is only ever one instance of ExternalToolBuilder per project,
  * and the external tool to run is specified in the builder's arguments.
  * </p>
  */
 public final class ExternalToolBuilder extends IncrementalProjectBuilder {
 	public static final String ID = "org.eclipse.ui.externaltools.ExternalToolBuilder"; //$NON-NLS-1$;

 	private static final String BUILD_TYPE_SEPARATOR = ","; //$NON-NLS-1$
 	private static final int[] DEFAULT_BUILD_TYPES= new int[] {
 									IncrementalProjectBuilder.INCREMENTAL_BUILD,
 									IncrementalProjectBuilder.FULL_BUILD};

 	private static String buildType = IExternalToolConstants.BUILD_TYPE_NONE;

 	private List projectsWithinScope;

 	private boolean buildKindCompatible(int kind, ILaunchConfiguration config) throws CoreException {
 		int[] buildKinds = buildTypesToArray(config.getAttribute(IExternalToolConstants.ATTR_RUN_BUILD_KINDS, "")); //$NON-NLS-1$
 		for (int j = 0; j < buildKinds.length; j++) {
 			if (kind == buildKinds[j]) {
 				return true;
 			}
 		}
 		return false;
 	}

 	/* (non-Javadoc)
 	 * Method declared on IncrementalProjectBuilder.
 	 */
 	protected IProject[] build(int kind, Map args, IProgressMonitor monitor) throws CoreException {
 		if (kind == FULL_BUILD) {
 			ILaunchConfiguration config = BuilderUtils.configFromBuildCommandArgs(getProject(), args);
 			if (config != null && buildKindCompatible(kind, config) && configEnabled(config)) {
 				launchBuild(kind, config, monitor);
 			}
 			return getProjectsWithinScope();
 		}

 		//need to build all external tools from one builder (see bug 39713)
 		//if not a full build
 		ICommand[] commands = getProject().getDescription().getBuildSpec();
 		projectsWithinScope= new ArrayList();
 		for (int i = 0; i < commands.length; i++) {
 			if (ID.equals(commands[i].getBuilderName())){
 				ILaunchConfiguration config = BuilderUtils.configFromBuildCommandArgs(getProject(), commands[i].getArguments());
 				if (config != null && buildKindCompatible(kind, config) && configEnabled(config)) {
 					doBuild(kind, config, monitor);
 				}
 			}
 		}
 		return getProjectsWithinScope();
 	}

 	/**
 	 * Returns whether the given builder config is enabled or not.
 	 *
 	 * @param config the config to examine
 	 * @return whether the config is enabled
 	 */
 	private boolean configEnabled(ILaunchConfiguration config) {
 		try {
 			return ExternalToolsUtil.isBuilderEnabled(config);
 		} catch (CoreException e) {
 			ExternalToolsPlugin.getDefault().log(e);
 		}
 		return true;
 	}

 	private IProject[] getProjectsWithinScope() {
 		if (projectsWithinScope == null || projectsWithinScope.isEmpty()) {
 			projectsWithinScope = null;
 			return null;
 		}
 		return (IProject[])projectsWithinScope.toArray(new IProject[projectsWithinScope.size()]);
 	}

 	private void doBuild(int kind, ILaunchConfiguration config, IProgressMonitor monitor) throws CoreException {
 		boolean buildForChange = true;
 		IResource[] resources = ExternalToolsUtil.getResourcesForBuildScope(config);
 		if (resources != null && resources.length > 0) {
 			for (int i = 0; i < resources.length; i++) {
 				IResource resource = resources[i];
 				projectsWithinScope.add(resource.getProject());
 			}
 			buildForChange = buildScopeIndicatesBuild(resources);
 		}

 		if (buildForChange) {
 			launchBuild(kind, config, monitor);
 		}
 	}

 	private void launchBuild(int kind, ILaunchConfiguration config, IProgressMonitor monitor) throws CoreException {
 		monitor.subTask(MessageFormat.format(ExternalToolsModelMessages.getString("ExternalToolBuilder.Running_{0}..._1"), new String[] { config.getName()})); //$NON-NLS-1$
 		buildStarted(kind);
 		// The default value for "launch in background" is true in debug core. If
 		// the user doesn't go through the UI, the new attribute won't be set. This means
 		// that existing Ant builders will try to run in the background (and likely conflict with
 		// each other) without migration.
 		config= ExternalToolMigration.migrateRunInBackground(config);
 		config.launch(ILaunchManager.RUN_MODE, monitor);
 		buildEnded();
 	}

 	/**
 	 * Returns the build type being performed if the
 	 * external tool is being run as a project builder.
 	 *
 	 * @return one of the <code>IExternalToolConstants.BUILD_TYPE_*</code> constants.
 	 */
 	public static String getBuildType() {
 		return buildType;
 	}

 	/**
 	 * Stores the currently active build kind when a build begins
 	 * @param buildKind
 	 */
 	private void buildStarted(int buildKind) {
 		switch (buildKind) {
 			case IncrementalProjectBuilder.INCREMENTAL_BUILD :
 				buildType = IExternalToolConstants.BUILD_TYPE_INCREMENTAL;
 				break;
 			case IncrementalProjectBuilder.FULL_BUILD :
 				buildType = IExternalToolConstants.BUILD_TYPE_FULL;
 				break;
 			case IncrementalProjectBuilder.AUTO_BUILD :
 				buildType = IExternalToolConstants.BUILD_TYPE_AUTO;
 				break;
 			default :
 				buildType = IExternalToolConstants.BUILD_TYPE_NONE;
 				break;
 		}
 	}

 	/**
 	 * Clears the current build kind when a build finishes.
 	 */
 	private void buildEnded() {
 		buildType= IExternalToolConstants.BUILD_TYPE_NONE;
 	}

 	private boolean buildScopeIndicatesBuild(IResource[] resources) {
 		for (int i = 0; i < resources.length; i++) {
 			IResourceDelta delta = getDelta(resources[i].getProject());
 			if (delta == null) {
 				//project just added to the workspace..no previous build tree
 				return true;
 			} else {
 				IPath path= resources[i].getProjectRelativePath();
 				IResourceDelta change= delta.findMember(path);
 				if (change != null) {
 					return true;
 				}
 			}
 		}
 		return false;
 	}

 	/**
 	 * Converts the build types string into an array of
 	 * build kinds.
 	 *
 	 * @param buildTypes the string of built types to convert
 	 * @return the array of build kinds.
 	 */
 	public static int[] buildTypesToArray(String buildTypes) {
 		if (buildTypes == null || buildTypes.length() == 0) {
 			return DEFAULT_BUILD_TYPES;
 		}

 		int count = 0;
 		boolean incremental = false;
 		boolean full = false;
 		boolean auto = false;

 		StringTokenizer tokenizer = new StringTokenizer(buildTypes, BUILD_TYPE_SEPARATOR);
 		while (tokenizer.hasMoreTokens()) {
 			String token = tokenizer.nextToken();
 			if (IExternalToolConstants.BUILD_TYPE_INCREMENTAL.equals(token)) {
 				if (!incremental) {
 					incremental = true;
 					count++;
 				}
 			} else if (IExternalToolConstants.BUILD_TYPE_FULL.equals(token)) {
 				if (!full) {
 					full = true;
 					count++;
 				}
 			} else if (IExternalToolConstants.BUILD_TYPE_AUTO.equals(token)) {
 				if (!auto) {
 					auto = true;
 					count++;
 				}
 			}
 		}

 		int[] results = new int[count];
 		count = 0;
 		if (incremental) {
 			results[count] = IncrementalProjectBuilder.INCREMENTAL_BUILD;
 			count++;
 		}
 		if (full) {
 			results[count] = IncrementalProjectBuilder.FULL_BUILD;
 			count++;
 		}
 		if (auto) {
 			results[count] = IncrementalProjectBuilder.AUTO_BUILD;
 			count++;
 		}

 		return results;
 	}
 }
	/*******************************************************************************
	* 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.ui.externaltools.internal.model;


	import java.text.MessageFormat;
	import java.util.ArrayList;
	import java.util.List;
	import java.util.Map;
	import java.util.StringTokenizer;

	import org.eclipse.core.resources.ICommand;
	import org.eclipse.core.resources.IProject;
	import org.eclipse.core.resources.IResource;
	import org.eclipse.core.resources.IResourceDelta;
	import org.eclipse.core.resources.IncrementalProjectBuilder;
	import org.eclipse.core.runtime.CoreException;
	import org.eclipse.core.runtime.IPath;
	import org.eclipse.core.runtime.IProgressMonitor;
	import org.eclipse.debug.core.ILaunchConfiguration;
	import org.eclipse.debug.core.ILaunchManager;
	import org.eclipse.ui.externaltools.internal.launchConfigurations.ExternalToolsUtil;
	import org.eclipse.ui.externaltools.internal.registry.ExternalToolMigration;

	/**
	* This project builder implementation will run an external tool or tools during the
	* build process.
	* <p>
	* Note that there is only ever one instance of ExternalToolBuilder per project,
	* and the external tool to run is specified in the builder's arguments.
	* </p>
	*/
	public final class ExternalToolBuilder extends IncrementalProjectBuilder {
	public static final String ID = "org.eclipse.ui.externaltools.ExternalToolBuilder"; //$NON-NLS-1$;

	private static final String BUILD_TYPE_SEPARATOR = ","; //$NON-NLS-1$
	private static final int[] DEFAULT_BUILD_TYPES= new int[] {
	IncrementalProjectBuilder.INCREMENTAL_BUILD,
	IncrementalProjectBuilder.FULL_BUILD};

	private static String buildType = IExternalToolConstants.BUILD_TYPE_NONE;

	private List projectsWithinScope;

	private boolean buildKindCompatible(int kind, ILaunchConfiguration config) throws CoreException {
	int[] buildKinds = buildTypesToArray(config.getAttribute(IExternalToolConstants.ATTR_RUN_BUILD_KINDS, "")); //$NON-NLS-1$
	for (int j = 0; j < buildKinds.length; j++) {
	if (kind == buildKinds[j]) {
	return true;
	}
	}
	return false;
	}

	/* (non-Javadoc)
	* Method declared on IncrementalProjectBuilder.
	*/
	protected IProject[] build(int kind, Map args, IProgressMonitor monitor) throws CoreException {
	if (kind == FULL_BUILD) {
	ILaunchConfiguration config = BuilderUtils.configFromBuildCommandArgs(getProject(), args);
	if (config != null && buildKindCompatible(kind, config) && configEnabled(config)) {
	launchBuild(kind, config, monitor);
	}
	return getProjectsWithinScope();
	}

	//need to build all external tools from one builder (see bug 39713)
	//if not a full build
	ICommand[] commands = getProject().getDescription().getBuildSpec();
	projectsWithinScope= new ArrayList();
	for (int i = 0; i < commands.length; i++) {
	if (ID.equals(commands[i].getBuilderName())){
	ILaunchConfiguration config = BuilderUtils.configFromBuildCommandArgs(getProject(), commands[i].getArguments());
	if (config != null && buildKindCompatible(kind, config) && configEnabled(config)) {
	doBuild(kind, config, monitor);
	}
	}
	}
	return getProjectsWithinScope();
	}

	/**
	* Returns whether the given builder config is enabled or not.
	*
	* @param config the config to examine
	* @return whether the config is enabled
	*/
	private boolean configEnabled(ILaunchConfiguration config) {
	try {
	return ExternalToolsUtil.isBuilderEnabled(config);
	} catch (CoreException e) {
	ExternalToolsPlugin.getDefault().log(e);
	}
	return true;
	}

	private IProject[] getProjectsWithinScope() {
	if (projectsWithinScope == null \|\| projectsWithinScope.isEmpty()) {
	projectsWithinScope = null;
	return null;
	}
	return (IProject[])projectsWithinScope.toArray(new IProject[projectsWithinScope.size()]);
	}

	private void doBuild(int kind, ILaunchConfiguration config, IProgressMonitor monitor) throws CoreException {
	boolean buildForChange = true;
	IResource[] resources = ExternalToolsUtil.getResourcesForBuildScope(config);
	if (resources != null && resources.length > 0) {
	for (int i = 0; i < resources.length; i++) {
	IResource resource = resources[i];
	projectsWithinScope.add(resource.getProject());
	}
	buildForChange = buildScopeIndicatesBuild(resources);
	}

	if (buildForChange) {
	launchBuild(kind, config, monitor);
	}
	}

	private void launchBuild(int kind, ILaunchConfiguration config, IProgressMonitor monitor) throws CoreException {
	monitor.subTask(MessageFormat.format(ExternalToolsModelMessages.getString("ExternalToolBuilder.Running_{0}..._1"), new String[] { config.getName()})); //$NON-NLS-1$
	buildStarted(kind);
	// The default value for "launch in background" is true in debug core. If
	// the user doesn't go through the UI, the new attribute won't be set. This means
	// that existing Ant builders will try to run in the background (and likely conflict with
	// each other) without migration.
	config= ExternalToolMigration.migrateRunInBackground(config);
	config.launch(ILaunchManager.RUN_MODE, monitor);
	buildEnded();
	}

	/**
	* Returns the build type being performed if the
	* external tool is being run as a project builder.
	*
	* @return one of the <code>IExternalToolConstants.BUILD_TYPE_*</code> constants.
	*/
	public static String getBuildType() {
	return buildType;
	}

	/**
	* Stores the currently active build kind when a build begins
	* @param buildKind
	*/
	private void buildStarted(int buildKind) {
	switch (buildKind) {
	case IncrementalProjectBuilder.INCREMENTAL_BUILD :
	buildType = IExternalToolConstants.BUILD_TYPE_INCREMENTAL;
	break;
	case IncrementalProjectBuilder.FULL_BUILD :
	buildType = IExternalToolConstants.BUILD_TYPE_FULL;
	break;
	case IncrementalProjectBuilder.AUTO_BUILD :
	buildType = IExternalToolConstants.BUILD_TYPE_AUTO;
	break;
	default :
	buildType = IExternalToolConstants.BUILD_TYPE_NONE;
	break;
	}
	}

	/**
	* Clears the current build kind when a build finishes.
	*/
	private void buildEnded() {
	buildType= IExternalToolConstants.BUILD_TYPE_NONE;
	}

	private boolean buildScopeIndicatesBuild(IResource[] resources) {
	for (int i = 0; i < resources.length; i++) {
	IResourceDelta delta = getDelta(resources[i].getProject());
	if (delta == null) {
	//project just added to the workspace..no previous build tree
	return true;
	} else {
	IPath path= resources[i].getProjectRelativePath();
	IResourceDelta change= delta.findMember(path);
	if (change != null) {
	return true;
	}
	}
	}
	return false;
	}

	/**
	* Converts the build types string into an array of
	* build kinds.
	*
	* @param buildTypes the string of built types to convert
	* @return the array of build kinds.
	*/
	public static int[] buildTypesToArray(String buildTypes) {
	if (buildTypes == null \|\| buildTypes.length() == 0) {
	return DEFAULT_BUILD_TYPES;
	}

	int count = 0;
	boolean incremental = false;
	boolean full = false;
	boolean auto = false;

	StringTokenizer tokenizer = new StringTokenizer(buildTypes, BUILD_TYPE_SEPARATOR);
	while (tokenizer.hasMoreTokens()) {
	String token = tokenizer.nextToken();
	if (IExternalToolConstants.BUILD_TYPE_INCREMENTAL.equals(token)) {
	if (!incremental) {
	incremental = true;
	count++;
	}
	} else if (IExternalToolConstants.BUILD_TYPE_FULL.equals(token)) {
	if (!full) {
	full = true;
	count++;
	}
	} else if (IExternalToolConstants.BUILD_TYPE_AUTO.equals(token)) {
	if (!auto) {
	auto = true;
	count++;
	}
	}
	}

	int[] results = new int[count];
	count = 0;
	if (incremental) {
	results[count] = IncrementalProjectBuilder.INCREMENTAL_BUILD;
	count++;
	}
	if (full) {
	results[count] = IncrementalProjectBuilder.FULL_BUILD;
	count++;
	}
	if (auto) {
	results[count] = IncrementalProjectBuilder.AUTO_BUILD;
	count++;
	}

	return results;
	}
	}