| /******************************************************************************* |
| * Copyright (c) 2000, 2011 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 |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| * Anton Leherbauer (Wind River) - [296800] UI build actions should not lock the workspace |
| * Broadcom Corporation - [335960] Update BuildAction to use new Workspace Build Configurations API |
| *******************************************************************************/ |
| package org.eclipse.ui.actions; |
| |
| import java.util.ArrayList; |
| import java.util.HashSet; |
| import java.util.Iterator; |
| import java.util.List; |
| import java.util.Set; |
| |
| import org.eclipse.core.resources.IBuildConfiguration; |
| import org.eclipse.core.resources.ICommand; |
| 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.resources.WorkspaceJob; |
| import org.eclipse.core.runtime.CoreException; |
| import org.eclipse.core.runtime.IProgressMonitor; |
| import org.eclipse.core.runtime.IStatus; |
| import org.eclipse.core.runtime.OperationCanceledException; |
| import org.eclipse.core.runtime.Status; |
| import org.eclipse.core.runtime.SubProgressMonitor; |
| import org.eclipse.core.runtime.jobs.ISchedulingRule; |
| import org.eclipse.core.runtime.jobs.Job; |
| import org.eclipse.jface.preference.IPreferenceStore; |
| import org.eclipse.jface.viewers.IStructuredSelection; |
| import org.eclipse.jface.viewers.StructuredSelection; |
| import org.eclipse.jface.window.IShellProvider; |
| import org.eclipse.swt.widgets.Shell; |
| import org.eclipse.ui.IWorkbenchWindow; |
| import org.eclipse.ui.PlatformUI; |
| import org.eclipse.ui.internal.ide.IDEInternalPreferences; |
| import org.eclipse.ui.internal.ide.IDEWorkbenchMessages; |
| import org.eclipse.ui.internal.ide.IDEWorkbenchPlugin; |
| import org.eclipse.ui.internal.ide.IIDEHelpContextIds; |
| import org.eclipse.ui.internal.ide.actions.BuildUtilities; |
| import org.eclipse.ui.progress.IProgressConstants2; |
| |
| /** |
| * Standard actions for full and incremental builds of the selected project(s) |
| * and their references project build configurations. |
| * <p> |
| * This class may be instantiated; it is not intended to be subclassed. |
| * </p> |
| * @noextend This class is not intended to be subclassed by clients. |
| */ |
| public class BuildAction extends WorkspaceAction { |
| |
| /** |
| * The id of an incremental build action. |
| */ |
| public static final String ID_BUILD = PlatformUI.PLUGIN_ID + ".BuildAction";//$NON-NLS-1$ |
| |
| /** |
| * The id of a rebuild all action. |
| */ |
| public static final String ID_REBUILD_ALL = PlatformUI.PLUGIN_ID |
| + ".RebuildAllAction";//$NON-NLS-1$ |
| |
| private int buildType; |
| |
| /** |
| * The list of IProjects to build (computed lazily). This is computed from the |
| * list of project build configurations that are to be built. |
| */ |
| private List projectsToBuild = null; |
| |
| /** |
| * The list of {@link IBuildConfiguration} to build (computed lazily). |
| */ |
| private List/*<IBuildConfiguration>*/ projectConfigsToBuild = null; |
| |
| /** |
| * Creates a new action of the appropriate type. The action id is |
| * <code>ID_BUILD</code> for incremental builds and <code>ID_REBUILD_ALL</code> |
| * for full builds. |
| * |
| * @param shell the shell for any dialogs |
| * @param type the type of build; one of |
| * <code>IncrementalProjectBuilder.INCREMENTAL_BUILD</code> or |
| * <code>IncrementalProjectBuilder.FULL_BUILD</code> |
| * @deprecated See {@link #BuildAction(IShellProvider, int)} |
| */ |
| @Deprecated |
| public BuildAction(Shell shell, int type) { |
| super(shell, "");//$NON-NLS-1$ |
| initAction(type); |
| } |
| |
| /** |
| * Creates a new action of the appropriate type. The action id is |
| * <code>ID_BUILD</code> for incremental builds and |
| * <code>ID_REBUILD_ALL</code> for full builds. |
| * |
| * @param provider |
| * the shell provider for any dialogs |
| * @param type |
| * the type of build; one of |
| * <code>IncrementalProjectBuilder.INCREMENTAL_BUILD</code> or |
| * <code>IncrementalProjectBuilder.FULL_BUILD</code> |
| * @since 3.4 |
| */ |
| public BuildAction(IShellProvider provider, int type) { |
| super(provider, ""); //$NON-NLS-1$ |
| initAction(type); |
| } |
| |
| /** |
| * @param type |
| */ |
| private void initAction(int type) { |
| if (type == IncrementalProjectBuilder.INCREMENTAL_BUILD) { |
| setText(IDEWorkbenchMessages.BuildAction_text); |
| setToolTipText(IDEWorkbenchMessages.BuildAction_toolTip); |
| setId(ID_BUILD); |
| PlatformUI.getWorkbench().getHelpSystem().setHelp(this, |
| IIDEHelpContextIds.INCREMENTAL_BUILD_ACTION); |
| } else { |
| setText(IDEWorkbenchMessages.RebuildAction_text); |
| setToolTipText(IDEWorkbenchMessages.RebuildAction_tooltip); |
| setId(ID_REBUILD_ALL); |
| PlatformUI.getWorkbench().getHelpSystem().setHelp(this, |
| IIDEHelpContextIds.FULL_BUILD_ACTION); |
| } |
| |
| this.buildType = type; |
| } |
| |
| /* (non-Javadoc) |
| * Method declared on WorkspaceAction. |
| */ |
| @Override |
| protected List getActionResources() { |
| return getProjectsToBuild(); |
| } |
| |
| /* (non-Javadoc) |
| * Method declared on WorkspaceAction. |
| */ |
| @Override |
| protected String getOperationMessage() { |
| return IDEWorkbenchMessages.BuildAction_operationMessage; |
| } |
| |
| /* (non-Javadoc) |
| * Method declared on WorkspaceAction. |
| */ |
| @Override |
| protected String getProblemsMessage() { |
| return IDEWorkbenchMessages.BuildAction_problemMessage; |
| } |
| |
| /* (non-Javadoc) |
| * Method declared on WorkspaceAction. |
| */ |
| @Override |
| protected String getProblemsTitle() { |
| return IDEWorkbenchMessages.BuildAction_problemTitle; |
| } |
| |
| /** |
| * Returns the projects to build. |
| * This contains the set of projects which have builders, across all selected resources. |
| */ |
| List getProjectsToBuild() { |
| if (projectsToBuild == null) { |
| Set projects = new HashSet(3); |
| List configurations = getBuildConfigurationsToBuild(); |
| for (Iterator it = configurations.iterator(); it.hasNext();) { |
| projects.add(((IBuildConfiguration) it.next()).getProject()); |
| } |
| projectsToBuild = new ArrayList(projects); |
| } |
| return projectsToBuild; |
| } |
| |
| /** |
| * This collection of project build configs, derived from the selected |
| * resources, is passed to the workspace for building. The Workspace |
| * is responsible for resolving references. |
| * @return List of project build configurations to build. |
| * @since 3.7 |
| */ |
| protected List getBuildConfigurationsToBuild() { |
| if (projectConfigsToBuild == null) { |
| Set configs = new HashSet(3); |
| for (Iterator i = getSelectedResources().iterator(); i.hasNext();) { |
| IResource resource = (IResource) i.next(); |
| IProject project = resource.getProject(); |
| if (project != null && hasBuilder(project)) { |
| try { |
| configs.add(project.getActiveBuildConfig()); |
| } catch(CoreException e) { |
| // Ignore project |
| } |
| } |
| } |
| projectConfigsToBuild = new ArrayList(configs); |
| } |
| return projectConfigsToBuild; |
| } |
| |
| /** |
| * Returns whether there are builders configured on the given project. |
| * |
| * @return <code>true</code> if it has builders, |
| * <code>false</code> if not, or if this couldn't be determined |
| */ |
| boolean hasBuilder(IProject project) { |
| if (!project.isAccessible()) |
| return false; |
| try { |
| ICommand[] commands = project.getDescription().getBuildSpec(); |
| if (commands.length > 0) { |
| return true; |
| } |
| } catch (CoreException e) { |
| // this method is called when selection changes, so |
| // just fall through if it fails. |
| // this shouldn't happen anyway, since the list of selected resources |
| // has already been checked for accessibility before this is called |
| } |
| return false; |
| } |
| |
| /* (non-Javadoc) |
| * Method declared on Action |
| */ |
| @Override |
| public boolean isEnabled() { |
| //update enablement based on active window and part |
| IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow(); |
| if (window != null) { |
| selectionChanged(new StructuredSelection(BuildUtilities.findSelectedProjects(window))); |
| } |
| return super.isEnabled(); |
| } |
| |
| /** |
| * Returns whether the user's preference is set to automatically save modified |
| * resources before a manual build is done. |
| * |
| * @return <code>true</code> if Save All Before Build is enabled |
| */ |
| public static boolean isSaveAllSet() { |
| IPreferenceStore store = IDEWorkbenchPlugin.getDefault() |
| .getPreferenceStore(); |
| return store.getBoolean(IDEInternalPreferences.SAVE_ALL_BEFORE_BUILD); |
| } |
| |
| /* (non-Javadoc) |
| * Method declared on IAction; overrides method on WorkspaceAction. |
| * This override allows the user to save the contents of selected |
| * open editors so that the updated contents will be used for building. |
| * The build is run as a background job. |
| */ |
| @Override |
| public void run() { |
| final List buildConfigurations = getBuildConfigurationsToBuild(); |
| if (buildConfigurations == null || buildConfigurations.isEmpty()) |
| return; |
| |
| // Save all resources prior to doing build |
| BuildUtilities.saveEditors(getProjectsToBuild()); |
| runInBackground(null, ResourcesPlugin.FAMILY_MANUAL_BUILD); |
| } |
| |
| /* |
| * (non-Javadoc) |
| * @see org.eclipse.ui.actions.WorkspaceAction#runInBackground(org.eclipse.core.runtime.jobs.ISchedulingRule, java.lang.Object[]) |
| */ |
| @Override |
| public void runInBackground(ISchedulingRule rule, Object[] jobFamilies) { |
| // Get immutable copies of the build settings |
| final int kind = buildType; |
| List buildConfigurations = getBuildConfigurationsToBuild(); |
| if (buildConfigurations == null || buildConfigurations.isEmpty()) |
| return; |
| final IBuildConfiguration[] configs = (IBuildConfiguration[])buildConfigurations.toArray(new IBuildConfiguration[buildConfigurations.size()]); |
| |
| // Schedule a Workspace Job to perform the build |
| Job job = new WorkspaceJob(removeMnemonics(getText())) { |
| /* |
| * (non-Javadoc) |
| * @see Job#belongsTo(Object) |
| */ |
| @Override |
| public boolean belongsTo(Object family) { |
| return ResourcesPlugin.FAMILY_MANUAL_BUILD.equals(family); |
| } |
| |
| /* |
| * (non-Javadoc) |
| * @see WorkspaceJob#runInWorkspace(IProgressMonitor) |
| */ |
| @Override |
| public IStatus runInWorkspace(IProgressMonitor monitor) { |
| IStatus status = null; |
| monitor.beginTask("", 10000); //$NON-NLS-1$ |
| monitor.setTaskName(getOperationMessage()); |
| try { |
| // Backwards compatibility: check shouldPerformResourcePruning(). |
| // Previously if this returned true, the full reference graph is built, otherwise just build the selected configurations |
| ResourcesPlugin.getWorkspace().build(configs, kind, shouldPerformResourcePruning(), new SubProgressMonitor(monitor, 10000)); |
| } catch (CoreException e) { |
| status = e.getStatus(); |
| } |
| if (monitor.isCanceled()) { |
| throw new OperationCanceledException(); |
| } |
| monitor.done(); |
| return status == null ? Status.OK_STATUS : status; |
| } |
| }; |
| job.setProperty(IProgressConstants2.SHOW_IN_TASKBAR_ICON_PROPERTY, Boolean.TRUE); |
| job.setUser(true); |
| job.schedule(); |
| } |
| |
| /* (non-Javadoc) |
| * Method declared on WorkspaceAction. |
| */ |
| @Override |
| protected boolean shouldPerformResourcePruning() { |
| return true; |
| } |
| |
| /** |
| * The <code>BuildAction</code> implementation of this |
| * <code>SelectionListenerAction</code> method ensures that this action is |
| * enabled only if all of the selected resources have buildable projects. |
| */ |
| @Override |
| protected boolean updateSelection(IStructuredSelection s) { |
| projectConfigsToBuild = null; |
| projectsToBuild = null; |
| IProject[] projects = (IProject[]) getProjectsToBuild().toArray(new IProject[0]); |
| return BuildUtilities.isEnabled(projects, IncrementalProjectBuilder.INCREMENTAL_BUILD); |
| } |
| } |