com.facebook.buck.shell

Class AbstractGenruleDescription<T extends AbstractGenruleDescription.CommonArg>

java.lang.Object

com.facebook.buck.shell.AbstractGenruleDescription<T>

All Implemented Interfaces:

ImplicitDepsInferringDescription<T>, BaseDescription<T>, Description<T>, DescriptionWithTargetGraph<T>

Direct Known Subclasses:

ApkGenruleDescription, CxxGenruleDescription, GenruleDescription, JarGenruleDescription, JsBundleGenruleDescription

public abstract class AbstractGenruleDescription<T extends AbstractGenruleDescription.CommonArg>
extends Object
implements DescriptionWithTargetGraph<T>, ImplicitDepsInferringDescription<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractGenruleDescription.CommonArg

Field Summary

Fields

Modifier and Type	Field and Description
protected BuckConfig	buckConfig
protected boolean	enableSandbox
protected SandboxExecutionStrategy	sandboxExecutionStrategy
protected ToolchainProvider	toolchainProvider

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGenruleDescription(ToolchainProvider toolchainProvider, BuckConfig buckConfig, SandboxExecutionStrategy sandboxExecutionStrategy, boolean enableSandbox)

Method Summary

Modifier and Type	Method and Description
protected boolean	canExecuteRemotely(T args)
BuildRule	createBuildRule(BuildRuleCreationContextWithTargetGraph context, BuildTarget buildTarget, BuildRuleParams params, T args) Create a BuildRule for the given BuildRuleParams.
protected abstract BuildRule	createBuildRule(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, ActionGraphBuilder graphBuilder, T args, Optional<Arg> cmd, Optional<Arg> bash, Optional<Arg> cmdExe)
protected BuildRule	createBuildRule(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleResolver resolver, T args, Optional<Arg> cmd, Optional<Arg> bash, Optional<Arg> cmdExe, Optional<String> outputFileName, Optional<com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableSet<String>>> outputFileNames)
void	findDepsForTargetFromConstructorArgs(BuildTarget buildTarget, CellNameResolver cellRoots, T constructorArg, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> extraDepsBuilder, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> targetGraphOnlyDepsBuilder)
protected Optional<AndroidTools>	getAndroidToolsOptional(T args, TargetConfiguration toolchainTargetConfiguration) Returns android tools if args has need_android_tools option set or empty optional otherwise.
protected String	getGenruleType()
protected Optional<com.google.common.collect.ImmutableList<MacroExpander<? extends Macro,?>>>	getMacroHandler(BuildTarget buildTarget, ProjectFilesystem filesystem, BuildRuleResolver resolver, TargetGraph targetGraph, T args)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

producesCacheableSubgraph

Methods inherited from interface com.facebook.buck.core.description.BaseDescription

getConfigurationDeps, getConstructorArgType

Field Detail

toolchainProvider

protected final ToolchainProvider toolchainProvider

buckConfig

protected final BuckConfig buckConfig

sandboxExecutionStrategy

protected final SandboxExecutionStrategy sandboxExecutionStrategy

enableSandbox

protected final boolean enableSandbox

Constructor Detail

AbstractGenruleDescription

protected AbstractGenruleDescription(ToolchainProvider toolchainProvider,
                                     BuckConfig buckConfig,
                                     SandboxExecutionStrategy sandboxExecutionStrategy,
                                     boolean enableSandbox)

Method Detail

createBuildRule

protected abstract BuildRule createBuildRule(BuildTarget buildTarget,
                                             ProjectFilesystem projectFilesystem,
                                             BuildRuleParams params,
                                             ActionGraphBuilder graphBuilder,
                                             T args,
                                             Optional<Arg> cmd,
                                             Optional<Arg> bash,
                                             Optional<Arg> cmdExe)

getGenruleType

protected String getGenruleType()

Returns:

a String representing the type of the genrule

canExecuteRemotely

protected boolean canExecuteRemotely(T args)

Returns:

whether this genrule can use remote execution.

createBuildRule

protected BuildRule createBuildRule(BuildTarget buildTarget,
                                    ProjectFilesystem projectFilesystem,
                                    BuildRuleResolver resolver,
                                    T args,
                                    Optional<Arg> cmd,
                                    Optional<Arg> bash,
                                    Optional<Arg> cmdExe,
                                    Optional<String> outputFileName,
                                    Optional<com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableSet<String>>> outputFileNames)

getAndroidToolsOptional

protected Optional<AndroidTools> getAndroidToolsOptional(T args,
                                                         TargetConfiguration toolchainTargetConfiguration)

Returns android tools if args has need_android_tools option set or empty optional otherwise.

getMacroHandler

protected Optional<com.google.common.collect.ImmutableList<MacroExpander<? extends Macro,?>>> getMacroHandler(BuildTarget buildTarget,
                                                                                                              ProjectFilesystem filesystem,
                                                                                                              BuildRuleResolver resolver,
                                                                                                              TargetGraph targetGraph,
                                                                                                              T args)

Returns:

the MacroExpanders which apply to the macros in this description.

createBuildRule

public BuildRule createBuildRule(BuildRuleCreationContextWithTargetGraph context,
                                 BuildTarget buildTarget,
                                 BuildRuleParams params,
                                 T args)

Description copied from interface: DescriptionWithTargetGraph

Create a BuildRule for the given BuildRuleParams. Note that the BuildTarget referred to in the params contains the Flavor to create.

Specified by:

createBuildRule in interface DescriptionWithTargetGraph<T extends AbstractGenruleDescription.CommonArg>

args - A constructor argument, of type as returned by BaseDescription.getConstructorArgType().

Returns:

The BuildRule that describes the default flavour of the rule being described.

findDepsForTargetFromConstructorArgs

public void findDepsForTargetFromConstructorArgs(BuildTarget buildTarget,
                                                 CellNameResolver cellRoots,
                                                 T constructorArg,
                                                 com.google.common.collect.ImmutableCollection.Builder<BuildTarget> extraDepsBuilder,
                                                 com.google.common.collect.ImmutableCollection.Builder<BuildTarget> targetGraphOnlyDepsBuilder)

Specified by:

findDepsForTargetFromConstructorArgs in interface ImplicitDepsInferringDescription<T extends AbstractGenruleDescription.CommonArg>