com.facebook.buck.rules.modern

Class ModernBuildRule<T extends Buildable>

java.lang.Object

com.facebook.buck.core.rules.impl.AbstractBuildRule

com.facebook.buck.rules.modern.ModernBuildRule<T>

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, SupportsInputBasedRuleKey, BuildRule, HasNameAndType, Comparable<BuildRule>

Direct Known Subclasses:

Aapt2Compile, Archive, BaseGenrule, CalculateClassAbi, CalculateSourceAbiFromLibraryTarget, CxxLink, CxxPreprocessAndCompile, CxxThinLTOIndex, CxxThinLTOOpt, DexProducedFromJavaLibrary, Filegroup, InferNullsafe, JsFile, JsLibrary, MachoDylibStubRule, MergeThirdPartyJarResources, PipelinedModernBuildRule, PythonCompileRule, RustCompileRule, SplitUberRDotJavaJar, StripLinkable, UnitTestOptions, WriteFileHashCode, Zip

public class ModernBuildRule<T extends Buildable>
extends AbstractBuildRule
implements SupportsInputBasedRuleKey

ModernBuildRule wraps a Buildable into something that implements BuildRule (and various other interfaces used by the build engine). Most of the overridden methods from BuildRule/AbstractBuildRule are intentionally final to keep users on the safe path.

Deps, outputs, inputs and rulekeys are derived from the fields of the Buildable.

For simple ModernBuildRules (e.g. those that don't have any fields that can't be added to the rulekey), the build rule class itself can (and should) implement Buildable. In this case, the constructor taking a Class<T> should be used.

Example:

 class WriteData extends ModernBuildRule<WriteData> implements Buildable {
   final String data;
   public WriteData(
       SourcePathRuleFinder ruleFinder,
       BuildTarget buildTarget,
       ProjectFilesystem projectFilesystem,
       String data) {
     super(buildTarget, projectFilesystem, ruleFinder, WriteData.class);
     this.data = data;
   }

   ...
 }
 

Some BuildRules contain more information than just that added to the rulekey and used for getBuildSteps(). For these rules, the part used for getBuildSteps should be split out into its own implementation of Buildable.

Example:

 class CopyData extends ModernBuildRule<CopyData.Impl> implements Buildable {
   BuildRule other;
   public WriteData(
       SourcePathRuleFinder ruleFinder,
       BuildTarget buildTarget,
       ProjectFilesystem projectFilesystem,
       BuildRule other) {
     super(buildTarget, projectFilesystem, ruleFinder, new Impl("hello"));
     this.other = other;
   }

   private static class Impl implements Buildable {
     ...
   }
   ...
 }
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModernBuildRule(BuildTarget buildTarget, ProjectFilesystem filesystem, SourcePathRuleFinder finder, Class<T> clazz)
protected	ModernBuildRule(BuildTarget buildTarget, ProjectFilesystem filesystem, SourcePathRuleFinder ruleFinder, T buildable)

Method Summary

