com.facebook.buck.apple

Class AppleDescriptions

java.lang.Object

com.facebook.buck.apple.AppleDescriptions

public class AppleDescriptions
extends Object

Common logic for a DescriptionWithTargetGraph that creates Apple target rules.

Field Summary

Fields

Modifier and Type	Field and Description
static Flavor	FRAMEWORK_FLAVOR
static FlavorDomain<Boolean>	INCLUDE_FRAMEWORKS
static Flavor	INCLUDE_FRAMEWORKS_FLAVOR
static Flavor	NO_INCLUDE_FRAMEWORKS_FLAVOR
static Flavor	SWIFT_COMPILE_FLAVOR
static Flavor	SWIFT_EXPORTED_OBJC_GENERATED_HEADER_SYMLINK_TREE_FLAVOR
static Flavor	SWIFT_OBJC_GENERATED_HEADER_SYMLINK_TREE_FLAVOR
static Flavor	SWIFT_UNDERLYING_MODULE_FLAVOR

Method Summary

Modifier and Type	Method and Description
static com.google.common.collect.ImmutableSortedMap<String,SourcePath>	convertAppleHeadersToPrivateCxxHeaders(BuildTarget buildTarget, java.util.function.Function<SourcePath,Path> pathResolver, Path headerPathPrefix, CxxLibraryDescription.CommonArg arg)
static com.google.common.collect.ImmutableSortedMap<String,SourcePath>	convertAppleHeadersToPublicCxxHeaders(BuildTarget buildTarget, java.util.function.Function<SourcePath,Path> pathResolver, Path headerPathPrefix, CxxLibraryDescription.CommonArg arg)
static com.google.common.collect.ImmutableSortedMap<String,SourcePath>	convertHeadersToPrivateCxxHeaders(BuildTarget buildTarget, java.util.function.Function<SourcePath,Path> pathResolver, Path headerPathPrefix, SourceSortedSet privateSourceSet, SourceSortedSet publicSourceSet)
static com.google.common.collect.ImmutableSortedMap<String,SourcePath>	convertHeadersToPublicCxxHeaders(BuildTarget buildTarget, java.util.function.Function<SourcePath,Path> pathResolver, Path headerPathPrefix, SourceSortedSet sourceSet)
static Optional<AppleAssetCatalog>	createBuildRuleForTransitiveAssetCatalogDependencies(XCodeDescriptions xcodeDescriptions, TargetGraph targetGraph, BuildTarget buildTarget, ProjectFilesystem projectFilesystem, SourcePathRuleFinder ruleFinder, Optional<String> productType, ApplePlatform applePlatform, String targetSDKVersion, Tool actool, AppleAssetCatalog.ValidationType assetCatalogValidation, AppleAssetCatalogsCompilationOptions appleAssetCatalogsCompilationOptions, java.util.function.Predicate<BuildTarget> filter)
static Optional<CoreDataModel>	createBuildRulesForCoreDataDependencies(XCodeDescriptions xcodeDescriptions, TargetGraph targetGraph, BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, String moduleName, AppleCxxPlatform appleCxxPlatform, java.util.function.Predicate<BuildTarget> filter)
static Optional<SceneKitAssets>	createBuildRulesForSceneKitAssetsDependencies(XCodeDescriptions xcodeDescriptions, TargetGraph targetGraph, BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, AppleCxxPlatform appleCxxPlatform, java.util.function.Predicate<BuildTarget> filter)
static boolean	flavorsDoNotAllowLinkerMapMode(BuildTarget buildTarget)
static Path	getHeaderPathPrefix(AppleNativeTargetDescriptionArg arg, BuildTarget buildTarget)
static BuildTarget	getTargetPlatformBinary(Optional<BuildTarget> binary, Optional<PatternMatchedCollection<BuildTarget>> platformBinary, Flavor cxxPlatformFlavor) Returns a build target of the apple binary for the requested target platform.
static void	populateCxxBinaryDescriptionArg(ActionGraphBuilder graphBuilder, CxxBinaryDescriptionArg.Builder output, Optional<UnresolvedAppleCxxPlatform> appleCxxPlatform, AppleNativeTargetDescriptionArg arg, BuildTarget buildTarget)
static void	populateCxxLibraryDescriptionArg(BuildRuleResolver ruleResolver, CxxLibraryDescriptionArg.Builder output, Optional<UnresolvedAppleCxxPlatform> appleCxxPlatform, AppleNativeTargetDescriptionArg arg, BuildTarget buildTarget)
static boolean	targetNodeContainsSwiftSourceCode(TargetNode<? extends CxxLibraryDescription.CommonArg> node)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FRAMEWORK_FLAVOR

public static final Flavor FRAMEWORK_FLAVOR

SWIFT_COMPILE_FLAVOR

public static final Flavor SWIFT_COMPILE_FLAVOR

SWIFT_EXPORTED_OBJC_GENERATED_HEADER_SYMLINK_TREE_FLAVOR

public static final Flavor SWIFT_EXPORTED_OBJC_GENERATED_HEADER_SYMLINK_TREE_FLAVOR

SWIFT_OBJC_GENERATED_HEADER_SYMLINK_TREE_FLAVOR

public static final Flavor SWIFT_OBJC_GENERATED_HEADER_SYMLINK_TREE_FLAVOR

SWIFT_UNDERLYING_MODULE_FLAVOR

public static final Flavor SWIFT_UNDERLYING_MODULE_FLAVOR

INCLUDE_FRAMEWORKS_FLAVOR

public static final Flavor INCLUDE_FRAMEWORKS_FLAVOR

