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
|
// 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.annotations.VisibleForTesting;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.RuleContext;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.packages.RuleClass.ConfiguredTargetFactory.RuleErrorException;
import com.google.devtools.build.lib.rules.java.JavaUtil;
import com.google.devtools.build.lib.syntax.Type;
import com.google.devtools.build.lib.vfs.PathFragment;
import java.util.Objects;
import javax.annotation.Nullable;
/** Wraps an Android Manifest and provides utilities for working with it */
@Immutable
public class AndroidManifest {
private static final String CUSTOM_PACKAGE_ATTR = "custom_package";
private final Artifact manifest;
/** The Android package. Will be null if and only if this is an aar_import target. */
@Nullable private final String pkg;
private final boolean exported;
public static AndroidManifest forAarImport(RuleContext ruleContext, Artifact manifest) {
return new AndroidManifest(manifest, /* pkg = */ null, /* exported = */ true);
}
/**
* Gets the manifest for this rule.
*
* <p>If no manifest is specified in the rule's attributes, an empty manifest will be generated.
*/
public static AndroidManifest from(RuleContext ruleContext, AndroidSemantics androidSemantics)
throws RuleErrorException, InterruptedException {
if (!AndroidResources.definesAndroidResources(ruleContext.attributes())) {
// Generate a dummy manifest
return StampedAndroidManifest.createEmpty(ruleContext, /* exported = */ false);
}
AndroidResources.validateRuleContext(ruleContext);
return new AndroidManifest(
androidSemantics.getManifestForRule(ruleContext).getManifest(),
getAndroidPackage(ruleContext),
AndroidCommon.getExportsManifest(ruleContext));
}
AndroidManifest(AndroidManifest other, Artifact manifest) {
this(manifest, other.pkg, other.exported);
}
@VisibleForTesting
AndroidManifest(Artifact manifest, @Nullable String pkg, boolean exported) {
this.manifest = manifest;
this.pkg = pkg;
this.exported = exported;
}
/** If needed, stamps the manifest with the correct Java package */
public StampedAndroidManifest stamp(RuleContext ruleContext) {
return new StampedAndroidManifest(
ApplicationManifest.maybeSetManifestPackage(ruleContext, manifest, pkg).orElse(manifest),
pkg,
exported);
}
/**
* Merges the manifest with any dependent manifests.
*
* <p>The resulting manifest will be stamped, even if no merging was done.
*/
public StampedAndroidManifest mergeWithDeps(RuleContext ruleContext) {
return ApplicationManifest.maybeMergeWith(
ruleContext,
manifest,
ResourceDependencies.fromRuleDeps(ruleContext, /* neverlink = */ false),
ApplicationManifest.getManifestValues(ruleContext))
.map(merged -> new StampedAndroidManifest(merged, pkg, exported))
// If we don't merge, we still need to guarantee the manifest is stamped correctly
.orElseGet(() -> stamp(ruleContext));
}
public Artifact getManifest() {
return manifest;
}
@Nullable
String getPackage() {
return pkg;
}
boolean isExported() {
return exported;
}
/** Gets the Android package for this target, from either rule configuration or Java package */
private static String getAndroidPackage(RuleContext ruleContext) {
if (ruleContext.attributes().isAttributeValueExplicitlySpecified(CUSTOM_PACKAGE_ATTR)) {
return ruleContext.attributes().get(CUSTOM_PACKAGE_ATTR, Type.STRING);
}
return getDefaultPackage(ruleContext);
}
/** Gets the default Java package */
private static String getDefaultPackage(RuleContext ruleContext) {
PathFragment dummyJar = ruleContext.getPackageDirectory().getChild("Dummy.jar");
return getJavaPackageFromPath(ruleContext, dummyJar);
}
/**
* Gets the Java package of a JAR file based on it's path.
*
* <p>Bazel requires that all Java code (including Android code) be in a path prefixed with "java"
* or "javatests" followed by the Java package; this method validates and takes advantage of that
* requirement.
*
* @param ruleContext the current context
* @param jarPathFragment The path to a JAR file contained in the current BUILD file's directory.
* @return the Java package, as a String
*/
static String getJavaPackageFromPath(RuleContext ruleContext, PathFragment jarPathFragment) {
// TODO(bazel-team): JavaUtil.getJavaPackageName does not check to see if the path is valid.
// So we need to check for the JavaRoot.
if (JavaUtil.getJavaRoot(jarPathFragment) == null) {
ruleContext.ruleError(
"The location of your BUILD file determines the Java package used for "
+ "Android resource processing. A directory named \"java\" or \"javatests\" will "
+ "be used as your Java source root and the path of your BUILD file relative to "
+ "the Java source root will be used as the package for Android resource "
+ "processing. The Java source root could not be determined for \""
+ ruleContext.getPackageDirectory()
+ "\". Move your BUILD file under a java or javatests directory, or set the "
+ "'custom_package' attribute.");
}
return JavaUtil.getJavaPackageName(jarPathFragment);
}
@Override
public boolean equals(Object object) {
if (object == null || getClass() != object.getClass()) {
return false;
}
AndroidManifest other = (AndroidManifest) object;
return manifest.equals(other.manifest)
&& Objects.equals(pkg, other.pkg)
&& exported == other.exported;
}
@Override
public int hashCode() {
// Hash the current class with the other fields to distinguish between this AndroidManifest and
// classes that extend it.
return Objects.hash(manifest, pkg, exported, getClass());
}
}
|
