Copyright	Isaac Jones 2003-2004
License	BSD3
Maintainer	cabal-devel@haskell.org
Portability	portable
Safe Haskell	None
Language	Haskell98

Distribution.Simple.LocalBuildInfo

Contents

Buildable package components
Installation directories

Description

Once a package has been configured we have resolved conditionals and dependencies, configured the compiler and other needed external programs. The LocalBuildInfo is used to hold all this information. It holds the install dirs, the compiler, the exact package dependencies, the configured programs, the package database to use and a bunch of miscellaneous configure flags. It gets saved and reloaded from a file (dist/setup-config). It gets passed in to very many subsequent build actions.

Synopsis

Documentation

data LocalBuildInfo Source

Data cached after configuration step. See also ConfigFlags.

Constructors

LocalBuildInfo

Fields

configFlags :: ConfigFlags
Options passed to the configuration step. Needed to re-run configuration when .cabal is out of date
extraConfigArgs :: [String]
Extra args on the command line for the configuration step. Needed to re-run configuration when .cabal is out of date
installDirTemplates :: InstallDirTemplates
The installation directories for the various different kinds of files TODO: inplaceDirTemplates :: InstallDirs FilePath
compiler :: Compiler
The compiler we're building with
hostPlatform :: Platform
The platform we're building for
buildDir :: FilePath
Where to build the package.
componentsConfigs :: [(ComponentName, ComponentLocalBuildInfo, [ComponentName])]
All the components to build, ordered by topological sort, and with their dependencies over the intrapackage dependency graph
installedPkgs :: InstalledPackageIndex
All the info about the installed packages that the current package depends on (directly or indirectly).
pkgDescrFile :: Maybe FilePath
the filename containing the .cabal file, if available
localPkgDescr :: PackageDescription
The resolved package description, that does not contain any conditionals.
pkgKey :: PackageKey
The package key for the current build, calculated from the package ID and the dependency graph.
instantiatedWith :: [(ModuleName, (InstalledPackageInfo, ModuleName))]
withPrograms :: ProgramConfiguration
Location and args for all programs
withPackageDB :: PackageDBStack
What package database to use, global/user
withVanillaLib :: Bool
Whether to build normal libs.
withProfLib :: Bool
Whether to build profiling versions of libs.
withSharedLib :: Bool
Whether to build shared versions of libs.
withDynExe :: Bool
Whether to link executables dynamically
withProfExe :: Bool
Whether to build executables for profiling.
withOptimization :: OptimisationLevel
Whether to build with optimization (if available).
withDebugInfo :: DebugInfoLevel
Whether to emit debug info (if available).
withGHCiLib :: Bool
Whether to build libs suitable for use with GHCi.
splitObjs :: Bool
Use -split-objs with GHC, if available
stripExes :: Bool
Whether to strip executables during install
stripLibs :: Bool
Whether to strip libraries during install
progPrefix :: PathTemplate
Prefix to be prepended to installed executables
progSuffix :: PathTemplate
Suffix to be appended to installed executables
relocatable :: Bool

Instances

Read LocalBuildInfo Source
Methods readsPrec :: Int -> ReadS LocalBuildInfo readList :: ReadS [LocalBuildInfo] readPrec :: ReadPrec LocalBuildInfo readListPrec :: ReadPrec [LocalBuildInfo]
Show LocalBuildInfo Source
Methods showsPrec :: Int -> LocalBuildInfo -> ShowS show :: LocalBuildInfo -> String showList :: [LocalBuildInfo] -> ShowS
Generic LocalBuildInfo Source
Associated Types type Rep LocalBuildInfo :: * -> * Methods from :: LocalBuildInfo -> Rep LocalBuildInfo x to :: Rep LocalBuildInfo x -> LocalBuildInfo
Binary LocalBuildInfo Source
Methods put :: LocalBuildInfo -> Put get :: Get LocalBuildInfo
type Rep LocalBuildInfo Source

externalPackageDeps :: LocalBuildInfo -> [(InstalledPackageId, PackageId)] Source

External package dependencies for the package as a whole. This is the union of the individual componentPackageDeps, less any internal deps.

inplacePackageId :: PackageId -> InstalledPackageId Source

The installed package Id we use for local packages registered in the local package db. This is what is used for intra-package deps between components.

Buildable package components

data Component Source

Constructors

CLib Library
CExe Executable
CTest TestSuite
CBench Benchmark

Instances

