com.facebook.buck.apple

Class PrebuiltAppleFramework

java.lang.Object

com.facebook.buck.core.rules.impl.AbstractBuildRule

com.facebook.buck.core.rules.impl.AbstractBuildRuleWithDeclaredAndExtraDeps

com.facebook.buck.apple.PrebuiltAppleFramework

All Implemented Interfaces:

BuildEngineAction, HasOutputName, AllowsNonAnnotatedFields, HasDeclaredAndExtraDeps, BuildRule, HasNameAndType, CxxPreprocessorDep, LegacyNativeLinkableGroup, NativeLinkableGroup, Comparable<BuildRule>

public class PrebuiltAppleFramework
extends AbstractBuildRuleWithDeclaredAndExtraDeps
implements CxxPreprocessorDep, LegacyNativeLinkableGroup, HasOutputName

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.buck.cxx.toolchain.nativelink.NativeLinkableGroup

NativeLinkableGroup.Linkage

Constructor Summary

Constructors

Constructor and Description

PrebuiltAppleFramework(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, ActionGraphBuilder graphBuilder, SourcePath frameworkPath, NativeLinkableGroup.Linkage preferredLinkage, com.google.common.collect.ImmutableSet<FrameworkPath> frameworks, Optional<Pattern> supportedPlatformsRegex, java.util.function.Function<? super CxxPlatform,com.google.common.collect.ImmutableList<String>> exportedLinkerFlags, FlavorDomain<UnresolvedAppleCxxPlatform> applePlatformFlavorDomain)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
Iterable<CxxPreprocessorDep>	getCxxPreprocessorDeps(CxxPlatform cxxPlatform, BuildRuleResolver ruleResolver)
CxxPreprocessorInput	getCxxPreprocessorInput(CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder) Returns the preprocessor input that represents this rule's public (exported) declarations.
PlatformLockedNativeLinkableGroup.Cache	getNativeLinkableCompatibilityCache()
Iterable<NativeLinkableGroup>	getNativeLinkableDeps(BuildRuleResolver ruleResolver)
Iterable<NativeLinkableGroup>	getNativeLinkableDepsForPlatform(CxxPlatform cxxPlatform, BuildRuleResolver ruleResolver)
Iterable<? extends NativeLinkableGroup>	getNativeLinkableExportedDeps(BuildRuleResolver ruleResolver)
NativeLinkableInput	getNativeLinkableInput(CxxPlatform cxxPlatform, Linker.LinkableDepType type, boolean forceLinkWhole, ActionGraphBuilder graphBuilder, TargetConfiguration targetConfiguration) Return input that *dependents* should put on their link line when linking against this linkable.
String	getOutputName(OutputLabel outputLabel) Returns an output name for the build target associated with the given output label.
NativeLinkableGroup.Linkage	getPreferredLinkage(CxxPlatform cxxPlatform)
com.google.common.collect.ImmutableMap<String,SourcePath>	getSharedLibraries(CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder)
SourcePath	getSourcePathToOutput()
com.google.common.collect.ImmutableMap<BuildTarget,CxxPreprocessorInput>	getTransitiveCxxPreprocessorInput(CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder) Returns all transitive preprocessor inputs for this library.
boolean	isCacheable() Whether this BuildRule can be cached.

Methods inherited from class com.facebook.buck.core.rules.impl.AbstractBuildRuleWithDeclaredAndExtraDeps

deprecatedGetExtraDeps, getBuildDeps, getDeclaredDeps, getTargetGraphOnlyDeps

Methods inherited from class com.facebook.buck.core.rules.impl.AbstractBuildRule

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, getType, hasBuildSteps, hashCode, injectFields, toString, updateBuildRuleResolver

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.facebook.buck.cxx.CxxPreprocessorDep

getBuildTarget

Methods inherited from interface com.facebook.buck.cxx.toolchain.nativelink.LegacyNativeLinkableGroup

forceLinkWholeForHaskellOmnibus, getExportedLinkerFlags, getExportedPostLinkerFlags, getNativeLinkable, getNativeLinkableCache, getNativeLinkableExportedDepsForPlatform, getNativeLinkableInput, getNativeLinkTarget, getRuleType, isPrebuiltSOForHaskellOmnibus, shouldBeLinkedInAppleTestAndHost, supportsOmnibusLinking, supportsOmnibusLinkingForHaskell

Methods inherited from interface com.facebook.buck.cxx.toolchain.nativelink.NativeLinkableGroup

getBuildTarget

Methods inherited from interface com.facebook.buck.core.rules.BuildRule

compareTo, getFullyQualifiedName, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution

Constructor Detail

PrebuiltAppleFramework

public PrebuiltAppleFramework(BuildTarget buildTarget,
                              ProjectFilesystem projectFilesystem,
                              BuildRuleParams params,
                              ActionGraphBuilder graphBuilder,
                              SourcePath frameworkPath,
                              NativeLinkableGroup.Linkage preferredLinkage,
                              com.google.common.collect.ImmutableSet<FrameworkPath> frameworks,
                              Optional<Pattern> supportedPlatformsRegex,
                              java.util.function.Function<? super CxxPlatform,com.google.common.collect.ImmutableList<String>> exportedLinkerFlags,
                              FlavorDomain<UnresolvedAppleCxxPlatform> applePlatformFlavorDomain)

