com.android.build.gradle.tasks.MergeSourceSetFolders Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-core Show documentation
Show all versions of gradle-core Show documentation
Core library to build Android Gradle plugin.
The newest version!
/*
* Copyright (C) 2012 The Android Open Source Project
*
* 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.android.build.gradle.tasks;
import com.android.annotations.NonNull;
import com.android.build.gradle.internal.core.GradleVariantConfiguration;
import com.android.build.gradle.internal.dsl.AaptOptions;
import com.android.build.gradle.internal.scope.ConventionMappingHelper;
import com.android.build.gradle.internal.scope.TaskConfigAction;
import com.android.build.gradle.internal.scope.VariantScope;
import com.android.build.gradle.internal.tasks.IncrementalTask;
import com.android.build.gradle.internal.variant.BaseVariantData;
import com.android.build.gradle.internal.variant.BaseVariantOutputData;
import com.android.builder.core.VariantConfiguration;
import com.android.builder.core.VariantType;
import com.android.ide.common.res2.AssetMerger;
import com.android.ide.common.res2.AssetSet;
import com.android.ide.common.res2.FileStatus;
import com.android.ide.common.res2.FileValidity;
import com.android.ide.common.res2.MergedAssetWriter;
import com.android.ide.common.res2.MergingException;
import com.android.utils.FileUtils;
import org.gradle.api.tasks.InputFiles;
import org.gradle.api.tasks.OutputDirectory;
import org.gradle.api.tasks.ParallelizableTask;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.Callable;
@ParallelizableTask
public class MergeSourceSetFolders extends IncrementalTask {
// ----- PUBLIC TASK API -----
private File outputDir;
@OutputDirectory
public File getOutputDir() {
return outputDir;
}
public void setOutputDir(File outputDir) {
this.outputDir = outputDir;
}
// ----- PRIVATE TASK API -----
@SuppressWarnings("unused") // fake input to detect changes. Not actually used by the task
@InputFiles
public Iterable getRawInputFolders() {
return IncrementalTask.flattenSourceSets(getInputDirectorySets());
}
// actual inputs
private List inputDirectorySets;
public List getInputDirectorySets() {
return inputDirectorySets;
}
public void setInputDirectorySets(List inputDirectorySets) {
this.inputDirectorySets = inputDirectorySets;
}
private final FileValidity fileValidity = new FileValidity<>();
@Override
protected boolean isIncremental() {
return true;
}
@Override
protected void doFullTaskAction() throws IOException {
// this is full run, clean the previous output
File destinationDir = getOutputDir();
FileUtils.cleanOutputDir(destinationDir);
List assetSets = getInputDirectorySets();
// create a new merger and populate it with the sets.
AssetMerger merger = new AssetMerger();
try {
for (AssetSet assetSet : assetSets) {
// set needs to be loaded.
assetSet.loadFromFiles(getILogger());
merger.addDataSet(assetSet);
}
// get the merged set and write it down.
MergedAssetWriter writer = new MergedAssetWriter(destinationDir);
merger.mergeData(writer, false /*doCleanUp*/);
// No exception? Write the known state.
merger.writeBlobTo(getIncrementalFolder(), writer, false);
} catch (MergingException e) {
getLogger().error("Could not merge source set folders: ", e);
merger.cleanBlob(getIncrementalFolder());
throw new ResourceException(e.getMessage(), e);
}
}
@Override
protected void doIncrementalTaskAction(Map changedInputs) throws IOException {
// create a merger and load the known state.
AssetMerger merger = new AssetMerger();
try {
if (!merger.loadFromBlob(getIncrementalFolder(), true /*incrementalState*/)) {
doFullTaskAction();
return;
}
// compare the known state to the current sets to detect incompatibility.
// This is in case there's a change that's too hard to do incrementally. In this case
// we'll simply revert to full build.
List assetSets = getInputDirectorySets();
if (!merger.checkValidUpdate(assetSets)) {
getLogger().info("Changed Asset sets: full task run!");
doFullTaskAction();
return;
}
// The incremental process is the following:
// Loop on all the changed files, find which ResourceSet it belongs to, then ask
// the resource set to update itself with the new file.
for (Map.Entry entry : changedInputs.entrySet()) {
File changedFile = entry.getKey();
// Ignore directories.
if (changedFile.isDirectory()) {
continue;
}
merger.findDataSetContaining(changedFile, fileValidity);
if (fileValidity.getStatus() == FileValidity.FileStatus.UNKNOWN_FILE) {
doFullTaskAction();
return;
} else if (fileValidity.getStatus() == FileValidity.FileStatus.VALID_FILE) {
if (!fileValidity.getDataSet().updateWith(
fileValidity.getSourceFile(),
changedFile,
entry.getValue(),
getILogger())) {
getLogger().info(
"Failed to process {} event! Full task run", entry.getValue());
doFullTaskAction();
return;
}
}
}
MergedAssetWriter writer = new MergedAssetWriter(getOutputDir());
merger.mergeData(writer, false /*doCleanUp*/);
// No exception? Write the known state.
merger.writeBlobTo(getIncrementalFolder(), writer, false);
} catch (MergingException e) {
getLogger().error("Could not merge source set folders: ", e);
merger.cleanBlob(getIncrementalFolder());
throw new ResourceException(e.getMessage(), e);
} finally {
// some clean up after the task to help multi variant/module builds.
fileValidity.clear();
}
}
protected abstract static class ConfigAction implements TaskConfigAction {
@NonNull
protected final VariantScope scope;
protected ConfigAction(@NonNull VariantScope scope) {
this.scope = scope;
}
@NonNull
@Override
public Class getType() {
return MergeSourceSetFolders.class;
}
@Override
public void execute(@NonNull MergeSourceSetFolders mergeAssetsTask) {
BaseVariantData variantData = scope.getVariantData();
VariantConfiguration variantConfig = variantData.getVariantConfiguration();
mergeAssetsTask.setAndroidBuilder(scope.getGlobalScope().getAndroidBuilder());
mergeAssetsTask.setVariantName(variantConfig.getFullName());
mergeAssetsTask.setIncrementalFolder(scope.getIncrementalDir(getName()));
}
}
public static class MergeAssetConfigAction extends ConfigAction {
public MergeAssetConfigAction(@NonNull VariantScope scope) {
super(scope);
}
@NonNull
@Override
public String getName() {
return scope.getTaskName("merge", "Assets");
}
@Override
public void execute(@NonNull MergeSourceSetFolders mergeAssetsTask) {
super.execute(mergeAssetsTask);
final BaseVariantData variantData =
scope.getVariantData();
final GradleVariantConfiguration variantConfig = variantData.getVariantConfiguration();
variantData.mergeAssetsTask = mergeAssetsTask;
final boolean includeDependencies = !variantConfig.getType()
.equals(VariantType.LIBRARY);
ConventionMappingHelper.map(mergeAssetsTask, "inputDirectorySets", () -> {
ArrayList generatedAssets = new ArrayList<>();
generatedAssets.add(scope.getShadersOutputDir());
if (variantData.copyApkTask != null) {
generatedAssets.add(variantData.copyApkTask.getDestinationDir());
}
List assetSets =
variantConfig.getAssetSets(generatedAssets, includeDependencies);
AaptOptions options = scope.getGlobalScope().getExtension().getAaptOptions();
if (options != null && options.getIgnoreAssets() != null) {
assetSets.forEach(as -> as.setIgnoredPatterns(options.getIgnoreAssets()));
}
return assetSets;
});
mergeAssetsTask.setOutputDir(scope.getMergeAssetsOutputDir());
}
}
public static class MergeJniLibFoldersConfigAction extends ConfigAction {
public MergeJniLibFoldersConfigAction(@NonNull VariantScope scope) {
super(scope);
}
@NonNull
@Override
public String getName() {
return scope.getTaskName("merge", "JniLibFolders");
}
@Override
public void execute(@NonNull MergeSourceSetFolders mergeAssetsTask) {
super.execute(mergeAssetsTask);
BaseVariantData variantData = scope.getVariantData();
final GradleVariantConfiguration variantConfig = variantData.getVariantConfiguration();
ConventionMappingHelper.map(mergeAssetsTask, "inputDirectorySets",
variantConfig::getJniLibsSets);
mergeAssetsTask.setOutputDir(scope.getMergeNativeLibsOutputDir());
}
}
public static class MergeShaderSourceFoldersConfigAction extends ConfigAction {
public MergeShaderSourceFoldersConfigAction(@NonNull VariantScope scope) {
super(scope);
}
@NonNull
@Override
public String getName() {
return scope.getTaskName("merge", "Shaders");
}
@Override
public void execute(@NonNull MergeSourceSetFolders mergeAssetsTask) {
super.execute(mergeAssetsTask);
BaseVariantData variantData = scope.getVariantData();
final GradleVariantConfiguration variantConfig = variantData.getVariantConfiguration();
ConventionMappingHelper.map(mergeAssetsTask, "inputDirectorySets",
(Callable>) variantConfig::getShaderSets);
mergeAssetsTask.setOutputDir(scope.getMergeShadersOutputDir());
}
}
}