Eq Component Source
Methods (==) :: Component -> Component -> Bool (/=) :: Component -> Component -> Bool
Read Component Source
Methods readsPrec :: Int -> ReadS Component readList :: ReadS [Component] readPrec :: ReadPrec Component readListPrec :: ReadPrec [Component]
Show Component Source
Methods showsPrec :: Int -> Component -> ShowS show :: Component -> String showList :: [Component] -> ShowS

data ComponentName Source

Constructors

CLibName
CExeName String
CTestName String
CBenchName String

Instances

Eq ComponentName Source
Methods (==) :: ComponentName -> ComponentName -> Bool (/=) :: ComponentName -> ComponentName -> Bool
Ord ComponentName Source
Methods compare :: ComponentName -> ComponentName -> Ordering (<) :: ComponentName -> ComponentName -> Bool (<=) :: ComponentName -> ComponentName -> Bool (>) :: ComponentName -> ComponentName -> Bool (>=) :: ComponentName -> ComponentName -> Bool max :: ComponentName -> ComponentName -> ComponentName min :: ComponentName -> ComponentName -> ComponentName
Read ComponentName Source
Methods readsPrec :: Int -> ReadS ComponentName readList :: ReadS [ComponentName] readPrec :: ReadPrec ComponentName readListPrec :: ReadPrec [ComponentName]
Show ComponentName Source
Methods showsPrec :: Int -> ComponentName -> ShowS show :: ComponentName -> String showList :: [ComponentName] -> ShowS
Generic ComponentName Source
Associated Types type Rep ComponentName :: * -> * Methods from :: ComponentName -> Rep ComponentName x to :: Rep ComponentName x -> ComponentName
Binary ComponentName Source
Methods put :: ComponentName -> Put get :: Get ComponentName
type Rep ComponentName Source

showComponentName :: ComponentName -> String Source

data ComponentLocalBuildInfo Source

Constructors

LibComponentLocalBuildInfo
Fields componentPackageDeps :: [(InstalledPackageId, PackageId)] Resolved internal and external package dependencies for this component. The `BuildInfo` specifies a set of build dependencies that must be satisfied in terms of version ranges. This field fixes those dependencies to the specific versions available on this machine for this compiler. componentExposedModules :: [ExposedModule] componentPackageRenaming :: Map PackageName ModuleRenaming componentLibraries :: [LibraryName]
ExeComponentLocalBuildInfo
Fields componentPackageDeps :: [(InstalledPackageId, PackageId)] Resolved internal and external package dependencies for this component. The `BuildInfo` specifies a set of build dependencies that must be satisfied in terms of version ranges. This field fixes those dependencies to the specific versions available on this machine for this compiler. componentPackageRenaming :: Map PackageName ModuleRenaming
TestComponentLocalBuildInfo
Fields componentPackageDeps :: [(InstalledPackageId, PackageId)] Resolved internal and external package dependencies for this component. The `BuildInfo` specifies a set of build dependencies that must be satisfied in terms of version ranges. This field fixes those dependencies to the specific versions available on this machine for this compiler. componentPackageRenaming :: Map PackageName ModuleRenaming
BenchComponentLocalBuildInfo
Fields componentPackageDeps :: [(InstalledPackageId, PackageId)] Resolved internal and external package dependencies for this component. The `BuildInfo` specifies a set of build dependencies that must be satisfied in terms of version ranges. This field fixes those dependencies to the specific versions available on this machine for this compiler. componentPackageRenaming :: Map PackageName ModuleRenaming

Instances

Read ComponentLocalBuildInfo Source
Methods readsPrec :: Int -> ReadS ComponentLocalBuildInfo readList :: ReadS [ComponentLocalBuildInfo] readPrec :: ReadPrec ComponentLocalBuildInfo readListPrec :: ReadPrec [ComponentLocalBuildInfo]
Show ComponentLocalBuildInfo Source
Methods showsPrec :: Int -> ComponentLocalBuildInfo -> ShowS show :: ComponentLocalBuildInfo -> String showList :: [ComponentLocalBuildInfo] -> ShowS
Generic ComponentLocalBuildInfo Source
Associated Types type Rep ComponentLocalBuildInfo :: * -> * Methods from :: ComponentLocalBuildInfo -> Rep ComponentLocalBuildInfo x to :: Rep ComponentLocalBuildInfo x -> ComponentLocalBuildInfo
Binary ComponentLocalBuildInfo Source
Methods put :: ComponentLocalBuildInfo -> Put get :: Get ComponentLocalBuildInfo
type Rep ComponentLocalBuildInfo Source

