-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
XcodePlugin.java
470 lines (413 loc) · 24.4 KB
/
XcodePlugin.java
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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
/*
* Copyright 2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.ide.xcode.plugins;
import org.apache.commons.lang.StringUtils;
import org.gradle.api.Action;
import org.gradle.api.GradleException;
import org.gradle.api.Project;
import org.gradle.api.Task;
import org.gradle.api.artifacts.ArtifactView;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.artifacts.component.ComponentIdentifier;
import org.gradle.api.artifacts.component.ProjectComponentIdentifier;
import org.gradle.api.component.SoftwareComponent;
import org.gradle.api.file.FileCollection;
import org.gradle.api.internal.project.ProjectInternal;
import org.gradle.api.model.ObjectFactory;
import org.gradle.api.specs.Spec;
import org.gradle.api.tasks.Delete;
import org.gradle.api.tasks.Sync;
import org.gradle.api.tasks.TaskContainer;
import org.gradle.api.tasks.TaskProvider;
import org.gradle.ide.xcode.XcodeExtension;
import org.gradle.ide.xcode.XcodeRootExtension;
import org.gradle.ide.xcode.internal.DefaultXcodeExtension;
import org.gradle.ide.xcode.internal.DefaultXcodeProject;
import org.gradle.ide.xcode.internal.DefaultXcodeRootExtension;
import org.gradle.ide.xcode.internal.DefaultXcodeWorkspace;
import org.gradle.ide.xcode.internal.XcodeProjectMetadata;
import org.gradle.ide.xcode.internal.XcodePropertyAdapter;
import org.gradle.ide.xcode.internal.XcodeTarget;
import org.gradle.ide.xcode.internal.xcodeproj.GidGenerator;
import org.gradle.ide.xcode.internal.xcodeproj.PBXTarget;
import org.gradle.ide.xcode.tasks.GenerateSchemeFileTask;
import org.gradle.ide.xcode.tasks.GenerateWorkspaceSettingsFileTask;
import org.gradle.ide.xcode.tasks.GenerateXcodeProjectFileTask;
import org.gradle.ide.xcode.tasks.GenerateXcodeWorkspaceFileTask;
import org.gradle.internal.Actions;
import org.gradle.language.cpp.CppBinary;
import org.gradle.language.cpp.CppExecutable;
import org.gradle.language.cpp.CppLibrary;
import org.gradle.language.cpp.CppSharedLibrary;
import org.gradle.language.cpp.CppStaticLibrary;
import org.gradle.language.cpp.ProductionCppComponent;
import org.gradle.language.cpp.internal.DefaultCppBinary;
import org.gradle.language.cpp.plugins.CppApplicationPlugin;
import org.gradle.language.cpp.plugins.CppLibraryPlugin;
import org.gradle.language.swift.ProductionSwiftComponent;
import org.gradle.language.swift.SwiftBinary;
import org.gradle.language.swift.SwiftExecutable;
import org.gradle.language.swift.SwiftSharedLibrary;
import org.gradle.language.swift.SwiftStaticLibrary;
import org.gradle.language.swift.internal.DefaultSwiftBinary;
import org.gradle.language.swift.plugins.SwiftApplicationPlugin;
import org.gradle.language.swift.plugins.SwiftLibraryPlugin;
import org.gradle.nativeplatform.test.xctest.SwiftXCTestSuite;
import org.gradle.nativeplatform.test.xctest.plugins.XCTestConventionPlugin;
import org.gradle.plugins.ide.internal.IdeArtifactRegistry;
import org.gradle.plugins.ide.internal.IdePlugin;
import org.gradle.util.internal.CollectionUtils;
import javax.inject.Inject;
import java.io.File;
/**
* A plugin for creating a XCode project for a gradle project.
*
* @since 4.2
*/
public abstract class XcodePlugin extends IdePlugin {
private final GidGenerator gidGenerator;
private final ObjectFactory objectFactory;
private final IdeArtifactRegistry artifactRegistry;
private DefaultXcodeProject xcodeProject;
@Inject
public XcodePlugin(GidGenerator gidGenerator, ObjectFactory objectFactory, IdeArtifactRegistry artifactRegistry) {
this.gidGenerator = gidGenerator;
this.objectFactory = objectFactory;
this.artifactRegistry = artifactRegistry;
}
@Override
protected String getLifecycleTaskName() {
return "xcode";
}
@Override
protected void onApply(final Project project) {
TaskProvider<? extends Task> lifecycleTask = getLifecycleTask();
lifecycleTask.configure(withDescription("Generates XCode project files (pbxproj, xcworkspace, xcscheme)"));
if (isRoot()) {
DefaultXcodeRootExtension xcode = (DefaultXcodeRootExtension) project.getExtensions().create(XcodeRootExtension.class, "xcode", DefaultXcodeRootExtension.class, objectFactory);
xcodeProject = xcode.getProject();
final GenerateXcodeWorkspaceFileTask workspaceTask = createWorkspaceTask(project, xcode.getWorkspace());
lifecycleTask.configure(dependsOn(workspaceTask));
addWorkspace(xcode.getWorkspace());
} else {
DefaultXcodeExtension xcode = (DefaultXcodeExtension) project.getExtensions().create(XcodeExtension.class, "xcode", DefaultXcodeExtension.class, objectFactory);
xcodeProject = xcode.getProject();
}
xcodeProject.setLocationDir(project.file(project.getName() + ".xcodeproj"));
GenerateXcodeProjectFileTask projectTask = createProjectTask((ProjectInternal) project);
lifecycleTask.configure(dependsOn(projectTask));
project.getTasks().addRule("Xcode bridge tasks begin with _xcode. Do not call these directly.", new XcodeBridge(xcodeProject, project));
configureForSwiftPlugin(project);
configureForCppPlugin(project);
includeBuildFilesInProject(project);
configureXcodeCleanTask(project);
}
private void includeBuildFilesInProject(Project project) {
// TODO: Add other build like files `build.gradle.kts`, `settings.gradle(.kts)`, other `.gradle`, `gradle.properties`
if (project.getBuildFile().exists()) {
xcodeProject.getGroups().getRoot().from(project.getBuildFile());
}
}
private void configureXcodeCleanTask(Project project) {
Delete cleanTask = project.getTasks().create("cleanXcodeProject", Delete.class);
cleanTask.delete(xcodeProject.getLocationDir());
if (isRoot()) {
cleanTask.delete(project.file(project.getName() + ".xcworkspace"));
}
getCleanTask().configure(Actions.composite(withDescription("Cleans XCode project files (xcodeproj)"), dependsOn(cleanTask)));
}
private GenerateXcodeProjectFileTask createProjectTask(final ProjectInternal project) {
File xcodeProjectPackageDir = xcodeProject.getLocationDir();
GenerateWorkspaceSettingsFileTask workspaceSettingsFileTask = project.getTasks().create("xcodeProjectWorkspaceSettings", GenerateWorkspaceSettingsFileTask.class);
workspaceSettingsFileTask.setOutputFile(new File(xcodeProjectPackageDir, "project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings"));
GenerateXcodeProjectFileTask projectFileTask = project.getTasks().create("xcodeProject", GenerateXcodeProjectFileTask.class);
projectFileTask.dependsOn(workspaceSettingsFileTask);
projectFileTask.dependsOn(xcodeProject.getTaskDependencies());
projectFileTask.dependsOn(project.getTasks().withType(GenerateSchemeFileTask.class));
projectFileTask.setXcodeProject(xcodeProject);
projectFileTask.setOutputFile(new File(xcodeProjectPackageDir, "project.pbxproj"));
artifactRegistry.registerIdeProject(new XcodeProjectMetadata(xcodeProject, projectFileTask));
return projectFileTask;
}
private GenerateXcodeWorkspaceFileTask createWorkspaceTask(Project project, DefaultXcodeWorkspace workspace) {
File xcodeWorkspacePackageDir = project.file(project.getName() + ".xcworkspace");
workspace.getLocation().set(xcodeWorkspacePackageDir);
GenerateWorkspaceSettingsFileTask workspaceSettingsFileTask = project.getTasks().create("xcodeWorkspaceWorkspaceSettings", GenerateWorkspaceSettingsFileTask.class);
workspaceSettingsFileTask.setOutputFile(new File(xcodeWorkspacePackageDir, "xcshareddata/WorkspaceSettings.xcsettings"));
GenerateXcodeWorkspaceFileTask workspaceFileTask = project.getTasks().create("xcodeWorkspace", GenerateXcodeWorkspaceFileTask.class);
workspaceFileTask.dependsOn(workspaceSettingsFileTask);
workspaceFileTask.setOutputFile(new File(xcodeWorkspacePackageDir, "contents.xcworkspacedata"));
workspaceFileTask.setXcodeProjectLocations(artifactRegistry.getIdeProjectFiles(XcodeProjectMetadata.class));
return workspaceFileTask;
}
private String getBridgeTaskPath(Project project) {
String projectPath = "";
if (!isRoot()) {
projectPath = project.getPath();
}
return projectPath + ":_xcode__${ACTION}_${PRODUCT_NAME}_${CONFIGURATION}";
}
private void configureForSwiftPlugin(final Project project) {
project.getPlugins().withType(SwiftApplicationPlugin.class, new Action<SwiftApplicationPlugin>() {
@Override
public void execute(SwiftApplicationPlugin plugin) {
configureXcodeForSwift(project);
}
});
project.getPlugins().withType(SwiftLibraryPlugin.class, new Action<SwiftLibraryPlugin>() {
@Override
public void execute(SwiftLibraryPlugin plugin) {
configureXcodeForSwift(project);
}
});
project.getPlugins().withType(XCTestConventionPlugin.class, new Action<XCTestConventionPlugin>() {
@Override
public void execute(XCTestConventionPlugin plugin) {
configureXcodeForXCTest(project);
}
});
}
private void configureXcodeForXCTest(final Project project) {
project.afterEvaluate(new Action<Project>() {
@Override
public void execute(Project project) {
SwiftXCTestSuite component = project.getExtensions().getByType(SwiftXCTestSuite.class);
FileCollection sources = component.getSwiftSource();
xcodeProject.getGroups().getTests().from(sources);
String targetName = component.getModule().get();
final XcodeTarget target = newTarget(targetName, component.getModule().get(), toGradleCommand(project), getBridgeTaskPath(project), sources);
target.getSwiftSourceCompatibility().convention(component.getSourceCompatibility());
if (component.getTestBinary().isPresent()) {
target.addBinary(DefaultXcodeProject.BUILD_DEBUG, component.getTestBinary().get().getInstallDirectory(), component.getTestBinary().get().getTargetMachine().getArchitecture().getName());
target.addBinary(DefaultXcodeProject.BUILD_RELEASE, component.getTestBinary().get().getInstallDirectory(), component.getTestBinary().get().getTargetMachine().getArchitecture().getName());
target.setProductType(PBXTarget.ProductType.UNIT_TEST);
target.getCompileModules().from(component.getTestBinary().get().getCompileModules());
target.addTaskDependency(filterArtifactsFromImplicitBuilds(((DefaultSwiftBinary) component.getTestBinary().get()).getImportPathConfiguration()).getBuildDependencies());
}
component.getBinaries().whenElementFinalized(new Action<SwiftBinary>() {
@Override
public void execute(SwiftBinary swiftBinary) {
target.getSwiftSourceCompatibility().set(swiftBinary.getTargetPlatform().getSourceCompatibility());
}
});
xcodeProject.addTarget(target);
}
});
}
private FileCollection filterArtifactsFromImplicitBuilds(Configuration configuration) {
return configuration.getIncoming().artifactView(fromSourceDependency()).getArtifacts().getArtifactFiles();
}
private void configureXcodeForSwift(final Project project) {
project.afterEvaluate(new Action<Project>() {
@Override
public void execute(final Project project) {
// TODO: Assumes there's a single 'main' Swift component
final ProductionSwiftComponent component = project.getComponents().withType(ProductionSwiftComponent.class).getByName("main");
FileCollection sources = component.getSwiftSource();
xcodeProject.getGroups().getSources().from(sources);
// TODO - should use the _install_ task for an executable
final String targetName = component.getModule().get();
final XcodeTarget target = newTarget(targetName, component.getModule().get(), toGradleCommand(project), getBridgeTaskPath(project), sources);
target.getDefaultConfigurationName().set(component.getDevelopmentBinary().map(devBinary -> toBuildConfigurationName(component, devBinary)));
component.getBinaries().whenElementFinalized(new Action<SwiftBinary>() {
@Override
public void execute(SwiftBinary swiftBinary) {
if (swiftBinary instanceof SwiftExecutable) {
target.addBinary(toBuildConfigurationName(component, swiftBinary), ((SwiftExecutable) swiftBinary).getDebuggerExecutableFile(), swiftBinary.getTargetMachine().getArchitecture().getName());
target.setProductType(PBXTarget.ProductType.TOOL);
} else if (swiftBinary instanceof SwiftSharedLibrary) {
target.addBinary(toBuildConfigurationName(component, swiftBinary), ((SwiftSharedLibrary) swiftBinary).getRuntimeFile(), swiftBinary.getTargetMachine().getArchitecture().getName());
target.setProductType(PBXTarget.ProductType.DYNAMIC_LIBRARY);
} else if (swiftBinary instanceof SwiftStaticLibrary) {
target.addBinary(toBuildConfigurationName(component, swiftBinary), ((SwiftStaticLibrary) swiftBinary).getLinkFile(), swiftBinary.getTargetMachine().getArchitecture().getName());
target.setProductType(PBXTarget.ProductType.STATIC_LIBRARY);
}
target.getSwiftSourceCompatibility().set(swiftBinary.getTargetPlatform().getSourceCompatibility());
if (swiftBinary == component.getDevelopmentBinary().get()) {
target.getCompileModules().from(component.getDevelopmentBinary().get().getCompileModules());
target.addTaskDependency(filterArtifactsFromImplicitBuilds(((DefaultSwiftBinary) component.getDevelopmentBinary().get()).getImportPathConfiguration()).getBuildDependencies());
createSchemeTask(project.getTasks(), targetName, xcodeProject);
}
}
});
xcodeProject.addTarget(target);
}
});
}
private String toBuildConfigurationName(SoftwareComponent component, SoftwareComponent binary) {
String result = binary.getName().replace(component.getName(), "");
if (binary instanceof SwiftSharedLibrary || binary instanceof CppSharedLibrary) {
return result.replace("Shared", "");
} else if (binary instanceof SwiftStaticLibrary || binary instanceof CppStaticLibrary) {
return result.replace("Static", "");
}
return result;
}
private void configureForCppPlugin(final Project project) {
project.getPlugins().withType(CppApplicationPlugin.class, new Action<CppApplicationPlugin>() {
@Override
public void execute(CppApplicationPlugin plugin) {
configureXcodeForCpp(project);
}
});
project.getPlugins().withType(CppLibraryPlugin.class, new Action<CppLibraryPlugin>() {
@Override
public void execute(CppLibraryPlugin plugin) {
configureXcodeForCpp(project);
}
});
}
private void configureXcodeForCpp(Project project) {
project.afterEvaluate(new Action<Project>() {
@Override
public void execute(final Project project) {
// TODO: Assumes there's a single 'main' C++ component
final ProductionCppComponent component = project.getComponents().withType(ProductionCppComponent.class).getByName("main");
FileCollection sources = component.getCppSource();
xcodeProject.getGroups().getSources().from(sources);
FileCollection headers = component.getHeaderFiles();
xcodeProject.getGroups().getHeaders().from(headers);
// TODO - should use the _install_ task for an executable
final String targetName = StringUtils.capitalize(component.getBaseName().get());
final XcodeTarget target = newTarget(targetName, targetName, toGradleCommand(project), getBridgeTaskPath(project), sources);
target.getDefaultConfigurationName().set(component.getDevelopmentBinary().map(devBinary -> toBuildConfigurationName(component, devBinary)));
component.getBinaries().whenElementFinalized(new Action<CppBinary>() {
@Override
public void execute(CppBinary cppBinary) {
if (cppBinary instanceof CppExecutable) {
target.addBinary(toBuildConfigurationName(component, cppBinary), ((CppExecutable) cppBinary).getDebuggerExecutableFile(), cppBinary.getTargetMachine().getArchitecture().getName());
target.setProductType(PBXTarget.ProductType.TOOL);
} else if (cppBinary instanceof CppSharedLibrary) {
target.addBinary(toBuildConfigurationName(component, cppBinary), ((CppSharedLibrary) cppBinary).getRuntimeFile(), cppBinary.getTargetMachine().getArchitecture().getName());
target.setProductType(PBXTarget.ProductType.DYNAMIC_LIBRARY);
} else if (cppBinary instanceof CppStaticLibrary) {
target.addBinary(toBuildConfigurationName(component, cppBinary), ((CppStaticLibrary) cppBinary).getLinkFile(), cppBinary.getTargetMachine().getArchitecture().getName());
target.setProductType(PBXTarget.ProductType.STATIC_LIBRARY);
}
if (cppBinary == component.getDevelopmentBinary().get()) {
target.getHeaderSearchPaths().from(component.getDevelopmentBinary().get().getCompileIncludePath());
target.getTaskDependencies().add(filterArtifactsFromImplicitBuilds(((DefaultCppBinary) component.getDevelopmentBinary().get()).getIncludePathConfiguration()).getBuildDependencies());
createSchemeTask(project.getTasks(), targetName, xcodeProject);
}
}
});
target.getHeaderSearchPaths().from(component.getPrivateHeaderDirs());
if (component instanceof CppLibrary) {
target.getHeaderSearchPaths().from(((CppLibrary) component).getPublicHeaderDirs());
}
xcodeProject.addTarget(target);
}
});
}
private static GenerateSchemeFileTask createSchemeTask(TaskContainer tasks, String schemeName, DefaultXcodeProject xcodeProject) {
// TODO - capitalise the target name in the task name
// TODO - don't create a launch target for a library
String name = "xcodeScheme";
GenerateSchemeFileTask schemeFileTask = tasks.maybeCreate(name, GenerateSchemeFileTask.class);
schemeFileTask.setXcodeProject(xcodeProject);
schemeFileTask.setOutputFile(new File(xcodeProject.getLocationDir(), "xcshareddata/xcschemes/" + schemeName + ".xcscheme"));
return schemeFileTask;
}
private XcodeTarget newTarget(String name, String productName, String gradleCommand, String taskName, FileCollection sources) {
String id = gidGenerator.generateGid("PBXLegacyTarget", name.hashCode());
XcodeTarget target = objectFactory.newInstance(XcodeTarget.class, name, id);
target.setTaskName(taskName);
target.setGradleCommand(gradleCommand);
target.setProductName(productName);
target.getSources().setFrom(sources);
return target;
}
private static class XcodeBridge implements Action<String> {
private final DefaultXcodeProject xcodeProject;
private final Project project;
private final XcodePropertyAdapter xcodePropertyAdapter;
XcodeBridge(DefaultXcodeProject xcodeProject, Project project) {
this.xcodeProject = xcodeProject;
this.project = project;
this.xcodePropertyAdapter = new XcodePropertyAdapter(project);
}
@Override
public void execute(String taskName) {
if (taskName.startsWith("_xcode")) {
Task bridgeTask = project.getTasks().create(taskName);
String action = xcodePropertyAdapter.getAction();
if (action.equals("clean")) {
bridgeTask.dependsOn("clean");
} else if ("".equals(action) || "build".equals(action)) {
final XcodeTarget target = findXcodeTarget();
if (target.isUnitTest()) {
bridgeTestExecution(bridgeTask, target);
} else {
bridgeProductBuild(bridgeTask, target);
}
} else {
throw new GradleException("Unrecognized bridge action from Xcode '" + action + "'");
}
}
}
private XcodeTarget findXcodeTarget() {
final String productName = xcodePropertyAdapter.getProductName();
final XcodeTarget target = CollectionUtils.findFirst(xcodeProject.getTargets(), new Spec<XcodeTarget>() {
@Override
public boolean isSatisfiedBy(XcodeTarget target) {
return target.getProductName().equals(productName);
}
});
if (target == null) {
throw new GradleException("Unknown Xcode target '" + productName + "', do you need to re-generate Xcode configuration?");
}
return target;
}
private void bridgeProductBuild(Task bridgeTask, XcodeTarget target) {
// Library or executable
final String configuration = xcodePropertyAdapter.getConfiguration();
bridgeTask.dependsOn(target.getBinaries().stream().filter(it -> it.getBuildConfigurationName().equals(configuration)).findFirst().get().getOutputFile());
}
private void bridgeTestExecution(Task bridgeTask, final XcodeTarget target) {
// XCTest executable
// Sync the binary to the BUILT_PRODUCTS_DIR, otherwise Xcode won't find any tests
final String builtProductsPath = xcodePropertyAdapter.getBuiltProductsDir();
final Sync syncTask = project.getTasks().create("syncBundleToXcodeBuiltProductDir", Sync.class, new Action<Sync>() {
@Override
public void execute(Sync task) {
task.from(target.getDebugOutputFile());
task.into(builtProductsPath);
}
});
bridgeTask.dependsOn(syncTask);
}
}
private Action<ArtifactView.ViewConfiguration> fromSourceDependency() {
return new Action<ArtifactView.ViewConfiguration>() {
@Override
public void execute(ArtifactView.ViewConfiguration viewConfiguration) {
viewConfiguration.componentFilter(isSourceDependency());
}
};
}
private Spec<ComponentIdentifier> isSourceDependency() {
return new Spec<ComponentIdentifier>() {
@Override
public boolean isSatisfiedBy(ComponentIdentifier id) {
if (id instanceof ProjectComponentIdentifier) {
// Include as binary when the target project is not included in the workspace
return artifactRegistry.getIdeProject(XcodeProjectMetadata.class, (ProjectComponentIdentifier) id) == null;
}
return false;
}
};
}
}