Safe Haskell	None
Language	GHC2021

Stack.Types.SourceMap

Contents

Source map types
Helper types

Description

A source map maps a package name to how it should be built, including source code, flags and options. This module exports types used in various stages of source map construction. See build_overview.md for details on these stages.

Synopsis

data SMWanted = SMWanted {
- compiler :: !WantedCompiler
- project :: !(Map PackageName ProjectPackage)
- deps :: !(Map PackageName DepPackage)
- snapshotLocation :: !RawSnapshotLocation
}
data SMActual global = SMActual {
- compiler :: !ActualCompiler
- project :: !(Map PackageName ProjectPackage)
- deps :: !(Map PackageName DepPackage)
- globals :: !(Map PackageName global)
}
data Target
- = TargetAll !PackageType
- | TargetComps !(Set NamedComponent)
data PackageType
- = PTProject
- | PTDependency
data SMTargets = SMTargets {
- targets :: !(Map PackageName Target)
- deps :: !(Map PackageName DepPackage)
}
data SourceMap = SourceMap {
- targets :: !SMTargets
- compiler :: !ActualCompiler
- project :: !(Map PackageName ProjectPackage)
- deps :: !(Map PackageName DepPackage)
- globalPkgs :: !(Map PackageName GlobalPackage)
}
data FromSnapshot
- = FromSnapshot
- | NotFromSnapshot
data DepPackage = DepPackage {
- depCommon :: !CommonPackage
- location :: !PackageLocation
- hidden :: !Bool
- fromSnapshot :: !FromSnapshot
}
data ProjectPackage = ProjectPackage {
- projectCommon :: !CommonPackage
- cabalFP :: !(Path Abs File)
- resolvedDir :: !(ResolvedPath Dir)
}
ppComponents :: MonadIO m => ProjectPackage -> m (Set NamedComponent)
ppComponentsMaybe :: MonadIO m => (NamedComponent -> Maybe NamedComponent) -> ProjectPackage -> m (Set NamedComponent)
ppGPD :: MonadIO m => ProjectPackage -> m GenericPackageDescription
ppRoot :: ProjectPackage -> Path Abs Dir
ppVersion :: MonadIO m => ProjectPackage -> m Version
data CommonPackage = CommonPackage {
- gpd :: !(IO GenericPackageDescription)
- name :: !PackageName
- flags :: !(Map FlagName Bool)
- ghcOptions :: ![Text]
- cabalConfigOpts :: ![Text]
- buildHaddocks :: !Bool
}
newtype GlobalPackageVersion = GlobalPackageVersion Version
data GlobalPackage
- = GlobalPackage !Version
- | ReplacedGlobalPackage ![PackageName]
isReplacedGlobal :: GlobalPackage -> Bool
newtype SourceMapHash = SourceMapHash SHA256
smRelDir :: MonadThrow m => SourceMapHash -> m (Path Rel Dir)

Source map types

data SMWanted Source #

A source map with information on the wanted (but not actual) compiler. This is derived by parsing the stack.yaml file for packages, extra-deps, their configuration (e.g., flags and options), and parsing the snapshot it refers to. It does not include global packages or any information from the command line.

Invariant: a PackageName appears in either smwProject or smwDeps, but not both.

Constructors

SMWanted
Fields compiler :: !WantedCompiler project :: !(Map PackageName ProjectPackage) deps :: !(Map PackageName DepPackage) snapshotLocation :: !RawSnapshotLocation Where this snapshot is loaded from.

data SMActual global Source #

A source map with information on the actual compiler, including the contents of its global package database. It does not include any information from the command line.

Invariant: a PackageName appears in only one of the Maps.

Constructors

SMActual
Fields compiler :: !ActualCompiler project :: !(Map PackageName ProjectPackage) deps :: !(Map PackageName DepPackage) globals :: !(Map PackageName global)

data Target Source #

A type representing how a package is intended to be built.

Constructors

TargetAll !PackageType	Build all of the default components.
TargetComps !(Set NamedComponent)	Only build specific components

data PackageType Source #

Constructors

PTProject
PTDependency

Instances

Instances details

Show PackageType Source #
Instance details Defined in Stack.Types.SourceMap Methods showsPrec :: Int -> PackageType -> ShowS # show :: PackageType -> String # showList :: [PackageType] -> ShowS #
Eq PackageType Source #
Instance details Defined in Stack.Types.SourceMap Methods (==) :: PackageType -> PackageType -> Bool # (/=) :: PackageType -> PackageType -> Bool #

