com.facebook.buck.cxx

Class PrebuiltCxxLibraryGroupDescription.CustomPrebuiltCxxLibrary

java.lang.Object

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

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

com.facebook.buck.core.rules.impl.NoopBuildRuleWithDeclaredAndExtraDeps

com.facebook.buck.cxx.PrebuiltCxxLibraryGroupDescription.CustomPrebuiltCxxLibrary

All Implemented Interfaces:

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

Enclosing class:

PrebuiltCxxLibraryGroupDescription

public static class PrebuiltCxxLibraryGroupDescription.CustomPrebuiltCxxLibrary
extends NoopBuildRuleWithDeclaredAndExtraDeps
implements AbstractCxxLibraryGroup, LegacyNativeLinkableGroup

An action graph representation of a custom prebuilt C/C++ library from the target graph, providing the various interfaces to make it consumable by C/C++ preprocessing and native linkable rules.

Nested Class Summary

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

NativeLinkableGroup.Linkage

Constructor Summary

Constructors

Constructor and Description
CustomPrebuiltCxxLibrary(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, PrebuiltCxxLibraryGroupDescriptionArg args)

Method Summary

Modifier and Type	Method and Description
void	addToCollector(AndroidPackageableCollector collector) Add concrete resources to the given collector.
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<? extends NativeLinkableGroup>	getNativeLinkableDeps(BuildRuleResolver ruleResolver)
Iterable<? extends NativeLinkableGroup>	getNativeLinkableDepsForPlatform(CxxPlatform cxxPlatform, BuildRuleResolver ruleResolver)
Iterable<? extends NativeLinkableGroup>	getNativeLinkableExportedDeps(BuildRuleResolver ruleResolver)
Iterable<? extends NativeLinkableGroup>	getNativeLinkableExportedDepsForPlatform(CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder)
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.
NativeLinkableGroup.Linkage	getPreferredLinkage(CxxPlatform cxxPlatform)
Iterable<AndroidPackageable>	getRequiredPackageables(BuildRuleResolver ruleResolver) Get the set of packagables that need to be included in any package that includes this object.
com.google.common.collect.ImmutableMap<String,SourcePath>	getSharedLibraries(CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder)
com.google.common.collect.ImmutableMap<BuildTarget,CxxPreprocessorInput>	getTransitiveCxxPreprocessorInput(CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder) Returns all transitive preprocessor inputs for this library.
boolean	isPrebuiltSOForHaskellOmnibus(CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder) Whether the nativeLinkable should be linked shared or otherwise for haskell omnibus.
boolean	supportsOmnibusLinking(CxxPlatform cxxPlatform)

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

getBuildSteps, getSourcePathToOutput, hasBuildSteps, isCacheable

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, 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, getNativeLinkableInput, getNativeLinkTarget, getRuleType, shouldBeLinkedInAppleTestAndHost, 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

CustomPrebuiltCxxLibrary

public CustomPrebuiltCxxLibrary(BuildTarget buildTarget,
                                ProjectFilesystem projectFilesystem,
                                BuildRuleParams params,
                                PrebuiltCxxLibraryGroupDescriptionArg args)

Method Detail

isPrebuiltSOForHaskellOmnibus

public boolean isPrebuiltSOForHaskellOmnibus(CxxPlatform cxxPlatform,
                                             ActionGraphBuilder graphBuilder)

Description copied from interface: LegacyNativeLinkableGroup

Whether the nativeLinkable should be linked shared or otherwise for haskell omnibus.

Specified by:

isPrebuiltSOForHaskellOmnibus in interface LegacyNativeLinkableGroup

getNativeLinkableCompatibilityCache

public PlatformLockedNativeLinkableGroup.Cache getNativeLinkableCompatibilityCache()

Specified by:

getNativeLinkableCompatibilityCache in interface LegacyNativeLinkableGroup

getRequiredPackageables

public Iterable<AndroidPackageable> getRequiredPackageables(BuildRuleResolver ruleResolver)

Description copied from interface: AndroidPackageable

Get the set of packagables that need to be included in any package that includes this object.

For example, an android_library will need all of its Java deps (except provided_deps), its resource deps, and its native library deps (even though it doesn't need the native library as a build-time dependency). An android_resource might need an android_library that declares a custom view that it references, as well as other android_resource rules that it references directly.

TODO(natthu): Once build rules and buildables are merged, replace this method with another interface that lets an AndroidPackageable override the default set which is all deps of the type AndroidPackageable.

Specified by:

getRequiredPackageables in interface AndroidPackageable

Returns:

All AndroidPackageables that must be included along with this one.

addToCollector

public void addToCollector(AndroidPackageableCollector collector)

Description copied from interface: AndroidPackageable

Add concrete resources to the given collector.

Implementations should call methods on the collector specify what concrete content must be included in an Android package that includes this object. For example, an android_library will add Java classes, an ndk_library will add native libraries, and android_resource will add resource directories.

Specified by:

addToCollector in interface AndroidPackageable

Parameters:

collector - The AndroidPackageableCollector that will receive the content.

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

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

supportsOmnibusLinking

public boolean supportsOmnibusLinking(CxxPlatform cxxPlatform)

Specified by:

supportsOmnibusLinking in interface LegacyNativeLinkableGroup

Returns:

whether this NativeLinkableGroup supports omnibus linking.

getNativeLinkableDepsForPlatform

public Iterable<? extends 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.

getNativeLinkableExportedDepsForPlatform

public Iterable<? extends NativeLinkableGroup> getNativeLinkableExportedDepsForPlatform(CxxPlatform cxxPlatform,
                                                                                        ActionGraphBuilder graphBuilder)

Specified by:

getNativeLinkableExportedDepsForPlatform in interface LegacyNativeLinkableGroup

Returns:

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

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.