1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
/*******************************************************************************
* 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;
}
}
|
