Documentation

Methods

structure :: Proxy LocalBuildInfo -> Structure Source #

structureHash' :: Tagged LocalBuildInfo MD5

Binary LocalBuildInfo #

Instance details

Methods

put :: LocalBuildInfo -> Put #

get :: Get LocalBuildInfo #

putList :: [LocalBuildInfo] -> Put #

Generic LocalBuildInfo #

Instance details

Associated Types

type Rep LocalBuildInfo

Instance details

type Rep LocalBuildInfo = D1 ('MetaData "LocalBuildInfo" "Distribution.Types.LocalBuildInfo" "Cabal-3.16.0.0-9b60" 'False) (C1 ('MetaCons "NewLocalBuildInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "localBuildDescr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LocalBuildDescr) :*: S1 ('MetaSel ('Just "localBuildConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LocalBuildConfig)))

Methods

from :: LocalBuildInfo -> Rep LocalBuildInfo x #

to :: Rep LocalBuildInfo x -> LocalBuildInfo #

Read LocalBuildInfo #

Instance details

Methods

readsPrec :: Int -> ReadS LocalBuildInfo #

readList :: ReadS [LocalBuildInfo] #

readPrec :: ReadPrec LocalBuildInfo #

readListPrec :: ReadPrec [LocalBuildInfo] #

Show LocalBuildInfo #

Instance details

Methods

showsPrec :: Int -> LocalBuildInfo -> ShowS #

show :: LocalBuildInfo -> String #

showList :: [LocalBuildInfo] -> ShowS #

type Rep LocalBuildInfo #

Instance details

type Rep LocalBuildInfo = D1 ('MetaData "LocalBuildInfo" "Distribution.Types.LocalBuildInfo" "Cabal-3.16.0.0-9b60" 'False) (C1 ('MetaCons "NewLocalBuildInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "localBuildDescr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LocalBuildDescr) :*: S1 ('MetaSel ('Just "localBuildConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LocalBuildConfig)))

localComponentId :: LocalBuildInfo -> ComponentId #

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 #

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 #

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.

Convenience accessors

buildDir :: LocalBuildInfo -> SymbolicPath Pkg ('Dir Build) #

packageRoot :: CommonSetupFlags -> FilePath #

The (relative or absolute) path to the package root, based on

the working directory flag
the .cabal path

progPrefix :: LocalBuildInfo -> PathTemplate #

progSuffix :: LocalBuildInfo -> PathTemplate #

interpretSymbolicPathLBI :: forall (allowAbsolute :: AllowAbsolute) (to :: FileOrDir). LocalBuildInfo -> SymbolicPathX allowAbsolute Pkg to -> FilePath #

Interpret a symbolic path with respect to the working directory stored in LocalBuildInfo.

Use this before directly interacting with the file system.

NB: when invoking external programs (such as GHC), it is preferable to set the working directory of the process rather than calling this function, as this function will turn relative paths into absolute paths if the working directory is an absolute path. This can degrade error messages, or worse, break the behaviour entirely (because the program might expect certain paths to be relative).

See Note [Symbolic paths] in Distribution.Utils.Path

mbWorkDirLBI :: LocalBuildInfo -> Maybe (SymbolicPath CWD ('Dir Pkg)) #

Retrieve an optional working directory from LocalBuildInfo.

absoluteWorkingDirLBI :: LocalBuildInfo -> IO (AbsolutePath ('Dir Pkg)) #

Absolute path to the current working directory.

buildWays :: LocalBuildInfo -> (Bool -> [BuildWay], Bool -> BuildWay, BuildWay) #

Returns a list of ways, in the order which they should be built, and the way we build executable and foreign library components.

Ideally all this info should be fixed at configure time and not dependent on additional info but LocalBuildInfo is per package (not per component) so it's currently not possible to configure components to be built in certain ways.

Buildable package components

data Component Source #

Constructors

CLib Library
CFLib ForeignLib
CExe Executable
CTest TestSuite
CBench Benchmark

Instances

Instances 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 #

jsppOptions :: Lens' Component [String] Source #

ldOptions :: Lens' Component [String] Source #

hsc2hsOptions :: Lens' Component [String] Source #

pkgconfigDepends :: Lens' Component [PkgconfigDependency] Source #

frameworks :: Lens' Component [RelativePath Framework 'File] Source #

extraFrameworkDirs :: Lens' Component [SymbolicPath Pkg ('Dir Framework)] Source #

asmSources :: Lens' Component [SymbolicPath Pkg 'File] Source #

cmmSources :: Lens' Component [SymbolicPath Pkg 'File] Source #

cSources :: Lens' Component [SymbolicPath Pkg 'File] Source #

cxxSources :: Lens' Component [SymbolicPath Pkg 'File] Source #

jsSources :: Lens' Component [SymbolicPath Pkg 'File] Source #

hsSourceDirs :: Lens' Component [SymbolicPath Pkg ('Dir Source)] 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 #

extraLibsStatic :: Lens' Component [String] Source #

extraGHCiLibs :: Lens' Component [String] Source #

extraBundledLibs :: Lens' Component [String] Source #

extraLibFlavours :: Lens' Component [String] Source #

extraDynLibFlavours :: Lens' Component [String] Source #

extraLibDirs :: Lens' Component [SymbolicPath Pkg ('Dir Lib)] Source #

