Stack.PackageDump

Documentation

type Line = Text

A single line of input, not including line endings

eachSection :: Monad m => ConduitM Line Void m a -> ConduitM Text a m ()

Apply the given Sink to each section of output, broken by a single line containing ---

eachPair :: Monad m => (Text -> ConduitM Line Void m a) -> ConduitM Line a m ()

Grab each key/value pair

data DumpPackage

Type representing dump information for a single package, as output by the ghc-pkg describe command.

Constructors

DumpPackage

Fields

• ghcPkgId :: !GhcPkgId

  The id field.

• packageIdent :: !PackageIdentifier

  The name and version fields. The name field is the munged package name. If the package is not for a sub library, its munged name is its name.

• sublib :: !(Maybe SublibDump)

  The sub library information if it's a sub-library.

• license :: !(Maybe License)
• libDirs :: ![FilePath]

  The library-dirs field.

• libraries :: ![Text]

  The hs-libraries field.

• hasExposedModules :: !Bool
• exposedModules :: !(Set ModuleName)
• depends :: ![GhcPkgId]

  The depends field (packages on which this package depends).

• haddockInterfaces :: ![FilePath]
• haddockHtml :: !(Maybe FilePath)
• isExposed :: !Bool

Instances

Read DumpPackage

Defined in Stack.Types.DumpPackage

Methods

readsPrec :: Int -> ReadS DumpPackage

readList :: ReadS [DumpPackage]

readPrec :: ReadPrec DumpPackage

readListPrec :: ReadPrec [DumpPackage]

Show DumpPackage

Defined in Stack.Types.DumpPackage

Methods

showsPrec :: Int -> DumpPackage -> ShowS

show :: DumpPackage -> String

showList :: [DumpPackage] -> ShowS

Eq DumpPackage

Defined in Stack.Types.DumpPackage

Methods

(==) :: DumpPackage -> DumpPackage -> Bool

(/=) :: DumpPackage -> DumpPackage -> Bool

conduitDumpPackage :: MonadThrow m => ConduitM Text DumpPackage m ()

Convert a stream of bytes into a stream of DumpPackages

ghcPkgDump

Arguments

:: (HasProcessContext env, HasTerm env)

=> GhcPkgExe

-> [Path Abs Dir]

A list of package databases. If empty, use the global package database.

-> ConduitM Text Void (RIO env) a

Sink.

-> RIO env a

Call ghc-pkg dump with appropriate flags and stream to the given sink, using either the global package database or the given package databases.

ghcPkgDescribe

Arguments

:: (HasCompiler env, HasProcessContext env, HasTerm env)

=> GhcPkgExe

-> PackageName

-> [Path Abs Dir]

A list of package databases. If empty, use the global package database.

-> ConduitM Text Void (RIO env) a

Sink.

-> RIO env a

Call ghc-pkg describe with appropriate flags and stream to the given sink, using either the global package database or the given package databases.

sinkMatching

Arguments

:: Monad m

=> Map PackageName Version

allowed versions

-> ConduitM DumpPackage o m (Map PackageName DumpPackage)

Find the package IDs matching the given constraints with all dependencies installed. Packages not mentioned in the provided Map are allowed to be present too.

pruneDeps

Arguments

:: (Ord name, Ord id)

=> (id -> name)

extract the name from an id

-> (item -> id)

the id of an item

-> (item -> [id])

get the dependencies of an item

-> (item -> item -> item)

choose the desired of two possible items

-> [item]

input items

-> Map name item

Prune a list of possible packages down to those whose dependencies are met.

• id uniquely identifies an item
• There can be multiple items per name