Stack.PackageDump

Documentation

type Line = ByteString

A single line of input, not including line endings

eachSection :: Monad m => Sink Line m a -> Conduit ByteString m a

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

eachPair :: Monad m => (ByteString -> Sink Line m a) -> Conduit Line m a

Grab each key/value pair

data DumpPackage profiling haddock

Dump information for a single package

Constructors

DumpPackage

Fields

• dpGhcPkgId :: !GhcPkgId
• dpPackageIdent :: !PackageIdentifier
• dpLibDirs :: ![FilePath]
• dpLibraries :: ![ByteString]
• dpHasExposedModules :: !Bool
• dpDepends :: ![GhcPkgId]
• dpHaddockInterfaces :: ![FilePath]
• dpHaddockHtml :: !(Maybe FilePath)
• dpProfiling :: !profiling
• dpHaddock :: !haddock
• dpIsExposed :: !Bool

Instances

(Eq profiling, Eq haddock) => Eq (DumpPackage profiling haddock)

Methods

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

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

(Ord profiling, Ord haddock) => Ord (DumpPackage profiling haddock)

Methods

compare :: DumpPackage profiling haddock -> DumpPackage profiling haddock -> Ordering

(<) :: DumpPackage profiling haddock -> DumpPackage profiling haddock -> Bool

(<=) :: DumpPackage profiling haddock -> DumpPackage profiling haddock -> Bool

(>) :: DumpPackage profiling haddock -> DumpPackage profiling haddock -> Bool

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

max :: DumpPackage profiling haddock -> DumpPackage profiling haddock -> DumpPackage profiling haddock

min :: DumpPackage profiling haddock -> DumpPackage profiling haddock -> DumpPackage profiling haddock

(Show profiling, Show haddock) => Show (DumpPackage profiling haddock)

Methods

showsPrec :: Int -> DumpPackage profiling haddock -> ShowS

show :: DumpPackage profiling haddock -> String

showList :: [DumpPackage profiling haddock] -> ShowS

conduitDumpPackage :: MonadThrow m => Conduit ByteString m (DumpPackage () ())

Convert a stream of bytes into a stream of DumpPackages

ghcPkgDump

Arguments

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

=> EnvOverride

-> WhichCompiler

-> [Path Abs Dir]

if empty, use global

-> Sink ByteString IO a

-> m a

Call ghc-pkg dump with appropriate flags and stream to the given Sink, for a single database

ghcPkgDescribe

Arguments

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

=> PackageName

-> EnvOverride

-> WhichCompiler

-> [Path Abs Dir]

if empty, use global

-> Sink ByteString IO a

-> m a

Call ghc-pkg describe with appropriate flags and stream to the given Sink, for a single database

data InstalledCache

Cached information on whether package have profiling libraries and haddocks.

data InstalledCacheEntry

Cached information on whether a package has profiling libraries and haddocks.

Constructors

InstalledCacheEntry

Fields

• installedCacheProfiling :: !Bool
• installedCacheHaddock :: !Bool
• installedCacheIdent :: !PackageIdentifier

Instances

Eq InstalledCacheEntry

Methods

(==) :: InstalledCacheEntry -> InstalledCacheEntry -> Bool

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

Generic InstalledCacheEntry

Associated Types

type Rep InstalledCacheEntry :: * -> *

Methods

from :: InstalledCacheEntry -> Rep InstalledCacheEntry x

to :: Rep InstalledCacheEntry x -> InstalledCacheEntry

Binary InstalledCacheEntry

Methods

put :: InstalledCacheEntry -> Put

get :: Get InstalledCacheEntry

HasStructuralInfo InstalledCacheEntry

Methods

structuralInfo :: Proxy * InstalledCacheEntry -> StructuralInfo

NFData InstalledCacheEntry

Methods

rnf :: InstalledCacheEntry -> ()

type Rep InstalledCacheEntry

newInstalledCache :: MonadIO m => m InstalledCache

Create a new, empty InstalledCache

loadInstalledCache :: (MonadLogger m, MonadIO m) => Path Abs File -> m InstalledCache

Load a InstalledCache from disk, swallowing any errors and returning an empty cache.

saveInstalledCache :: MonadIO m => Path Abs File -> InstalledCache -> m ()

Save a InstalledCache to disk

addProfiling :: MonadIO m => InstalledCache -> Conduit (DumpPackage a b) m (DumpPackage Bool b)

Add profiling information to the stream of DumpPackages

addHaddock :: MonadIO m => InstalledCache -> Conduit (DumpPackage a b) m (DumpPackage a Bool)

Add haddock information to the stream of DumpPackages

sinkMatching

Arguments

:: Monad m

=> Bool

require profiling?

-> Bool

require haddock?

-> Map PackageName Version

allowed versions

-> Consumer (DumpPackage Bool Bool) m (Map PackageName (DumpPackage Bool Bool))

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