com.facebook.buck.features.haskell

Class HaskellGhciDescription

java.lang.Object

com.facebook.buck.features.haskell.HaskellGhciDescription

All Implemented Interfaces:

ImplicitDepsInferringDescription<com.facebook.buck.features.haskell.HaskellGhciDescription.AbstractHaskellGhciDescriptionArg>, BaseDescription<HaskellGhciDescriptionArg>, Description<HaskellGhciDescriptionArg>, DescriptionWithTargetGraph<HaskellGhciDescriptionArg>, VersionRoot<HaskellGhciDescriptionArg>

public class HaskellGhciDescription
extends Object
implements DescriptionWithTargetGraph<HaskellGhciDescriptionArg>, ImplicitDepsInferringDescription<com.facebook.buck.features.haskell.HaskellGhciDescription.AbstractHaskellGhciDescriptionArg>, VersionRoot<HaskellGhciDescriptionArg>

Constructor Summary

Constructors

Constructor and Description
HaskellGhciDescription(ToolchainProvider toolchainProvider, CxxBuckConfig cxxBuckConfig)

Method Summary

Modifier and Type	Method and Description
BuildRule	createBuildRule(BuildRuleCreationContextWithTargetGraph context, BuildTarget buildTarget, BuildRuleParams params, HaskellGhciDescriptionArg args) Create a BuildRule for the given BuildRuleParams.
void	findDepsForTargetFromConstructorArgs(BuildTarget buildTarget, CellNameResolver cellRoots, com.facebook.buck.features.haskell.HaskellGhciDescription.AbstractHaskellGhciDescriptionArg constructorArg, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> extraDepsBuilder, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> targetGraphOnlyDepsBuilder)
Class<HaskellGhciDescriptionArg>	getConstructorArgType() The type of the constructor argument that is used by this description to create a rule
static com.facebook.buck.features.haskell.HaskellGhciDescription.HaskellGhciOmnibusSpec	getOmnibusSpec(BuildTarget baseTarget, ActionGraphBuilder graphBuilder, com.google.common.collect.ImmutableList<? extends NativeLinkable> omnibusRoots, com.google.common.collect.ImmutableList<? extends NativeLinkable> excludedRoots)
static Path	getSoLibsRelDir(BuildTarget baseTarget) Give the relative path from the omnibus to its shared library directory.
static BuildRule	requireOmnibusSharedObject(CellPathResolver cellPathResolver, BuildTarget baseTarget, ProjectFilesystem projectFilesystem, ActionGraphBuilder graphBuilder, CxxPlatform cxxPlatform, CxxBuckConfig cxxBuckConfig, Iterable<NativeLinkable> body, Iterable<NativeLinkable> deps, com.google.common.collect.ImmutableList<Arg> extraLdFlags) Give a rule for an omnibus object to be loaded into a ghci session

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.versions.VersionRoot

isVersionRoot

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

producesCacheableSubgraph

Methods inherited from interface com.facebook.buck.core.description.BaseDescription

getConfigurationDeps

Constructor Detail

HaskellGhciDescription

public HaskellGhciDescription(ToolchainProvider toolchainProvider,
                              CxxBuckConfig cxxBuckConfig)

Method Detail

getConstructorArgType

public Class<HaskellGhciDescriptionArg> getConstructorArgType()

Description copied from interface: BaseDescription

The type of the constructor argument that is used by this description to create a rule

Specified by:

getConstructorArgType in interface BaseDescription<HaskellGhciDescriptionArg>

getOmnibusSpec

public static com.facebook.buck.features.haskell.HaskellGhciDescription.HaskellGhciOmnibusSpec getOmnibusSpec(BuildTarget baseTarget,
                                                                                                              ActionGraphBuilder graphBuilder,
                                                                                                              com.google.common.collect.ImmutableList<? extends NativeLinkable> omnibusRoots,
                                                                                                              com.google.common.collect.ImmutableList<? extends NativeLinkable> excludedRoots)

Parameters:

omnibusRoots - roots of the graph of nodes (including transitive deps) to include in the omnibus link.

excludedRoots - roots of a the graph of nodes (including transitive deps) that cannot be included in the omnibus link.

Returns:

the HaskellGhciOmnibusSpec describing the omnibus link.

getSoLibsRelDir

public static Path getSoLibsRelDir(BuildTarget baseTarget)

Give the relative path from the omnibus to its shared library directory. Expose this to enable setting -rpath.

requireOmnibusSharedObject

public static BuildRule requireOmnibusSharedObject(CellPathResolver cellPathResolver,
                                                   BuildTarget baseTarget,
                                                   ProjectFilesystem projectFilesystem,
                                                   ActionGraphBuilder graphBuilder,
                                                   CxxPlatform cxxPlatform,
                                                   CxxBuckConfig cxxBuckConfig,
                                                   Iterable<NativeLinkable> body,
                                                   Iterable<NativeLinkable> deps,
                                                   com.google.common.collect.ImmutableList<Arg> extraLdFlags)

Give a rule for an omnibus object to be loaded into a ghci session

createBuildRule

public BuildRule createBuildRule(BuildRuleCreationContextWithTargetGraph context,
                                 BuildTarget buildTarget,
                                 BuildRuleParams params,
                                 HaskellGhciDescriptionArg args)

Description copied from interface: DescriptionWithTargetGraph

Create a BuildRule for the given BuildRuleParams. Note that the BuildTarget referred to in the params contains the Flavor to create.

Specified by:

createBuildRule in interface DescriptionWithTargetGraph<HaskellGhciDescriptionArg>

args - A constructor argument, of type as returned by BaseDescription.getConstructorArgType().

Returns:

The BuildRule that describes the default flavour of the rule being described.

findDepsForTargetFromConstructorArgs

public void findDepsForTargetFromConstructorArgs(BuildTarget buildTarget,
                                                 CellNameResolver cellRoots,
                                                 com.facebook.buck.features.haskell.HaskellGhciDescription.AbstractHaskellGhciDescriptionArg constructorArg,
                                                 com.google.common.collect.ImmutableCollection.Builder<BuildTarget> extraDepsBuilder,
                                                 com.google.common.collect.ImmutableCollection.Builder<BuildTarget> targetGraphOnlyDepsBuilder)

Specified by:

findDepsForTargetFromConstructorArgs in interface ImplicitDepsInferringDescription<com.facebook.buck.features.haskell.HaskellGhciDescription.AbstractHaskellGhciDescriptionArg>