Safe Haskell	None
Language	Haskell2010

Stack.BuildPlan

Description

Resolving a build plan for a set of packages in a given Stackage snapshot.

Synopsis

Documentation

data BuildPlanException Source

Constructors

UnknownPackages (Path Abs File) (Map PackageName (Maybe Version, Set PackageName)) (Map PackageName (Set PackageIdentifier))
SnapshotNotFound SnapName

Instances

Show BuildPlanException Source
Methods showsPrec :: Int -> BuildPlanException -> ShowS show :: BuildPlanException -> String showList :: [BuildPlanException] -> ShowS
Exception BuildPlanException Source
Methods toException :: BuildPlanException -> SomeException fromException :: SomeException -> Maybe BuildPlanException displayException :: BuildPlanException -> String

data MiniBuildPlan Source

A simplified version of the BuildPlan + cabal file.

Constructors

MiniBuildPlan
Fields mbpCompilerVersion :: !CompilerVersion mbpPackages :: !(Map PackageName MiniPackageInfo)

Instances

Eq MiniBuildPlan Source
Methods (==) :: MiniBuildPlan -> MiniBuildPlan -> Bool (/=) :: MiniBuildPlan -> MiniBuildPlan -> Bool
Show MiniBuildPlan Source
Methods showsPrec :: Int -> MiniBuildPlan -> ShowS show :: MiniBuildPlan -> String showList :: [MiniBuildPlan] -> ShowS
Generic MiniBuildPlan Source
Associated Types type Rep MiniBuildPlan :: * -> * Methods from :: MiniBuildPlan -> Rep MiniBuildPlan x to :: Rep MiniBuildPlan x -> MiniBuildPlan
Binary MiniBuildPlan Source
Methods put :: MiniBuildPlan -> Put get :: Get MiniBuildPlan
HasStructuralInfo MiniBuildPlan Source
Methods structuralInfo :: Proxy * MiniBuildPlan -> StructuralInfo
HasSemanticVersion MiniBuildPlan Source
Associated Types type SemanticVersion MiniBuildPlan :: Nat
NFData MiniBuildPlan Source
Methods rnf :: MiniBuildPlan -> ()
type Rep MiniBuildPlan Source
type SemanticVersion MiniBuildPlan = 0

data MiniPackageInfo Source

Information on a single package for the MiniBuildPlan.

Constructors

MiniPackageInfo

Fields

mpiVersion :: !Version
mpiFlags :: !(Map FlagName Bool)
mpiPackageDeps :: !(Set PackageName)
mpiToolDeps :: !(Set ByteString)
Due to ambiguity in Cabal, it is unclear whether this refers to the executable name, the package name, or something else. We have to guess based on what's available, which is why we store this is an unwrapped ByteString.
mpiExes :: !(Set ExeName)
Executables provided by this package
mpiHasLibrary :: !Bool
Is there a library present?

Instances

Eq MiniPackageInfo Source
Methods (==) :: MiniPackageInfo -> MiniPackageInfo -> Bool (/=) :: MiniPackageInfo -> MiniPackageInfo -> Bool
Show MiniPackageInfo Source
Methods showsPrec :: Int -> MiniPackageInfo -> ShowS show :: MiniPackageInfo -> String showList :: [MiniPackageInfo] -> ShowS
Generic MiniPackageInfo Source
Associated Types type Rep MiniPackageInfo :: * -> * Methods from :: MiniPackageInfo -> Rep MiniPackageInfo x to :: Rep MiniPackageInfo x -> MiniPackageInfo
Binary MiniPackageInfo Source
Methods put :: MiniPackageInfo -> Put get :: Get MiniPackageInfo
HasStructuralInfo MiniPackageInfo Source
Methods structuralInfo :: Proxy * MiniPackageInfo -> StructuralInfo
NFData MiniPackageInfo Source
Methods rnf :: MiniPackageInfo -> ()
type Rep MiniPackageInfo Source

data Snapshots Source

Most recent Nightly and newest LTS version per major release.

Constructors

Snapshots
Fields snapshotsNightly :: !Day snapshotsLts :: !(IntMap Int)

Instances

Show Snapshots Source
Methods showsPrec :: Int -> Snapshots -> ShowS show :: Snapshots -> String showList :: [Snapshots] -> ShowS
FromJSON Snapshots Source
Methods parseJSON :: Value -> Parser Snapshots

getSnapshots :: (MonadThrow m, MonadIO m, MonadReader env m, HasHttpManager env, HasStackRoot env, HasConfig env) => m Snapshots Source

Download the Snapshots value from stackage.org.

loadMiniBuildPlan :: (MonadIO m, MonadThrow m, MonadLogger m, MonadReader env m, HasHttpManager env, HasConfig env, HasGHCVariant env, MonadBaseControl IO m, MonadCatch m) => SnapName -> m MiniBuildPlan Source

Load up a MiniBuildPlan, preferably from cache

resolveBuildPlan Source

Arguments

:: (MonadThrow m, MonadIO m, MonadReader env m, HasBuildConfig env, MonadLogger m, HasHttpManager env, MonadBaseControl IO m, MonadCatch m)
=> EnvOverride
-> MiniBuildPlan
-> (PackageName -> Bool)	is it shadowed by a local package?
-> Map PackageName (Set PackageName)	required packages, and users of it
-> m (Map PackageName (Version, Map FlagName Bool), Map PackageName (Set PackageName))

Determine the necessary packages to install to have the given set of packages available.

This function will not provide test suite and benchmark dependencies.

This may fail if a target package is not present in the BuildPlan.

findBuildPlan :: (MonadIO m, MonadCatch m, MonadLogger m, MonadReader env m, HasHttpManager env, HasConfig env, HasGHCVariant env, MonadBaseControl IO m) => [GenericPackageDescription] -> [SnapName] -> m (Maybe (SnapName, Map PackageName (Map FlagName Bool))) Source

Find a snapshot and set of flags that is compatible with the given GenericPackageDescription. Returns Nothing if no such snapshot is found.

type ToolMap = Map ByteString (Set PackageName) Source

Look up with packages provide which tools.

getToolMap :: MiniBuildPlan -> Map ByteString (Set PackageName) Source

Map from tool name to package providing it

shadowMiniBuildPlan :: MiniBuildPlan -> Set PackageName -> (MiniBuildPlan, Map PackageName MiniPackageInfo) Source

parseCustomMiniBuildPlan Source

Arguments

:: (MonadIO m, MonadCatch m, MonadLogger m, MonadReader env m, HasHttpManager env, HasConfig env, MonadBaseControl IO m)
=> Path Abs File	stack.yaml file location
-> Text
-> m MiniBuildPlan