com.facebook.buck.cxx

Class CxxGenruleDescription

java.lang.Object

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

com.facebook.buck.cxx.CxxGenruleDescription

All Implemented Interfaces:

ImplicitDepsInferringDescription<CxxGenruleDescriptionArg>, BaseDescription<CxxGenruleDescriptionArg>, Description<CxxGenruleDescriptionArg>, Flavored, DescriptionWithTargetGraph<CxxGenruleDescriptionArg>, VersionPropagator<CxxGenruleDescriptionArg>

public class CxxGenruleDescription
extends AbstractGenruleDescription<CxxGenruleDescriptionArg>
implements Flavored, VersionPropagator<CxxGenruleDescriptionArg>, ImplicitDepsInferringDescription<CxxGenruleDescriptionArg>

Nested Class Summary

Nested classes/interfaces inherited from class com.facebook.buck.shell.AbstractGenruleDescription

AbstractGenruleDescription.CommonArg

Field Summary

Fields inherited from class com.facebook.buck.shell.AbstractGenruleDescription

buckConfig, enableSandbox, sandboxExecutionStrategy, toolchainProvider

Constructor Summary

Constructors

Constructor and Description
CxxGenruleDescription(ToolchainProvider toolchainProvider, BuckConfig buckConfig, CxxBuckConfig cxxBuckConfig, SandboxExecutionStrategy sandboxExecutionStrategy)

Method Summary

Modifier and Type	Method and Description
BuildRule	createBuildRule(BuildRuleCreationContextWithTargetGraph context, BuildTarget buildTarget, BuildRuleParams params, CxxGenruleDescriptionArg args) Create a BuildRule for the given BuildRuleParams.
protected BuildRule	createBuildRule(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, ActionGraphBuilder graphBuilder, CxxGenruleDescriptionArg args, Optional<Arg> cmd, Optional<Arg> bash, Optional<Arg> cmdExe)
void	findDepsForTargetFromConstructorArgs(BuildTarget buildTarget, CellNameResolver cellRoots, CxxGenruleDescriptionArg constructorArg, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> extraDepsBuilder, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> targetGraphOnlyDepsBuilder)
static SourcePath	fixupSourcePath(ActionGraphBuilder graphBuilder, CxxPlatform platform, SourcePath path)
static com.google.common.collect.ImmutableList<SourcePath>	fixupSourcePaths(ActionGraphBuilder graphBuilder, CxxPlatform cxxPlatform, com.google.common.collect.ImmutableList<SourcePath> paths)
static <T> com.google.common.collect.ImmutableMap<T,SourcePath>	fixupSourcePaths(ActionGraphBuilder graphBuilder, CxxPlatform cxxPlatform, com.google.common.collect.ImmutableMap<T,SourcePath> paths)
static com.google.common.collect.ImmutableSortedSet<SourcePath>	fixupSourcePaths(ActionGraphBuilder graphBuilder, CxxPlatform cxxPlatform, com.google.common.collect.ImmutableSortedSet<SourcePath> paths)
Class<CxxGenruleDescriptionArg>	getConstructorArgType() The type of the constructor argument that is used by this description to create a rule
protected Optional<com.google.common.collect.ImmutableList<MacroExpander<? extends Macro,?>>>	getMacroHandler(BuildTarget buildTarget, ProjectFilesystem filesystem, BuildRuleResolver resolver, TargetGraph targetGraph, CxxGenruleDescriptionArg args)
boolean	hasFlavors(com.google.common.collect.ImmutableSet<Flavor> flavors, TargetConfiguration toolchainTargetConfiguration)
boolean	producesCacheableSubgraph() Whether or not the build rule subgraph produced by this Description is safe to cache in IncrementalActionGraphGenerator for incremental action graph generation.
static boolean	wrapsCxxGenrule(SourcePathRuleFinder ruleFinder, SourcePath path)

Methods inherited from class com.facebook.buck.shell.AbstractGenruleDescription