Modifier and Type	Method and Description
int	compareTo(BuildRule that)
T	getBuildable()
protected static DefaultBuildCellRelativePathFactory	getBuildCellPathFactory(BuildContext context, ProjectFilesystem filesystem, OutputPathResolver outputPathResolver)
com.google.common.collect.ImmutableSortedSet<BuildRule>	getBuildDeps()
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
OutputPathResolver	getOutputPathResolver() This field could be used unsafely, most ModernBuildRule should never need this directly and it should only be used within the getBuildSteps() call.
static void	getSetupStepsForBuildable(BuildContext context, ProjectFilesystem filesystem, Iterable<Path> outputs, com.google.common.collect.ImmutableList.Builder<Step> stepBuilder, OutputPathResolver outputPathResolver) Gets the steps for preparing the output directories of the build rule.
protected BuildTargetSourcePath	getSourcePath(OutputPath outputPath) This should only be exposed to implementations of the ModernBuildRule, not of the Buildable.
protected com.google.common.collect.ImmutableSortedSet<SourcePath>	getSourcePaths(Collection<OutputPath> outputPaths) Same as getSourcePath(com.facebook.buck.rules.modern.OutputPath), but takes multiple OutputPath instances and returns multiple SourcePath instances.
SourcePath	getSourcePathToOutput()
static void	injectFieldsIfNecessary(ProjectFilesystem filesystem, BuildTarget target, Buildable buildable, SourcePathRuleFinder ruleFinder) Allows injecting the AbstractBuildRule fields into a Buildable after construction.
boolean	inputBasedRuleKeyIsEnabled()
void	recordOutputs(BuildableContext buildableContext) Records the outputs of this buildrule.
static <T extends AddsToRuleKey> void	recordOutputs(BuildableContext buildableContext, OutputPathResolver outputPathResolver, ClassInfo<T> classInfo, T buildable) Records the outputs of this buildrule.
static <T extends AddsToRuleKey> void	recordOutputs(BuildableContext buildableContext, OutputPathResolver outputPathResolver, T buildable) Records the outputs of this buildrule.
static <T extends Buildable> com.google.common.collect.ImmutableList<Step>	stepsForBuildable(BuildContext context, T buildable, ProjectFilesystem filesystem, BuildTarget buildTarget) Return the steps for a buildable.
static <T extends Buildable> com.google.common.collect.ImmutableList<Step>	stepsForBuildable(BuildContext context, T buildable, ProjectFilesystem filesystem, BuildTarget buildTarget, Iterable<Path> outputs) Returns the build steps for the Buildable.
void	updateBuildRuleResolver(BuildRuleResolver ruleResolver) Updates the BuildRuleResolver and associated objects for this build rule.

Methods inherited from class com.facebook.buck.core.rules.impl.AbstractBuildRule

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, getType, hasBuildSteps, hashCode, injectFields, isCacheable, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.facebook.buck.core.rules.attr.SupportsInputBasedRuleKey

isSupported

Methods inherited from interface com.facebook.buck.core.rules.BuildRule

getBuildTarget, getFullyQualifiedName, getProjectFilesystem, hasBuildSteps, isCacheable, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution, toString

Methods inherited from interface com.facebook.buck.core.build.action.BuildEngineAction

getDependencies, getSourcePathOutputs

Methods inherited from interface com.facebook.buck.core.rules.HasNameAndType

getType

Constructor Detail

ModernBuildRule

protected ModernBuildRule(BuildTarget buildTarget,
                          ProjectFilesystem filesystem,
                          SourcePathRuleFinder finder,
                          Class<T> clazz)

ModernBuildRule

protected ModernBuildRule(BuildTarget buildTarget,
                          ProjectFilesystem filesystem,
                          SourcePathRuleFinder ruleFinder,
                          T buildable)

Method Detail

injectFieldsIfNecessary

public static void injectFieldsIfNecessary(ProjectFilesystem filesystem,
                                           BuildTarget target,
                                           Buildable buildable,
                                           SourcePathRuleFinder ruleFinder)

Allows injecting the AbstractBuildRule fields into a Buildable after construction.

getBuildable

public final T getBuildable()

getSourcePathToOutput

@Nullable
public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

getOutputPathResolver

public OutputPathResolver getOutputPathResolver()

This field could be used unsafely, most ModernBuildRule should never need this directly and it should only be used within the getBuildSteps() call.

updateBuildRuleResolver

public void updateBuildRuleResolver(BuildRuleResolver ruleResolver)

Description copied from interface: BuildRule

Updates the BuildRuleResolver and associated objects for this build rule.

Build rules sometimes hold field references to build rule resolvers. If this build rule is to be cached, it must update its BuildRuleResolver when a new action graph is constructed to avoid leaking the entire action graph it was originally associated with.

Specified by:

updateBuildRuleResolver in interface BuildRule

Overrides:

