com.facebook.buck.cxx

Class CxxBinaryDescription

java.lang.Object

com.facebook.buck.cxx.CxxBinaryDescription

All Implemented Interfaces:

ImplicitDepsInferringDescription<com.facebook.buck.cxx.CxxBinaryDescription.AbstractCxxBinaryDescriptionArg>, ImplicitFlavorsInferringDescription, BaseDescription<CxxBinaryDescriptionArg>, Description<CxxBinaryDescriptionArg>, MetadataProvidingDescription<CxxBinaryDescriptionArg>, Flavored, DescriptionWithTargetGraph<CxxBinaryDescriptionArg>, VersionRoot<CxxBinaryDescriptionArg>

public class CxxBinaryDescription
extends Object
implements DescriptionWithTargetGraph<CxxBinaryDescriptionArg>, Flavored, ImplicitDepsInferringDescription<com.facebook.buck.cxx.CxxBinaryDescription.AbstractCxxBinaryDescriptionArg>, ImplicitFlavorsInferringDescription, MetadataProvidingDescription<CxxBinaryDescriptionArg>, VersionRoot<CxxBinaryDescriptionArg>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CxxBinaryDescription.CommonArg

Constructor Summary

Constructors

Constructor and Description
CxxBinaryDescription(ToolchainProvider toolchainProvider, CxxBinaryImplicitFlavors cxxBinaryImplicitFlavors, CxxBinaryFactory cxxBinaryFactory, CxxBinaryMetadataFactory cxxBinaryMetadataFactory, CxxBinaryFlavored cxxBinaryFlavored)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSortedSet<Flavor>	addImplicitFlavors(com.google.common.collect.ImmutableSortedSet<Flavor> argDefaultFlavors, TargetConfiguration toolchainTargetConfiguration)
BuildRule	createBuildRule(BuildRuleCreationContextWithTargetGraph context, BuildTarget buildTarget, BuildRuleParams params, CxxBinaryDescriptionArg args) Create a BuildRule for the given BuildRuleParams.
<U> Optional<U>	createMetadata(BuildTarget buildTarget, ActionGraphBuilder graphBuilder, CellPathResolver cellRoots, CxxBinaryDescriptionArg args, Optional<com.google.common.collect.ImmutableMap<BuildTarget,Version>> selectedVersions, Class<U> metadataClass)
void	findDepsForTargetFromConstructorArgs(BuildTarget buildTarget, CellNameResolver cellRoots, com.facebook.buck.cxx.CxxBinaryDescription.AbstractCxxBinaryDescriptionArg constructorArg, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> extraDepsBuilder, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> targetGraphOnlyDepsBuilder)
Optional<com.google.common.collect.ImmutableSet<FlavorDomain<?>>>	flavorDomains(TargetConfiguration toolchainTargetConfiguration)
Class<CxxBinaryDescriptionArg>	getConstructorArgType() The type of the constructor argument that is used by this description to create a rule
boolean	hasFlavors(com.google.common.collect.ImmutableSet<Flavor> inputFlavors, 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.

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.versions.VersionRoot

isVersionRoot

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

getConfigurationDeps

Constructor Detail

CxxBinaryDescription

public CxxBinaryDescription(ToolchainProvider toolchainProvider,
                            CxxBinaryImplicitFlavors cxxBinaryImplicitFlavors,
                            CxxBinaryFactory cxxBinaryFactory,
                            CxxBinaryMetadataFactory cxxBinaryMetadataFactory,
                            CxxBinaryFlavored cxxBinaryFlavored)

Method Detail

getConstructorArgType

public Class<CxxBinaryDescriptionArg> 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<CxxBinaryDescriptionArg>

createBuildRule

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

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,
                                                 com.facebook.buck.cxx.CxxBinaryDescription.AbstractCxxBinaryDescriptionArg constructorArg,
                                                 com.google.common.collect.ImmutableCollection.Builder<BuildTarget> extraDepsBuilder,
                                                 com.google.common.collect.ImmutableCollection.Builder<BuildTarget> targetGraphOnlyDepsBuilder)

Specified by:

findDepsForTargetFromConstructorArgs in interface ImplicitDepsInferringDescription<com.facebook.buck.cxx.CxxBinaryDescription.AbstractCxxBinaryDescriptionArg>

flavorDomains

public Optional<com.google.common.collect.ImmutableSet<FlavorDomain<?>>> flavorDomains(TargetConfiguration toolchainTargetConfiguration)

Specified by:

flavorDomains in interface Flavored

hasFlavors

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

Specified by:

hasFlavors in interface Flavored

Parameters:

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

Returns:

Whether a BuildRule of the given Flavor can be created.

createMetadata

public <U> Optional<U> createMetadata(BuildTarget buildTarget,
                                      ActionGraphBuilder graphBuilder,
                                      CellPathResolver cellRoots,
                                      CxxBinaryDescriptionArg args,
                                      Optional<com.google.common.collect.ImmutableMap<BuildTarget,Version>> selectedVersions,
                                      Class<U> metadataClass)

Specified by:

createMetadata in interface MetadataProvidingDescription<CxxBinaryDescriptionArg>

addImplicitFlavors

public com.google.common.collect.ImmutableSortedSet<Flavor> addImplicitFlavors(com.google.common.collect.ImmutableSortedSet<Flavor> argDefaultFlavors,
                                                                               TargetConfiguration toolchainTargetConfiguration)

Specified by:

addImplicitFlavors in interface ImplicitFlavorsInferringDescription

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<CxxBinaryDescriptionArg>

Specified by:

producesCacheableSubgraph in interface DescriptionWithTargetGraph<CxxBinaryDescriptionArg>