com.facebook.buck.apple

Class AppleLibraryDescription

java.lang.Object

com.facebook.buck.apple.AppleLibraryDescription

All Implemented Interfaces:

ImplicitDepsInferringDescription<com.facebook.buck.apple.AppleLibraryDescription.AbstractAppleLibraryDescriptionArg>, ImplicitFlavorsInferringDescription, BaseDescription<AppleLibraryDescriptionArg>, Description<AppleLibraryDescriptionArg>, MetadataProvidingDescription<AppleLibraryDescriptionArg>, Flavored, DescriptionWithTargetGraph<AppleLibraryDescriptionArg>, VersionPropagator<AppleLibraryDescriptionArg>

public class AppleLibraryDescription
extends Object
implements DescriptionWithTargetGraph<AppleLibraryDescriptionArg>, Flavored, ImplicitDepsInferringDescription<com.facebook.buck.apple.AppleLibraryDescription.AbstractAppleLibraryDescriptionArg>, ImplicitFlavorsInferringDescription, MetadataProvidingDescription<AppleLibraryDescriptionArg>, VersionPropagator<AppleLibraryDescriptionArg>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AppleLibraryDescription.Type

Field Summary

Fields

Modifier and Type	Field and Description
static FlavorDomain<AppleLibraryDescription.Type>	LIBRARY_TYPE
static FlavorDomain<com.facebook.buck.apple.AppleLibraryDescription.MetadataType>	METADATA_TYPE

Constructor Summary

Constructors

Constructor and Description

AppleLibraryDescription(ToolchainProvider toolchainProvider, XCodeDescriptions xcodeDescriptions, SwiftLibraryDescription swiftDelegate, AppleConfig appleConfig, CxxBuckConfig cxxBuckConfig, SwiftBuckConfig swiftBuckConfig, 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, AppleLibraryDescriptionArg args) Create a BuildRule for the given BuildRuleParams.
<A extends AppleNativeTargetDescriptionArg> BuildRule	createLibraryBuildRule(BuildRuleCreationContextWithTargetGraph context, BuildTarget buildTarget, BuildRuleParams params, ActionGraphBuilder graphBuilder, A args, Optional<Linker.LinkableDepType> linkableDepType, Optional<SourcePath> bundleLoader, com.google.common.collect.ImmutableSet<BuildTarget> blacklist, com.google.common.collect.ImmutableSortedSet<BuildTarget> extraCxxDeps, CxxLibraryDescription.TransitiveCxxPreprocessorInputFunction transitiveCxxPreprocessorInput)
<U> Optional<U>	createMetadata(BuildTarget buildTarget, ActionGraphBuilder graphBuilder, CellPathResolver cellRoots, AppleLibraryDescriptionArg args, Optional<com.google.common.collect.ImmutableMap<BuildTarget,Version>> selectedVersions, Class<U> metadataClass)
Optional<BuildRule>	createSwiftBuildRule(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, ActionGraphBuilder graphBuilder, CellPathResolver cellRoots, AppleNativeTargetDescriptionArg args, Optional<AppleLibrarySwiftDelegate> swiftDelegate)
void	findDepsForTargetFromConstructorArgs(BuildTarget buildTarget, CellNameResolver cellRoots, com.facebook.buck.apple.AppleLibraryDescription.AbstractAppleLibraryDescriptionArg 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<AppleLibraryDescriptionArg>	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> flavors, TargetConfiguration toolchainTargetConfiguration)
static boolean	isNotStaticallyLinkedLibraryNode(TargetNode<CxxLibraryDescription.CommonArg> node)
static Optional<CxxPreprocessorInput>	underlyingModuleCxxPreprocessorInput(BuildTarget target, ActionGraphBuilder graphBuilder, CxxPlatform platform)

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

Field Detail

METADATA_TYPE

public static final FlavorDomain<com.facebook.buck.apple.AppleLibraryDescription.MetadataType> METADATA_TYPE

LIBRARY_TYPE

public static final FlavorDomain<AppleLibraryDescription.Type> LIBRARY_TYPE

Constructor Detail

AppleLibraryDescription

public AppleLibraryDescription(ToolchainProvider toolchainProvider,
                               XCodeDescriptions xcodeDescriptions,
                               SwiftLibraryDescription swiftDelegate,
                               AppleConfig appleConfig,
                               CxxBuckConfig cxxBuckConfig,
                               SwiftBuckConfig swiftBuckConfig,
                               CxxLibraryImplicitFlavors cxxLibraryImplicitFlavors,
                               CxxLibraryFlavored cxxLibraryFlavored,
                               CxxLibraryFactory cxxLibraryFactory,
                               CxxLibraryMetadataFactory cxxLibraryMetadataFactory)

Method Detail

getConstructorArgType

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

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.

createSwiftBuildRule

public Optional<BuildRule> createSwiftBuildRule(BuildTarget buildTarget,
                                                ProjectFilesystem projectFilesystem,
                                                ActionGraphBuilder graphBuilder,
                                                CellPathResolver cellRoots,
                                                AppleNativeTargetDescriptionArg args,
                                                Optional<AppleLibrarySwiftDelegate> swiftDelegate)

createBuildRule

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

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

Returns:

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

createLibraryBuildRule

public <A extends AppleNativeTargetDescriptionArg> BuildRule createLibraryBuildRule(BuildRuleCreationContextWithTargetGraph context,
                                                                                    BuildTarget buildTarget,
                                                                                    BuildRuleParams params,
                                                                                    ActionGraphBuilder graphBuilder,
                                                                                    A args,
                                                                                    Optional<Linker.LinkableDepType> linkableDepType,
                                                                                    Optional<SourcePath> bundleLoader,
                                                                                    com.google.common.collect.ImmutableSet<BuildTarget> blacklist,
                                                                                    com.google.common.collect.ImmutableSortedSet<BuildTarget> extraCxxDeps,
                                                                                    CxxLibraryDescription.TransitiveCxxPreprocessorInputFunction transitiveCxxPreprocessorInput)

Parameters:

bundleLoader - The binary in which the current library will be (dynamically) loaded into.

createMetadata

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

Specified by:

createMetadata in interface MetadataProvidingDescription<AppleLibraryDescriptionArg>

addImplicitFlavors

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

Specified by:

addImplicitFlavors in interface ImplicitFlavorsInferringDescription

findDepsForTargetFromConstructorArgs

public void findDepsForTargetFromConstructorArgs(BuildTarget buildTarget,
                                                 CellNameResolver cellRoots,
                                                 com.facebook.buck.apple.AppleLibraryDescription.AbstractAppleLibraryDescriptionArg 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.apple.AppleLibraryDescription.AbstractAppleLibraryDescriptionArg>

isNotStaticallyLinkedLibraryNode

public static boolean isNotStaticallyLinkedLibraryNode(TargetNode<CxxLibraryDescription.CommonArg> node)

underlyingModuleCxxPreprocessorInput

public static Optional<CxxPreprocessorInput> underlyingModuleCxxPreprocessorInput(BuildTarget target,
                                                                                  ActionGraphBuilder graphBuilder,
                                                                                  CxxPlatform platform)