Stack.Types.Package

Documentation

data BioInput

Type representing inputs to generateBuildInfoOpts.

Constructors

BioInput

Fields

• installMap :: !InstallMap
• installedMap :: !InstalledMap
• cabalDir :: !(Path Abs Dir)
• distDir :: !(Path Abs Dir)
• omitPackages :: ![PackageName]
• addPackages :: ![PackageName]
• buildInfo :: !StackBuildInfo
• dotCabalPaths :: ![DotCabalPath]
• configLibDirs :: ![FilePath]
• configIncludeDirs :: ![FilePath]
• componentName :: !NamedComponent
• cabalVersion :: !Version

data BuildInfoOpts

GHC options based on cabal information and ghc-options.

Constructors

BuildInfoOpts

Fields

• opts :: [String]
• oneWordOpts :: [String]
• packageFlags :: [String]

  These options can safely have nubOrd applied to them, as there are no multi-word options (see https://github.com/commercialhaskell/stack/issues/1255)

• cabalMacros :: Path Abs File

Instances

Show BuildInfoOpts

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> BuildInfoOpts -> ShowS

show :: BuildInfoOpts -> String

showList :: [BuildInfoOpts] -> ShowS

newtype ExeName

Name of an executable.

Constructors

ExeName

Fields

• exeName :: Text

Instances

Data ExeName

Defined in Stack.Types.Package

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExeName -> c ExeName

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExeName

toConstr :: ExeName -> Constr

dataTypeOf :: ExeName -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ExeName)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExeName)

gmapT :: (forall b. Data b => b -> b) -> ExeName -> ExeName

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExeName -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExeName -> r

gmapQ :: (forall d. Data d => d -> u) -> ExeName -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ExeName -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExeName -> m ExeName

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExeName -> m ExeName

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExeName -> m ExeName

IsString ExeName

Defined in Stack.Types.Package

Methods

fromString :: String -> ExeName

Generic ExeName

Defined in Stack.Types.Package

Associated Types

type Rep ExeName :: Type -> Type

Methods

from :: ExeName -> Rep ExeName x

to :: Rep ExeName x -> ExeName

Show ExeName

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> ExeName -> ShowS

show :: ExeName -> String

showList :: [ExeName] -> ShowS

NFData ExeName

Defined in Stack.Types.Package

Methods

rnf :: ExeName -> ()

Eq ExeName

Defined in Stack.Types.Package

Methods

(==) :: ExeName -> ExeName -> Bool

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

Ord ExeName

Defined in Stack.Types.Package

Methods

compare :: ExeName -> ExeName -> Ordering

(<) :: ExeName -> ExeName -> Bool

(<=) :: ExeName -> ExeName -> Bool

(>) :: ExeName -> ExeName -> Bool

(>=) :: ExeName -> ExeName -> Bool

max :: ExeName -> ExeName -> ExeName

min :: ExeName -> ExeName -> ExeName

Hashable ExeName

Defined in Stack.Types.Package

Methods

hashWithSalt :: Int -> ExeName -> Int

hash :: ExeName -> Int

type Rep ExeName

Defined in Stack.Types.Package

