Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Build-specific types.
Synopsis
- data BuildException
- = Couldn'tFindPkgId PackageName
- | CompilerVersionMismatch (Maybe (ActualCompiler, Arch)) (WantedCompiler, Arch) GHCVariant CompilerBuild VersionCheck (Maybe (Path Abs File)) Text
- | Couldn'tParseTargets [Text]
- | UnknownTargets (Set PackageName) (Map PackageName Version) (Path Abs File)
- | TestSuiteFailure PackageIdentifier (Map Text (Maybe ExitCode)) (Maybe (Path Abs File)) ByteString
- | TestSuiteTypeUnsupported TestSuiteInterface
- | LocalPackageDoesn'tMatchTarget PackageName Version Version
- | NoSetupHsFound (Path Abs Dir)
- | InvalidFlagSpecification (Set UnusedFlags)
- | InvalidGhcOptionsSpecification [PackageName]
- | TargetParseException [Text]
- | SomeTargetsNotBuildable [(PackageName, NamedComponent)]
- | TestSuiteExeMissing Bool String String String
- | CabalCopyFailed Bool String
- | LocalPackagesPresent [PackageIdentifier]
- | CouldNotLockDistDir !(Path Abs File)
- | TaskCycleBug PackageIdentifier
- | PackageIdMissingBug PackageIdentifier
- | AllInOneBuildBug
- | MulipleResultsBug PackageName [DumpPackage]
- | TemplateHaskellNotFoundBug
- | HaddockIndexNotFound
- | ShowBuildErrorBug
- data BuildPrettyException
- = ConstructPlanFailed [ConstructPlanException] (Path Abs File) (Path Abs Dir) ParentMap (Set PackageName) (Map PackageName [PackageName])
- | ExecutionFailure [SomeException]
- | CabalExitedUnsuccessfully ExitCode PackageIdentifier (Path Abs File) [String] (Maybe (Path Abs File)) [Text]
- | SetupHsBuildFailure ExitCode (Maybe PackageIdentifier) (Path Abs File) [String] (Maybe (Path Abs File)) [Text]
- data ConstructPlanException
- = DependencyCycleDetected [PackageName]
- | DependencyPlanFailures Package (Map PackageName (VersionRange, LatestApplicableVersion, BadDependency))
- | UnknownPackage PackageName
- data BadDependency
- type ParentMap = MonoidMap PackageName (First Version, [(PackageIdentifier, VersionRange)])
- data FlagSource
- data UnusedFlags
- data InstallLocation
- data Installed
- psVersion :: PackageSource -> Version
- data Task = Task {}
- taskIsTarget :: Task -> Bool
- taskLocation :: Task -> InstallLocation
- taskTargetIsMutable :: Task -> IsMutable
- data LocalPackage = LocalPackage {
- lpPackage :: !Package
- lpComponents :: !(Set NamedComponent)
- lpUnbuildable :: !(Set NamedComponent)
- lpWanted :: !Bool
- lpTestBench :: !(Maybe Package)
- lpCabalFile :: !(Path Abs File)
- lpBuildHaddocks :: !Bool
- lpForceDirty :: !Bool
- lpDirtyFiles :: !(MemoizedWith EnvConfig (Maybe (Set FilePath)))
- lpNewBuildCaches :: !(MemoizedWith EnvConfig (Map NamedComponent (Map FilePath FileCacheInfo)))
- lpComponentFiles :: !(MemoizedWith EnvConfig (Map NamedComponent (Set (Path Abs File))))
- data BaseConfigOpts = BaseConfigOpts {
- bcoSnapDB :: !(Path Abs Dir)
- bcoLocalDB :: !(Path Abs Dir)
- bcoSnapInstallRoot :: !(Path Abs Dir)
- bcoLocalInstallRoot :: !(Path Abs Dir)
- bcoBuildOpts :: !BuildOpts
- bcoBuildOptsCLI :: !BuildOptsCLI
- bcoExtraDBs :: ![Path Abs Dir]
- data Plan = Plan {
- planTasks :: !(Map PackageName Task)
- planFinals :: !(Map PackageName Task)
- planUnregisterLocal :: !(Map GhcPkgId (PackageIdentifier, Text))
- planInstallExes :: !(Map Text InstallLocation)
- data TestOpts = TestOpts {
- toRerunTests :: !Bool
- toAdditionalArgs :: ![String]
- toCoverage :: !Bool
- toDisableRun :: !Bool
- toMaximumTimeSeconds :: !(Maybe Int)
- toAllowStdin :: !Bool
- data BenchmarkOpts = BenchmarkOpts {
- beoAdditionalArgs :: !(Maybe String)
- beoDisableRun :: !Bool
- data FileWatchOpts
- data BuildOpts = BuildOpts {
- boptsLibProfile :: !Bool
- boptsExeProfile :: !Bool
- boptsLibStrip :: !Bool
- boptsExeStrip :: !Bool
- boptsHaddock :: !Bool
- boptsHaddockOpts :: !HaddockOpts
- boptsOpenHaddocks :: !Bool
- boptsHaddockDeps :: !(Maybe Bool)
- boptsHaddockInternal :: !Bool
- boptsHaddockHyperlinkSource :: !Bool
- boptsInstallExes :: !Bool
- boptsInstallCompilerTool :: !Bool
- boptsPreFetch :: !Bool
- boptsKeepGoing :: !(Maybe Bool)
- boptsKeepTmpFiles :: !Bool
- boptsForceDirty :: !Bool
- boptsTests :: !Bool
- boptsTestOpts :: !TestOpts
- boptsBenchmarks :: !Bool
- boptsBenchmarkOpts :: !BenchmarkOpts
- boptsReconfigure :: !Bool
- boptsCabalVerbose :: !CabalVerbosity
- boptsSplitObjs :: !Bool
- boptsSkipComponents :: ![Text]
- boptsInterleavedOutput :: !Bool
- boptsDdumpDir :: !(Maybe Text)
- data BuildSubset
- defaultBuildOpts :: BuildOpts
- data TaskType
- data IsMutable
- installLocationIsMutable :: InstallLocation -> IsMutable
- data TaskConfigOpts = TaskConfigOpts {
- tcoMissing :: !(Set PackageIdentifier)
- tcoOpts :: !(Map PackageIdentifier GhcPkgId -> ConfigureOpts)
- newtype BuildCache = BuildCache {}
- data ConfigCache = ConfigCache {}
- configureOpts :: EnvConfig -> BaseConfigOpts -> Map PackageIdentifier GhcPkgId -> Bool -> IsMutable -> Package -> ConfigureOpts
- data CachePkgSrc
- toCachePkgSrc :: PackageSource -> CachePkgSrc
- isStackOpt :: Text -> Bool
- wantedLocalPackages :: [LocalPackage] -> Set PackageName
- newtype FileCacheInfo = FileCacheInfo {}
- data ConfigureOpts = ConfigureOpts {}
- data PrecompiledCache base = PrecompiledCache {}
Documentation
data BuildException Source #
Type representing exceptions thrown by functions exported by modules with
names beginning Stack.Build
.
Instances
Exception BuildException Source # | |
Defined in Stack.Types.Build | |
Show BuildException Source # | |
Defined in Stack.Types.Build showsPrec :: Int -> BuildException -> ShowS # show :: BuildException -> String # showList :: [BuildException] -> ShowS # |
data BuildPrettyException Source #
Instances
Exception BuildPrettyException Source # | |
Defined in Stack.Types.Build | |
Show BuildPrettyException Source # | |
Defined in Stack.Types.Build showsPrec :: Int -> BuildPrettyException -> ShowS # show :: BuildPrettyException -> String # showList :: [BuildPrettyException] -> ShowS # | |
Pretty BuildPrettyException Source # | |
Defined in Stack.Types.Build pretty :: BuildPrettyException -> StyleDoc # |
data ConstructPlanException Source #
DependencyCycleDetected [PackageName] | |
DependencyPlanFailures Package (Map PackageName (VersionRange, LatestApplicableVersion, BadDependency)) | |
UnknownPackage PackageName | Recommend adding to extra-deps, give a helpful version number? |
Instances
Show ConstructPlanException Source # | |
Defined in Stack.Types.Build showsPrec :: Int -> ConstructPlanException -> ShowS # show :: ConstructPlanException -> String # showList :: [ConstructPlanException] -> ShowS # | |
Eq ConstructPlanException Source # | |
Defined in Stack.Types.Build |
data BadDependency Source #
Reason why a dependency was not used
NotInBuildPlan | |
Couldn'tResolveItsDependencies Version | |
DependencyMismatch Version | |
HasNoLibrary | See description of |
BDDependencyCycleDetected ![PackageName] |
Instances
Show BadDependency Source # | |
Defined in Stack.Types.Build showsPrec :: Int -> BadDependency -> ShowS # show :: BadDependency -> String # showList :: [BadDependency] -> ShowS # | |
Eq BadDependency Source # | |
Defined in Stack.Types.Build (==) :: BadDependency -> BadDependency -> Bool # (/=) :: BadDependency -> BadDependency -> Bool # | |
Ord BadDependency Source # | |
Defined in Stack.Types.Build compare :: BadDependency -> BadDependency -> Ordering # (<) :: BadDependency -> BadDependency -> Bool # (<=) :: BadDependency -> BadDependency -> Bool # (>) :: BadDependency -> BadDependency -> Bool # (>=) :: BadDependency -> BadDependency -> Bool # max :: BadDependency -> BadDependency -> BadDependency # min :: BadDependency -> BadDependency -> BadDependency # |
type ParentMap = MonoidMap PackageName (First Version, [(PackageIdentifier, VersionRange)]) Source #
data FlagSource Source #
Instances
Show FlagSource Source # | |
Defined in Stack.Types.Build showsPrec :: Int -> FlagSource -> ShowS # show :: FlagSource -> String # showList :: [FlagSource] -> ShowS # | |
Eq FlagSource Source # | |
Defined in Stack.Types.Build (==) :: FlagSource -> FlagSource -> Bool # (/=) :: FlagSource -> FlagSource -> Bool # | |
Ord FlagSource Source # | |
Defined in Stack.Types.Build compare :: FlagSource -> FlagSource -> Ordering # (<) :: FlagSource -> FlagSource -> Bool # (<=) :: FlagSource -> FlagSource -> Bool # (>) :: FlagSource -> FlagSource -> Bool # (>=) :: FlagSource -> FlagSource -> Bool # max :: FlagSource -> FlagSource -> FlagSource # min :: FlagSource -> FlagSource -> FlagSource # |
data UnusedFlags Source #
UFNoPackage FlagSource PackageName | |
UFFlagsNotDefined FlagSource PackageName (Set FlagName) (Set FlagName) | |
UFSnapshot PackageName |
Instances
Show UnusedFlags Source # | |
Defined in Stack.Types.Build showsPrec :: Int -> UnusedFlags -> ShowS # show :: UnusedFlags -> String # showList :: [UnusedFlags] -> ShowS # | |
Eq UnusedFlags Source # | |
Defined in Stack.Types.Build (==) :: UnusedFlags -> UnusedFlags -> Bool # (/=) :: UnusedFlags -> UnusedFlags -> Bool # | |
Ord UnusedFlags Source # | |
Defined in Stack.Types.Build compare :: UnusedFlags -> UnusedFlags -> Ordering # (<) :: UnusedFlags -> UnusedFlags -> Bool # (<=) :: UnusedFlags -> UnusedFlags -> Bool # (>) :: UnusedFlags -> UnusedFlags -> Bool # (>=) :: UnusedFlags -> UnusedFlags -> Bool # max :: UnusedFlags -> UnusedFlags -> UnusedFlags # min :: UnusedFlags -> UnusedFlags -> UnusedFlags # |
data InstallLocation Source #
A location to install a package into, either snapshot or local
Instances
Monoid InstallLocation Source # | |
Defined in Stack.Types.Package mappend :: InstallLocation -> InstallLocation -> InstallLocation # mconcat :: [InstallLocation] -> InstallLocation # | |
Semigroup InstallLocation Source # | |
Defined in Stack.Types.Package (<>) :: InstallLocation -> InstallLocation -> InstallLocation # sconcat :: NonEmpty InstallLocation -> InstallLocation # stimes :: Integral b => b -> InstallLocation -> InstallLocation # | |
Show InstallLocation Source # | |
Defined in Stack.Types.Package showsPrec :: Int -> InstallLocation -> ShowS # show :: InstallLocation -> String # showList :: [InstallLocation] -> ShowS # | |
Eq InstallLocation Source # | |
Defined in Stack.Types.Package (==) :: InstallLocation -> InstallLocation -> Bool # (/=) :: InstallLocation -> InstallLocation -> Bool # |
Instances
psVersion :: PackageSource -> Version Source #
A task to perform when building
Task | |
|
taskIsTarget :: Task -> Bool Source #
taskLocation :: Task -> InstallLocation Source #
taskTargetIsMutable :: Task -> IsMutable Source #
data LocalPackage Source #
Information on a locally available package of source code
LocalPackage | |
|
Instances
Show LocalPackage Source # | |
Defined in Stack.Types.Package showsPrec :: Int -> LocalPackage -> ShowS # show :: LocalPackage -> String # showList :: [LocalPackage] -> ShowS # |
data BaseConfigOpts Source #
Basic information used to calculate what the configure options are
BaseConfigOpts | |
|
Instances
Show BaseConfigOpts Source # | |
Defined in Stack.Types.Build showsPrec :: Int -> BaseConfigOpts -> ShowS # show :: BaseConfigOpts -> String # showList :: [BaseConfigOpts] -> ShowS # |
A complete plan of what needs to be built and how to do it
Plan | |
|
Options for the FinalAction
DoTests
TestOpts | |
|
Instances
data BenchmarkOpts Source #
Options for the FinalAction
DoBenchmarks
BenchmarkOpts | |
|
Instances
Show BenchmarkOpts Source # | |
Defined in Stack.Types.Config.Build showsPrec :: Int -> BenchmarkOpts -> ShowS # show :: BenchmarkOpts -> String # showList :: [BenchmarkOpts] -> ShowS # | |
Eq BenchmarkOpts Source # | |
Defined in Stack.Types.Config.Build (==) :: BenchmarkOpts -> BenchmarkOpts -> Bool # (/=) :: BenchmarkOpts -> BenchmarkOpts -> Bool # |
data FileWatchOpts Source #
Instances
Show FileWatchOpts Source # | |
Defined in Stack.Types.Config.Build showsPrec :: Int -> FileWatchOpts -> ShowS # show :: FileWatchOpts -> String # showList :: [FileWatchOpts] -> ShowS # | |
Eq FileWatchOpts Source # | |
Defined in Stack.Types.Config.Build (==) :: FileWatchOpts -> FileWatchOpts -> Bool # (/=) :: FileWatchOpts -> FileWatchOpts -> Bool # |
Build options that is interpreted by the build command. This is built up from BuildOptsCLI and BuildOptsMonoid
BuildOpts | |
|
data BuildSubset Source #
Which subset of packages to build
BSAll | |
BSOnlySnapshot | Only install packages in the snapshot database, skipping packages intended for the local database. |
BSOnlyDependencies | |
BSOnlyLocals | Refuse to build anything in the snapshot database, see https://github.com/commercialhaskell/stack/issues/5272 |
Instances
Show BuildSubset Source # | |
Defined in Stack.Types.Config.Build showsPrec :: Int -> BuildSubset -> ShowS # show :: BuildSubset -> String # showList :: [BuildSubset] -> ShowS # | |
Eq BuildSubset Source # | |
Defined in Stack.Types.Config.Build (==) :: BuildSubset -> BuildSubset -> Bool # (/=) :: BuildSubset -> BuildSubset -> Bool # |
The type of a task, either building local code or something from the package index (upstream)
data TaskConfigOpts Source #
Given the IDs of any missing packages, produce the configure options
TaskConfigOpts | |
|
Instances
Show TaskConfigOpts Source # | |
Defined in Stack.Types.Build showsPrec :: Int -> TaskConfigOpts -> ShowS # show :: TaskConfigOpts -> String # showList :: [TaskConfigOpts] -> ShowS # |
newtype BuildCache Source #
Stored on disk to know whether the files have changed.
BuildCache | |
|
Instances
data ConfigCache Source #
Stored on disk to know whether the flags have changed.
ConfigCache | |
|
Instances
:: EnvConfig | |
-> BaseConfigOpts | |
-> Map PackageIdentifier GhcPkgId | dependencies |
-> Bool | local non-extra-dep? |
-> IsMutable | |
-> Package | |
-> ConfigureOpts |
Render a BaseConfigOpts
to an actual list of options
data CachePkgSrc Source #
Instances
isStackOpt :: Text -> Bool Source #
wantedLocalPackages :: [LocalPackage] -> Set PackageName Source #
Get set of wanted package names from locals.
newtype FileCacheInfo Source #
Instances
data ConfigureOpts Source #
Configure options to be sent to Setup.hs configure
Instances
data PrecompiledCache base Source #
Information on a compiled package: the library conf file (if relevant), the sublibraries (if present) and all of the executable paths.