canExecuteRemotely, createBuildRule, getAndroidToolsOptional, getGenruleType

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.model.Flavored

flavorDomains

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

getConfigurationDeps

Constructor Detail

CxxGenruleDescription

public CxxGenruleDescription(ToolchainProvider toolchainProvider,
                             BuckConfig buckConfig,
                             CxxBuckConfig cxxBuckConfig,
                             SandboxExecutionStrategy sandboxExecutionStrategy)

Method Detail

wrapsCxxGenrule

public static boolean wrapsCxxGenrule(SourcePathRuleFinder ruleFinder,
                                      SourcePath path)

fixupSourcePath

public static SourcePath fixupSourcePath(ActionGraphBuilder graphBuilder,
                                         CxxPlatform platform,
                                         SourcePath path)

Returns:

a new BuildTargetSourcePath for an existing BuildTargetSourcePath which refers to a CxxGenrule with the given platform flavor applied.

fixupSourcePaths

public static com.google.common.collect.ImmutableList<SourcePath> fixupSourcePaths(ActionGraphBuilder graphBuilder,
                                                                                   CxxPlatform cxxPlatform,
                                                                                   com.google.common.collect.ImmutableList<SourcePath> paths)

fixupSourcePaths

public static com.google.common.collect.ImmutableSortedSet<SourcePath> fixupSourcePaths(ActionGraphBuilder graphBuilder,
                                                                                        CxxPlatform cxxPlatform,
                                                                                        com.google.common.collect.ImmutableSortedSet<SourcePath> paths)

fixupSourcePaths

public static <T> com.google.common.collect.ImmutableMap<T,SourcePath> fixupSourcePaths(ActionGraphBuilder graphBuilder,
                                                                                        CxxPlatform cxxPlatform,
                                                                                        com.google.common.collect.ImmutableMap<T,SourcePath> paths)

getConstructorArgType

public Class<CxxGenruleDescriptionArg> getConstructorArgType()

Description copied from interface: BaseDescription

The type of the constructor argument that is used by this description to create a rule

Specified by:

getConstructorArgType in interface BaseDescription<CxxGenruleDescriptionArg>

hasFlavors

public boolean hasFlavors(com.google.common.collect.ImmutableSet<Flavor> flavors,
                          TargetConfiguration toolchainTargetConfiguration)

Specified by:

hasFlavors in interface Flavored

Parameters:

flavors - The set of Flavors to consider. All must match.

Returns:

Whether a BuildRule of the given Flavor can be created.

getMacroHandler

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

Overrides:

getMacroHandler in class AbstractGenruleDescription<CxxGenruleDescriptionArg>

Returns:

the MacroExpanders which apply to the macros in this description.

createBuildRule

public BuildRule createBuildRule(BuildRuleCreationContextWithTargetGraph context,
                                 BuildTarget buildTarget,
                                 BuildRuleParams params,
                                 CxxGenruleDescriptionArg 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<CxxGenruleDescriptionArg>

Overrides:

createBuildRule in class AbstractGenruleDescription<CxxGenruleDescriptionArg>

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

Returns:

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

createBuildRule

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

Specified by:

createBuildRule in class AbstractGenruleDescription<CxxGenruleDescriptionArg>

findDepsForTargetFromConstructorArgs

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

Specified by:

findDepsForTargetFromConstructorArgs in interface ImplicitDepsInferringDescription<CxxGenruleDescriptionArg>

Overrides:

findDepsForTargetFromConstructorArgs in class AbstractGenruleDescription<CxxGenruleDescriptionArg>

producesCacheableSubgraph

public boolean producesCacheableSubgraph()

Description copied from interface: DescriptionWithTargetGraph

Whether or not the build rule subgraph produced by this Description is safe to cache in IncrementalActionGraphGenerator for incremental action graph generation.

Specified by:

producesCacheableSubgraph in interface Description<CxxGenruleDescriptionArg>

Specified by:

producesCacheableSubgraph in interface DescriptionWithTargetGraph<CxxGenruleDescriptionArg>