Cabal-2.2.0.0: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2004
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Simple.LocalBuildInfo

Contents

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

Instances
Read LocalBuildInfo Source # 
Instance details
Show LocalBuildInfo Source # 
Instance details
Generic LocalBuildInfo Source # 
Instance details

Associated Types

type Rep LocalBuildInfo :: * -> * #

Binary LocalBuildInfo Source # 
Instance details
type Rep LocalBuildInfo Source # 
Instance details
type Rep LocalBuildInfo = D1 (MetaData "LocalBuildInfo" "Distribution.Types.LocalBuildInfo" "Cabal-2.2.0.0-inplace" False) (C1 (MetaCons "LocalBuildInfo" PrefixI True) (((((S1 (MetaSel (Just "configFlags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ConfigFlags) :*: S1 (MetaSel (Just "flagAssignment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FlagAssignment)) :*: (S1 (MetaSel (Just "componentEnabledSpec") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentRequestedSpec) :*: S1 (MetaSel (Just "extraConfigArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]))) :*: ((S1 (MetaSel (Just "installDirTemplates") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 InstallDirTemplates) :*: S1 (MetaSel (Just "compiler") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Compiler)) :*: (S1 (MetaSel (Just "hostPlatform") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Platform) :*: (S1 (MetaSel (Just "buildDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "cabalFilePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)))))) :*: (((S1 (MetaSel (Just "componentGraph") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Graph ComponentLocalBuildInfo)) :*: S1 (MetaSel (Just "componentNameMap") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map ComponentName [ComponentLocalBuildInfo]))) :*: (S1 (MetaSel (Just "installedPkgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 InstalledPackageIndex) :*: S1 (MetaSel (Just "pkgDescrFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)))) :*: ((S1 (MetaSel (Just "localPkgDescr") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageDescription) :*: S1 (MetaSel (Just "withPrograms") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ProgramDb)) :*: (S1 (MetaSel (Just "withPackageDB") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PackageDBStack) :*: (S1 (MetaSel (Just "withVanillaLib") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "withProfLib") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))))) :*: ((((S1 (MetaSel (Just "withSharedLib") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "withStaticLib") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "withDynExe") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "withProfExe") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :*: ((S1 (MetaSel (Just "withProfLibDetail") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ProfDetailLevel) :*: S1 (MetaSel (Just "withProfExeDetail") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ProfDetailLevel)) :*: (S1 (MetaSel (Just "withOptimization") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OptimisationLevel) :*: (S1 (MetaSel (Just "withDebugInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 DebugInfoLevel) :*: S1 (MetaSel (Just "withGHCiLib") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))) :*: (((S1 (MetaSel (Just "splitSections") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "splitObjs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "stripExes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "stripLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :*: ((S1 (MetaSel (Just "exeCoverage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "libCoverage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "progPrefix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PathTemplate) :*: (S1 (MetaSel (Just "progSuffix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PathTemplate) :*: S1 (MetaSel (Just "relocatable") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))))))

externalPackageDeps :: LocalBuildInfo -> [(UnitId, MungedPackageId)] Source #

Deprecated: You almost certainly don't want this function, which agglomerates the dependencies of ALL enabled components. If you're using this to write out information on your dependencies, read off the dependencies directly from the actual component in question. To be removed in Cabal 3.0

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

localComponentId :: LocalBuildInfo -> ComponentId Source #

Extract the ComponentId from the public library component of a LocalBuildInfo if it exists, or make a fake component ID based on the package ID.

localUnitId :: LocalBuildInfo -> UnitId Source #

Extract the UnitId from the library component of a LocalBuildInfo if it exists, or make a fake unit ID based on the package ID.

localCompatPackageKey :: LocalBuildInfo -> String Source #

Extract the compatibility package key from the public library component of a LocalBuildInfo if it exists, or make a fake package key based on the package ID.

Buildable package components

data Component Source #

Instances
Eq Component Source # 
Instance details
Read Component Source # 
Instance details
Show Component Source # 
Instance details
Semigroup Component Source # 
Instance details
HasBuildInfo Component Source # 
Instance details

Methods

buildInfo :: Lens' Component BuildInfo Source #

buildable :: Lens' Component Bool Source #

buildTools :: Lens' Component [LegacyExeDependency] Source #

buildToolDepends :: Lens' Component [ExeDependency] Source #

cppOptions :: Lens' Component [String] Source #

asmOptions :: Lens' Component [String] Source #

cmmOptions :: Lens' Component [String] Source #

ccOptions :: Lens' Component [String] Source #

cxxOptions :: Lens' Component [String] Source #

ldOptions :: Lens' Component [String] Source #

pkgconfigDepends :: Lens' Component [PkgconfigDependency] Source #

frameworks :: Lens' Component [String] Source #

extraFrameworkDirs :: Lens' Component [String] Source #

asmSources :: Lens' Component [FilePath] Source #

cmmSources :: Lens' Component [FilePath] Source #

cSources :: Lens' Component [FilePath] Source #

cxxSources :: Lens' Component [FilePath] Source #

jsSources :: Lens' Component [FilePath] Source #

hsSourceDirs :: Lens' Component [FilePath] Source #

otherModules :: Lens' Component [ModuleName] Source #

virtualModules :: Lens' Component [ModuleName] Source #

autogenModules :: Lens' Component [ModuleName] Source #

defaultLanguage :: Lens' Component (Maybe Language) Source #

otherLanguages :: Lens' Component [Language] Source #

defaultExtensions :: Lens' Component [Extension] Source #

otherExtensions :: Lens' Component [Extension] Source #

oldExtensions :: Lens' Component [Extension] Source #

extraLibs :: Lens' Component [String] Source #

extraGHCiLibs :: Lens' Component [String] Source #

extraBundledLibs :: Lens' Component [String] Source #

extraLibFlavours :: Lens' Component [String] Source #

extraLibDirs :: Lens' Component [String] Source #

includeDirs :: Lens' Component [FilePath] Source #

includes :: Lens' Component [FilePath] Source #

installIncludes :: Lens' Component [FilePath] Source #

options :: Lens' Component [(CompilerFlavor, [String])] Source #

profOptions :: Lens' Component [(CompilerFlavor, [String])] Source #

sharedOptions :: Lens' Component [(CompilerFlavor, [String])] Source #

staticOptions :: Lens' Component [(CompilerFlavor, [String])] Source #

customFieldsBI :: Lens' Component [(String, String)] Source #

targetBuildDepends :: Lens' Component [Dependency] Source #

mixins :: Lens' Component [Mixin] Source #

data ComponentName Source #

Instances
Eq ComponentName Source # 
Instance details
Ord ComponentName Source # 
Instance details
Read ComponentName Source # 
Instance details
Show ComponentName Source # 
Instance details
Generic ComponentName Source # 
Instance details

Associated Types

type Rep ComponentName :: * -> * #

Binary ComponentName Source # 
Instance details
Pretty ComponentName Source # 
Instance details
Text ComponentName Source # 
Instance details
type Rep ComponentName Source # 
Instance details

componentNameString :: ComponentName -> Maybe UnqualComponentName Source #

This gets the underlying unqualified component name. In fact, it is guaranteed to uniquely identify a component, returning Nothing if the ComponentName was for the public library.

data ComponentLocalBuildInfo Source #

The first five fields are common across all algebraic variants.

Constructors

LibComponentLocalBuildInfo 

Fields

FLibComponentLocalBuildInfo 

Fields

ExeComponentLocalBuildInfo 

Fields

TestComponentLocalBuildInfo 

Fields

BenchComponentLocalBuildInfo 

Fields

Instances
Read ComponentLocalBuildInfo Source # 
Instance details
Show ComponentLocalBuildInfo Source # 
Instance details
Generic ComponentLocalBuildInfo Source # 
Instance details

Associated Types

type Rep ComponentLocalBuildInfo :: * -> * #

Binary ComponentLocalBuildInfo Source # 
Instance details
IsNode ComponentLocalBuildInfo Source # 
Instance details

Associated Types

type Key ComponentLocalBuildInfo :: * Source #

type Rep ComponentLocalBuildInfo Source # 
Instance details
type Rep ComponentLocalBuildInfo = D1 (MetaData "ComponentLocalBuildInfo" "Distribution.Types.ComponentLocalBuildInfo" "Cabal-2.2.0.0-inplace" False) ((C1 (MetaCons "LibComponentLocalBuildInfo" PrefixI True) (((S1 (MetaSel (Just "componentLocalName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName) :*: (S1 (MetaSel (Just "componentComponentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: S1 (MetaSel (Just "componentUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId))) :*: (S1 (MetaSel (Just "componentIsIndefinite_") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: (S1 (MetaSel (Just "componentInstantiatedWith") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(ModuleName, OpenModule)]) :*: S1 (MetaSel (Just "componentPackageDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnitId, MungedPackageId)])))) :*: ((S1 (MetaSel (Just "componentIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)]) :*: (S1 (MetaSel (Just "componentExeDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]) :*: S1 (MetaSel (Just "componentInternalDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]))) :*: ((S1 (MetaSel (Just "componentCompatPackageKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "componentCompatPackageName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MungedPackageName)) :*: (S1 (MetaSel (Just "componentExposedModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ExposedModule]) :*: S1 (MetaSel (Just "componentIsPublic") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))) :+: C1 (MetaCons "FLibComponentLocalBuildInfo" PrefixI True) ((S1 (MetaSel (Just "componentLocalName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName) :*: (S1 (MetaSel (Just "componentComponentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: S1 (MetaSel (Just "componentUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId))) :*: ((S1 (MetaSel (Just "componentPackageDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnitId, MungedPackageId)]) :*: S1 (MetaSel (Just "componentIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)])) :*: (S1 (MetaSel (Just "componentExeDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]) :*: S1 (MetaSel (Just "componentInternalDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]))))) :+: (C1 (MetaCons "ExeComponentLocalBuildInfo" PrefixI True) ((S1 (MetaSel (Just "componentLocalName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName) :*: (S1 (MetaSel (Just "componentComponentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: S1 (MetaSel (Just "componentUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId))) :*: ((S1 (MetaSel (Just "componentPackageDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnitId, MungedPackageId)]) :*: S1 (MetaSel (Just "componentIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)])) :*: (S1 (MetaSel (Just "componentExeDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]) :*: S1 (MetaSel (Just "componentInternalDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId])))) :+: (C1 (MetaCons "TestComponentLocalBuildInfo" PrefixI True) ((S1 (MetaSel (Just "componentLocalName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName) :*: (S1 (MetaSel (Just "componentComponentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: S1 (MetaSel (Just "componentUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId))) :*: ((S1 (MetaSel (Just "componentPackageDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnitId, MungedPackageId)]) :*: S1 (MetaSel (Just "componentIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)])) :*: (S1 (MetaSel (Just "componentExeDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]) :*: S1 (MetaSel (Just "componentInternalDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId])))) :+: C1 (MetaCons "BenchComponentLocalBuildInfo" PrefixI True) ((S1 (MetaSel (Just "componentLocalName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentName) :*: (S1 (MetaSel (Just "componentComponentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ComponentId) :*: S1 (MetaSel (Just "componentUnitId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnitId))) :*: ((S1 (MetaSel (Just "componentPackageDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(UnitId, MungedPackageId)]) :*: S1 (MetaSel (Just "componentIncludes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)])) :*: (S1 (MetaSel (Just "componentExeDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId]) :*: S1 (MetaSel (Just "componentInternalDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [UnitId])))))))
type Key ComponentLocalBuildInfo Source # 
Instance details

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

componentBuildable :: Component -> Bool Source #

Is a component buildable (i.e., not marked with buildable: False)? See also this note in Distribution.Types.ComponentRequestedSpec.

Since: 2.0.0.2

pkgComponents :: PackageDescription -> [Component] Source #

All the components in the package.

pkgBuildableComponents :: PackageDescription -> [Component] Source #

A list of all components in the package that are buildable, i.e., were not marked with buildable: False. This does NOT indicate if we are actually going to build the component, see enabledComponents instead.

Since: 2.0.0.2

getComponentLocalBuildInfo :: LocalBuildInfo -> ComponentName -> ComponentLocalBuildInfo Source #

Deprecated: This function is not well-defined, because a ComponentName does not uniquely identify a ComponentLocalBuildInfo. If you have a TargetInfo, you should use targetCLBI to get the ComponentLocalBuildInfo. Otherwise, use componentNameTargets to get all possible ComponentLocalBuildInfos. This will be removed in Cabal 2.2.

componentsInBuildOrder :: LocalBuildInfo -> [ComponentName] -> [ComponentLocalBuildInfo] Source #

Deprecated: You've got TargetInfo right? Use neededTargetsInBuildOrder on the UnitIds you can nodeKey out.

depLibraryPaths Source #

Arguments

:: Bool

Building for inplace?

-> Bool

Generate prefix-relative library paths

-> LocalBuildInfo 
-> ComponentLocalBuildInfo

Component that is being built

-> NoCallStackIO [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

allLibModules :: Library -> ComponentLocalBuildInfo -> [ModuleName] Source #

Get all module names that needed to be built by GHC; i.e., all of these ModuleNames have interface files associated with them that need to be installed.

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 #

Deprecated: You have got a TargetInfo right? Use withNeededTargetsInBuildOrder on the UnitIds you can nodeKey out.

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

Deprecated: Use withAllComponentsInBuildOrder

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

Perform the action on each enabled library in the package description with the ComponentLocalBuildInfo.

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

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

withBenchLBI :: PackageDescription -> LocalBuildInfo -> (Benchmark -> ComponentLocalBuildInfo -> IO ()) -> IO () Source #

Perform the action on each enabled Benchmark in the package description.

Installation directories

data PathTemplateVariable Source #

Constructors

PrefixVar

The $prefix path variable

BindirVar

The $bindir path variable

LibdirVar

The $libdir path variable

LibsubdirVar

The $libsubdir path variable

DynlibdirVar

The $dynlibdir path variable

DatadirVar

The $datadir path variable

DatasubdirVar

The $datasubdir path variable

DocdirVar

The $docdir path variable

HtmldirVar

The $htmldir path variable

PkgNameVar

The $pkg package name path variable

PkgVerVar

The $version package version path variable

PkgIdVar

The $pkgid package Id path variable, eg foo-1.0

LibNameVar

The $libname path variable

CompilerVar

The compiler name and version, eg ghc-6.6.1

OSVar

The operating system name, eg windows or linux

ArchVar

The CPU architecture name, eg i386 or x86_64

AbiVar

The Compiler's ABI identifier, $arch-$os-$compiler-$abitag

AbiTagVar

The optional ABI tag for the compiler

ExecutableNameVar

The executable name; used in shell wrappers

TestSuiteNameVar

The name of the test suite being run

TestSuiteResultVar

The result of the test suite being run, eg pass, fail, or error.

BenchmarkNameVar

The name of the benchmark being run

Instances
Eq PathTemplateVariable Source # 
Instance details
Ord PathTemplateVariable Source # 
Instance details
Read PathTemplateVariable Source # 
Instance details
Show PathTemplateVariable Source # 
Instance details
Generic PathTemplateVariable Source # 
Instance details

Associated Types

type Rep PathTemplateVariable :: * -> * #

Binary PathTemplateVariable Source # 
Instance details
type Rep PathTemplateVariable Source # 
Instance details
type Rep PathTemplateVariable = D1 (MetaData "PathTemplateVariable" "Distribution.Simple.InstallDirs" "Cabal-2.2.0.0-inplace" False) ((((C1 (MetaCons "PrefixVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BindirVar" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "LibdirVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "LibsubdirVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DynlibdirVar" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "DatadirVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "DatasubdirVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "DocdirVar" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "HtmldirVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "PkgNameVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "PkgVerVar" PrefixI False) (U1 :: * -> *))))) :+: (((C1 (MetaCons "PkgIdVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "LibNameVar" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CompilerVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "OSVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ArchVar" PrefixI False) (U1 :: * -> *)))) :+: ((C1 (MetaCons "AbiVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "AbiTagVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ExecutableNameVar" PrefixI False) (U1 :: * -> *))) :+: (C1 (MetaCons "TestSuiteNameVar" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "TestSuiteResultVar" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "BenchmarkNameVar" PrefixI False) (U1 :: * -> *))))))

data PathTemplate Source #

An abstract path, possibly containing variables that need to be substituted for to get a real FilePath.

data CopyDest Source #

The location prefix for the copy command.

Constructors

NoCopyDest 
CopyTo FilePath 
CopyToDb FilePath

when using the ${pkgroot} as prefix. The CopyToDb will adjust the paths to be relative to the provided package database when copying / installing.

Instances
Eq CopyDest Source # 
Instance details
Show CopyDest Source # 
Instance details
Generic CopyDest Source # 
Instance details

Associated Types

type Rep CopyDest :: * -> * #

Methods

from :: CopyDest -> Rep CopyDest x #

to :: Rep CopyDest x -> CopyDest #

Binary CopyDest Source # 
Instance details

Methods

put :: CopyDest -> Put #

get :: Get CopyDest #

putList :: [CopyDest] -> Put #

type Rep CopyDest Source # 
Instance details
type Rep CopyDest = D1 (MetaData "CopyDest" "Distribution.Simple.InstallDirs" "Cabal-2.2.0.0-inplace" False) (C1 (MetaCons "NoCopyDest" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CopyTo" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :+: C1 (MetaCons "CopyToDb" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath))))

type InstallDirTemplates = InstallDirs PathTemplate Source #

The installation directories in terms of PathTemplates that contain variables.

The defaults for most of the directories are relative to each other, in particular they are all relative to a single prefix. This makes it convenient for the user to override the default installation directory by only having to specify --prefix=... rather than overriding each individually. This is done by allowing $-style variables in the dirs. These are expanded by textual substitution (see substPathTemplate).

A few of these installation directories are split into two components, the dir and subdir. The full installation path is formed by combining the two together with /. The reason for this is compatibility with other Unix build systems which also support --libdir and --datadir. We would like users to be able to configure --libdir=/usr/lib64 for example but because by default we want to support installing multiple versions of packages and building the same package for multiple compilers we append the libsubdir to get: /usr/lib64/$libname/$compiler.

An additional complication is the need to support relocatable packages on systems which support such things, like Windows.

data InstallDirs dir Source #

The directories where we will install files for packages.

We have several different directories for different types of files since many systems have conventions whereby different types of files in a package are installed in different directories. This is particularly the case on Unix style systems.

Constructors

InstallDirs 

Fields

Instances
Functor InstallDirs Source # 
Instance details

Methods

fmap :: (a -> b) -> InstallDirs a -> InstallDirs b #

(<$) :: a -> InstallDirs b -> InstallDirs a #

Eq dir => Eq (InstallDirs dir) Source # 
Instance details

Methods

(==) :: InstallDirs dir -> InstallDirs dir -> Bool #

(/=) :: InstallDirs dir -> InstallDirs dir -> Bool #

Read dir => Read (InstallDirs dir) Source # 
Instance details
Show dir => Show (InstallDirs dir) Source # 
Instance details

Methods

showsPrec :: Int -> InstallDirs dir -> ShowS #

show :: InstallDirs dir -> String #

showList :: [InstallDirs dir] -> ShowS #

Generic (InstallDirs dir) Source # 
Instance details

Associated Types

type Rep (InstallDirs dir) :: * -> * #

Methods

from :: InstallDirs dir -> Rep (InstallDirs dir) x #

to :: Rep (InstallDirs dir) x -> InstallDirs dir #

Semigroup dir => Semigroup (InstallDirs dir) Source # 
Instance details

Methods

(<>) :: InstallDirs dir -> InstallDirs dir -> InstallDirs dir #

sconcat :: NonEmpty (InstallDirs dir) -> InstallDirs dir #

stimes :: Integral b => b -> InstallDirs dir -> InstallDirs dir #

(Semigroup dir, Monoid dir) => Monoid (InstallDirs dir) Source # 
Instance details

Methods

mempty :: InstallDirs dir #

mappend :: InstallDirs dir -> InstallDirs dir -> InstallDirs dir #

mconcat :: [InstallDirs dir] -> InstallDirs dir #

Binary dir => Binary (InstallDirs dir) Source # 
Instance details

Methods

put :: InstallDirs dir -> Put #

get :: Get (InstallDirs dir) #

putList :: [InstallDirs dir] -> Put #

type Rep (InstallDirs dir) Source # 
Instance details
type Rep (InstallDirs dir) = D1 (MetaData "InstallDirs" "Distribution.Simple.InstallDirs" "Cabal-2.2.0.0-inplace" False) (C1 (MetaCons "InstallDirs" PrefixI True) ((((S1 (MetaSel (Just "prefix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "bindir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir)) :*: (S1 (MetaSel (Just "libdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "libsubdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir))) :*: ((S1 (MetaSel (Just "dynlibdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "flibdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir)) :*: (S1 (MetaSel (Just "libexecdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "libexecsubdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir)))) :*: (((S1 (MetaSel (Just "includedir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "datadir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir)) :*: (S1 (MetaSel (Just "datasubdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "docdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir))) :*: ((S1 (MetaSel (Just "mandir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "htmldir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir)) :*: (S1 (MetaSel (Just "haddockdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir) :*: S1 (MetaSel (Just "sysconfdir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 dir))))))

substituteInstallDirTemplates :: PathTemplateEnv -> InstallDirTemplates -> InstallDirTemplates Source #

Substitute the install dir templates into each other.

To prevent cyclic substitutions, only some variables are allowed in particular dir templates. If out of scope vars are present, they are not substituted for. Checking for any remaining unsubstituted vars can be done as a subsequent operation.

The reason it is done this way is so that in prefixRelativeInstallDirs we can replace prefix with the PrefixVar and get resulting PathTemplates that still have the PrefixVar in them. Doing this makes it each to check which paths are relative to the $prefix.

toPathTemplate :: FilePath -> PathTemplate Source #

Convert a FilePath to a PathTemplate including any template vars.

fromPathTemplate :: PathTemplate -> FilePath Source #

Convert back to a path, any remaining vars are included

initialPathTemplateEnv :: PackageIdentifier -> UnitId -> CompilerInfo -> Platform -> PathTemplateEnv Source #

The initial environment has all the static stuff but no paths

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

Backwards compatibility function which computes the InstallDirs assuming that $libname points to the public library (or some fake package identifier if there is no public library.) IF AT ALL POSSIBLE, please use absoluteComponentInstallDirs instead.

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

Backwards compatibility function which computes the InstallDirs assuming that $libname points to the public library (or some fake package identifier if there is no public library.) IF AT ALL POSSIBLE, please use prefixRelativeComponentInstallDirs instead.