NO_INCLUDE_FRAMEWORKS_FLAVOR

public static final Flavor NO_INCLUDE_FRAMEWORKS_FLAVOR

INCLUDE_FRAMEWORKS

public static final FlavorDomain<Boolean> INCLUDE_FRAMEWORKS

Method Detail

getHeaderPathPrefix

public static Path getHeaderPathPrefix(AppleNativeTargetDescriptionArg arg,
                                       BuildTarget buildTarget)

convertAppleHeadersToPublicCxxHeaders

public static com.google.common.collect.ImmutableSortedMap<String,SourcePath> convertAppleHeadersToPublicCxxHeaders(BuildTarget buildTarget,
                                                                                                                    java.util.function.Function<SourcePath,Path> pathResolver,
                                                                                                                    Path headerPathPrefix,
                                                                                                                    CxxLibraryDescription.CommonArg arg)

convertHeadersToPublicCxxHeaders

public static com.google.common.collect.ImmutableSortedMap<String,SourcePath> convertHeadersToPublicCxxHeaders(BuildTarget buildTarget,
                                                                                                               java.util.function.Function<SourcePath,Path> pathResolver,
                                                                                                               Path headerPathPrefix,
                                                                                                               SourceSortedSet sourceSet)

convertAppleHeadersToPrivateCxxHeaders

public static com.google.common.collect.ImmutableSortedMap<String,SourcePath> convertAppleHeadersToPrivateCxxHeaders(BuildTarget buildTarget,
                                                                                                                     java.util.function.Function<SourcePath,Path> pathResolver,
                                                                                                                     Path headerPathPrefix,
                                                                                                                     CxxLibraryDescription.CommonArg arg)

convertHeadersToPrivateCxxHeaders

public static com.google.common.collect.ImmutableSortedMap<String,SourcePath> convertHeadersToPrivateCxxHeaders(BuildTarget buildTarget,
                                                                                                                java.util.function.Function<SourcePath,Path> pathResolver,
                                                                                                                Path headerPathPrefix,
                                                                                                                SourceSortedSet privateSourceSet,
                                                                                                                SourceSortedSet publicSourceSet)

populateCxxBinaryDescriptionArg

public static void populateCxxBinaryDescriptionArg(ActionGraphBuilder graphBuilder,
                                                   CxxBinaryDescriptionArg.Builder output,
                                                   Optional<UnresolvedAppleCxxPlatform> appleCxxPlatform,
                                                   AppleNativeTargetDescriptionArg arg,
                                                   BuildTarget buildTarget)

populateCxxLibraryDescriptionArg

public static void populateCxxLibraryDescriptionArg(BuildRuleResolver ruleResolver,
                                                    CxxLibraryDescriptionArg.Builder output,
                                                    Optional<UnresolvedAppleCxxPlatform> appleCxxPlatform,
                                                    AppleNativeTargetDescriptionArg arg,
                                                    BuildTarget buildTarget)

createBuildRuleForTransitiveAssetCatalogDependencies

public static Optional<AppleAssetCatalog> createBuildRuleForTransitiveAssetCatalogDependencies(XCodeDescriptions xcodeDescriptions,
                                                                                               TargetGraph targetGraph,
                                                                                               BuildTarget buildTarget,
                                                                                               ProjectFilesystem projectFilesystem,
                                                                                               SourcePathRuleFinder ruleFinder,
                                                                                               Optional<String> productType,
                                                                                               ApplePlatform applePlatform,
                                                                                               String targetSDKVersion,
                                                                                               Tool actool,
                                                                                               AppleAssetCatalog.ValidationType assetCatalogValidation,
                                                                                               AppleAssetCatalogsCompilationOptions appleAssetCatalogsCompilationOptions,
                                                                                               java.util.function.Predicate<BuildTarget> filter)

createBuildRulesForCoreDataDependencies

public static Optional<CoreDataModel> createBuildRulesForCoreDataDependencies(XCodeDescriptions xcodeDescriptions,
                                                                              TargetGraph targetGraph,
                                                                              BuildTarget buildTarget,
                                                                              ProjectFilesystem projectFilesystem,
                                                                              BuildRuleParams params,
                                                                              String moduleName,
                                                                              AppleCxxPlatform appleCxxPlatform,
                                                                              java.util.function.Predicate<BuildTarget> filter)

createBuildRulesForSceneKitAssetsDependencies

public static Optional<SceneKitAssets> createBuildRulesForSceneKitAssetsDependencies(XCodeDescriptions xcodeDescriptions,
                                                                                     TargetGraph targetGraph,
                                                                                     BuildTarget buildTarget,
                                                                                     ProjectFilesystem projectFilesystem,
                                                                                     BuildRuleParams params,
                                                                                     AppleCxxPlatform appleCxxPlatform,
                                                                                     java.util.function.Predicate<BuildTarget> filter)

getTargetPlatformBinary

public static BuildTarget getTargetPlatformBinary(Optional<BuildTarget> binary,
                                                  Optional<PatternMatchedCollection<BuildTarget>> platformBinary,
                                                  Flavor cxxPlatformFlavor)

Returns a build target of the apple binary for the requested target platform.

By default it's the binary that was provided using binary attribute, but in case platform_binary is specified and one of its patterns matches the target platform, it will be returned instead.

flavorsDoNotAllowLinkerMapMode

public static boolean flavorsDoNotAllowLinkerMapMode(BuildTarget buildTarget)

targetNodeContainsSwiftSourceCode

public static boolean targetNodeContainsSwiftSourceCode(TargetNode<? extends CxxLibraryDescription.CommonArg> node)