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
|
// Copyright 2015 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.collect.ImmutableList;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.RuleContext;
import com.google.devtools.build.lib.analysis.actions.CustomCommandLine;
import com.google.devtools.build.lib.analysis.actions.SpawnAction;
import com.google.devtools.build.lib.analysis.actions.SymlinkAction;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.packages.RuleClass.ConfiguredTargetFactory.RuleErrorException;
import com.google.devtools.build.lib.rules.java.JavaCompilationArtifacts;
import com.google.devtools.build.lib.rules.java.JavaSemantics;
import com.google.devtools.build.lib.rules.java.JavaTargetAttributes;
import com.google.devtools.build.lib.rules.java.ProguardHelper.ProguardOutput;
import javax.annotation.Nullable;
/**
* Pluggable semantics for Android rules.
*
* <p>A new instance of this class is created for each configured target, therefore, it is allowed
* to keep state.
*/
public interface AndroidSemantics {
/**
* Add additional resources to IDE info for {@code android_binary} and {@code android_library}
*
* @param ruleContext rule context for target rule
* @param resourceApk resource apk directly provided by the rule
* @param ideInfoProviderBuilder
*/
void addNonLocalResources(
RuleContext ruleContext,
@Nullable ResourceApk resourceApk,
AndroidIdeInfoProvider.Builder ideInfoProviderBuilder);
/**
* Returns the manifest to be used when compiling a given rule.
*
* @throws InterruptedException
*/
default ApplicationManifest getManifestForRule(RuleContext ruleContext)
throws InterruptedException, RuleErrorException {
ApplicationManifest result = ApplicationManifest.fromRule(ruleContext);
Artifact manifest = result.getManifest();
if (manifest.getFilename().equals("AndroidManifest.xml")) {
return result;
} else {
/*
* If the manifest file is not named AndroidManifest.xml, we create a symlink named
* AndroidManifest.xml to it. aapt requires the manifest to be named as such.
*/
Artifact manifestSymlink =
ruleContext.getImplicitOutputArtifact(AndroidRuleClasses.ANDROID_SYMLINKED_MANIFEST);
SymlinkAction symlinkAction =
new SymlinkAction(
ruleContext.getActionOwner(), manifest, manifestSymlink, "Renaming Android manifest");
ruleContext.registerAction(symlinkAction);
return ApplicationManifest.fromExplicitManifest(ruleContext, manifestSymlink);
}
}
/** Returns the name of the file in which the file names of native dependencies are listed. */
String getNativeDepsFileName();
/**
* Returns the command line options to be used when compiling Java code for {@code android_*}
* rules.
*
* <p>These will come after the default options specified by the toolchain and the ones in the
* {@code javacopts} attribute.
*/
ImmutableList<String> getJavacArguments(RuleContext ruleContext);
/**
* Configures the builder for generating the output jar used to configure the main dex file.
*
* @throws InterruptedException
*/
void addMainDexListActionArguments(
RuleContext ruleContext,
SpawnAction.Builder builder,
CustomCommandLine.Builder commandLine,
Artifact proguardMap)
throws InterruptedException;
/** Given an Android {@code manifest}, returns a list of relevant Proguard specs. */
ImmutableList<Artifact> getProguardSpecsForManifest(RuleContext ruleContext, Artifact manifest);
/**
* Add coverage instrumentation to the Java compilation of an Android binary.
*
* @throws InterruptedException
*/
void addCoverageSupport(
RuleContext ruleContext,
AndroidCommon common,
JavaSemantics javaSemantics,
boolean forAndroidTest,
JavaTargetAttributes.Builder attributes,
JavaCompilationArtifacts.Builder artifactsBuilder)
throws InterruptedException;
/** Returns the list of attributes that may contribute Java runtime dependencies. */
ImmutableList<String> getAttributesWithJavaRuntimeDeps(RuleContext ruleContext);
/** A hook for checks of internal-only or external-only attributes of {@code android_binary}. */
default void validateAndroidBinaryRuleContext(RuleContext ruleContext) throws RuleErrorException {
}
/** The artifact for the map that proguard will output. */
Artifact getProguardOutputMap(RuleContext ruleContext) throws InterruptedException;
/** Maybe post process the dex files and proguard output map. */
AndroidBinary.DexPostprocessingOutput postprocessClassesDexZip(
RuleContext ruleContext,
NestedSetBuilder<Artifact> filesBuilder,
Artifact classesDexZip,
ProguardOutput proguardOutput)
throws InterruptedException;
}
|
