| /* |
| * Copyright 2012-present Facebook, Inc. |
| * |
| * 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.facebook.buck.android; |
| |
| import com.facebook.buck.model.BuildTarget; |
| import com.facebook.buck.model.BuildTargets; |
| import com.facebook.buck.rules.AbstractBuildRule; |
| import com.facebook.buck.rules.BuildContext; |
| import com.facebook.buck.rules.BuildRule; |
| import com.facebook.buck.rules.BuildRuleParams; |
| import com.facebook.buck.rules.BuildableContext; |
| import com.facebook.buck.rules.RuleKey; |
| import com.facebook.buck.rules.SourcePath; |
| import com.facebook.buck.rules.SourcePathResolver; |
| import com.facebook.buck.step.Step; |
| import com.facebook.buck.step.fs.MkdirStep; |
| import com.facebook.buck.step.fs.RmStep; |
| import com.google.common.collect.ImmutableCollection; |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.ImmutableSet; |
| import com.google.common.collect.ImmutableSortedSet; |
| import com.google.common.collect.Iterables; |
| |
| import java.nio.file.Path; |
| import java.util.Collections; |
| import java.util.Set; |
| |
| /** |
| * {@link AndroidManifest} is a {@link BuildRule} that can generate an Android manifest from a |
| * skeleton manifest and the library manifests from its dependencies. |
| * <pre> |
| * android_manifest( |
| * name = 'my_manifest', |
| * skeleton = 'AndroidManifestSkeleton.xml', |
| * deps = [ |
| * ':sample_manifest', |
| * # Additional dependent android_resource and android_library rules would be listed here, |
| * # as well. |
| * ], |
| * ) |
| * </pre> |
| * This will produce a file under buck-out/gen that will be parameterized by the name of the |
| * {@code android_manifest} rule. This can be used as follows: |
| * <pre> |
| * android_binary( |
| * name = 'my_app', |
| * manifest = ':my_manifest', |
| * ... |
| * ) |
| * </pre> |
| */ |
| public class AndroidManifest extends AbstractBuildRule { |
| |
| private final SourcePath skeletonFile; |
| |
| /** These must be sorted so {@link #getInputsToCompareToOutput} returns a consistent value. */ |
| private final ImmutableSortedSet<SourcePath> manifestFiles; |
| |
| private final Path pathToOutputFile; |
| |
| protected AndroidManifest( |
| BuildRuleParams params, |
| SourcePathResolver resolver, |
| SourcePath skeletonFile, |
| Set<SourcePath> manifestFiles) { |
| super(params, resolver); |
| this.skeletonFile = skeletonFile; |
| this.manifestFiles = ImmutableSortedSet.copyOf(manifestFiles); |
| BuildTarget buildTarget = params.getBuildTarget(); |
| this.pathToOutputFile = BuildTargets.getGenPath(buildTarget, "AndroidManifest__%s__.xml"); |
| } |
| |
| @Override |
| public ImmutableCollection<Path> getInputsToCompareToOutput() { |
| return getResolver().filterInputsToCompareToOutput( |
| Iterables.concat( |
| Collections.singleton(skeletonFile), |
| manifestFiles)); |
| } |
| |
| @Override |
| public RuleKey.Builder appendDetailsToRuleKey(RuleKey.Builder builder) { |
| return builder; |
| } |
| |
| @Override |
| public ImmutableList<Step> getBuildSteps( |
| BuildContext context, |
| BuildableContext buildableContext) { |
| |
| ImmutableList.Builder<Step> commands = ImmutableList.builder(); |
| |
| // Clear out the old file, if it exists. |
| commands.add(new RmStep(pathToOutputFile, |
| /* shouldForceDeletion */ true, |
| /* shouldRecurse */ false)); |
| |
| // Make sure the directory for the output file exists. |
| commands.add(new MkdirStep(pathToOutputFile.getParent())); |
| |
| commands.add(new GenerateManifestStep( |
| getResolver().getPath(skeletonFile), |
| ImmutableSet.copyOf(getResolver().getAllPaths(manifestFiles)), |
| getPathToOutputFile())); |
| |
| buildableContext.recordArtifact(pathToOutputFile); |
| return commands.build(); |
| } |
| |
| @Override |
| public Path getPathToOutputFile() { |
| return pathToOutputFile; |
| } |
| } |