blob: c9228d30793421c7f70c3e7b2e5957fe74ed8ebb [file] [log] [blame]
// 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.base.Strings;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.ParameterFile.ParameterFileType;
import com.google.devtools.build.lib.analysis.RuleContext;
import com.google.devtools.build.lib.analysis.actions.ActionConstructionContext;
import com.google.devtools.build.lib.analysis.actions.CustomCommandLine;
import com.google.devtools.build.lib.analysis.actions.CustomCommandLine.Builder;
import com.google.devtools.build.lib.analysis.actions.CustomCommandLine.VectorArg;
import com.google.devtools.build.lib.analysis.actions.ParamFileInfo;
import com.google.devtools.build.lib.analysis.actions.SpawnAction;
import com.google.devtools.build.lib.analysis.configuredtargets.RuleConfiguredTarget.Mode;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.rules.android.AndroidConfiguration.AndroidAaptVersion;
import com.google.devtools.build.lib.rules.android.ResourceContainerConverter.Builder.SeparatorType;
import com.google.devtools.build.lib.util.OS;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/**
* Builder for creating resource processing action.
*/
public class AndroidResourcesProcessorBuilder {
private static final ResourceContainerConverter.ToArg AAPT2_RESOURCE_DEP_TO_ARG =
ResourceContainerConverter.builder()
.includeResourceRoots()
.includeManifest()
.includeAapt2RTxt()
.includeSymbolsBin()
.includeCompiledSymbols()
.withSeparator(SeparatorType.COLON_COMMA)
.toArgConverter();
private static final ResourceContainerConverter.ToArg RESOURCE_CONTAINER_TO_ARG =
ResourceContainerConverter.builder()
.includeResourceRoots()
.includeManifest()
.withSeparator(SeparatorType.COLON_COMMA)
.toArgConverter();
private static final ResourceContainerConverter.ToArg RESOURCE_DEP_TO_ARG =
ResourceContainerConverter.builder()
.includeResourceRoots()
.includeManifest()
.includeRTxt()
.includeSymbolsBin()
.withSeparator(SeparatorType.COLON_COMMA)
.toArgConverter();
private ResourceContainer primary;
private ResourceDependencies dependencies;
private Artifact proguardOut;
private Artifact mainDexProguardOut;
private Artifact rTxtOut;
private Artifact sourceJarOut;
private boolean debug = false;
private ResourceFilterFactory resourceFilterFactory;
private List<String> uncompressedExtensions = Collections.emptyList();
private Artifact apkOut;
private final AndroidSdkProvider sdk;
private SpawnAction.Builder spawnActionBuilder;
private String customJavaPackage;
private final RuleContext ruleContext;
private String versionCode;
private String applicationId;
private String versionName;
private Artifact symbols;
private Artifact dataBindingInfoZip;
private Artifact manifestOut;
private Artifact mergedResourcesOut;
private boolean isLibrary;
private boolean crunchPng = true;
private Artifact featureOf;
private Artifact featureAfter;
private AndroidAaptVersion aaptVersion;
private boolean throwOnResourceConflict;
private String packageUnderTest;
/**
* @param ruleContext The RuleContext that was used to create the SpawnAction.Builder.
*/
public AndroidResourcesProcessorBuilder(RuleContext ruleContext) {
this.sdk = AndroidSdkProvider.fromRuleContext(ruleContext);
this.ruleContext = ruleContext;
this.spawnActionBuilder = new SpawnAction.Builder();
this.resourceFilterFactory = ResourceFilterFactory.empty(ruleContext);
}
/**
* The primary resource for merging. This resource will overwrite any resource or data
* value in the transitive closure.
*/
public AndroidResourcesProcessorBuilder withPrimary(ResourceContainer primary) {
this.primary = primary;
return this;
}
/**
* The output zip for resource-processed data binding expressions (i.e. a zip of .xml files).
* If null, data binding processing is skipped (and data binding expressions aren't allowed in
* layout resources).
*/
public AndroidResourcesProcessorBuilder setDataBindingInfoZip(Artifact zip) {
this.dataBindingInfoZip = zip;
return this;
}
public AndroidResourcesProcessorBuilder withDependencies(ResourceDependencies resourceDeps) {
this.dependencies = resourceDeps;
return this;
}
public AndroidResourcesProcessorBuilder setUncompressedExtensions(
List<String> uncompressedExtensions) {
this.uncompressedExtensions = uncompressedExtensions;
return this;
}
public AndroidResourcesProcessorBuilder setCrunchPng(boolean crunchPng) {
this.crunchPng = crunchPng;
return this;
}
public AndroidResourcesProcessorBuilder setResourceFilterFactory(
ResourceFilterFactory resourceFilterFactory) {
this.resourceFilterFactory = resourceFilterFactory;
return this;
}
public AndroidResourcesProcessorBuilder setDebug(boolean debug) {
this.debug = debug;
return this;
}
public AndroidResourcesProcessorBuilder setProguardOut(Artifact proguardCfg) {
this.proguardOut = proguardCfg;
return this;
}
public AndroidResourcesProcessorBuilder setMainDexProguardOut(Artifact mainDexProguardCfg) {
this.mainDexProguardOut = mainDexProguardCfg;
return this;
}
public AndroidResourcesProcessorBuilder setRTxtOut(Artifact rTxtOut) {
this.rTxtOut = rTxtOut;
return this;
}
public AndroidResourcesProcessorBuilder setSymbols(Artifact symbols) {
this.symbols = symbols;
return this;
}
public AndroidResourcesProcessorBuilder setApkOut(Artifact apkOut) {
this.apkOut = apkOut;
return this;
}
public AndroidResourcesProcessorBuilder setSourceJarOut(Artifact sourceJarOut) {
this.sourceJarOut = sourceJarOut;
return this;
}
public AndroidResourcesProcessorBuilder setManifestOut(Artifact manifestOut) {
this.manifestOut = manifestOut;
return this;
}
public AndroidResourcesProcessorBuilder setMergedResourcesOut(Artifact mergedResourcesOut) {
this.mergedResourcesOut = mergedResourcesOut;
return this;
}
public AndroidResourcesProcessorBuilder setLibrary(boolean isLibrary) {
this.isLibrary = isLibrary;
return this;
}
public AndroidResourcesProcessorBuilder setFeatureOf(Artifact featureOf) {
this.featureOf = featureOf;
return this;
}
public AndroidResourcesProcessorBuilder setFeatureAfter(Artifact featureAfter) {
this.featureAfter = featureAfter;
return this;
}
public AndroidResourcesProcessorBuilder targetAaptVersion(AndroidAaptVersion aaptVersion) {
this.aaptVersion = aaptVersion;
return this;
}
public AndroidResourcesProcessorBuilder setThrowOnResourceConflict(
boolean throwOnResourceConflict) {
this.throwOnResourceConflict = throwOnResourceConflict;
return this;
}
public ResourceContainer build(ActionConstructionContext context) {
if (aaptVersion == AndroidAaptVersion.AAPT2) {
return createAapt2ApkAction(context);
}
return createAaptAction(context);
}
public AndroidResourcesProcessorBuilder setJavaPackage(String customJavaPackage) {
this.customJavaPackage = customJavaPackage;
return this;
}
public AndroidResourcesProcessorBuilder setVersionCode(String versionCode) {
this.versionCode = versionCode;
return this;
}
public AndroidResourcesProcessorBuilder setApplicationId(String applicationId) {
if (applicationId != null && !applicationId.isEmpty()) {
this.applicationId = applicationId;
}
return this;
}
public AndroidResourcesProcessorBuilder setVersionName(String versionName) {
this.versionName = versionName;
return this;
}
public AndroidResourcesProcessorBuilder setPackageUnderTest(String packageUnderTest) {
this.packageUnderTest = packageUnderTest;
return this;
}
private ResourceContainer createAapt2ApkAction(ActionConstructionContext context) {
List<Artifact> outs = new ArrayList<>();
// TODO(corysmith): Convert to an immutable list builder, as there is no benefit to a NestedSet
// here, as it will already have been flattened.
NestedSetBuilder<Artifact> inputs = NestedSetBuilder.naiveLinkOrder();
CustomCommandLine.Builder builder = new CustomCommandLine.Builder();
// Set the busybox tool.
builder.add("--tool").add("AAPT2_PACKAGE").add("--");
builder.addExecPath("--aapt2", sdk.getAapt2().getExecutable());
if (dependencies != null) {
ResourceContainerConverter.addToCommandLine(dependencies, builder, AAPT2_RESOURCE_DEP_TO_ARG);
inputs
.addTransitive(dependencies.getTransitiveResources())
.addTransitive(dependencies.getTransitiveAssets())
.addTransitive(dependencies.getTransitiveManifests())
.addTransitive(dependencies.getTransitiveAapt2RTxt())
.addTransitive(dependencies.getTransitiveSymbolsBin())
.addTransitive(dependencies.getTransitiveCompiledSymbols());
}
configureCommonFlags(outs, inputs, builder);
ParamFileInfo.Builder paramFileInfo = ParamFileInfo.builder(ParameterFileType.SHELL_QUOTED);
// Some flags (e.g. --mainData) may specify lists (or lists of lists) separated by special
// characters (colon, semicolon, hashmark, ampersand) that don't work on Windows, and quoting
// semantics are very complicated (more so than in Bash), so let's just always use a parameter
// file.
// TODO(laszlocsomor), TODO(corysmith): restructure the Android BusyBux's flags by deprecating
// list-type and list-of-list-type flags that use such problematic separators in favor of
// multi-value flags (to remove one level of listing) and by changing all list separators to a
// platform-safe character (= comma).
paramFileInfo.setUseAlways(OS.getCurrent() == OS.WINDOWS);
// Create the spawn action.
ruleContext.registerAction(
this.spawnActionBuilder
.useDefaultShellEnvironment()
.useDefaultShellEnvironment()
.addTool(sdk.getAapt2())
.addTransitiveInputs(inputs.build())
.addOutputs(ImmutableList.<Artifact>copyOf(outs))
.addCommandLine(builder.build(), paramFileInfo.build())
.setExecutable(
ruleContext.getExecutablePrerequisite("$android_resources_busybox", Mode.HOST))
.setProgressMessage("Processing Android resources for %s", ruleContext.getLabel())
.setMnemonic("AndroidAapt2")
.build(context));
// Return the full set of processed transitive dependencies.
ResourceContainer.Builder result =
primary.toBuilder().setJavaSourceJar(sourceJarOut).setRTxt(rTxtOut).setSymbols(symbols);
// If there is an apk to be generated, use it, else reuse the apk from the primary resources.
// All android_binary ResourceContainers have to have an apk, but if a new one is not
// requested to be built for this resource processing action (in case of just creating an
// R.txt or proguard merging), reuse the primary resource from the dependencies.
if (apkOut != null) {
result.setApk(apkOut);
}
if (manifestOut != null) {
result.setManifest(manifestOut);
}
return result.build();
}
private ResourceContainer createAaptAction(ActionConstructionContext context) {
List<Artifact> outs = new ArrayList<>();
// TODO(corysmith): Convert to an immutable list builder, as there is no benefit to a NestedSet
// here, as it will already have been flattened.
NestedSetBuilder<Artifact> inputs = NestedSetBuilder.naiveLinkOrder();
CustomCommandLine.Builder builder = new CustomCommandLine.Builder();
// Set the busybox tool.
builder.add("--tool").add("PACKAGE").add("--");
if (dependencies != null) {
ResourceContainerConverter.addToCommandLine(dependencies, builder, RESOURCE_DEP_TO_ARG);
inputs
.addTransitive(dependencies.getTransitiveResources())
.addTransitive(dependencies.getTransitiveAssets())
.addTransitive(dependencies.getTransitiveManifests())
.addTransitive(dependencies.getTransitiveRTxt())
.addTransitive(dependencies.getTransitiveSymbolsBin());
}
builder.addExecPath("--aapt", sdk.getAapt().getExecutable());
configureCommonFlags(outs, inputs, builder);
ParamFileInfo.Builder paramFileInfo = ParamFileInfo.builder(ParameterFileType.SHELL_QUOTED);
// Some flags (e.g. --mainData) may specify lists (or lists of lists) separated by special
// characters (colon, semicolon, hashmark, ampersand) that don't work on Windows, and quoting
// semantics are very complicated (more so than in Bash), so let's just always use a parameter
// file.
// TODO(laszlocsomor), TODO(corysmith): restructure the Android BusyBux's flags by deprecating
// list-type and list-of-list-type flags that use such problematic separators in favor of
// multi-value flags (to remove one level of listing) and by changing all list separators to a
// platform-safe character (= comma).
paramFileInfo.setUseAlways(OS.getCurrent() == OS.WINDOWS);
// Create the spawn action.
ruleContext.registerAction(
this.spawnActionBuilder
.useDefaultShellEnvironment()
.useDefaultShellEnvironment()
.addTool(sdk.getAapt())
.addTransitiveInputs(inputs.build())
.addOutputs(ImmutableList.copyOf(outs))
.addCommandLine(builder.build(), paramFileInfo.build())
.setExecutable(
ruleContext.getExecutablePrerequisite("$android_resources_busybox", Mode.HOST))
.setProgressMessage("Processing Android resources for %s", ruleContext.getLabel())
.setMnemonic("AaptPackage")
.build(context));
// Return the full set of processed transitive dependencies.
ResourceContainer.Builder result =
primary.toBuilder().setJavaSourceJar(sourceJarOut).setRTxt(rTxtOut).setSymbols(symbols);
// If there is an apk to be generated, use it, else reuse the apk from the primary resources.
// All android_binary ResourceContainers have to have an apk, but if a new one is not
// requested to be built for this resource processing action (in case of just creating an
// R.txt or proguard merging), reuse the primary resource from the dependencies.
if (apkOut != null) {
result.setApk(apkOut);
}
if (manifestOut != null) {
result.setManifest(manifestOut);
}
return result.build();
}
private void configureCommonFlags(
List<Artifact> outs, NestedSetBuilder<Artifact> inputs, Builder builder) {
// Add data
builder.add("--primaryData", RESOURCE_CONTAINER_TO_ARG.apply(primary));
inputs.addAll(primary.getArtifacts());
inputs.add(primary.getManifest());
if (!Strings.isNullOrEmpty(sdk.getBuildToolsVersion())) {
builder.add("--buildToolsVersion", sdk.getBuildToolsVersion());
}
builder.addExecPath("--annotationJar", sdk.getAnnotationsJar());
inputs.add(sdk.getAnnotationsJar());
builder.addExecPath("--androidJar", sdk.getAndroidJar());
inputs.add(sdk.getAndroidJar());
if (isLibrary) {
builder.add("--packageType").add("LIBRARY");
}
if (rTxtOut != null) {
builder.addExecPath("--rOutput", rTxtOut);
outs.add(rTxtOut);
}
if (symbols != null) {
builder.addExecPath("--symbolsOut", symbols);
outs.add(symbols);
}
if (sourceJarOut != null) {
builder.addExecPath("--srcJarOutput", sourceJarOut);
outs.add(sourceJarOut);
}
if (proguardOut != null) {
builder.addExecPath("--proguardOutput", proguardOut);
outs.add(proguardOut);
}
if (mainDexProguardOut != null) {
builder.addExecPath("--mainDexProguardOutput", mainDexProguardOut);
outs.add(mainDexProguardOut);
}
if (manifestOut != null) {
builder.addExecPath("--manifestOutput", manifestOut);
outs.add(manifestOut);
}
if (mergedResourcesOut != null) {
builder.addExecPath("--resourcesOutput", mergedResourcesOut);
outs.add(mergedResourcesOut);
}
if (apkOut != null) {
builder.addExecPath("--packagePath", apkOut);
outs.add(apkOut);
}
if (resourceFilterFactory.hasConfigurationFilters()) {
// Always pass filters to aapt, even if we filtered in analysis, since aapt is stricter and
// might remove resources that we previously accepted.
builder.add("--resourceConfigs", resourceFilterFactory.getConfigurationFilterString());
}
if (resourceFilterFactory.hasDensities()) {
// If we did not filter by density in analysis, filter in execution. Otherwise, don't filter
// in execution, but still pass the densities so they can be added to the manifest.
if (resourceFilterFactory.isPrefiltering()) {
builder.add("--densitiesForManifest", resourceFilterFactory.getDensityString());
} else {
builder.add("--densities", resourceFilterFactory.getDensityString());
}
}
ImmutableList<String> filteredResources =
resourceFilterFactory.getResourcesToIgnoreInExecution();
if (!filteredResources.isEmpty()) {
builder.addAll("--prefilteredResources", VectorArg.join(",").each(filteredResources));
}
if (!uncompressedExtensions.isEmpty()) {
builder.addAll("--uncompressedExtensions", VectorArg.join(",").each(uncompressedExtensions));
}
if (!crunchPng) {
builder.add("--useAaptCruncher=no");
}
if (debug) {
builder.add("--debug");
}
if (versionCode != null) {
builder.add("--versionCode", versionCode);
}
if (versionName != null) {
builder.add("--versionName", versionName);
}
if (applicationId != null) {
builder.add("--applicationId", applicationId);
}
if (dataBindingInfoZip != null) {
builder.addExecPath("--dataBindingInfoOut", dataBindingInfoZip);
outs.add(dataBindingInfoZip);
}
if (!Strings.isNullOrEmpty(customJavaPackage)) {
// Sets an alternative java package for the generated R.java
// this allows android rules to generate resources outside of the java{,tests} tree.
builder.add("--packageForR", customJavaPackage);
}
if (featureOf != null) {
builder.addExecPath("--featureOf", featureOf);
inputs.add(featureOf);
}
if (featureAfter != null) {
builder.addExecPath("--featureAfter", featureAfter);
inputs.add(featureAfter);
}
if (throwOnResourceConflict) {
builder.add("--throwOnResourceConflict");
}
if (packageUnderTest != null) {
builder.add("--packageUnderTest", packageUnderTest);
}
}
}