extraLibDirsStatic :: Lens' Component [SymbolicPath Pkg ('Dir Lib)] Source #

includeDirs :: Lens' Component [SymbolicPath Pkg ('Dir Include)] Source #

includes :: Lens' Component [SymbolicPath Include 'File] Source #

autogenIncludes :: Lens' Component [RelativePath Include 'File] Source #

installIncludes :: Lens' Component [RelativePath Include 'File] Source #

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

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

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

profSharedOptions :: Lens' Component (PerCompilerFlavor [String]) Source #

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

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

targetBuildDepends :: Lens' Component [Dependency] Source #

mixins :: Lens' Component [Mixin] Source #

Structured Component Source #

Instance details

Methods

structure :: Proxy Component -> Structure Source #

structureHash' :: Tagged Component MD5

Binary Component Source #

Instance details

Methods

put :: Component -> Put #

get :: Get Component #

putList :: [Component] -> Put #

Semigroup Component Source #

Instance details

Methods

(<>) :: Component -> Component -> Component #

sconcat :: NonEmpty Component -> Component #

stimes :: Integral b => b -> Component -> Component #

Eq Component Source #

Instance details

Methods

(==) :: Component -> Component -> Bool #

(/=) :: Component -> Component -> Bool #

Generic Component Source #

Instance details

Associated Types

type Rep Component

Instance details

