Distribution.Simple.Toolkit

This module provides helper functions for writing custom Setup.hs scripts.

Writing build metadata in Setup.hs

userHooksWithBuildInfo :: UserHooks -> UserHooks

Attach a post-configure action to a UserHooks which serializes PackageDescription to .pkg_descr.buildinfo and LocalBuildInfo to .lbi.buildinfo. They should be added to your project's .gitignore file. Don't forget to edit the custom-setup stanza of your project's .cabal file and add cabal-toolkit to the dependencies.

simpleUserHooksWithBuildInfo :: UserHooks

defaultMainWithBuildInfo :: IO ()

Retrieving build metadata via Template Haskell

packageDescriptionQ :: Q Exp

The Template Haskell splice to retrieve PackageDescription.

packageDescriptionTypedQ :: Q (TExp PackageDescription)

localBuildInfoQ :: Q Exp

The Template Haskell splice to retrieve LocalBuildInfo.

localBuildInfoTypedQ :: Q (TExp LocalBuildInfo)

Convenient functions for working with build metadata

getComponentInstallDirs :: PackageDescription -> LocalBuildInfo -> ComponentName -> InstallDirs FilePath

Retrieve the InstallDirs corresponding to a ComponentName, assuming that component does exist and is unique.

getComponentBuildInfo :: PackageDescription -> ComponentName -> BuildInfo

Retrieve the BuildInfo corresponding to a ComponentName, assuming that component does exist and is unique.

getGHCLibDir :: LocalBuildInfo -> FilePath

Equivalent to what you get from ghc --print-libdir.

runLBIProgram :: LocalBuildInfo -> Program -> [ProgArg] -> IO ()

Run a Program with default Verbosity.

getLBIProgramOutput :: LocalBuildInfo -> Program -> [ProgArg] -> IO String

Run a Program and retrieve stdout with default Verbosity.

Convenient functions for working with GHC API

getGHCPackageDBFlags :: LocalBuildInfo -> [PackageDBFlag]

Extract PackageDBFlags from LocalBuildInfo to put into the packageDBFlags field of DynFlags. This is useful to ensure the invocation of GHC API shares the same package databases (e.g. a stack snapshot)

Extra Programs

cmakeProgram :: Program

makeProgram :: Program

ninjaProgram :: Program