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
|
// 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 com.google.common.base.Preconditions;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.Root;
import com.google.devtools.build.lib.analysis.AnalysisEnvironment;
import com.google.devtools.build.lib.analysis.AnalysisUtils;
import com.google.devtools.build.lib.syntax.Label;
import com.google.devtools.build.lib.vfs.FileSystemUtils;
import com.google.devtools.build.lib.vfs.PathFragment;
/**
* Factory class for generating artifacts which are used as intermediate output.
*/
// TODO(bazel-team): This should really be named DerivedArtifacts as it contains methods for
// final as well as intermediate artifacts.
final class IntermediateArtifacts {
/**
* Extension used on the temporary dsym bundle location. Must end in {@code .dSYM} for dsymutil
* to generate a plist file.
*/
static final String TMP_DSYM_BUNDLE_SUFFIX = ".temp.app.dSYM";
private final AnalysisEnvironment analysisEnvironment;
private final Root binDirectory;
private final Label ownerLabel;
private final String archiveFileNameSuffix;
IntermediateArtifacts(
AnalysisEnvironment analysisEnvironment, Root binDirectory, Label ownerLabel,
String archiveFileNameSuffix) {
this.analysisEnvironment = Preconditions.checkNotNull(analysisEnvironment);
this.binDirectory = Preconditions.checkNotNull(binDirectory);
this.ownerLabel = Preconditions.checkNotNull(ownerLabel);
this.archiveFileNameSuffix = Preconditions.checkNotNull(archiveFileNameSuffix);
}
/**
* Returns a derived artifact in the bin directory obtained by appending some extension to the end
* of the given {@link PathFragment}.
*/
private Artifact appendExtension(PathFragment original, String extension) {
return analysisEnvironment.getDerivedArtifact(
FileSystemUtils.appendExtension(original, extension), binDirectory);
}
/**
* Returns a derived artifact in the bin directory obtained by appending some extension to the end
* of the {@link PathFragment} corresponding to the owner {@link Label}.
*/
private Artifact appendExtension(String extension) {
return appendExtension(ownerLabel.toPathFragment(), extension);
}
/**
* The output of using {@code actooloribtoolzip} to run {@code actool} for a given bundle which is
* merged under the {@code .app} or {@code .bundle} directory root.
*/
public Artifact actoolzipOutput() {
return appendExtension(".actool.zip");
}
/**
* Output of the partial infoplist generated by {@code actool} when given the
* {@code --output-partial-info-plist [path]} flag.
*/
public Artifact actoolPartialInfoplist() {
return appendExtension(".actool-PartialInfo.plist");
}
/**
* The Info.plist file for a bundle which is comprised of more than one originating plist file.
* This is not needed for a bundle which has no source Info.plist files, or only one Info.plist
* file, since no merging occurs in that case.
*/
public Artifact mergedInfoplist() {
return appendExtension("-MergedInfo.plist");
}
/**
* The .objlist file, which contains a list of paths of object files to archive and is read by
* libtool in the archive action.
*/
public Artifact objList() {
return appendExtension(".objlist");
}
/**
* The artifact which is the binary (or library) which is comprised of one or more .a files linked
* together.
*/
public Artifact singleArchitectureBinary() {
return appendExtension("_bin");
}
/**
* Lipo binary generated by combining one or more linked binaries. This binary is the one included
* in generated bundles and invoked as entry point to the application.
*
* @param bundleDirSuffix suffix of the bundle containing this binary
*/
public Artifact combinedArchitectureBinary(String bundleDirSuffix) {
String baseName = ownerLabel.toPathFragment().getBaseName();
return appendExtension(bundleDirSuffix + "/" + baseName);
}
/**
* The {@code .a} file which contains all the compiled sources for a rule.
*/
public Artifact archive() {
PathFragment labelPath = ownerLabel.toPathFragment();
PathFragment rootRelative = labelPath
.getParentDirectory()
.getRelative(String.format("lib%s%s.a", labelPath.getBaseName(), archiveFileNameSuffix));
return analysisEnvironment.getDerivedArtifact(rootRelative, binDirectory);
}
/**
* The debug symbol bundle file which contains debug symbols generated by dsymutil.
*/
public Artifact dsymBundle() {
return appendExtension(TMP_DSYM_BUNDLE_SUFFIX);
}
/**
* The artifact for the .o file that should be generated when compiling the {@code source}
* artifact.
*/
public Artifact objFile(Artifact source) {
return analysisEnvironment.getDerivedArtifact(
FileSystemUtils.replaceExtension(
AnalysisUtils.getUniqueDirectory(ownerLabel, new PathFragment("_objs"))
.getRelative(source.getRootRelativePath()),
".o"),
binDirectory);
}
/**
* Returns the artifact corresponding to the pbxproj control file, which specifies the information
* required to generate the Xcode project file.
*/
public Artifact pbxprojControlArtifact() {
return appendExtension(".xcodeproj-control");
}
/**
* The artifact which contains the zipped-up results of compiling the storyboard. This is merged
* into the final bundle under the {@code .app} or {@code .bundle} directory root.
*/
public Artifact compiledStoryboardZip(Artifact input) {
return appendExtension("/" + BundleableFile.bundlePath(input.getExecPath()) + ".zip");
}
/**
* Returns the artifact which is the output of building an entire xcdatamodel[d] made of artifacts
* specified by a single rule.
*
* @param containerDir the containing *.xcdatamodeld or *.xcdatamodel directory
* @return the artifact for the zipped up compilation results.
*/
public Artifact compiledMomZipArtifact(PathFragment containerDir) {
return appendExtension(
"/" + FileSystemUtils.replaceExtension(containerDir, ".zip").getBaseName());
}
/**
* Returns the compiled (i.e. converted to binary plist format) artifact corresponding to the
* given {@code .strings} file.
*/
public Artifact convertedStringsFile(Artifact originalFile) {
return appendExtension(originalFile.getExecPath(), ".binary");
}
/**
* Returns the artifact corresponding to the zipped-up compiled form of the given {@code .xib}
* file.
*/
public Artifact compiledXibFileZip(Artifact originalFile) {
return analysisEnvironment.getDerivedArtifact(
FileSystemUtils.replaceExtension(originalFile.getExecPath(), ".nib.zip"),
binDirectory);
}
/**
* Debug symbol plist generated for a linked binary.
*/
public Artifact dsymPlist() {
return appendExtension(".app.dSYM/Contents/Info.plist");
}
/**
* Debug symbol file generated for a linked binary.
*/
public Artifact dsymSymbol() {
return appendExtension(
String.format(".app.dSYM/Contents/Resources/DWARF/%s_bin", ownerLabel.getName()));
}
/**
* Breakpad debug symbol representation.
*/
public Artifact breakpadSym() {
return appendExtension(".breakpad");
}
}
|
