com.facebook.buck.cxx

Class CxxLibraryDescription

java.lang.Object

com.facebook.buck.cxx.CxxLibraryDescription

All Implemented Interfaces:

ImplicitDepsInferringDescription<CxxLibraryDescription.CommonArg>, ImplicitFlavorsInferringDescription, BaseDescription<CxxLibraryDescriptionArg>, Description<CxxLibraryDescriptionArg>, MetadataProvidingDescription<CxxLibraryDescriptionArg>, Flavored, DescriptionWithTargetGraph<CxxLibraryDescriptionArg>, VersionPropagator<CxxLibraryDescriptionArg>

public class CxxLibraryDescription
extends Object
implements DescriptionWithTargetGraph<CxxLibraryDescriptionArg>, ImplicitDepsInferringDescription<CxxLibraryDescription.CommonArg>, ImplicitFlavorsInferringDescription, Flavored, MetadataProvidingDescription<CxxLibraryDescriptionArg>, VersionPropagator<CxxLibraryDescriptionArg>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CxxLibraryDescription.CommonArg
static class	CxxLibraryDescription.MetadataType
static interface	CxxLibraryDescription.TransitiveCxxPreprocessorInputFunction This is a hack to allow fine grained control over how the transitive CxxPreprocessorInputs are found.
static class	CxxLibraryDescription.Type

Field Summary

Fields

Modifier and Type	Field and Description
static FlavorDomain<HeaderMode>	HEADER_MODE
static FlavorDomain<HeaderVisibility>	HEADER_VISIBILITY
static FlavorDomain<CxxLibraryDescription.Type>	LIBRARY_TYPE
static FlavorDomain<CxxLibraryDescription.MetadataType>	METADATA_TYPE

Constructor Summary

Constructors

Constructor and Description
CxxLibraryDescription(CxxLibraryImplicitFlavors cxxLibraryImplicitFlavors, CxxLibraryFlavored cxxLibraryFlavored, CxxLibraryFactory cxxLibraryFactory, CxxLibraryMetadataFactory cxxLibraryMetadataFactory)

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, CxxLibraryDescriptionArg args) Create a BuildRule for the given BuildRuleParams.
<U> Optional<U>	createMetadata(BuildTarget buildTarget, ActionGraphBuilder graphBuilder, CellPathResolver cellRoots, CxxLibraryDescriptionArg args, Optional<com.google.common.collect.ImmutableMap<BuildTarget,Version>> selectedVersions, Class<U> metadataClass)
void	findDepsForTargetFromConstructorArgs(BuildTarget buildTarget, CellNameResolver cellRoots, CxxLibraryDescription.CommonArg 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<CxxLibraryDescriptionArg>	getConstructorArgType() The type of the constructor argument that is used by this description to create a rule
static Optional<Map.Entry<Flavor,CxxLibraryDescription.Type>>	getLibType(BuildTarget buildTarget)
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 Optional<CxxPreprocessorInput>	queryMetadataCxxPreprocessorInput(ActionGraphBuilder graphBuilder, BuildTarget baseTarget, CxxPlatform platform, HeaderVisibility visibility) Convenience function to query the CxxPreprocessorInput metadata of a target.

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.description.BaseDescription

getConfigurationDeps

Field Detail

LIBRARY_TYPE

public static final FlavorDomain<CxxLibraryDescription.Type> LIBRARY_TYPE

METADATA_TYPE

public static final FlavorDomain<CxxLibraryDescription.MetadataType> METADATA_TYPE

HEADER_VISIBILITY

public static final FlavorDomain<HeaderVisibility> HEADER_VISIBILITY

HEADER_MODE

public static final FlavorDomain<HeaderMode> HEADER_MODE

Constructor Detail

CxxLibraryDescription

public CxxLibraryDescription(CxxLibraryImplicitFlavors cxxLibraryImplicitFlavors,
                             CxxLibraryFlavored cxxLibraryFlavored,
                             CxxLibraryFactory cxxLibraryFactory,
                             CxxLibraryMetadataFactory cxxLibraryMetadataFactory)

Method Detail

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

getConstructorArgType

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

createBuildRule

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

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

Returns:

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

getLibType

public static Optional<Map.Entry<Flavor,CxxLibraryDescription.Type>> getLibType(BuildTarget buildTarget)

findDepsForTargetFromConstructorArgs

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

Specified by:

findDepsForTargetFromConstructorArgs in interface ImplicitDepsInferringDescription<CxxLibraryDescription.CommonArg>

queryMetadataCxxPreprocessorInput

public static Optional<CxxPreprocessorInput> queryMetadataCxxPreprocessorInput(ActionGraphBuilder graphBuilder,
                                                                               BuildTarget baseTarget,
                                                                               CxxPlatform platform,
                                                                               HeaderVisibility visibility)

Convenience function to query the CxxPreprocessorInput metadata of a target.

Use this function instead of constructing the BuildTarget manually.

createMetadata

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

Specified by:

createMetadata in interface MetadataProvidingDescription<CxxLibraryDescriptionArg>

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

Specified by:

producesCacheableSubgraph in interface DescriptionWithTargetGraph<CxxLibraryDescriptionArg>