data LibraryName Source

Constructors

LibraryName String

Instances

Read LibraryName Source
Methods readsPrec :: Int -> ReadS LibraryName readList :: ReadS [LibraryName] readPrec :: ReadPrec LibraryName readListPrec :: ReadPrec [LibraryName]
Show LibraryName Source
Methods showsPrec :: Int -> LibraryName -> ShowS show :: LibraryName -> String showList :: [LibraryName] -> ShowS
Generic LibraryName Source
Associated Types type Rep LibraryName :: * -> * Methods from :: LibraryName -> Rep LibraryName x to :: Rep LibraryName x -> LibraryName
Binary LibraryName Source
Methods put :: LibraryName -> Put get :: Get LibraryName
type Rep LibraryName Source

foldComponent :: (Library -> a) -> (Executable -> a) -> (TestSuite -> a) -> (Benchmark -> a) -> Component -> a Source

componentName :: Component -> ComponentName Source

componentBuildInfo :: Component -> BuildInfo Source

componentEnabled :: Component -> Bool Source

componentDisabledReason :: Component -> Maybe ComponentDisabledReason Source

data ComponentDisabledReason Source

Constructors

DisabledComponent
DisabledAllTests
DisabledAllBenchmarks

pkgComponents :: PackageDescription -> [Component] Source

All the components in the package (libs, exes, or test suites).

pkgEnabledComponents :: PackageDescription -> [Component] Source

All the components in the package that are buildable and enabled. Thus this excludes non-buildable components and test suites or benchmarks that have been disabled.

lookupComponent :: PackageDescription -> ComponentName -> Maybe Component Source

getComponent :: PackageDescription -> ComponentName -> Component Source

getComponentLocalBuildInfo :: LocalBuildInfo -> ComponentName -> ComponentLocalBuildInfo Source

allComponentsInBuildOrder :: LocalBuildInfo -> [(ComponentName, ComponentLocalBuildInfo)] Source

componentsInBuildOrder :: LocalBuildInfo -> [ComponentName] -> [(ComponentName, ComponentLocalBuildInfo)] Source

checkComponentsCyclic :: Ord key => [(node, key, [key])] -> Maybe [(node, key, [key])] Source

depLibraryPaths Source

Arguments

:: Bool	Building for inplace?
-> Bool	Generate prefix-relative library paths
-> LocalBuildInfo
-> ComponentLocalBuildInfo	Component that is being built
-> IO [FilePath]

Determine the directories containing the dynamic libraries of the transitive dependencies of the component we are building.

When wanted, and possible, returns paths relative to the installDirs prefix

withAllComponentsInBuildOrder :: PackageDescription -> LocalBuildInfo -> (Component -> ComponentLocalBuildInfo -> IO ()) -> IO () Source

Perform the action on each buildable Library or Executable (Component) in the PackageDescription, subject to the build order specified by the compBuildOrder field of the given LocalBuildInfo

withComponentsInBuildOrder :: PackageDescription -> LocalBuildInfo -> [ComponentName] -> (Component -> ComponentLocalBuildInfo -> IO ()) -> IO () Source

withComponentsLBI :: PackageDescription -> LocalBuildInfo -> (Component -> ComponentLocalBuildInfo -> IO ()) -> IO () Source

Deprecated: Use withAllComponentsInBuildOrder

withLibLBI :: PackageDescription -> LocalBuildInfo -> (Library -> ComponentLocalBuildInfo -> IO ()) -> IO () Source

If the package description has a library section, call the given function with the library build info as argument. Extended version of withLib that also gives corresponding build info.

withExeLBI :: PackageDescription -> LocalBuildInfo -> (Executable -> ComponentLocalBuildInfo -> IO ()) -> IO () Source

Perform the action on each buildable Executable in the package description. Extended version of withExe that also gives corresponding build info.

withTestLBI :: PackageDescription -> LocalBuildInfo -> (TestSuite -> ComponentLocalBuildInfo -> IO ()) -> IO () Source

Installation directories

module Distribution.Simple.InstallDirs

absoluteInstallDirs :: PackageDescription -> LocalBuildInfo -> CopyDest -> InstallDirs FilePath Source

See absoluteInstallDirs

prefixRelativeInstallDirs :: PackageId -> LocalBuildInfo -> InstallDirs (Maybe FilePath) Source

See prefixRelativeInstallDirs

substPathTemplate :: PackageId -> LocalBuildInfo -> PathTemplate -> FilePath Source