com.android.build.gradle.tasks.GenerateSplitAbiRes 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
Core library to build Android Gradle plugin.
The newest version!
/*
 * Copyright (C) 2014 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.aapt.AaptGradleFactory;
import com.android.build.gradle.internal.dsl.AaptOptions;
import com.android.build.gradle.internal.dsl.AbiSplitOptions;
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.BaseTask;
import com.android.build.gradle.internal.variant.ApkVariantOutputData;
import com.android.builder.core.VariantConfiguration;
import com.android.builder.internal.aapt.Aapt;
import com.android.builder.internal.aapt.AaptPackageConfig;
import com.android.ide.common.process.ProcessException;
import com.android.utils.FileUtils;
import com.google.common.base.CharMatcher;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.util.List;
import java.util.Set;
import java.util.concurrent.Callable;
import java.util.stream.Collectors;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.Nested;
import org.gradle.api.tasks.Optional;
import org.gradle.api.tasks.OutputFiles;
import org.gradle.api.tasks.ParallelizableTask;
import org.gradle.api.tasks.TaskAction;

/**
 * Generates all metadata (like AndroidManifest.xml) necessary for a ABI dimension split APK.
 */
@ParallelizableTask
public class GenerateSplitAbiRes extends BaseTask {

    private String applicationId;

    private String outputBaseName;

    private Set splits;

    private File outputDirectory;

    private boolean debuggable;

    private AaptOptions aaptOptions;

    private ApkVariantOutputData variantOutputData;

    @SuppressWarnings("unused") // Synthetic task output
    @OutputFiles
    public List getOutputFiles() {
        return getSplits().stream()
                .map(this::getOutputFileForSplit).collect(Collectors.toList());
    }

    @TaskAction
    protected void doFullTaskAction() throws IOException, InterruptedException, ProcessException {

        for (String split : getSplits()) {
            String resPackageFileName = getOutputFileForSplit(split).getAbsolutePath();

            File tmpDirectory = new File(getOutputDirectory(), getOutputBaseName());
            tmpDirectory.mkdirs();

            File tmpFile = new File(tmpDirectory, "AndroidManifest.xml");

            String versionNameToUse = getVersionName();
            if (versionNameToUse == null) {
                versionNameToUse = String.valueOf(getVersionCode());
            }

            try (OutputStreamWriter fileWriter =
                         new OutputStreamWriter(new FileOutputStream(tmpFile), "UTF-8")) {
                // Split name can only contains 0-9, a-z, A-Z, '.' and '_'.  Replace all other
                // characters with underscore.
                String splitName = CharMatcher.inRange('0', '9')
                        .or(CharMatcher.inRange('A', 'Z'))
                        .or(CharMatcher.inRange('a', 'z'))
                        .or(CharMatcher.is('_'))
                        .or(CharMatcher.is('.'))
                        .negate()
                        .replaceFrom(split + "_" + getOutputBaseName(), '_');
                fileWriter.append("\n"
                        + "\n"
                        + "       \n" + " ");
                fileWriter.flush();
            }

            Aapt aapt =
                    AaptGradleFactory.make(
                            getBuilder(),
                            variantOutputData.getScope().getVariantScope(),
                            FileUtils.mkdirs(
                                    new File(
                                            variantOutputData
                                                    .getScope()
                                                    .getVariantScope()
                                                    .getIncrementalDir(getName()),
                                            "aapt-temp")));
            AaptPackageConfig.Builder aaptConfig = new AaptPackageConfig.Builder();
            aaptConfig
                    .setManifestFile(tmpFile)
                    .setOptions(getAaptOptions())
                    .setDebuggable(isDebuggable())
                    .setResourceOutputApk(new File(resPackageFileName))
                    .setVariantType(
                            variantOutputData.getScope()
                                    .getVariantScope().getVariantConfiguration().getType());

            getBuilder().processResources(
                    aapt,
                    aaptConfig,
                    false /* enforceUniquePackageName */);
        }
    }

    private File getOutputFileForSplit(final String split) {
        return new File(getOutputDirectory(),
                "resources-" + getOutputBaseName() + "-" + split + ".ap_");
    }

    @Input
    public String getApplicationId() {
        return applicationId;
    }

    public void setApplicationId(String applicationId) {
        this.applicationId = applicationId;
    }

    @Input
    public int getVersionCode() {
        return variantOutputData.getVersionCode();
    }

    @Input
    @Optional
    public String getVersionName() {
        return variantOutputData.getVersionName();
    }

    @Input
    public String getOutputBaseName() {
        return outputBaseName;
    }

    public void setOutputBaseName(String outputBaseName) {
        this.outputBaseName = outputBaseName;
    }

    @Input
    public Set getSplits() {
        return splits;
    }

    public void setSplits(Set splits) {
        this.splits = splits;
    }

    public File getOutputDirectory() {
        return outputDirectory;
    }

    public void setOutputDirectory(File outputDirectory) {
        this.outputDirectory = outputDirectory;
    }

    @Input
    public boolean isDebuggable() {
        return debuggable;
    }

    public void setDebuggable(boolean debuggable) {
        this.debuggable = debuggable;
    }

    @Nested
    public AaptOptions getAaptOptions() {
        return aaptOptions;
    }

    public void setAaptOptions(AaptOptions aaptOptions) {
        this.aaptOptions = aaptOptions;
    }

    // ----- ConfigAction -----

    public static class ConfigAction implements TaskConfigAction {

        private VariantScope scope;

        public ConfigAction(VariantScope scope) {
            this.scope = scope;
        }

        @Override
        @NonNull
        public String getName() {
            return scope.getTaskName("generate", "SplitAbiRes");
        }

        @Override
        @NonNull
        public Class getType() {
            return GenerateSplitAbiRes.class;
        }

        @Override
        public void execute(@NonNull GenerateSplitAbiRes generateSplitAbiRes) {
            final VariantConfiguration config = scope.getVariantConfiguration();
            Set filters = AbiSplitOptions.getAbiFilters(
                    scope.getGlobalScope().getExtension().getSplits().getAbiFilters());

            generateSplitAbiRes.setAndroidBuilder(scope.getGlobalScope().getAndroidBuilder());
            generateSplitAbiRes.setVariantName(config.getFullName());

            generateSplitAbiRes.setOutputDirectory(scope.getGenerateSplitAbiResOutputDirectory());
            generateSplitAbiRes.setSplits(filters);
            generateSplitAbiRes.setOutputBaseName(config.getBaseName());
            generateSplitAbiRes.setApplicationId(config.getApplicationId());
            generateSplitAbiRes.variantOutputData =
                    (ApkVariantOutputData) scope.getVariantData().getMainOutput();
            ConventionMappingHelper.map(generateSplitAbiRes, "debuggable", new Callable() {
                @Override
                public Boolean call() throws Exception {
                    return config.getBuildType().isDebuggable();
                }
            });
            ConventionMappingHelper.map(generateSplitAbiRes, "aaptOptions",
                    new Callable() {
                        @Override
                        public AaptOptions call() throws Exception {
                            return scope.getGlobalScope().getExtension().getAaptOptions();
                        }
                    });
        }
    }
}