updateBuildRuleResolver in class AbstractBuildRule

inputBasedRuleKeyIsEnabled

public final boolean inputBasedRuleKeyIsEnabled()

Specified by:

inputBasedRuleKeyIsEnabled in interface SupportsInputBasedRuleKey

getSourcePath

protected final BuildTargetSourcePath getSourcePath(OutputPath outputPath)

This should only be exposed to implementations of the ModernBuildRule, not of the Buildable.

getSourcePaths

protected final com.google.common.collect.ImmutableSortedSet<SourcePath> getSourcePaths(Collection<OutputPath> outputPaths)

Same as getSourcePath(com.facebook.buck.rules.modern.OutputPath), but takes multiple OutputPath instances and returns multiple SourcePath instances.

getBuildDeps

public final com.google.common.collect.ImmutableSortedSet<BuildRule> getBuildDeps()

Specified by:

getBuildDeps in interface BuildRule

Returns:

the set of rules that must be built before this rule. Normally, this matches the value of the deps argument for this build rule in the build file in which it was defined.

However, there are special cases where other arguments pull in implicit dependencies (e.g., the keystore argument in android_binary). In these cases, the implicit dependencies are also included in the set returned by this method. The value of the original deps argument, as defined in the build file, must be accessed via a custom getter provided by the build rule.

getBuildSteps

public final com.google.common.collect.ImmutableList<Step> getBuildSteps(BuildContext context,
                                                                         BuildableContext buildableContext)

Specified by:

getBuildSteps in interface BuildRule

stepsForBuildable

public static <T extends Buildable> com.google.common.collect.ImmutableList<Step> stepsForBuildable(BuildContext context,
                                                                                                    T buildable,
                                                                                                    ProjectFilesystem filesystem,
                                                                                                    BuildTarget buildTarget,
                                                                                                    Iterable<Path> outputs)

Returns the build steps for the Buildable. Unlike getBuildSteps(), this does not record outputs (callers should call recordOutputs() themselves).

getBuildCellPathFactory

protected static DefaultBuildCellRelativePathFactory getBuildCellPathFactory(BuildContext context,
                                                                             ProjectFilesystem filesystem,
                                                                             OutputPathResolver outputPathResolver)

getSetupStepsForBuildable

public static void getSetupStepsForBuildable(BuildContext context,
                                             ProjectFilesystem filesystem,
                                             Iterable<Path> outputs,
                                             com.google.common.collect.ImmutableList.Builder<Step> stepBuilder,
                                             OutputPathResolver outputPathResolver)

Gets the steps for preparing the output directories of the build rule.

stepsForBuildable

public static <T extends Buildable> com.google.common.collect.ImmutableList<Step> stepsForBuildable(BuildContext context,
                                                                                                    T buildable,
                                                                                                    ProjectFilesystem filesystem,
                                                                                                    BuildTarget buildTarget)

Return the steps for a buildable.

recordOutputs

public void recordOutputs(BuildableContext buildableContext)

Records the outputs of this buildrule. An output will only be recorded once (i.e. no duplicates and if a directory is recorded, none of its contents will be).

recordOutputs

public static <T extends AddsToRuleKey> void recordOutputs(BuildableContext buildableContext,
                                                           OutputPathResolver outputPathResolver,
                                                           ClassInfo<T> classInfo,
                                                           T buildable)

Records the outputs of this buildrule. An output will only be recorded once (i.e. no duplicates and if a directory is recorded, none of its contents will be).

recordOutputs

public static <T extends AddsToRuleKey> void recordOutputs(BuildableContext buildableContext,
                                                           OutputPathResolver outputPathResolver,
                                                           T buildable)

Records the outputs of this buildrule. An output will only be recorded once (i.e. no duplicates and if a directory is recorded, none of its contents will be).

compareTo

public final int compareTo(BuildRule that)

Specified by:

compareTo in interface BuildRule

Specified by:

compareTo in interface Comparable<BuildRule>