com.facebook.buck.swift

Class SwiftLibraryDescription

java.lang.Object

com.facebook.buck.swift.SwiftLibraryDescription

All Implemented Interfaces:

ImplicitDepsInferringDescription<com.facebook.buck.swift.SwiftLibraryDescription.AbstractSwiftLibraryDescriptionArg>, BaseDescription<SwiftLibraryDescriptionArg>, Description<SwiftLibraryDescriptionArg>, Flavored, DescriptionWithTargetGraph<SwiftLibraryDescriptionArg>

public class SwiftLibraryDescription
extends Object
implements DescriptionWithTargetGraph<SwiftLibraryDescriptionArg>, Flavored, ImplicitDepsInferringDescription<com.facebook.buck.swift.SwiftLibraryDescription.AbstractSwiftLibraryDescriptionArg>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SwiftLibraryDescription.Type

Constructor Summary

Constructors

Constructor and Description
SwiftLibraryDescription(ToolchainProvider toolchainProvider, CxxBuckConfig cxxBuckConfig, SwiftBuckConfig swiftBuckConfig)

Method Summary

Modifier and Type	Method and Description
BuildRule	createBuildRule(BuildRuleCreationContextWithTargetGraph context, BuildTarget buildTarget, BuildRuleParams params, SwiftLibraryDescriptionArg args) Create a BuildRule for the given BuildRuleParams.
Optional<BuildRule>	createCompanionBuildRule(BuildRuleCreationContextWithTargetGraph context, BuildTarget buildTarget, BuildRuleParams params, ActionGraphBuilder graphBuilder, CxxLibraryDescription.CommonArg args, Optional<String> targetSdkVersion)
static SwiftCompile	createSwiftCompileRule(CxxPlatform cxxPlatform, SwiftPlatform swiftPlatform, SwiftBuckConfig swiftBuckConfig, BuildTarget buildTarget, ActionGraphBuilder graphBuilder, CellPathResolver cellRoots, ProjectFilesystem projectFilesystem, SwiftLibraryDescriptionArg args, Preprocessor preprocessor, PreprocessorFlags preprocessFlags, boolean importUnderlyingModule, Optional<SwiftTargetTriple> swiftTarget)
void	findDepsForTargetFromConstructorArgs(BuildTarget buildTarget, CellNameResolver cellRoots, com.facebook.buck.swift.SwiftLibraryDescription.AbstractSwiftLibraryDescriptionArg 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<SwiftLibraryDescriptionArg>	getConstructorArgType() The type of the constructor argument that is used by this description to create a rule
com.google.common.collect.ImmutableSet<Flavor>	getSupportedFlavors(com.google.common.collect.ImmutableSet<Flavor> flavors, TargetConfiguration toolchainTargetConfiguration)
boolean	hasFlavors(com.google.common.collect.ImmutableSet<Flavor> flavors, TargetConfiguration toolchainTargetConfiguration)
static boolean	isSwiftTarget(BuildTarget buildTarget)

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

Constructor Detail

SwiftLibraryDescription

public SwiftLibraryDescription(ToolchainProvider toolchainProvider,
                               CxxBuckConfig cxxBuckConfig,
                               SwiftBuckConfig swiftBuckConfig)

Method Detail

findDepsForTargetFromConstructorArgs

public void findDepsForTargetFromConstructorArgs(BuildTarget buildTarget,
                                                 CellNameResolver cellRoots,
                                                 com.facebook.buck.swift.SwiftLibraryDescription.AbstractSwiftLibraryDescriptionArg 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.swift.SwiftLibraryDescription.AbstractSwiftLibraryDescriptionArg>

getConstructorArgType

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

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.

createBuildRule

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

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

Returns:

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

createCompanionBuildRule

public Optional<BuildRule> createCompanionBuildRule(BuildRuleCreationContextWithTargetGraph context,
                                                    BuildTarget buildTarget,
                                                    BuildRuleParams params,
                                                    ActionGraphBuilder graphBuilder,
                                                    CxxLibraryDescription.CommonArg args,
                                                    Optional<String> targetSdkVersion)

createSwiftCompileRule

public static SwiftCompile createSwiftCompileRule(CxxPlatform cxxPlatform,
                                                  SwiftPlatform swiftPlatform,
                                                  SwiftBuckConfig swiftBuckConfig,
                                                  BuildTarget buildTarget,
                                                  ActionGraphBuilder graphBuilder,
                                                  CellPathResolver cellRoots,
                                                  ProjectFilesystem projectFilesystem,
                                                  SwiftLibraryDescriptionArg args,
                                                  Preprocessor preprocessor,
                                                  PreprocessorFlags preprocessFlags,
                                                  boolean importUnderlyingModule,
                                                  Optional<SwiftTargetTriple> swiftTarget)

isSwiftTarget

public static boolean isSwiftTarget(BuildTarget buildTarget)

getSupportedFlavors

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