Stack.GhcPkg

Functions for the GHC package database.

Documentation

findGhcPkgId

Arguments

:: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m, MonadThrow m)

=> EnvOverride

-> WhichCompiler

-> [Path Abs Dir]

package databases

-> PackageName

-> m (Maybe GhcPkgId)

Get the id of the package e.g. foo-0.0.0-9c293923c0685761dcff6f8c3ad8f8ec.

findGhcPkgKey

Arguments

:: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m, MonadThrow m)

=> EnvOverride

-> WhichCompiler

-> [Path Abs Dir]

package databases

-> PackageName

-> m (Maybe Text)

Get the package key e.g. foo_9bTCpMF7G4UFWJJvtDrIdB.

NOTE: GHC > 7.10 only! Will always yield Nothing otherwise.

getGlobalDB :: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m, MonadThrow m) => EnvOverride -> WhichCompiler -> m (Path Abs Dir)

Get the global package database

data EnvOverride

Override the environment received by a child process

envHelper :: EnvOverride -> Maybe [(String, String)]

Helper conversion function

createDatabase :: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m, MonadThrow m) => EnvOverride -> WhichCompiler -> Path Abs Dir -> m ()

Create a package database in the given directory, if it doesn't exist.

unregisterGhcPkgId

Arguments

:: (MonadIO m, MonadLogger m, MonadThrow m, MonadCatch m, MonadBaseControl IO m)

=> EnvOverride

-> WhichCompiler

-> CompilerVersion

-> Path Abs Dir

package database

-> GhcPkgId

-> PackageIdentifier

-> m ()

getCabalPkgVer :: (MonadThrow m, MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m) => EnvOverride -> WhichCompiler -> m Version

Get the version of Cabal from the global package database.

findGhcPkgHaddockHtml

Arguments

:: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m, MonadThrow m)

=> EnvOverride

-> WhichCompiler

-> [Path Abs Dir]

package databases

-> String

PackageIdentifier or GhcPkgId

-> m (Maybe (PackageIdentifier, Path Abs Dir))

Get the Haddock HTML documentation path of the package.

findGhcPkgDepends

Arguments

:: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m, MonadThrow m)

=> EnvOverride

-> WhichCompiler

-> [Path Abs Dir]

package databases

-> String

package identifier or GhcPkgId

-> m [GhcPkgId]

Get the dependencies of the package.

findTransitiveGhcPkgDepends

Arguments

:: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m, MonadThrow m)

=> EnvOverride

-> WhichCompiler

-> [Path Abs Dir]

package databases

-> PackageIdentifier

-> m (Set PackageIdentifier)

Finds dependencies of package, and all their dependencies, etc.

listGhcPkgDbs :: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m, MonadThrow m) => EnvOverride -> WhichCompiler -> [Path Abs Dir] -> m [PackageIdentifier]

ghcPkgExeName :: WhichCompiler -> String

Get the name to use for "ghc-pkg", given the compiler version.

mkGhcPackagePath :: Bool -> Path Abs Dir -> Path Abs Dir -> Path Abs Dir -> Text

Get the value for GHC_PACKAGE_PATH