com.facebook.buck.cxx.toolchain.nativelink

Class NativeLinkableInfo

java.lang.Object

com.facebook.buck.cxx.toolchain.nativelink.NativeLinkableInfo

All Implemented Interfaces:

NativeLinkable

public class NativeLinkableInfo
extends Object
implements NativeLinkable

An implementation of NativeLinkable where (most of) the behavior is fixed when created.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NativeLinkableInfo.Configuration Configuration is used for configuring the less-commonly changed parts of the @{link NativeLinkableInfo}.
static interface	NativeLinkableInfo.Delegate The Delegate allows instances to create NativeLinkableInput when requested.

Constructor Summary

Constructors

Constructor and Description
NativeLinkableInfo(BuildTarget buildTarget, String ruleType, com.google.common.collect.ImmutableList<NativeLinkable> deps, com.google.common.collect.ImmutableList<NativeLinkable> exportedDeps, NativeLinkableGroup.Linkage preferredLinkage, NativeLinkableInfo.Delegate delegate, NativeLinkableInfo.Configuration config)

Method Summary

Modifier and Type	Method and Description
static NativeLinkableInfo.Configuration	defaults() Returns a Configuration with all the default values.
static NativeLinkableInfo.Delegate	fixedDelegate(NativeLinkableInput instance, com.google.common.collect.ImmutableMap<String,SourcePath> sharedLibraries) Creates a delegate that always returns a fixed instance.
boolean	forceLinkWholeForHaskellOmnibus()
BuildTarget	getBuildTarget()
Iterable<? extends Arg>	getExportedLinkerFlags(ActionGraphBuilder graphBuilder)
Iterable<? extends Arg>	getExportedPostLinkerFlags(ActionGraphBuilder graphBuilder)
Iterable<? extends NativeLinkable>	getNativeLinkableDeps(ActionGraphBuilder graphBuilder)
Iterable<? extends NativeLinkable>	getNativeLinkableExportedDeps(ActionGraphBuilder graphBuilder)
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()
String	getRuleType()
com.google.common.collect.ImmutableMap<String,SourcePath>	getSharedLibraries(ActionGraphBuilder graphBuilder)
boolean	isPrebuiltSOForHaskellOmnibus(ActionGraphBuilder graphBuilder)
boolean	shouldBeLinkedInAppleTestAndHost()
boolean	supportsOmnibusLinking()
boolean	supportsOmnibusLinkingForHaskell()
String	toString()

Methods inherited from class java.lang.Object

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

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

getNativeLinkableInput

Constructor Detail

NativeLinkableInfo

public NativeLinkableInfo(BuildTarget buildTarget,
                          String ruleType,
                          com.google.common.collect.ImmutableList<NativeLinkable> deps,
                          com.google.common.collect.ImmutableList<NativeLinkable> exportedDeps,
                          NativeLinkableGroup.Linkage preferredLinkage,
                          NativeLinkableInfo.Delegate delegate,
                          NativeLinkableInfo.Configuration config)

Method Detail

fixedDelegate

public static NativeLinkableInfo.Delegate fixedDelegate(NativeLinkableInput instance,
                                                        com.google.common.collect.ImmutableMap<String,SourcePath> sharedLibraries)

Creates a delegate that always returns a fixed instance.

defaults

public static NativeLinkableInfo.Configuration defaults()

Returns a Configuration with all the default values. These can be overriden with the various set methods.

toString

public String toString()

Overrides:

toString in class Object

getRuleType

public String getRuleType()

Specified by:

getRuleType in interface NativeLinkable

supportsOmnibusLinking

public boolean supportsOmnibusLinking()

Specified by:

supportsOmnibusLinking in interface NativeLinkable

Returns:

whether this NativeLinkable supports omnibus linking.

isPrebuiltSOForHaskellOmnibus

public boolean isPrebuiltSOForHaskellOmnibus(ActionGraphBuilder graphBuilder)

Specified by:

isPrebuiltSOForHaskellOmnibus in interface NativeLinkable

supportsOmnibusLinkingForHaskell

public boolean supportsOmnibusLinkingForHaskell()

Specified by:

supportsOmnibusLinkingForHaskell in interface NativeLinkable

forceLinkWholeForHaskellOmnibus

public boolean forceLinkWholeForHaskellOmnibus()

Specified by:

forceLinkWholeForHaskellOmnibus in interface NativeLinkable

getBuildTarget

public BuildTarget getBuildTarget()

Specified by:

getBuildTarget in interface NativeLinkable

Returns:

The BuildTarget for this linkable.

getNativeLinkableDeps

public Iterable<? extends NativeLinkable> getNativeLinkableDeps(ActionGraphBuilder graphBuilder)

Specified by:

getNativeLinkableDeps in interface NativeLinkable

Returns:

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

getNativeLinkableExportedDeps

public Iterable<? extends NativeLinkable> getNativeLinkableExportedDeps(ActionGraphBuilder graphBuilder)

Specified by:

getNativeLinkableExportedDeps in interface NativeLinkable

Returns:

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

getNativeLinkableInput

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

Description copied from interface: NativeLinkable

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

Specified by:

getNativeLinkableInput in interface NativeLinkable

getNativeLinkTarget

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

Description copied from interface: NativeLinkable

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

Specified by:

getNativeLinkTarget in interface NativeLinkable

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

getPreferredLinkage

public NativeLinkableGroup.Linkage getPreferredLinkage()

Specified by:

getPreferredLinkage in interface NativeLinkable

Returns:

The preferred NativeLinkableGroup.Linkage for this linkable.

getSharedLibraries

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

Specified by:

getSharedLibraries in interface NativeLinkable

Returns:

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

getExportedLinkerFlags

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

Specified by:

getExportedLinkerFlags in interface NativeLinkable

Returns:

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

getExportedPostLinkerFlags

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

Specified by:

getExportedPostLinkerFlags in interface NativeLinkable

Returns:

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

shouldBeLinkedInAppleTestAndHost

public boolean shouldBeLinkedInAppleTestAndHost()

Specified by:

shouldBeLinkedInAppleTestAndHost in interface NativeLinkable