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
|
// Copyright 2014 Google Inc. All rights reserved.
//
// 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 com.google.devtools.build.lib.rules.objc;
import static com.google.devtools.build.lib.rules.objc.ObjcProvider.MERGE_ZIP;
import com.google.common.base.Optional;
import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.ConfiguredTarget;
import com.google.devtools.build.lib.analysis.RuleConfiguredTargetBuilder;
import com.google.devtools.build.lib.analysis.RuleContext;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.rules.RuleConfiguredTargetFactory;
import com.google.devtools.build.lib.rules.objc.ReleaseBundlingSupport.LinkedBinary;
import com.google.devtools.build.lib.rules.objc.ReleaseBundlingSupport.SplitArchTransition.ConfigurationDistinguisher;
/**
* Base class for rules that bundle releases.
*/
public abstract class ReleaseBundlingTargetFactory implements RuleConfiguredTargetFactory {
/**
* Indicates whether a target factory should export an {@link ObjcProvider} containing itself as
* a nested bundle.
*/
protected enum ExposeAsNestedBundle { YES, NO }
private final String bundleDirFormat;
private final XcodeProductType xcodeProductType;
private final ExposeAsNestedBundle exposeAsNestedBundle;
private final ImmutableSet<Attribute> dependencyAttributes;
private final ConfigurationDistinguisher configurationDistinguisher;
/**
* @param bundleDirFormat format string representing the bundle's directory with a single
* placeholder for the target name (e.g. {@code "Payload/%s.app"})
* @param exposeAsNestedBundle whether to export an {@link ObjcProvider} with this target as a
* @param dependencyAttributes all attributes that contain dependencies of this rule. Any
* dependency so listed must expose {@link XcodeProvider} and {@link ObjcProvider}.
* @param configurationDistinguisher distinguisher used for cases where inputs from dependencies
* of this bundle may need distinguishing because they come from configurations that are only
* different by this value
*/
public ReleaseBundlingTargetFactory(String bundleDirFormat, XcodeProductType xcodeProductType,
ExposeAsNestedBundle exposeAsNestedBundle, ImmutableSet<Attribute> dependencyAttributes,
ConfigurationDistinguisher configurationDistinguisher) {
this.bundleDirFormat = bundleDirFormat;
this.xcodeProductType = xcodeProductType;
this.exposeAsNestedBundle = exposeAsNestedBundle;
this.dependencyAttributes = dependencyAttributes;
this.configurationDistinguisher = configurationDistinguisher;
}
@Override
public ConfiguredTarget create(RuleContext ruleContext) throws InterruptedException {
ObjcCommon common = common(ruleContext);
XcodeProvider.Builder xcodeProviderBuilder = new XcodeProvider.Builder();
NestedSetBuilder<Artifact> filesToBuild = NestedSetBuilder.stableOrder();
ReleaseBundlingSupport releaseBundlingSupport = new ReleaseBundlingSupport(
ruleContext, common.getObjcProvider(), optionsProvider(ruleContext),
LinkedBinary.DEPENDENCIES_ONLY, bundleDirFormat, bundleMinimumOsVersion(ruleContext));
releaseBundlingSupport
.registerActions()
.addXcodeSettings(xcodeProviderBuilder)
.addFilesToBuild(filesToBuild)
.validateResources()
.validateAttributes();
XcodeSupport xcodeSupport = new XcodeSupport(ruleContext)
.addFilesToBuild(filesToBuild)
.addXcodeSettings(xcodeProviderBuilder, common.getObjcProvider(), xcodeProductType,
ObjcRuleClasses.objcConfiguration(ruleContext).getDependencySingleArchitecture(),
configurationDistinguisher)
.addDummySource(xcodeProviderBuilder);
for (Attribute attribute : dependencyAttributes) {
xcodeSupport.addDependencies(xcodeProviderBuilder, attribute);
}
xcodeSupport.registerActions(xcodeProviderBuilder.build());
Optional<ObjcProvider> exposedObjcProvider;
if (exposeAsNestedBundle == ExposeAsNestedBundle.YES) {
exposedObjcProvider = Optional.of(new ObjcProvider.Builder()
.add(MERGE_ZIP, ruleContext.getImplicitOutputArtifact(ReleaseBundlingSupport.IPA))
.build());
} else {
exposedObjcProvider = Optional.absent();
}
RuleConfiguredTargetBuilder targetBuilder =
ObjcRuleClasses.ruleConfiguredTarget(ruleContext, filesToBuild.build())
.addProvider(XcTestAppProvider.class, releaseBundlingSupport.xcTestAppProvider())
.addProvider(XcodeProvider.class, xcodeProviderBuilder.build());
if (exposedObjcProvider.isPresent()) {
targetBuilder.addProvider(ObjcProvider.class, exposedObjcProvider.get());
}
configureTarget(targetBuilder, ruleContext, releaseBundlingSupport);
return targetBuilder.build();
}
/**
* Returns the minimum OS version this bundle's plist and resources should be generated for
* (<b>not</b> the minimum OS version its binary is compiled with, that needs to be set in the
* configuration).
*/
protected String bundleMinimumOsVersion(RuleContext ruleContext) {
return ObjcRuleClasses.objcConfiguration(ruleContext).getMinimumOs();
}
/**
* Returns a provider based on this rule's options and those of its option-providing dependencies.
*/
protected abstract OptionsProvider optionsProvider(RuleContext ruleContext);
/**
* Performs additional configuration of the target. The default implementation does nothing, but
* subclasses may override it to add logic.
*/
protected void configureTarget(RuleConfiguredTargetBuilder target, RuleContext ruleContext,
ReleaseBundlingSupport releaseBundlingSupport) {}
private ObjcCommon common(RuleContext ruleContext) {
ObjcCommon.Builder builder = new ObjcCommon.Builder(ruleContext)
.setIntermediateArtifacts(ObjcRuleClasses.intermediateArtifacts(ruleContext));
for (Attribute attribute : dependencyAttributes) {
builder.addDepObjcProviders(
ruleContext.getPrerequisites(
attribute.getName(), attribute.getAccessMode(), ObjcProvider.class));
}
return builder.build();
}
}
|