type Rep ExeName = D1 ('MetaData "ExeName" "Stack.Types.Package" "stack-2.15.1-BDsvBT8AtC4AOYQNYrK19c" 'True) (C1 ('MetaCons "ExeName" 'PrefixI 'True) (S1 ('MetaSel ('Just "exeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype FileCacheInfo

Constructors

FileCacheInfo

Fields

• hash :: SHA256

Instances

FromJSON FileCacheInfo

Defined in Stack.Types.Package

Methods

parseJSON :: Value -> Parser FileCacheInfo

parseJSONList :: Value -> Parser [FileCacheInfo]

ToJSON FileCacheInfo

Defined in Stack.Types.Package

Methods

toJSON :: FileCacheInfo -> Value

toEncoding :: FileCacheInfo -> Encoding

toJSONList :: [FileCacheInfo] -> Value

toEncodingList :: [FileCacheInfo] -> Encoding

Generic FileCacheInfo

Defined in Stack.Types.Package

Associated Types

type Rep FileCacheInfo :: Type -> Type

Methods

from :: FileCacheInfo -> Rep FileCacheInfo x

to :: Rep FileCacheInfo x -> FileCacheInfo

Show FileCacheInfo

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> FileCacheInfo -> ShowS

show :: FileCacheInfo -> String

showList :: [FileCacheInfo] -> ShowS

NFData FileCacheInfo

Defined in Stack.Types.Package

Methods

rnf :: FileCacheInfo -> ()

Eq FileCacheInfo

Defined in Stack.Types.Package

Methods

(==) :: FileCacheInfo -> FileCacheInfo -> Bool

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

type Rep FileCacheInfo

Defined in Stack.Types.Package

type Rep FileCacheInfo = D1 ('MetaData "FileCacheInfo" "Stack.Types.Package" "stack-2.15.1-BDsvBT8AtC4AOYQNYrK19c" 'True) (C1 ('MetaCons "FileCacheInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "hash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SHA256)))

data InstallLocation

Type representing user package databases that packages can be installed into.

Constructors

Snap

The write-only package database, formerly known as the snapshot database.

Local

The mutable package database, formerly known as the local database.

Instances

Monoid InstallLocation

Defined in Stack.Types.Installed

Methods

mempty :: InstallLocation

mappend :: InstallLocation -> InstallLocation -> InstallLocation

mconcat :: [InstallLocation] -> InstallLocation

Semigroup InstallLocation

Defined in Stack.Types.Installed

Methods

(<>) :: InstallLocation -> InstallLocation -> InstallLocation

sconcat :: NonEmpty InstallLocation -> InstallLocation

stimes :: Integral b => b -> InstallLocation -> InstallLocation

Show InstallLocation

Defined in Stack.Types.Installed

Methods

showsPrec :: Int -> InstallLocation -> ShowS

show :: InstallLocation -> String

showList :: [InstallLocation] -> ShowS

Eq InstallLocation

Defined in Stack.Types.Installed

Methods

(==) :: InstallLocation -> InstallLocation -> Bool

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

data Installed

Type representing information about what is installed.

Constructors

Library PackageIdentifier InstalledLibraryInfo

A library, including its installed package id and, optionally, its license.

Executable PackageIdentifier

An executable.

Instances

Show Installed

Defined in Stack.Types.Installed

Methods

showsPrec :: Int -> Installed -> ShowS

show :: Installed -> String

showList :: [Installed] -> ShowS

Eq Installed

Defined in Stack.Types.Installed

Methods

(==) :: Installed -> Installed -> Bool

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

data InstalledLibraryInfo

Constructors

InstalledLibraryInfo

Fields

• ghcPkgId :: GhcPkgId
• license :: Maybe (Either License License)
• subLib :: Map StackUnqualCompName GhcPkgId

Instances

Show InstalledLibraryInfo

Defined in Stack.Types.Installed

Methods

showsPrec :: Int -> InstalledLibraryInfo -> ShowS

show :: InstalledLibraryInfo -> String

showList :: [InstalledLibraryInfo] -> ShowS

Eq InstalledLibraryInfo

Defined in Stack.Types.Installed

Methods

(==) :: InstalledLibraryInfo -> InstalledLibraryInfo -> Bool

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

data InstalledPackageLocation

Type representing user (non-global) package databases that can provide installed packages.

Constructors

InstalledTo InstallLocation

A package database that a package can be installed into.

ExtraPkgDb

An 'extra' package database, specified by extra-package-dbs.

Instances

Show InstalledPackageLocation

Defined in Stack.Types.Installed

Methods

showsPrec :: Int -> InstalledPackageLocation -> ShowS

show :: InstalledPackageLocation -> String

showList :: [InstalledPackageLocation] -> ShowS

Eq InstalledPackageLocation

Defined in Stack.Types.Installed

Methods

(==) :: InstalledPackageLocation -> InstalledPackageLocation -> Bool

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

data LocalPackage

Information on a locally available package of source code.

Constructors

LocalPackage

Fields

• package :: !Package

  The Package info itself, after resolution with package flags, with tests and benchmarks disabled

• components :: !(Set NamedComponent)

  Components to build, not including the library component.

• unbuildable :: !(Set NamedComponent)

  Components explicitly requested for build, that are marked "buildable: false".

• wanted :: !Bool

  Whether this package is wanted as a target.

• testBench :: !(Maybe Package)

  This stores the Package with tests and benchmarks enabled, if either is asked for by the user.

• cabalFP :: !(Path Abs File)

  Absolute path to the Cabal file.

• buildHaddocks :: !Bool

  Is Haddock documentation being built for this package?

• forceDirty :: !Bool
• dirtyFiles :: !(MemoizedWith EnvConfig (Maybe (Set FilePath)))

  Nothing == not dirty, Just == dirty. Note that the Set may be empty if we forced the build to treat packages as dirty. Also, the Set may not include all modified files.

• newBuildCaches :: !(MemoizedWith EnvConfig (Map NamedComponent (Map FilePath FileCacheInfo)))

  current state of the files

• componentFiles :: !(MemoizedWith EnvConfig (Map NamedComponent (Set (Path Abs File))))

  all files used by this package

Instances

Show LocalPackage

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> LocalPackage -> ShowS

show :: LocalPackage -> String

showList :: [LocalPackage] -> ShowS

newtype MemoizedWith env a

Constructors

MemoizedWith

Fields

• memoizedWith :: RIO env a

Instances

Applicative (MemoizedWith env)

Defined in Stack.Types.Package

Methods

pure :: a -> MemoizedWith env a

(<*>) :: MemoizedWith env (a -> b) -> MemoizedWith env a -> MemoizedWith env b

liftA2 :: (a -> b -> c) -> MemoizedWith env a -> MemoizedWith env b -> MemoizedWith env c

(*>) :: MemoizedWith env a -> MemoizedWith env b -> MemoizedWith env b

(<*) :: MemoizedWith env a -> MemoizedWith env b -> MemoizedWith env a

Functor (MemoizedWith env)

Defined in Stack.Types.Package

Methods

fmap :: (a -> b) -> MemoizedWith env a -> MemoizedWith env b

(<$) :: a -> MemoizedWith env b -> MemoizedWith env a

Monad (MemoizedWith env)

Defined in Stack.Types.Package

Methods

(>>=) :: MemoizedWith env a -> (a -> MemoizedWith env b) -> MemoizedWith env b

(>>) :: MemoizedWith env a -> MemoizedWith env b -> MemoizedWith env b

return :: a -> MemoizedWith env a

Show (MemoizedWith env a)

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> MemoizedWith env a -> ShowS

show :: MemoizedWith env a -> String

showList :: [MemoizedWith env a] -> ShowS

data Package

Some package info.

Constructors

Package

Fields

• name :: !PackageName

  Name of the package.

• version :: !Version

  Version of the package

• license :: !(Either License License)

  The license the package was released under.

• ghcOptions :: ![Text]

  Ghc options used on package.

• cabalConfigOpts :: ![Text]

  Additional options passed to ./Setup.hs configure

• flags :: !(Map FlagName Bool)

  Flags used on package.

• defaultFlags :: !(Map FlagName Bool)

  Defaults for unspecified flags.

• library :: !(Maybe StackLibrary)

  Does the package have a buildable main library stanza?

• subLibraries :: !(CompCollection StackLibrary)

  The sub-libraries of the package.

• foreignLibraries :: !(CompCollection StackForeignLibrary)

  The foreign libraries of the package.

• testSuites :: !(CompCollection StackTestSuite)

  The test suites of the package.

• benchmarks :: !(CompCollection StackBenchmark)

  The benchmarks of the package.

• executables :: !(CompCollection StackExecutable)

  The executables of the package.

• buildType :: !BuildType

  Package build-type.

• setupDeps :: !(Maybe (Map PackageName DepValue))

  If present: custom-setup dependencies

• cabalSpec :: !CabalSpecVersion

  Cabal spec range

• file :: StackPackageFile

  The Cabal sourced files related to the package at the package level The components may have file information in their own types

• testEnabled :: Bool

  This is a requirement because when tests are not enabled, Stack's package dependencies should ignore test dependencies. Directly set from packageConfigEnableTests.

• benchmarkEnabled :: Bool

  This is a requirement because when benchmark are not enabled, Stack's package dependencies should ignore benchmark dependencies. Directly set from packageConfigEnableBenchmarks.

Instances

Show Package

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> Package -> ShowS

show :: Package -> String

showList :: [Package] -> ShowS

Eq Package

Compares the package name.

Defined in Stack.Types.Package

Methods

(==) :: Package -> Package -> Bool

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

Ord Package

Compares the package name.

Defined in Stack.Types.Package

Methods

compare :: Package -> Package -> Ordering

(<) :: Package -> Package -> Bool

(<=) :: Package -> Package -> Bool

(>) :: Package -> Package -> Bool

(>=) :: Package -> Package -> Bool

max :: Package -> Package -> Package

min :: Package -> Package -> Package

data PackageConfig

Package build configuration

Constructors

PackageConfig

Fields

• enableTests :: !Bool

  Are tests enabled?

• enableBenchmarks :: !Bool

  Are benchmarks enabled?

• flags :: !(Map FlagName Bool)

  Configured flags.

• ghcOptions :: ![Text]

  Configured ghc options.

• cabalConfigOpts :: ![Text]

  ./Setup.hs configure options

• compilerVersion :: ActualCompiler

  GHC version

• platform :: !Platform

  host platform

Instances

Show PackageConfig

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> PackageConfig -> ShowS

show :: PackageConfig -> String

showList :: [PackageConfig] -> ShowS

data PackageDatabase

Type representing package databases that can provide installed packages.

Constructors

GlobalPkgDb

GHC's global package database.

UserPkgDb InstalledPackageLocation (Path Abs Dir)

A user package database.

Instances

Show PackageDatabase

Defined in Stack.Types.Installed

Methods

showsPrec :: Int -> PackageDatabase -> ShowS

show :: PackageDatabase -> String

showList :: [PackageDatabase] -> ShowS

Eq PackageDatabase

Defined in Stack.Types.Installed

Methods

(==) :: PackageDatabase -> PackageDatabase -> Bool

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

data PackageDbVariety

Type representing varieties of package databases that can provide installed packages.

Constructors

GlobalDb

GHC's global package database.

ExtraDb

An 'extra' package database, specified by extra-package-dbs.

WriteOnlyDb

The write-only package database, for immutable packages.

MutableDb

The mutable package database.

Instances

Show PackageDbVariety

Defined in Stack.Types.Installed

Methods

showsPrec :: Int -> PackageDbVariety -> ShowS

show :: PackageDbVariety -> String

showList :: [PackageDbVariety] -> ShowS

Eq PackageDbVariety

Defined in Stack.Types.Installed

Methods

(==) :: PackageDbVariety -> PackageDbVariety -> Bool

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

data PackageException

Type representing exceptions thrown by functions exported by the Stack.Package module.

Constructors

PackageInvalidCabalFile !(Either PackageIdentifierRevision (Path Abs File)) !(Maybe Version) ![PError] ![PWarning]

MismatchedCabalIdentifier !PackageIdentifierRevision !PackageIdentifier

CabalFileNameParseFail FilePath

CabalFileNameInvalidPackageName FilePath

ComponentNotParsedBug String

Instances

Exception PackageException

Defined in Stack.Types.Package

Methods

toException :: PackageException -> SomeException

fromException :: SomeException -> Maybe PackageException

displayException :: PackageException -> String

Show PackageException

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> PackageException -> ShowS

show :: PackageException -> String

showList :: [PackageException] -> ShowS

data PackageSource

Where the package's source is located: local directory or package index

Constructors

PSFilePath LocalPackage

Package which exist on the filesystem

PSRemote PackageLocationImmutable Version FromSnapshot CommonPackage

Package which is downloaded remotely.

Instances

Show PackageSource

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> PackageSource -> ShowS

show :: PackageSource -> String

showList :: [PackageSource] -> ShowS

dotCabalCFilePath :: DotCabalPath -> Maybe (Path Abs File)

Get the c file path.

dotCabalGetPath :: DotCabalPath -> Path Abs File

Get the path.

dotCabalMain :: DotCabalDescriptor -> Maybe FilePath

Maybe get the main name from the .cabal descriptor.

dotCabalMainPath :: DotCabalPath -> Maybe (Path Abs File)

Get the main path.

dotCabalModule :: DotCabalDescriptor -> Maybe ModuleName

Maybe get the module name from the .cabal descriptor.

dotCabalModulePath :: DotCabalPath -> Maybe (Path Abs File)

Get the module path.

installedMapGhcPkgId :: PackageIdentifier -> InstalledLibraryInfo -> Map PackageIdentifier GhcPkgId

Gathers all the GhcPkgId provided by a library into a map

lpFiles :: HasEnvConfig env => LocalPackage -> RIO env (Set (Path Abs File))

lpFilesForComponents :: HasEnvConfig env => Set NamedComponent -> LocalPackage -> RIO env (Set (Path Abs File))

memoizeRefWith :: MonadIO m => RIO env a -> m (MemoizedWith env a)

packageDefinedFlags :: Package -> Set FlagName

packageIdentifier :: Package -> PackageIdentifier

psVersion :: PackageSource -> Version

runMemoizedWith :: (HasEnvConfig env, MonadReader env m, MonadIO m) => MemoizedWith EnvConfig a -> m a

simpleInstalledLib :: PackageIdentifier -> GhcPkgId -> Map StackUnqualCompName GhcPkgId -> Installed

toCabalMungedPackageName :: PackageName -> StackUnqualCompName -> MungedPackageName

toPackageDbVariety :: PackageDatabase -> PackageDbVariety

A function to yield the variety of package database for a given package database that can provide installed packages.