Method Detail

isCacheable

public boolean isCacheable()

Description copied from interface: BuildRule

Whether this BuildRule can be cached.

Uncached build rules are never written out to cache, never read from cache, and does not count in cache statistics. This rule is useful for artifacts which cannot be easily normalized.

Uncached rules are not always rebuilt, however, as long as the existing on-disk representation is up to date. This means that these rules can take advantage of SupportsInputBasedRuleKey to prevent rebuilding.

Specified by:

isCacheable in interface BuildEngineAction

Specified by:

isCacheable in interface BuildRule

Overrides:

isCacheable in class AbstractBuildRule

getBuildSteps

public com.google.common.collect.ImmutableList<Step> getBuildSteps(BuildContext context,
                                                                   BuildableContext buildableContext)

Specified by:

getBuildSteps in interface BuildRule

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

getOutputName

public String getOutputName(OutputLabel outputLabel)

Description copied from interface: HasOutputName

Returns an output name for the build target associated with the given output label. Not necessarily a path relative to any directory

Specified by:

getOutputName in interface HasOutputName

getNativeLinkableCompatibilityCache

public PlatformLockedNativeLinkableGroup.Cache getNativeLinkableCompatibilityCache()

Specified by:

getNativeLinkableCompatibilityCache in interface LegacyNativeLinkableGroup

getCxxPreprocessorDeps

public Iterable<CxxPreprocessorDep> getCxxPreprocessorDeps(CxxPlatform cxxPlatform,
                                                           BuildRuleResolver ruleResolver)

Specified by:

getCxxPreprocessorDeps in interface CxxPreprocessorDep

getCxxPreprocessorInput

public CxxPreprocessorInput getCxxPreprocessorInput(CxxPlatform cxxPlatform,
                                                    ActionGraphBuilder graphBuilder)

Description copied from interface: CxxPreprocessorDep

Returns the preprocessor input that represents this rule's public (exported) declarations. This includes any exported preprocessor flags, headers, etc.

Specified by:

getCxxPreprocessorInput in interface CxxPreprocessorDep

getTransitiveCxxPreprocessorInput

public com.google.common.collect.ImmutableMap<BuildTarget,CxxPreprocessorInput> getTransitiveCxxPreprocessorInput(CxxPlatform cxxPlatform,
                                                                                                                  ActionGraphBuilder graphBuilder)

Description copied from interface: CxxPreprocessorDep

Returns all transitive preprocessor inputs for this library. This includes public headers (and exported preprocessor flags) of all exported dependencies.

Specified by:

getTransitiveCxxPreprocessorInput in interface CxxPreprocessorDep

getNativeLinkableDeps

public Iterable<NativeLinkableGroup> getNativeLinkableDeps(BuildRuleResolver ruleResolver)

Specified by:

getNativeLinkableDeps in interface LegacyNativeLinkableGroup

Returns:

All native linkable dependencies that might be required by this linkable on any platform.

getNativeLinkableDepsForPlatform

public Iterable<NativeLinkableGroup> getNativeLinkableDepsForPlatform(CxxPlatform cxxPlatform,
                                                                      BuildRuleResolver ruleResolver)

Specified by:

getNativeLinkableDepsForPlatform in interface LegacyNativeLinkableGroup

Returns:

All native linkable dependencies that are required by this linkable on a specific platform.

getNativeLinkableExportedDeps

public Iterable<? extends NativeLinkableGroup> getNativeLinkableExportedDeps(BuildRuleResolver ruleResolver)

Specified by:

getNativeLinkableExportedDeps in interface LegacyNativeLinkableGroup

Returns:

All native linkable exported dependencies that might be required by this linkable on any platform.

getNativeLinkableInput

public NativeLinkableInput getNativeLinkableInput(CxxPlatform cxxPlatform,
                                                  Linker.LinkableDepType type,
                                                  boolean forceLinkWhole,
                                                  ActionGraphBuilder graphBuilder,
                                                  TargetConfiguration targetConfiguration)

Description copied from interface: LegacyNativeLinkableGroup

Return input that *dependents* should put on their link line when linking against this linkable.

Specified by:

getNativeLinkableInput in interface LegacyNativeLinkableGroup

getPreferredLinkage

public NativeLinkableGroup.Linkage getPreferredLinkage(CxxPlatform cxxPlatform)

Specified by:

getPreferredLinkage in interface LegacyNativeLinkableGroup

getSharedLibraries

public com.google.common.collect.ImmutableMap<String,SourcePath> getSharedLibraries(CxxPlatform cxxPlatform,
                                                                                    ActionGraphBuilder graphBuilder)

Specified by:

getSharedLibraries in interface LegacyNativeLinkableGroup

Returns:

a map of shared library SONAME to shared library path for the given CxxPlatform.