Safe Haskell	None
Language	Haskell2010

Stack.Types.Package

Synopsis

Documentation

data PackageException Source

All exceptions thrown by the library.

Constructors

PackageInvalidCabalFile (Maybe (Path Abs File)) PError
PackageNoCabalFileFound (Path Abs Dir)
PackageMultipleCabalFilesFound (Path Abs Dir) [Path Abs File]
MismatchedCabalName (Path Abs File) PackageName

Instances

Show PackageException Source
Exception PackageException Source

data Package Source

Some package info.

Constructors

Package

Fields

packageName :: !PackageName: Name of the package.
packageVersion :: !Version: Version of the package
packageLicense :: !License: The license the package was released under.
packageFiles :: !GetPackageFiles: Get all files of the package.
packageDeps :: !(Map PackageName VersionRange): Packages that the package depends on.
packageTools :: ![Dependency]: A build tool name.
packageAllDeps :: !(Set PackageName): Original dependencies (not sieved).
packageGhcOptions :: ![Text]: Ghc options used on package.
packageFlags :: !(Map FlagName Bool): Flags used on package.
packageDefaultFlags :: !(Map FlagName Bool): Defaults for unspecified flags.
packageHasLibrary :: !Bool: does the package have a buildable library stanza?
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?
packageSimpleType :: !Bool: Does the package of build-type: Simple

Instances

Eq Package Source	Compares the package name.
Ord Package Source	Compares the package name.
Show Package Source

packageIdentifier :: Package -> PackageIdentifier Source

packageDefinedFlags :: Package -> Set FlagName Source

newtype GetPackageOpts Source

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

Constructors

GetPackageOpts
Fields getPackageOpts :: forall env m. (StackM env m, HasEnvConfig env) => SourceMap -> InstalledMap -> [PackageName] -> [PackageName] -> Path Abs File -> m (Map NamedComponent (Set ModuleName), Map NamedComponent (Set DotCabalPath), Map NamedComponent BuildInfoOpts)

Instances

Show GetPackageOpts Source

data BuildInfoOpts Source

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 :: Maybe (Path Abs File)

Instances

Show BuildInfoOpts Source

data CabalFileType Source

Files to get for a cabal package.

Constructors

AllFiles
Modules

newtype GetPackageFiles Source

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

Constructors

GetPackageFiles
Fields getPackageFiles :: forall m env. (StackM env m, HasEnvConfig env) => Path Abs File -> m (Map NamedComponent (Set ModuleName), Map NamedComponent (Set DotCabalPath), Set (Path Abs File), [PackageWarning])

Instances

Show GetPackageFiles Source

data PackageWarning Source

Warning generated when reading a package

Constructors

UnlistedModulesWarning (Maybe String) [ModuleName]

Modules found that are not listed in cabal file

data PackageConfig Source

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. packageConfigCompilerVersion :: !CompilerVersion GHC version packageConfigPlatform :: !Platform host platform

Instances

Show PackageConfig Source

type SourceMap = Map PackageName PackageSource Source

data PackageSource Source

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

Constructors

PSLocal LocalPackage
PSUpstream Version InstallLocation (Map FlagName Bool) [Text] (Maybe GitSHA1)	Upstream packages could be installed in either local or snapshot databases; this is what `InstallLocation` specifies.

Instances

Show PackageSource Source
PackageInstallInfo PackageSource Source

class PackageInstallInfo a where Source

Datatype which tells how which version of a package to install and where to install it into

Methods

piiVersion :: a -> Version Source

piiLocation :: a -> InstallLocation Source

Instances

PackageInstallInfo PackageSource Source

data LocalPackage Source

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.
lpDir :: !(Path Abs Dir): Directory of the package.
lpCabalFile :: !(Path Abs File): The .cabal file
lpForceDirty :: !Bool
lpDirtyFiles :: !(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.
lpNewBuildCache :: !(Map FilePath FileCacheInfo): current state of the files
lpFiles :: !(Set (Path Abs File)): all files used by this package

Instances

Show LocalPackage Source

data NamedComponent Source

A single, fully resolved component of a package

Constructors

CLib
CExe !Text
CTest !Text
CBench !Text

Instances

Eq NamedComponent Source
Ord NamedComponent Source
Show NamedComponent Source
type Ann (PackageName, NamedComponent) = AnsiAnn

renderComponent :: NamedComponent -> ByteString Source

renderPkgComponents :: [(PackageName, NamedComponent)] -> Text Source

renderPkgComponent :: (PackageName, NamedComponent) -> Text Source

exeComponents :: Set NamedComponent -> Set Text Source

testComponents :: Set NamedComponent -> Set Text Source

benchComponents :: Set NamedComponent -> Set Text Source

isCLib :: NamedComponent -> Bool Source

isCExe :: NamedComponent -> Bool Source

isCTest :: NamedComponent -> Bool Source

isCBench :: NamedComponent -> Bool Source

data InstallLocation Source

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

Constructors

Snap
Local

Instances

Eq InstallLocation Source
Show InstallLocation Source
Monoid InstallLocation Source

data InstalledPackageLocation Source

Constructors

InstalledTo InstallLocation
ExtraGlobal

Instances

Eq InstalledPackageLocation Source
Show InstalledPackageLocation Source

data FileCacheInfo Source

Constructors

FileCacheInfo
Fields fciModTime :: !ModTime fciSize :: !Word64 fciHash :: !ByteString

newtype ModTime Source

Used for storage and comparison.

Constructors

ModTime (Integer, Rational)

Instances

Eq ModTime Source
Data ModTime Source
Ord ModTime Source
Show ModTime Source
Generic ModTime Source
NFData ModTime Source
Store ModTime Source
type Rep ModTime Source

modTimeVC :: VersionConfig ModTime Source

testSuccessVC :: VersionConfig Bool Source

data DotCabalDescriptor Source

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 Source
Ord DotCabalDescriptor Source
Show DotCabalDescriptor Source

dotCabalModule :: DotCabalDescriptor -> Maybe ModuleName Source

Maybe get the module name from the .cabal descriptor.

dotCabalMain :: DotCabalDescriptor -> Maybe FilePath Source

Maybe get the main name from the .cabal descriptor.

data DotCabalPath Source

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 Source
Ord DotCabalPath Source
Show DotCabalPath Source

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

Get the module path.

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

Get the main path.

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

Get the c file path.

dotCabalGetPath :: DotCabalPath -> Path Abs File Source

Get the path.

type InstalledMap = Map PackageName (InstallLocation, Installed) Source

data Installed Source

Constructors

Library PackageIdentifier GhcPkgId
Executable PackageIdentifier

Instances

Eq Installed Source
Ord Installed Source
Show Installed Source

installedPackageIdentifier :: Installed -> PackageIdentifier Source

installedVersion :: Installed -> Version Source

Get the installed Version.

Eq FileCacheInfo Source
Data FileCacheInfo Source
Show FileCacheInfo Source
Generic FileCacheInfo Source
NFData FileCacheInfo Source
Store FileCacheInfo Source
type Rep FileCacheInfo Source