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
|
// Copyright 2018 The Bazel Authors. 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.android;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.Artifact.SpecialArtifact;
import com.google.devtools.build.lib.analysis.FileProvider;
import com.google.devtools.build.lib.analysis.RuleContext;
import com.google.devtools.build.lib.analysis.TransitiveInfoCollection;
import com.google.devtools.build.lib.analysis.configuredtargets.RuleConfiguredTarget.Mode;
import com.google.devtools.build.lib.packages.RuleClass.ConfiguredTargetFactory.RuleErrorException;
import com.google.devtools.build.lib.syntax.Type;
import com.google.devtools.build.lib.vfs.PathFragment;
/** Wraps this target's Android assets */
public final class AndroidAssets {
private static final String ASSETS_ATTR = "assets";
private static final String ASSETS_DIR_ATTR = "assets_dir";
static void validateAssetsAndAssetsDir(RuleContext ruleContext) throws RuleErrorException {
if (ruleContext.attributes().isAttributeValueExplicitlySpecified(ASSETS_ATTR)
^ ruleContext.attributes().isAttributeValueExplicitlySpecified(ASSETS_DIR_ATTR)) {
ruleContext.throwWithRuleError(
String.format(
"'%s' and '%s' should be either both empty or both non-empty",
ASSETS_ATTR, ASSETS_DIR_ATTR));
}
}
/** Collects this rule's android assets. */
public static AndroidAssets from(RuleContext ruleContext) throws RuleErrorException {
validateAssetsAndAssetsDir(ruleContext);
if (!ruleContext.attributes().has(ASSETS_ATTR)) {
return new AndroidAssets(ImmutableList.of(), ImmutableList.of());
}
PathFragment assetsDir = getAssetDir(ruleContext);
ImmutableList.Builder<Artifact> assets = ImmutableList.builder();
ImmutableList.Builder<PathFragment> assetRoots = ImmutableList.builder();
for (TransitiveInfoCollection target :
ruleContext.getPrerequisitesIf(ASSETS_ATTR, Mode.TARGET, FileProvider.class)) {
for (Artifact file : target.getProvider(FileProvider.class).getFilesToBuild()) {
PathFragment packageFragment =
file.getArtifactOwner().getLabel().getPackageIdentifier().getSourceRoot();
PathFragment packageRelativePath = file.getRootRelativePath().relativeTo(packageFragment);
if (packageRelativePath.startsWith(assetsDir)) {
PathFragment relativePath = packageRelativePath.relativeTo(assetsDir);
PathFragment path = file.getExecPath();
assetRoots.add(path.subFragment(0, path.segmentCount() - relativePath.segmentCount()));
} else {
ruleContext.attributeError(ASSETS_ATTR,
String.format(
"'%s' (generated by '%s') is not beneath '%s'",
file.getRootRelativePath(), target.getLabel(), assetsDir));
throw new RuleErrorException();
}
assets.add(file);
}
}
return new AndroidAssets(assets.build(), assetRoots.build());
}
private static PathFragment getAssetDir(RuleContext ruleContext) {
return PathFragment.create(ruleContext.attributes().get(ASSETS_DIR_ATTR, Type.STRING));
}
/**
* Creates a {@link AndroidAssets} containing all the assets in a directory artifact, for use with
* AarImport rules.
*
* <p>In general, {@link #from(RuleContext)} should be used instead, but it can't be for AarImport
* since we don't know about its individual assets at analysis time.
*
* @param assetsDir the tree artifact containing a {@code assets/} directory
*/
static AndroidAssets forAarImport(SpecialArtifact assetsDir) {
Preconditions.checkArgument(assetsDir.isTreeArtifact());
return new AndroidAssets(
ImmutableList.of(assetsDir), ImmutableList.of(assetsDir.getExecPath().getChild("assets")));
}
static AndroidAssets empty() {
return new AndroidAssets(ImmutableList.of(), ImmutableList.of());
}
private final ImmutableList<Artifact> assets;
private final ImmutableList<PathFragment> assetRoots;
private AndroidAssets(ImmutableList<Artifact> assets, ImmutableList<PathFragment> assetRoots) {
this.assets = assets;
this.assetRoots = assetRoots;
}
public ImmutableList<Artifact> getAssets() {
return assets;
}
public ImmutableList<PathFragment> getAssetRoots() {
return assetRoots;
}
}
|