type Rep Component = D1 ('MetaData "Component" "Distribution.Types.Component" "Cabal-syntax-3.16.0.0-2829" 'False) ((C1 ('MetaCons "CLib" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Library)) :+: C1 ('MetaCons "CFLib" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ForeignLib))) :+: (C1 ('MetaCons "CExe" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Executable)) :+: (C1 ('MetaCons "CTest" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TestSuite)) :+: C1 ('MetaCons "CBench" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Benchmark)))))

Methods

from :: Component -> Rep Component x #

to :: Rep Component x -> Component #

Read Component Source #

Instance details

Methods

readsPrec :: Int -> ReadS Component #

readList :: ReadS [Component] #

readPrec :: ReadPrec Component #

readListPrec :: ReadPrec [Component] #

Show Component Source #

Instance details

Methods

showsPrec :: Int -> Component -> ShowS #

show :: Component -> String #

showList :: [Component] -> ShowS #

type Rep Component Source #

Instance details

type Rep Component = D1 ('MetaData "Component" "Distribution.Types.Component" "Cabal-syntax-3.16.0.0-2829" 'False) ((C1 ('MetaCons "CLib" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Library)) :+: C1 ('MetaCons "CFLib" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ForeignLib))) :+: (C1 ('MetaCons "CExe" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Executable)) :+: (C1 ('MetaCons "CTest" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TestSuite)) :+: C1 ('MetaCons "CBench" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Benchmark)))))

data ComponentName Source #

Constructors

CLibName LibraryName
CNotLibName NotLibComponentName

Bundled Patterns

pattern CBenchName :: UnqualComponentName -> ComponentName
pattern CExeName :: UnqualComponentName -> ComponentName
pattern CFLibName :: UnqualComponentName -> ComponentName
pattern CTestName :: UnqualComponentName -> ComponentName

Instances

Instances details

Parsec ComponentName Source #

Instance details

Methods

parsec :: CabalParsing m => m ComponentName Source #

Pretty ComponentName Source #

Instance details

Methods

pretty :: ComponentName -> Doc Source #

prettyVersioned :: CabalSpecVersion -> ComponentName -> Doc Source #

Structured ComponentName Source #

Instance details

Methods

structure :: Proxy ComponentName -> Structure Source #

structureHash' :: Tagged ComponentName MD5

Binary ComponentName Source #

Instance details

Methods

put :: ComponentName -> Put #

get :: Get ComponentName #

putList :: [ComponentName] -> Put #

Eq ComponentName Source #

Instance details

Methods

(==) :: ComponentName -> ComponentName -> Bool #

(/=) :: ComponentName -> ComponentName -> Bool #

Ord ComponentName Source #

Instance details

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 #

Generic ComponentName Source #

Instance details

Associated Types

type Rep ComponentName

Instance details

type Rep ComponentName = D1 ('MetaData "ComponentName" "Distribution.Types.ComponentName" "Cabal-syntax-3.16.0.0-2829" 'False) (C1 ('MetaCons "CLibName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LibraryName)) :+: C1 ('MetaCons "CNotLibName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NotLibComponentName)))

Methods

from :: ComponentName -> Rep ComponentName x #

to :: Rep ComponentName x -> ComponentName #

Read ComponentName Source #

Instance details

Methods

readsPrec :: Int -> ReadS ComponentName #

readList :: ReadS [ComponentName] #

readPrec :: ReadPrec ComponentName #

readListPrec :: ReadPrec [ComponentName] #

Show ComponentName Source #

Instance details

Methods

showsPrec :: Int -> ComponentName -> ShowS #

show :: ComponentName -> String #

showList :: [ComponentName] -> ShowS #

type Rep ComponentName Source #

Instance details

type Rep ComponentName = D1 ('MetaData "ComponentName" "Distribution.Types.ComponentName" "Cabal-syntax-3.16.0.0-2829" 'False) (C1 ('MetaCons "CLibName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LibraryName)) :+: C1 ('MetaCons "CNotLibName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NotLibComponentName)))

data LibraryName Source #

Constructors

LMainLibName
LSubLibName UnqualComponentName

Instances

Instances details

Structured LibraryName Source #

Instance details

Methods

structure :: Proxy LibraryName -> Structure Source #

structureHash' :: Tagged LibraryName MD5

Binary LibraryName Source #

Instance details

Methods

put :: LibraryName -> Put #

get :: Get LibraryName #

putList :: [LibraryName] -> Put #

NFData LibraryName Source #

Instance details

Methods

rnf :: LibraryName -> () Source #

Eq LibraryName Source #

Instance details

Methods

(==) :: LibraryName -> LibraryName -> Bool #

(/=) :: LibraryName -> LibraryName -> Bool #

Ord LibraryName Source #

Instance details

Methods

compare :: LibraryName -> LibraryName -> Ordering #

(<) :: LibraryName -> LibraryName -> Bool #

(<=) :: LibraryName -> LibraryName -> Bool #

(>) :: LibraryName -> LibraryName -> Bool #

(>=) :: LibraryName -> LibraryName -> Bool #

max :: LibraryName -> LibraryName -> LibraryName #

min :: LibraryName -> LibraryName -> LibraryName #

Data LibraryName Source #

Instance details

Methods

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

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

toConstr :: LibraryName -> Constr #

dataTypeOf :: LibraryName -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> LibraryName -> LibraryName #

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

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

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

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

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

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

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

Generic LibraryName Source #

Instance details

Associated Types

type Rep LibraryName

Instance details

type Rep LibraryName = D1 ('MetaData "LibraryName" "Distribution.Types.LibraryName" "Cabal-syntax-3.16.0.0-2829" 'False) (C1 ('MetaCons "LMainLibName" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LSubLibName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnqualComponentName)))

Methods

from :: LibraryName -> Rep LibraryName x #

to :: Rep LibraryName x -> LibraryName #

Read LibraryName Source #

Instance details

Methods

readsPrec :: Int -> ReadS LibraryName #

readList :: ReadS [LibraryName] #

readPrec :: ReadPrec LibraryName #

readListPrec :: ReadPrec [LibraryName] #

Show LibraryName Source #

Instance details

Methods

showsPrec :: Int -> LibraryName -> ShowS #

show :: LibraryName -> String #

showList :: [LibraryName] -> ShowS #

type Rep LibraryName Source #

Instance details

IsNode ComponentLocalBuildInfo #

type Rep LibraryName = D1 ('MetaData "LibraryName" "Distribution.Types.LibraryName" "Cabal-syntax-3.16.0.0-2829" 'False) (C1 ('MetaCons "LMainLibName" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LSubLibName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnqualComponentName)))

defaultLibName :: LibraryName Source #

showComponentName :: ComponentName -> String Source #

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 #

The first five fields are common across all algebraic variants.

Constructors

LibComponentLocalBuildInfo
Fields componentLocalName :: ComponentName It would be very convenient to store the literal Library here, but if we do that, it will get serialized (via the Binary) instance twice. So instead we just provide the ComponentName, which can be used to find the Component in the PackageDescription. NB: eventually, this will NOT uniquely identify the ComponentLocalBuildInfo. componentComponentId :: ComponentId The computed `ComponentId` of this component. componentUnitId :: UnitId The computed `UnitId` which uniquely identifies this component. Might be hashed. componentIsIndefinite_ :: Bool Is this an indefinite component (i.e. has unfilled holes)? componentInstantiatedWith :: [(ModuleName, OpenModule)] How the component was instantiated componentPackageDeps :: [(UnitId, MungedPackageId)] 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. componentIncludes :: [(OpenUnitId, ModuleRenaming)] The set of packages that are brought into scope during compilation, including a `ModuleRenaming` which may used to hide or rename modules. This is what gets translated into `-package-id` arguments. This is a modernized version of `componentPackageDeps`, which is kept around for BC purposes. componentExeDeps :: [UnitId] componentInternalDeps :: [UnitId] The internal dependencies which induce a graph on the `ComponentLocalBuildInfo` of this package. This does NOT coincide with `componentPackageDeps` because it ALSO records 'build-tool' dependencies on executables. Maybe one day `cabal-install` will also handle these correctly too! componentCompatPackageKey :: String Compatibility "package key" that we pass to older versions of GHC. componentCompatPackageName :: MungedPackageName Compatibility "package name" that we register this component as. componentExposedModules :: [ExposedModule] A list of exposed modules (either defined in this component, or reexported from another component.) componentIsPublic :: Bool Convenience field, specifying whether or not this is the "public library" that has the same name as the package.
FLibComponentLocalBuildInfo
Fields componentLocalName :: ComponentName It would be very convenient to store the literal Library here, but if we do that, it will get serialized (via the Binary) instance twice. So instead we just provide the ComponentName, which can be used to find the Component in the PackageDescription. NB: eventually, this will NOT uniquely identify the ComponentLocalBuildInfo. componentComponentId :: ComponentId The computed `ComponentId` of this component. componentUnitId :: UnitId The computed `UnitId` which uniquely identifies this component. Might be hashed. componentPackageDeps :: [(UnitId, MungedPackageId)] 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. componentIncludes :: [(OpenUnitId, ModuleRenaming)] The set of packages that are brought into scope during compilation, including a `ModuleRenaming` which may used to hide or rename modules. This is what gets translated into `-package-id` arguments. This is a modernized version of `componentPackageDeps`, which is kept around for BC purposes. componentExeDeps :: [UnitId] componentInternalDeps :: [UnitId] The internal dependencies which induce a graph on the `ComponentLocalBuildInfo` of this package. This does NOT coincide with `componentPackageDeps` because it ALSO records 'build-tool' dependencies on executables. Maybe one day `cabal-install` will also handle these correctly too!
ExeComponentLocalBuildInfo
Fields componentLocalName :: ComponentName It would be very convenient to store the literal Library here, but if we do that, it will get serialized (via the Binary) instance twice. So instead we just provide the ComponentName, which can be used to find the Component in the PackageDescription. NB: eventually, this will NOT uniquely identify the ComponentLocalBuildInfo. componentComponentId :: ComponentId The computed `ComponentId` of this component. componentUnitId :: UnitId The computed `UnitId` which uniquely identifies this component. Might be hashed. componentPackageDeps :: [(UnitId, MungedPackageId)] 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. componentIncludes :: [(OpenUnitId, ModuleRenaming)] The set of packages that are brought into scope during compilation, including a `ModuleRenaming` which may used to hide or rename modules. This is what gets translated into `-package-id` arguments. This is a modernized version of `componentPackageDeps`, which is kept around for BC purposes. componentExeDeps :: [UnitId] componentInternalDeps :: [UnitId] The internal dependencies which induce a graph on the `ComponentLocalBuildInfo` of this package. This does NOT coincide with `componentPackageDeps` because it ALSO records 'build-tool' dependencies on executables. Maybe one day `cabal-install` will also handle these correctly too!
TestComponentLocalBuildInfo
Fields componentLocalName :: ComponentName It would be very convenient to store the literal Library here, but if we do that, it will get serialized (via the Binary) instance twice. So instead we just provide the ComponentName, which can be used to find the Component in the PackageDescription. NB: eventually, this will NOT uniquely identify the ComponentLocalBuildInfo. componentComponentId :: ComponentId The computed `ComponentId` of this component. componentUnitId :: UnitId The computed `UnitId` which uniquely identifies this component. Might be hashed. componentPackageDeps :: [(UnitId, MungedPackageId)] 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. componentIncludes :: [(OpenUnitId, ModuleRenaming)] The set of packages that are brought into scope during compilation, including a `ModuleRenaming` which may used to hide or rename modules. This is what gets translated into `-package-id` arguments. This is a modernized version of `componentPackageDeps`, which is kept around for BC purposes. componentExeDeps :: [UnitId] componentInternalDeps :: [UnitId] The internal dependencies which induce a graph on the `ComponentLocalBuildInfo` of this package. This does NOT coincide with `componentPackageDeps` because it ALSO records 'build-tool' dependencies on executables. Maybe one day `cabal-install` will also handle these correctly too!
BenchComponentLocalBuildInfo
Fields componentLocalName :: ComponentName It would be very convenient to store the literal Library here, but if we do that, it will get serialized (via the Binary) instance twice. So instead we just provide the ComponentName, which can be used to find the Component in the PackageDescription. NB: eventually, this will NOT uniquely identify the ComponentLocalBuildInfo. componentComponentId :: ComponentId The computed `ComponentId` of this component. componentUnitId :: UnitId The computed `UnitId` which uniquely identifies this component. Might be hashed. componentPackageDeps :: [(UnitId, MungedPackageId)] 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. componentIncludes :: [(OpenUnitId, ModuleRenaming)] The set of packages that are brought into scope during compilation, including a `ModuleRenaming` which may used to hide or rename modules. This is what gets translated into `-package-id` arguments. This is a modernized version of `componentPackageDeps`, which is kept around for BC purposes. componentExeDeps :: [UnitId] componentInternalDeps :: [UnitId] The internal dependencies which induce a graph on the `ComponentLocalBuildInfo` of this package. This does NOT coincide with `componentPackageDeps` because it ALSO records 'build-tool' dependencies on executables. Maybe one day `cabal-install` will also handle these correctly too!

Instances

Instances details

Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Associated Types

type Key ComponentLocalBuildInfo
Instance details Defined in Distribution.Types.ComponentLocalBuildInfo type Key ComponentLocalBuildInfo = UnitId

Methods

nodeKey :: ComponentLocalBuildInfo -> Key ComponentLocalBuildInfo Source #

nodeNeighbors :: ComponentLocalBuildInfo -> [Key ComponentLocalBuildInfo] Source #

Structured ComponentLocalBuildInfo #

Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Methods

structure :: Proxy ComponentLocalBuildInfo -> Structure Source #

structureHash' :: Tagged ComponentLocalBuildInfo MD5

Binary ComponentLocalBuildInfo #

Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Methods

put :: ComponentLocalBuildInfo -> Put #

get :: Get ComponentLocalBuildInfo #

putList :: [ComponentLocalBuildInfo] -> Put #

Generic ComponentLocalBuildInfo #

Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Associated Types

type Rep ComponentLocalBuildInfo

Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Methods

from :: ComponentLocalBuildInfo -> Rep ComponentLocalBuildInfo x #

to :: Rep ComponentLocalBuildInfo x -> ComponentLocalBuildInfo #

Read ComponentLocalBuildInfo #

Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Methods

readsPrec :: Int -> ReadS ComponentLocalBuildInfo #

readList :: ReadS [ComponentLocalBuildInfo] #

readPrec :: ReadPrec ComponentLocalBuildInfo #

readListPrec :: ReadPrec [ComponentLocalBuildInfo] #

Show ComponentLocalBuildInfo #

Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

Methods

showsPrec :: Int -> ComponentLocalBuildInfo -> ShowS #

show :: ComponentLocalBuildInfo -> String #

showList :: [ComponentLocalBuildInfo] -> ShowS #

type Key ComponentLocalBuildInfo #

Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

type Key ComponentLocalBuildInfo = UnitId

type Rep ComponentLocalBuildInfo #

Instance details

Defined in Distribution.Types.ComponentLocalBuildInfo

componentBuildDir :: LocalBuildInfo -> ComponentLocalBuildInfo -> SymbolicPath Pkg ('Dir Build) #

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

componentName :: Component -> ComponentName Source #

componentBuildInfo :: Component -> BuildInfo 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: Cabal-syntax-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: Cabal-syntax-2.0.0.2

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

getComponent :: PackageDescription -> ComponentName -> Component Source #

allComponentsInBuildOrder :: LocalBuildInfo -> [ComponentLocalBuildInfo] #

depLibraryPaths #

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

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

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 () #

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

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

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

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

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 () #

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

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

enabledTestLBIs :: PackageDescription -> LocalBuildInfo -> [(TestSuite, ComponentLocalBuildInfo)] #

enabledBenchLBIs :: PackageDescription -> LocalBuildInfo -> [(Benchmark, ComponentLocalBuildInfo)] #

Installation directories

abiTemplateEnv :: CompilerInfo -> Platform -> PathTemplateEnv #

combineInstallDirs :: (a -> b -> c) -> InstallDirs a -> InstallDirs b -> InstallDirs c #

combinePathTemplate :: PathTemplate -> PathTemplate -> PathTemplate #

compilerTemplateEnv :: CompilerInfo -> PathTemplateEnv #

defaultInstallDirs :: CompilerFlavor -> Bool -> Bool -> IO InstallDirTemplates #

defaultInstallDirs' :: Bool -> CompilerFlavor -> Bool -> Bool -> IO InstallDirTemplates #

fromPathTemplate :: PathTemplate -> FilePath #

Convert back to a path, any remaining vars are included

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

The initial environment has all the static stuff but no paths

installDirsTemplateEnv :: InstallDirs PathTemplate -> PathTemplateEnv #

packageTemplateEnv :: PackageIdentifier -> UnitId -> PathTemplateEnv #

platformTemplateEnv :: Platform -> PathTemplateEnv #

substituteInstallDirTemplates :: PathTemplateEnv -> InstallDirTemplates -> InstallDirTemplates #

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 #

Convert a FilePath to a PathTemplate including any template vars.

data CopyDest #

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

Instances details

Structured CopyDest #

Instance details

Methods

structure :: Proxy CopyDest -> Structure Source #

structureHash' :: Tagged CopyDest MD5

Binary CopyDest #

Instance details

Methods

put :: CopyDest -> Put #

get :: Get CopyDest #

putList :: [CopyDest] -> Put #

Eq CopyDest #

Instance details

Methods

(==) :: CopyDest -> CopyDest -> Bool #

(/=) :: CopyDest -> CopyDest -> Bool #

Generic CopyDest #

Instance details

Associated Types

type Rep CopyDest

Instance details

type Rep CopyDest = D1 ('MetaData "CopyDest" "Distribution.Simple.InstallDirs" "Cabal-3.16.0.0-9b60" 'False) (C1 ('MetaCons "NoCopyDest" 'PrefixI 'False) (U1 :: Type -> Type) :+: (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))))

Methods

from :: CopyDest -> Rep CopyDest x #

to :: Rep CopyDest x -> CopyDest #

Show CopyDest #

Instance details

Methods

showsPrec :: Int -> CopyDest -> ShowS #

show :: CopyDest -> String #

showList :: [CopyDest] -> ShowS #

type Rep CopyDest #

Instance details

type Rep CopyDest = D1 ('MetaData "CopyDest" "Distribution.Simple.InstallDirs" "Cabal-3.16.0.0-9b60" 'False) (C1 ('MetaCons "NoCopyDest" 'PrefixI 'False) (U1 :: Type -> Type) :+: (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 #

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 #

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 prefix :: dir bindir :: dir libdir :: dir libsubdir :: dir dynlibdir :: dir flibdir :: dir foreign libraries libexecdir :: dir libexecsubdir :: dir includedir :: dir datadir :: dir datasubdir :: dir docdir :: dir mandir :: dir htmldir :: dir haddockdir :: dir sysconfdir :: dir

Instances

Instances details

Functor InstallDirs #

Instance details

Methods

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

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

Structured dir => Structured (InstallDirs dir) #

Instance details

Methods

structure :: Proxy (InstallDirs dir) -> Structure Source #

structureHash' :: Tagged (InstallDirs dir) MD5

Binary dir => Binary (InstallDirs dir) #

Instance details

Methods

put :: InstallDirs dir -> Put #

get :: Get (InstallDirs dir) #

putList :: [InstallDirs dir] -> Put #

(Semigroup dir, Monoid dir) => Monoid (InstallDirs dir) #

Instance details

Methods

mempty :: InstallDirs dir #

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

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

Semigroup dir => Semigroup (InstallDirs dir) #

Instance details

Methods

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

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

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

Eq dir => Eq (InstallDirs dir) #

Instance details

Methods

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

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

Generic (InstallDirs dir) #

Instance details

Associated Types

type Rep (InstallDirs dir)

Instance details

Methods

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

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

Read dir => Read (InstallDirs dir) #

Instance details

Methods

readsPrec :: Int -> ReadS (InstallDirs dir) #

readList :: ReadS [InstallDirs dir] #

readPrec :: ReadPrec (InstallDirs dir) #

readListPrec :: ReadPrec [InstallDirs dir] #

Show dir => Show (InstallDirs dir) #

Instance details

Methods

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

show :: InstallDirs dir -> String #

showList :: [InstallDirs dir] -> ShowS #

type Rep (InstallDirs dir) #

Instance details

data PathTemplate #

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

Instances

Instances details

Structured PathTemplate #

Instance details

Methods

structure :: Proxy PathTemplate -> Structure Source #

structureHash' :: Tagged PathTemplate MD5

Binary PathTemplate #

Instance details

Methods

put :: PathTemplate -> Put #

get :: Get PathTemplate #

putList :: [PathTemplate] -> Put #

Eq PathTemplate #

Instance details

Methods

(==) :: PathTemplate -> PathTemplate -> Bool #

(/=) :: PathTemplate -> PathTemplate -> Bool #

Ord PathTemplate #

Instance details

Methods

compare :: PathTemplate -> PathTemplate -> Ordering #

(<) :: PathTemplate -> PathTemplate -> Bool #

(<=) :: PathTemplate -> PathTemplate -> Bool #

(>) :: PathTemplate -> PathTemplate -> Bool #

(>=) :: PathTemplate -> PathTemplate -> Bool #

max :: PathTemplate -> PathTemplate -> PathTemplate #

min :: PathTemplate -> PathTemplate -> PathTemplate #

Generic PathTemplate #

Instance details

Associated Types

type Rep PathTemplate
Instance details Defined in Distribution.Simple.InstallDirs type Rep PathTemplate = D1 ('MetaData "PathTemplate" "Distribution.Simple.InstallDirs" "Cabal-3.16.0.0-9b60" 'True) (C1 ('MetaCons "PathTemplate" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PathComponent])))

Methods

from :: PathTemplate -> Rep PathTemplate x #

to :: Rep PathTemplate x -> PathTemplate #

Read PathTemplate #

Instance details

Methods

readsPrec :: Int -> ReadS PathTemplate #

readList :: ReadS [PathTemplate] #

readPrec :: ReadPrec PathTemplate #

readListPrec :: ReadPrec [PathTemplate] #

Show PathTemplate #

Instance details

Methods

showsPrec :: Int -> PathTemplate -> ShowS #

show :: PathTemplate -> String #

showList :: [PathTemplate] -> ShowS #

type Rep PathTemplate #

Instance details