com.facebook.buck.cxx.toolchain.nativelink

Interface NativeLinkable

All Known Implementing Classes:

NativeLinkableInfo, PlatformLockedNativeLinkableGroup

public interface NativeLinkable

Interface for objects (e.g. C++ libraries) which can contribute to the top-level link of a native binary (e.g. C++ binary). This represents the linkable object for a specific platform.

Method Summary

Modifier and Type	Method and Description
default boolean	forceLinkWholeForHaskellOmnibus()
BuildTarget	getBuildTarget()
default Iterable<? extends Arg>	getExportedLinkerFlags(ActionGraphBuilder graphBuilder)
default Iterable<? extends Arg>	getExportedPostLinkerFlags(ActionGraphBuilder graphBuilder)
Iterable<? extends NativeLinkable>	getNativeLinkableDeps(ActionGraphBuilder graphBuilder)
Iterable<? extends NativeLinkable>	getNativeLinkableExportedDeps(ActionGraphBuilder graphBuilder)
default NativeLinkableInput	getNativeLinkableInput(Linker.LinkableDepType type, ActionGraphBuilder graphBuilder, TargetConfiguration targetConfiguration) Return input that *dependents* should put on their link line when linking against this linkable.
NativeLinkableInput	getNativeLinkableInput(Linker.LinkableDepType type, boolean forceLinkWhole, ActionGraphBuilder graphBuilder, TargetConfiguration targetConfiguration) Return input that *dependents* should put on their link line when linking against this linkable.
Optional<NativeLinkTarget>	getNativeLinkTarget(ActionGraphBuilder graphBuilder, boolean includePrivateLinkerFlags) Optionally returns a NativeLinkTarget.
NativeLinkableGroup.Linkage	getPreferredLinkage()
default String	getRuleType()
com.google.common.collect.ImmutableMap<String,SourcePath>	getSharedLibraries(ActionGraphBuilder graphBuilder)
default boolean	isPrebuiltSOForHaskellOmnibus(ActionGraphBuilder graphBuilder)
boolean	shouldBeLinkedInAppleTestAndHost()
default boolean	supportsOmnibusLinking()
default boolean	supportsOmnibusLinkingForHaskell()

Method Detail

getBuildTarget

BuildTarget getBuildTarget()

Returns:

The BuildTarget for this linkable.

getNativeLinkableDeps

Iterable<? extends NativeLinkable> getNativeLinkableDeps(ActionGraphBuilder graphBuilder)

Returns:

All native linkable dependencies that might be required by this linkable.

getNativeLinkableExportedDeps

Iterable<? extends NativeLinkable> getNativeLinkableExportedDeps(ActionGraphBuilder graphBuilder)

Returns:

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

getNativeLinkableInput

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

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

getNativeLinkableInput

default NativeLinkableInput getNativeLinkableInput(Linker.LinkableDepType type,
                                                   ActionGraphBuilder graphBuilder,
                                                   TargetConfiguration targetConfiguration)

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

getNativeLinkTarget

Optional<NativeLinkTarget> getNativeLinkTarget(ActionGraphBuilder graphBuilder,
                                               boolean includePrivateLinkerFlags)

Optionally returns a NativeLinkTarget. Most implementations of NativeLinkable are themselves instances of NativeLinkTarget.

Parameters:

includePrivateLinkerFlags - whether to include rule-specific non-exported linker flags.

getPreferredLinkage

NativeLinkableGroup.Linkage getPreferredLinkage()

Returns:

The preferred NativeLinkableGroup.Linkage for this linkable.

getSharedLibraries

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

Returns:

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

supportsOmnibusLinking

default boolean supportsOmnibusLinking()

Returns:

whether this NativeLinkable supports omnibus linking.

getExportedLinkerFlags

default Iterable<? extends Arg> getExportedLinkerFlags(ActionGraphBuilder graphBuilder)

Returns:

exported linker flags. These should be added to link lines of dependents.

getExportedPostLinkerFlags

default Iterable<? extends Arg> getExportedPostLinkerFlags(ActionGraphBuilder graphBuilder)

Returns:

exported post-linker flags. This should be added to lines of dependents after other linker flags.

getRuleType

default String getRuleType()

shouldBeLinkedInAppleTestAndHost

boolean shouldBeLinkedInAppleTestAndHost()

isPrebuiltSOForHaskellOmnibus

default boolean isPrebuiltSOForHaskellOmnibus(ActionGraphBuilder graphBuilder)

supportsOmnibusLinkingForHaskell

default boolean supportsOmnibusLinkingForHaskell()

forceLinkWholeForHaskellOmnibus

default boolean forceLinkWholeForHaskellOmnibus()