data SMTargets Source #

Builds on an SMActual by resolving the targets specified on the command line, potentially adding in new dependency packages in the process.

Constructors

SMTargets
Fields targets :: !(Map PackageName Target) deps :: !(Map PackageName DepPackage)

data SourceMap Source #

The final source map, taking an SMTargets and applying all command line flags and GHC options.

One source map value is distinguished from another by a hash of the parts of the value that are immutable.

Constructors

SourceMap

Fields

targets :: !SMTargets
Doesn't need to be included in the hash, does not affect the source map.
compiler :: !ActualCompiler
Need to hash the compiler version _and_ its installation path. Ideally there would be some kind of output from GHC telling us some unique ID for the compiler itself.
project :: !(Map PackageName ProjectPackage)
Doesn't need to be included in hash, doesn't affect any of the packages that get stored in the snapshot database.
deps :: !(Map PackageName DepPackage)
Need to hash all of the immutable dependencies, can ignore the mutable dependencies.
globalPkgs :: !(Map PackageName GlobalPackage)
Doesn't actually need to be hashed, implicitly captured by smCompiler. Can be broken if someone installs new global packages. We can document that as not supported, _or_ we could actually include all of this in the hash and make Stack more resilient.

Helper types

data FromSnapshot Source #

Flag showing if package comes from a snapshot. Used to ignore dependency bounds between such packages.

Constructors

FromSnapshot
NotFromSnapshot

Instances

Instances details

Show FromSnapshot Source #
Instance details Defined in Stack.Types.SourceMap Methods showsPrec :: Int -> FromSnapshot -> ShowS # show :: FromSnapshot -> String # showList :: [FromSnapshot] -> ShowS #

data DepPackage Source #

A view of a dependency package, specified in stack.yaml

Constructors

DepPackage
Fields depCommon :: !CommonPackage location :: !PackageLocation hidden :: !Bool Should the package be hidden after registering? Affects the script interpreter's module name import parser. fromSnapshot :: !FromSnapshot Needed to ignore bounds between snapshot packages See https://github.com/commercialhaskell/stackage/issues/3185

data ProjectPackage Source #

A view of a project package. Used to resolve components.

Constructors

ProjectPackage
Fields projectCommon :: !CommonPackage cabalFP :: !(Path Abs File) resolvedDir :: !(ResolvedPath Dir)

ppComponents :: MonadIO m => ProjectPackage -> m (Set NamedComponent) Source #

All components available in the given ProjectPackage

ppComponentsMaybe :: MonadIO m => (NamedComponent -> Maybe NamedComponent) -> ProjectPackage -> m (Set NamedComponent) Source #

ppGPD :: MonadIO m => ProjectPackage -> m GenericPackageDescription Source #

ppRoot :: ProjectPackage -> Path Abs Dir Source #

Root directory for the given ProjectPackage

ppVersion :: MonadIO m => ProjectPackage -> m Version Source #

Version for the given 'ProjectPackage

data CommonPackage Source #

Settings common to dependency packages (DepPackage) and project packages (ProjectPackage).

Constructors

CommonPackage
Fields gpd :: !(IO GenericPackageDescription) name :: !PackageName flags :: !(Map FlagName Bool) overrides default flags ghcOptions :: ![Text] cabalConfigOpts :: ![Text] buildHaddocks :: !Bool Should Haddock documentation be built for this package?

newtype GlobalPackageVersion Source #

A type representing versions of packages in the global package database.

Constructors

GlobalPackageVersion Version

data GlobalPackage Source #

A view of a package installed in the global package database or a marker for a replaced global package. A global package could be replaced because of a replaced dependency.

Constructors

GlobalPackage !Version
ReplacedGlobalPackage ![PackageName]

Instances

Instances details

Eq GlobalPackage Source #
Instance details Defined in Stack.Types.SourceMap Methods (==) :: GlobalPackage -> GlobalPackage -> Bool # (/=) :: GlobalPackage -> GlobalPackage -> Bool #

isReplacedGlobal :: GlobalPackage -> Bool Source #

newtype SourceMapHash Source #

A unique hash for the immutable portions of a SourceMap.

Constructors

SourceMapHash SHA256

smRelDir :: MonadThrow m => SourceMapHash -> m (Path Rel Dir) Source #

Returns relative directory name with source map's hash