Stack.Types.Package

Documentation

data PackageException

All exceptions thrown by the library.

Constructors

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

MismatchedCabalIdentifier !PackageIdentifierRevision !PackageIdentifier

Instances

Show PackageException

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> PackageException -> ShowS

show :: PackageException -> String

showList :: [PackageException] -> ShowS

Exception PackageException

Defined in Stack.Types.Package

Methods

toException :: PackageException -> SomeException

fromException :: SomeException -> Maybe PackageException

displayException :: PackageException -> String

data PackageLibraries

Libraries in a package. Since Cabal 2.0, internal libraries are a thing.

Constructors

NoLibraries

HasLibraries !(Set Text)

the foreign library names, sub libraries get built automatically without explicit component name passing

Instances

Show PackageLibraries

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> PackageLibraries -> ShowS

show :: PackageLibraries -> String

showList :: [PackageLibraries] -> ShowS

newtype ExeName

Name of an executable.

Constructors

ExeName

Fields

• unExeName :: Text

Instances

Eq ExeName

Defined in Stack.Types.Package

Methods

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

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

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 :: (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

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

Show ExeName

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> ExeName -> ShowS

show :: ExeName -> String

showList :: [ExeName] -> ShowS

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

NFData ExeName

Defined in Stack.Types.Package

Methods

rnf :: 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.1.1-61yUJamJcYLHh5iq4tOGPX" True) (C1 (MetaCons "ExeName" PrefixI True) (S1 (MetaSel (Just "unExeName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data Package

Some package info.

Constructors

Package

Fields

• packageName :: !PackageName

  Name of the package.

• packageVersion :: !Version

  Version of the package

• packageLicense :: !(Either License License)

  The license the package was released under.

• packageFiles :: !GetPackageFiles

  Get all files of the package.

• packageDeps :: !(Map PackageName DepValue)

  Packages that the package depends on, both as libraries and build tools.

• packageUnknownTools :: !(Set ExeName)

  Build tools specified in the legacy manner (build-tools:) that failed the hard-coded lookup.

• packageAllDeps :: !(Set PackageName)

  Original dependencies (not sieved).

• packageGhcOptions :: ![Text]

  Ghc options used on package.

• packageCabalConfigOpts :: ![Text]

  Additional options passed to ./Setup.hs configure

• packageFlags :: !(Map FlagName Bool)

  Flags used on package.

• packageDefaultFlags :: !(Map FlagName Bool)

  Defaults for unspecified flags.

• packageLibraries :: !PackageLibraries

  does the package have a buildable library stanza?

• packageInternalLibraries :: !(Set Text)

  names of internal libraries

• packageTests :: !(Map Text TestSuiteInterface)

  names and interfaces of test suites

• packageBenchmarks :: !(Set Text)

  names of benchmarks

• packageExes :: !(Set Text)

  names of executables

• packageOpts :: !GetPackageOpts

  Args to pass to GHC.

• packageHasExposedModules :: !Bool

  Does the package have exposed modules?

• packageBuildType :: !BuildType

  Package build-type.

• packageSetupDeps :: !(Maybe (Map PackageName VersionRange))

  If present: custom-setup dependencies

• packageCabalSpec :: !VersionRange

  Cabal spec range

Instances

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

Show Package

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> Package -> ShowS

show :: Package -> String

showList :: [Package] -> ShowS

packageIdent :: Package -> PackageIdentifier

data DepValue

The value for a map from dependency name. This contains both the version range and the type of dependency, and provides a semigroup instance.

Constructors

DepValue

Fields

• dvVersionRange :: !VersionRange
• dvType :: !DepType

Instances

Show DepValue

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> DepValue -> ShowS

show :: DepValue -> String

showList :: [DepValue] -> ShowS

Semigroup DepValue

Defined in Stack.Types.Package

Methods

(<>) :: DepValue -> DepValue -> DepValue

sconcat :: NonEmpty DepValue -> DepValue

stimes :: Integral b => b -> DepValue -> DepValue

data DepType

Is this package being used as a library, or just as a build tool? If the former, we need to ensure that a library actually exists. See https://github.com/commercialhaskell/stack/issues/2195

Constructors

AsLibrary

AsBuildTool

Instances

Eq DepType

Defined in Stack.Types.Package

Methods

(==) :: DepType -> DepType -> Bool

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

Show DepType

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> DepType -> ShowS

show :: DepType -> String

showList :: [DepType] -> ShowS

Semigroup DepType

Defined in Stack.Types.Package

Methods

(<>) :: DepType -> DepType -> DepType

sconcat :: NonEmpty DepType -> DepType

stimes :: Integral b => b -> DepType -> DepType

packageIdentifier :: Package -> PackageIdentifier

packageDefinedFlags :: Package -> Set FlagName

type InstallMap = Map PackageName (InstallLocation, Version)

newtype GetPackageOpts

Files that the package depends on, relative to package directory. Argument is the location of the .cabal file

Constructors

GetPackageOpts

Fields

• getPackageOpts :: forall env. HasEnvConfig env => InstallMap -> InstalledMap -> [PackageName] -> [PackageName] -> Path Abs File -> RIO env (Map NamedComponent (Map ModuleName (Path Abs File)), Map NamedComponent [DotCabalPath], Map NamedComponent BuildInfoOpts)

Instances

Show GetPackageOpts

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> GetPackageOpts -> ShowS

show :: GetPackageOpts -> String

showList :: [GetPackageOpts] -> ShowS

data BuildInfoOpts

GHC options based on cabal information and ghc-options.

Constructors

BuildInfoOpts

Fields

• bioOpts :: [String]
• bioOneWordOpts :: [String]
• bioPackageFlags :: [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)

• bioCabalMacros :: Path Abs File

Instances

Show BuildInfoOpts

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> BuildInfoOpts -> ShowS

show :: BuildInfoOpts -> String

showList :: [BuildInfoOpts] -> ShowS

data CabalFileType

Files to get for a cabal package.

Constructors

AllFiles

Modules

newtype GetPackageFiles

Files that the package depends on, relative to package directory. Argument is the location of the .cabal file

Constructors

GetPackageFiles

Fields

• getPackageFiles :: forall env. HasEnvConfig env => Path Abs File -> RIO env (Map NamedComponent (Map ModuleName (Path Abs File)), Map NamedComponent [DotCabalPath], Set (Path Abs File), [PackageWarning])

Instances

Show GetPackageFiles

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> GetPackageFiles -> ShowS

show :: GetPackageFiles -> String

showList :: [GetPackageFiles] -> ShowS

data PackageWarning

Warning generated when reading a package

Constructors

UnlistedModulesWarning NamedComponent [ModuleName]

Modules found that are not listed in cabal file

data PackageConfig

Package build configuration

Constructors

PackageConfig

Fields

• packageConfigEnableTests :: !Bool

  Are tests enabled?

• packageConfigEnableBenchmarks :: !Bool

  Are benchmarks enabled?

• packageConfigFlags :: !(Map FlagName Bool)

  Configured flags.

• packageConfigGhcOptions :: ![Text]

  Configured ghc options.

• packageConfigCabalConfigOpts :: ![Text]

  ./Setup.hs configure options

• packageConfigCompilerVersion :: ActualCompiler

  GHC version

• packageConfigPlatform :: !Platform

  host platform

Instances

Show PackageConfig

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> PackageConfig -> ShowS

show :: PackageConfig -> String

showList :: [PackageConfig] -> 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

psVersion :: PackageSource -> Version

data LocalPackage

Information on a locally available package of source code

Constructors

LocalPackage

Fields

• lpPackage :: !Package

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

• lpComponents :: !(Set NamedComponent)

  Components to build, not including the library component.

• lpUnbuildable :: !(Set NamedComponent)

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

• lpWanted :: !Bool

  Whether this package is wanted as a target.

• lpTestDeps :: !(Map PackageName VersionRange)

  Used for determining if we can use --enable-tests in a normal build.

• lpBenchDeps :: !(Map PackageName VersionRange)

  Used for determining if we can use --enable-benchmarks in a normal build.

• lpTestBench :: !(Maybe Package)

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

• lpCabalFile :: !(Path Abs File)

  The .cabal file

• lpBuildHaddocks :: !Bool
• lpForceDirty :: !Bool
• lpDirtyFiles :: !(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.

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

  current state of the files

• lpComponentFiles :: !(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

• unMemoizedWith :: RIO env a

Instances

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

fail :: String -> 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

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

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

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

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

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

data InstallLocation

A location to install a package into, either snapshot or local

Constructors

Snap

Local

Instances

Eq InstallLocation

Defined in Stack.Types.Package

Methods

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

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

Show InstallLocation

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> InstallLocation -> ShowS

show :: InstallLocation -> String

showList :: [InstallLocation] -> ShowS

Semigroup InstallLocation

Defined in Stack.Types.Package

Methods

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

sconcat :: NonEmpty InstallLocation -> InstallLocation

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

Monoid InstallLocation

Defined in Stack.Types.Package

Methods

mempty :: InstallLocation

mappend :: InstallLocation -> InstallLocation -> InstallLocation

mconcat :: [InstallLocation] -> InstallLocation

data InstalledPackageLocation

Constructors

InstalledTo InstallLocation

ExtraGlobal

Instances

Eq InstalledPackageLocation

Defined in Stack.Types.Package

Methods

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

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

Show InstalledPackageLocation

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> InstalledPackageLocation -> ShowS

show :: InstalledPackageLocation -> String

showList :: [InstalledPackageLocation] -> ShowS

data FileCacheInfo

Constructors

FileCacheInfo

Fields

• fciModTime :: !CTime
• fciSize :: !FileSize
• fciHash :: !SHA256

Instances

Eq FileCacheInfo

Defined in Stack.Types.Package

Methods

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

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

Show FileCacheInfo

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> FileCacheInfo -> ShowS

show :: FileCacheInfo -> String

showList :: [FileCacheInfo] -> ShowS

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

NFData FileCacheInfo

Defined in Stack.Types.Package

Methods

rnf :: FileCacheInfo -> ()

ToJSON FileCacheInfo

Defined in Stack.Types.Package

Methods

toJSON :: FileCacheInfo -> Value

toEncoding :: FileCacheInfo -> Encoding

toJSONList :: [FileCacheInfo] -> Value

toEncodingList :: [FileCacheInfo] -> Encoding

FromJSON FileCacheInfo

Defined in Stack.Types.Package

Methods

parseJSON :: Value -> Parser FileCacheInfo

parseJSONList :: Value -> Parser [FileCacheInfo]

type Rep FileCacheInfo

Defined in Stack.Types.Package

type Rep FileCacheInfo = D1 (MetaData "FileCacheInfo" "Stack.Types.Package" "stack-2.1.1-61yUJamJcYLHh5iq4tOGPX" False) (C1 (MetaCons "FileCacheInfo" PrefixI True) (S1 (MetaSel (Just "fciModTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CTime) :*: (S1 (MetaSel (Just "fciSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 FileSize) :*: S1 (MetaSel (Just "fciHash") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SHA256))))

data DotCabalDescriptor

A descriptor from a .cabal file indicating one of the following:

exposed-modules: Foo other-modules: Foo or main-is: Foo.hs

Constructors

DotCabalModule !ModuleName

DotCabalMain !FilePath

DotCabalFile !FilePath

DotCabalCFile !FilePath

Instances

Eq DotCabalDescriptor

Defined in Stack.Types.Package

Methods

(==) :: DotCabalDescriptor -> DotCabalDescriptor -> Bool

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

Ord DotCabalDescriptor

Defined in Stack.Types.Package

Methods

compare :: DotCabalDescriptor -> DotCabalDescriptor -> Ordering

(<) :: DotCabalDescriptor -> DotCabalDescriptor -> Bool

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

(>) :: DotCabalDescriptor -> DotCabalDescriptor -> Bool

(>=) :: DotCabalDescriptor -> DotCabalDescriptor -> Bool

max :: DotCabalDescriptor -> DotCabalDescriptor -> DotCabalDescriptor

min :: DotCabalDescriptor -> DotCabalDescriptor -> DotCabalDescriptor

Show DotCabalDescriptor

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> DotCabalDescriptor -> ShowS

show :: DotCabalDescriptor -> String

showList :: [DotCabalDescriptor] -> ShowS

dotCabalModule :: DotCabalDescriptor -> Maybe ModuleName

Maybe get the module name from the .cabal descriptor.

dotCabalMain :: DotCabalDescriptor -> Maybe FilePath

Maybe get the main name from the .cabal descriptor.

data DotCabalPath

A path resolved from the .cabal file, which is either main-is or an exposedinternalreferenced module.

Constructors

DotCabalModulePath !(Path Abs File)

DotCabalMainPath !(Path Abs File)

DotCabalFilePath !(Path Abs File)

DotCabalCFilePath !(Path Abs File)

Instances

Eq DotCabalPath

Defined in Stack.Types.Package

Methods

(==) :: DotCabalPath -> DotCabalPath -> Bool

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

Ord DotCabalPath

Defined in Stack.Types.Package

Methods

compare :: DotCabalPath -> DotCabalPath -> Ordering

(<) :: DotCabalPath -> DotCabalPath -> Bool

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

(>) :: DotCabalPath -> DotCabalPath -> Bool

(>=) :: DotCabalPath -> DotCabalPath -> Bool

max :: DotCabalPath -> DotCabalPath -> DotCabalPath

min :: DotCabalPath -> DotCabalPath -> DotCabalPath

Show DotCabalPath

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> DotCabalPath -> ShowS

show :: DotCabalPath -> String

showList :: [DotCabalPath] -> ShowS

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

Get the module path.

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

Get the main path.

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

Get the c file path.

dotCabalGetPath :: DotCabalPath -> Path Abs File

Get the path.

type InstalledMap = Map PackageName (InstallLocation, Installed)

data Installed

Constructors

Library PackageIdentifier GhcPkgId (Maybe (Either License License))

Executable PackageIdentifier

Instances

Eq Installed

Defined in Stack.Types.Package

Methods

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

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

Show Installed

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> Installed -> ShowS

show :: Installed -> String

showList :: [Installed] -> ShowS

installedPackageIdentifier :: Installed -> PackageIdentifier

installedVersion :: Installed -> Version

Get the installed Version.