Distribution.Simple.LocalBuildInfo

Cabal-2.1.0.0: A framework for packaging Haskell software

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

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

- data LocalBuildInfo = LocalBuildInfo {
  - configFlags :: ConfigFlags
  - flagAssignment :: FlagAssignment
  - componentEnabledSpec :: ComponentRequestedSpec
  - extraConfigArgs :: [String]
  - installDirTemplates :: InstallDirTemplates
  - compiler :: Compiler
  - hostPlatform :: Platform
  - buildDir :: FilePath
  - componentGraph :: Graph ComponentLocalBuildInfo
  - componentNameMap :: Map ComponentName [ComponentLocalBuildInfo]
  - installedPkgs :: InstalledPackageIndex
  - pkgDescrFile :: Maybe FilePath
  - localPkgDescr :: PackageDescription
  - withPrograms :: ProgramDb
  - withPackageDB :: PackageDBStack
  - withVanillaLib :: Bool
  - withProfLib :: Bool
  - withSharedLib :: Bool
  - withStaticLib :: Bool
  - withDynExe :: Bool
  - withProfExe :: Bool
  - withProfLibDetail :: ProfDetailLevel
  - withProfExeDetail :: ProfDetailLevel
  - withOptimization :: OptimisationLevel
  - withDebugInfo :: DebugInfoLevel
  - withGHCiLib :: Bool
  - splitSections :: Bool
  - splitObjs :: Bool
  - stripExes :: Bool
  - stripLibs :: Bool
  - exeCoverage :: Bool
  - libCoverage :: Bool
  - progPrefix :: PathTemplate
  - progSuffix :: PathTemplate
  - relocatable :: Bool
  }
- externalPackageDeps :: LocalBuildInfo -> [(UnitId, MungedPackageId)]
- localComponentId :: LocalBuildInfo -> ComponentId
- localUnitId :: LocalBuildInfo -> UnitId
- localCompatPackageKey :: LocalBuildInfo -> String
- data Component
  - = CLib Library
  - | CFLib ForeignLib
  - | CExe Executable
  - | CTest TestSuite
  - | CBench Benchmark
- data ComponentName
  - = CLibName
  - | CSubLibName UnqualComponentName
  - | CFLibName UnqualComponentName
  - | CExeName UnqualComponentName
  - | CTestName UnqualComponentName
  - | CBenchName UnqualComponentName
- defaultLibName :: ComponentName
- showComponentName :: ComponentName -> String
- componentNameString :: ComponentName -> Maybe UnqualComponentName
- data ComponentLocalBuildInfo
  - = LibComponentLocalBuildInfo {
    - componentLocalName :: ComponentName
    - componentComponentId :: ComponentId
    - componentUnitId :: UnitId
    - componentIsIndefinite_ :: Bool
    - componentInstantiatedWith :: [(ModuleName, OpenModule)]
    - componentPackageDeps :: [(UnitId, MungedPackageId)]
    - componentIncludes :: [(OpenUnitId, ModuleRenaming)]
    - componentExeDeps :: [UnitId]
    - componentInternalDeps :: [UnitId]
    - componentCompatPackageKey :: String
    - componentCompatPackageName :: MungedPackageName
    - componentExposedModules :: [ExposedModule]
    - componentIsPublic :: Bool
    }
  - | FLibComponentLocalBuildInfo {
    - componentLocalName :: ComponentName
    - componentComponentId :: ComponentId
    - componentUnitId :: UnitId
    - componentPackageDeps :: [(UnitId, MungedPackageId)]
    - componentIncludes :: [(OpenUnitId, ModuleRenaming)]
    - componentExeDeps :: [UnitId]
    - componentInternalDeps :: [UnitId]
    }
  - | ExeComponentLocalBuildInfo {
    - componentLocalName :: ComponentName
    - componentComponentId :: ComponentId
    - componentUnitId :: UnitId
    - componentPackageDeps :: [(UnitId, MungedPackageId)]
    - componentIncludes :: [(OpenUnitId, ModuleRenaming)]
    - componentExeDeps :: [UnitId]
    - componentInternalDeps :: [UnitId]
    }
  - | TestComponentLocalBuildInfo {
    - componentLocalName :: ComponentName
    - componentComponentId :: ComponentId
    - componentUnitId :: UnitId
    - componentPackageDeps :: [(UnitId, MungedPackageId)]
    - componentIncludes :: [(OpenUnitId, ModuleRenaming)]
    - componentExeDeps :: [UnitId]
    - componentInternalDeps :: [UnitId]
    }
  - | BenchComponentLocalBuildInfo {
    - componentLocalName :: ComponentName
    - componentComponentId :: ComponentId
    - componentUnitId :: UnitId
    - componentPackageDeps :: [(UnitId, MungedPackageId)]
    - componentIncludes :: [(OpenUnitId, ModuleRenaming)]
    - componentExeDeps :: [UnitId]
    - componentInternalDeps :: [UnitId]
    }
- componentBuildDir :: LocalBuildInfo -> ComponentLocalBuildInfo -> FilePath
- foldComponent :: (Library -> a) -> (ForeignLib -> a) -> (Executable -> a) -> (TestSuite -> a) -> (Benchmark -> a) -> Component -> a
- componentName :: Component -> ComponentName
- componentBuildInfo :: Component -> BuildInfo
- componentBuildable :: Component -> Bool
- pkgComponents :: PackageDescription -> [Component]
- pkgBuildableComponents :: PackageDescription -> [Component]
- lookupComponent :: PackageDescription -> ComponentName -> Maybe Component
- getComponent :: PackageDescription -> ComponentName -> Component
- getComponentLocalBuildInfo :: LocalBuildInfo -> ComponentName -> ComponentLocalBuildInfo
- allComponentsInBuildOrder :: LocalBuildInfo -> [ComponentLocalBuildInfo]
- componentsInBuildOrder :: LocalBuildInfo -> [ComponentName] -> [ComponentLocalBuildInfo]
- depLibraryPaths :: Bool -> Bool -> LocalBuildInfo -> ComponentLocalBuildInfo -> NoCallStackIO [FilePath]
- allLibModules :: Library -> ComponentLocalBuildInfo -> [ModuleName]
- withAllComponentsInBuildOrder :: PackageDescription -> LocalBuildInfo -> (Component -> ComponentLocalBuildInfo -> IO ()) -> IO ()
- withComponentsInBuildOrder :: PackageDescription -> LocalBuildInfo -> [ComponentName] -> (Component -> ComponentLocalBuildInfo -> IO ()) -> IO ()
- withComponentsLBI :: PackageDescription -> LocalBuildInfo -> (Component -> ComponentLocalBuildInfo -> IO ()) -> IO ()
- withLibLBI :: PackageDescription -> LocalBuildInfo -> (Library -> ComponentLocalBuildInfo -> IO ()) -> IO ()
- withExeLBI :: PackageDescription -> LocalBuildInfo -> (Executable -> ComponentLocalBuildInfo -> IO ()) -> IO ()
- withBenchLBI :: PackageDescription -> LocalBuildInfo -> (Benchmark -> ComponentLocalBuildInfo -> IO ()) -> IO ()
- withTestLBI :: PackageDescription -> LocalBuildInfo -> (TestSuite -> ComponentLocalBuildInfo -> IO ()) -> IO ()
- enabledTestLBIs :: PackageDescription -> LocalBuildInfo -> [(TestSuite, ComponentLocalBuildInfo)]
- enabledBenchLBIs :: PackageDescription -> LocalBuildInfo -> [(Benchmark, ComponentLocalBuildInfo)]
- type PathTemplateEnv = [(PathTemplateVariable, PathTemplate)]
- data PathTemplateVariable
  - = PrefixVar
  - | BindirVar
  - | LibdirVar
  - | LibsubdirVar
  - | DynlibdirVar
  - | DatadirVar
  - | DatasubdirVar
  - | DocdirVar
  - | HtmldirVar
  - | PkgNameVar
  - | PkgVerVar
  - | PkgIdVar
  - | LibNameVar
  - | CompilerVar
  - | OSVar
  - | ArchVar
  - | AbiVar
  - | AbiTagVar
  - | ExecutableNameVar
  - | TestSuiteNameVar
  - | TestSuiteResultVar
  - | BenchmarkNameVar
- data PathTemplate
- data CopyDest
  - = NoCopyDest
  - | CopyTo FilePath
- type InstallDirTemplates = InstallDirs PathTemplate
- data InstallDirs dir = InstallDirs {
  - prefix :: dir
  - bindir :: dir
  - libdir :: dir
  - libsubdir :: dir
  - dynlibdir :: dir
  - flibdir :: dir
  - libexecdir :: dir
  - libexecsubdir :: dir
  - includedir :: dir
  - datadir :: dir
  - datasubdir :: dir
  - docdir :: dir
  - mandir :: dir
  - htmldir :: dir
  - haddockdir :: dir
  - sysconfdir :: dir
  }
- combineInstallDirs :: (a -> b -> c) -> InstallDirs a -> InstallDirs b -> InstallDirs c
- defaultInstallDirs :: CompilerFlavor -> Bool -> Bool -> IO InstallDirTemplates
- defaultInstallDirs' :: Bool -> CompilerFlavor -> Bool -> Bool -> IO InstallDirTemplates
- substituteInstallDirTemplates :: PathTemplateEnv -> InstallDirTemplates -> InstallDirTemplates
- toPathTemplate :: FilePath -> PathTemplate
- fromPathTemplate :: PathTemplate -> FilePath
- combinePathTemplate :: PathTemplate -> PathTemplate -> PathTemplate
- initialPathTemplateEnv :: PackageIdentifier -> UnitId -> CompilerInfo -> Platform -> PathTemplateEnv
- packageTemplateEnv :: PackageIdentifier -> UnitId -> PathTemplateEnv
- compilerTemplateEnv :: CompilerInfo -> PathTemplateEnv
- platformTemplateEnv :: Platform -> PathTemplateEnv
- abiTemplateEnv :: CompilerInfo -> Platform -> PathTemplateEnv
- installDirsTemplateEnv :: InstallDirs PathTemplate -> PathTemplateEnv
- absoluteInstallDirs :: PackageDescription -> LocalBuildInfo -> CopyDest -> InstallDirs FilePath
- prefixRelativeInstallDirs :: PackageId -> LocalBuildInfo -> InstallDirs (Maybe FilePath)
- absoluteComponentInstallDirs :: PackageDescription -> LocalBuildInfo -> UnitId -> CopyDest -> InstallDirs FilePath
- prefixRelativeComponentInstallDirs :: PackageId -> LocalBuildInfo -> UnitId -> InstallDirs (Maybe FilePath)
- substPathTemplate :: PackageId -> LocalBuildInfo -> UnitId -> PathTemplate -> FilePath

# 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 flagAssignment :: FlagAssignment The final set of flags which were picked for this package componentEnabledSpec :: ComponentRequestedSpec What components were enabled during configuration, and why. 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. componentGraph :: Graph ComponentLocalBuildInfo All the components to build, ordered by topological sort, and with their INTERNAL dependencies over the intrapackage dependency graph. TODO: this is assumed to be short; otherwise we want some sort of ordered map. componentNameMap :: Map ComponentName [ComponentLocalBuildInfo] A map from component name to all matching components. These coincide with `componentGraph` installedPkgs :: InstalledPackageIndex All the info about the installed packages that the current package depends on (directly or indirectly). The copy saved on disk does NOT include internal dependencies (because we just don't have enough information at this point to have an `InstalledPackageInfo` for an internal dep), but we will often update it with the internal dependencies; see for example `build`. (This admonition doesn't apply for per-component builds.) pkgDescrFile :: Maybe FilePath the filename containing the .cabal file, if available localPkgDescr :: PackageDescription WARNING WARNING WARNING Be VERY careful about using this function; we haven't deprecated it but using it could introduce subtle bugs related to `HookedBuildInfo`. In principle, this is supposed to contain the resolved package description, that does not contain any conditionals. However, it MAY NOT contain the description wtih a `HookedBuildInfo` applied to it; see `HookedBuildInfo` for the whole sordid saga. As much as possible, Cabal library should avoid using this parameter. withPrograms :: ProgramDb 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. withStaticLib :: Bool Whether to build static versions of libs (with all other libs rolled in) withDynExe :: Bool Whether to link executables dynamically withProfExe :: Bool Whether to build executables for profiling. withProfLibDetail :: ProfDetailLevel Level of automatic profile detail. withProfExeDetail :: ProfDetailLevel Level of automatic profile detail. 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. splitSections :: Bool Use -split-sections with GHC, if available 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 exeCoverage :: Bool Whether to enable executable program coverage libCoverage :: Bool Whether to enable library program coverage progPrefix :: PathTemplate Prefix to be prepended to installed executables progSuffix :: PathTemplate Suffix to be appended to installed executables relocatable :: Bool

Instances

Read LocalBuildInfo # |
Instance details Methods readsPrec :: Int -> ReadS LocalBuildInfo Source # readList :: ReadS [LocalBuildInfo] Source # readPrec :: ReadPrec LocalBuildInfo Source # readListPrec :: ReadPrec [LocalBuildInfo] Source #
Show LocalBuildInfo # |
Instance details Methods showsPrec :: Int -> LocalBuildInfo -> ShowS Source # show :: LocalBuildInfo -> String Source # showList :: [LocalBuildInfo] -> ShowS Source #
Generic LocalBuildInfo # |
Instance details Associated Types type Rep LocalBuildInfo :: * -> * Source # Methods from :: LocalBuildInfo -> Rep LocalBuildInfo x Source # to :: Rep LocalBuildInfo x -> LocalBuildInfo Source #
Binary LocalBuildInfo # |
Instance details Methods put :: LocalBuildInfo -> Put Source # get :: Get LocalBuildInfo Source # putList :: [LocalBuildInfo] -> Put Source #
type Rep LocalBuildInfo # |
Instance details type Rep LocalBuildInfo = D1 (MetaData "LocalBuildInfo" "Distribution.Types.LocalBuildInfo" "Cabal-2.1.0.0" 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 "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 2.2

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 #

Constructors

CLib Library |
CFLib ForeignLib |
CExe Executable |
CTest TestSuite |
CBench Benchmark |

Instances

Eq Component # |
Instance details Methods (==) :: Component -> Component -> Bool # (/=) :: Component -> Component -> Bool #
Read Component # |
Instance details Methods readsPrec :: Int -> ReadS Component Source # readList :: ReadS [Component] Source # readPrec :: ReadPrec Component Source # readListPrec :: ReadPrec [Component] Source #
Show Component # |
Instance details Methods showsPrec :: Int -> Component -> ShowS Source # show :: Component -> String Source # showList :: [Component] -> ShowS Source #
Semigroup Component # |
Instance details Methods (<>) :: Component -> Component -> Component Source # sconcat :: NonEmpty Component -> Component Source # stimes :: Integral b => b -> Component -> Component Source #
HasBuildInfo Component # |
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 #

Constructors

CLibName |
CSubLibName UnqualComponentName |
CFLibName UnqualComponentName |
CExeName UnqualComponentName |
CTestName UnqualComponentName |
CBenchName UnqualComponentName |

Instances

Eq ComponentName # |
Instance details Methods (==) :: ComponentName -> ComponentName -> Bool # (/=) :: ComponentName -> ComponentName -> Bool #
Ord ComponentName # |
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 #
Read ComponentName # |
Instance details Methods readsPrec :: Int -> ReadS ComponentName Source # readList :: ReadS [ComponentName] Source # readPrec :: ReadPrec ComponentName Source # readListPrec :: ReadPrec [ComponentName] Source #
Show ComponentName # |
Instance details Methods showsPrec :: Int -> ComponentName -> ShowS Source # show :: ComponentName -> String Source # showList :: [ComponentName] -> ShowS Source #
Generic ComponentName # |
Instance details Associated Types type Rep ComponentName :: * -> * Source # Methods from :: ComponentName -> Rep ComponentName x Source # to :: Rep ComponentName x -> ComponentName Source #
Binary ComponentName # |
Instance details Methods put :: ComponentName -> Put Source # get :: Get ComponentName Source # putList :: [ComponentName] -> Put Source #
Pretty ComponentName # |
Instance details Methods pretty :: ComponentName -> Doc Source #
Text ComponentName # |
Instance details Methods disp :: ComponentName -> Doc Source # parse :: ReadP r ComponentName Source #
type Rep ComponentName # |
Instance details type Rep ComponentName = D1 (MetaData "ComponentName" "Distribution.Types.ComponentName" "Cabal-2.1.0.0" False) ((C1 (MetaCons "CLibName" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "CSubLibName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)) :+: C1 (MetaCons "CFLibName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)))) :+: (C1 (MetaCons "CExeName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)) :+: (C1 (MetaCons "CTestName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)) :+: C1 (MetaCons "CBenchName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UnqualComponentName)))))

defaultLibName :: ComponentName 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 Source #

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

Read ComponentLocalBuildInfo # |
Instance details Methods readsPrec :: Int -> ReadS ComponentLocalBuildInfo Source # readList :: ReadS [ComponentLocalBuildInfo] Source # readPrec :: ReadPrec ComponentLocalBuildInfo Source # readListPrec :: ReadPrec [ComponentLocalBuildInfo] Source #
Show ComponentLocalBuildInfo # |
Instance details Methods showsPrec :: Int -> ComponentLocalBuildInfo -> ShowS Source # show :: ComponentLocalBuildInfo -> String Source # showList :: [ComponentLocalBuildInfo] -> ShowS Source #
Generic ComponentLocalBuildInfo # |
Instance details Associated Types type Rep ComponentLocalBuildInfo :: * -> * Source # Methods from :: ComponentLocalBuildInfo -> Rep ComponentLocalBuildInfo x Source # to :: Rep ComponentLocalBuildInfo x -> ComponentLocalBuildInfo Source #
Binary ComponentLocalBuildInfo # |
Instance details Methods put :: ComponentLocalBuildInfo -> Put Source # get :: Get ComponentLocalBuildInfo Source # putList :: [ComponentLocalBuildInfo] -> Put Source #
IsNode ComponentLocalBuildInfo # |
Instance details Associated Types type Key ComponentLocalBuildInfo :: * Source # Methods nodeKey :: ComponentLocalBuildInfo -> Key ComponentLocalBuildInfo Source # nodeNeighbors :: ComponentLocalBuildInfo -> [Key ComponentLocalBuildInfo] Source #
type Rep ComponentLocalBuildInfo # |
Instance details type Rep ComponentLocalBuildInfo = D1 (MetaData "ComponentLocalBuildInfo" "Distribution.Types.ComponentLocalBuildInfo" "Cabal-2.1.0.0" 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 # |
Instance details type Key ComponentLocalBuildInfo = UnitId

componentBuildDir :: LocalBuildInfo -> ComponentLocalBuildInfo -> FilePath Source #

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

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

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

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 `ComponentLocalBuildInfo`s. This will be removed in Cabal 2.2.

allComponentsInBuildOrder :: LocalBuildInfo -> [ComponentLocalBuildInfo] Source #

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

Deprecated: You've got `TargetInfo` right? Use `neededTargetsInBuildOrder` on the `UnitId`s 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 `ModuleName`s 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 `UnitId`s 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.

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

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

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

# Installation directories

type PathTemplateEnv = [(PathTemplateVariable, PathTemplate)] Source #

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 # |
Instance details Methods (==) :: PathTemplateVariable -> PathTemplateVariable -> Bool # (/=) :: PathTemplateVariable -> PathTemplateVariable -> Bool #
Ord PathTemplateVariable # |
Instance details Methods compare :: PathTemplateVariable -> PathTemplateVariable -> Ordering # (<) :: PathTemplateVariable -> PathTemplateVariable -> Bool # (<=) :: PathTemplateVariable -> PathTemplateVariable -> Bool # (>) :: PathTemplateVariable -> PathTemplateVariable -> Bool # (>=) :: PathTemplateVariable -> PathTemplateVariable -> Bool # max :: PathTemplateVariable -> PathTemplateVariable -> PathTemplateVariable # min :: PathTemplateVariable -> PathTemplateVariable -> PathTemplateVariable #
Read PathTemplateVariable # |
Instance details Methods readsPrec :: Int -> ReadS PathTemplateVariable Source # readList :: ReadS [PathTemplateVariable] Source # readPrec :: ReadPrec PathTemplateVariable Source # readListPrec :: ReadPrec [PathTemplateVariable] Source #
Show PathTemplateVariable # |
Instance details Methods showsPrec :: Int -> PathTemplateVariable -> ShowS Source # show :: PathTemplateVariable -> String Source # showList :: [PathTemplateVariable] -> ShowS Source #
Generic PathTemplateVariable # |
Instance details Associated Types type Rep PathTemplateVariable :: * -> * Source # Methods from :: PathTemplateVariable -> Rep PathTemplateVariable x Source # to :: Rep PathTemplateVariable x -> PathTemplateVariable Source #
Binary PathTemplateVariable # |
Instance details Methods put :: PathTemplateVariable -> Put Source # get :: Get PathTemplateVariable Source # putList :: [PathTemplateVariable] -> Put Source #
type Rep PathTemplateVariable # |
Instance details type Rep PathTemplateVariable = D1 (MetaData "PathTemplateVariable" "Distribution.Simple.InstallDirs" "Cabal-2.1.0.0" 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`.

Instances

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 #
Read PathTemplate # |
Instance details Methods readsPrec :: Int -> ReadS PathTemplate Source # readList :: ReadS [PathTemplate] Source # readPrec :: ReadPrec PathTemplate Source # readListPrec :: ReadPrec [PathTemplate] Source #
Show PathTemplate # |
Instance details Methods showsPrec :: Int -> PathTemplate -> ShowS Source # show :: PathTemplate -> String Source # showList :: [PathTemplate] -> ShowS Source #
Generic PathTemplate # |
Instance details Associated Types type Rep PathTemplate :: * -> * Source # Methods from :: PathTemplate -> Rep PathTemplate x Source # to :: Rep PathTemplate x -> PathTemplate Source #
Binary PathTemplate # |
Instance details Methods put :: PathTemplate -> Put Source # get :: Get PathTemplate Source # putList :: [PathTemplate] -> Put Source #
type Rep PathTemplate # |
Instance details type Rep PathTemplate

data CopyDest Source #

The location prefix for the copy command.

Constructors

NoCopyDest |
CopyTo FilePath |

Instances

Eq CopyDest # |
Instance details Methods (==) :: CopyDest -> CopyDest -> Bool # (/=) :: CopyDest -> CopyDest -> Bool #
Show CopyDest # |
Instance details Methods showsPrec :: Int -> CopyDest -> ShowS Source # show :: CopyDest -> String Source # showList :: [CopyDest] -> ShowS Source #

type InstallDirTemplates = InstallDirs PathTemplate Source #

The installation directories in terms of `PathTemplate`s 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 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

Functor InstallDirs # |
Instance details Methods fmap :: (a -> b) -> InstallDirs a -> InstallDirs b Source # (<$) :: a -> InstallDirs b -> InstallDirs a Source #
Eq dir => Eq (InstallDirs dir) # |
Instance details Methods (==) :: InstallDirs dir -> InstallDirs dir -> Bool # (/=) :: InstallDirs dir -> InstallDirs dir -> Bool #
Read dir => Read (InstallDirs dir) # |
Instance details Methods readsPrec :: Int -> ReadS (InstallDirs dir) Source # readList :: ReadS [InstallDirs dir] Source # readPrec :: ReadPrec (InstallDirs dir) Source # readListPrec :: ReadPrec [InstallDirs dir] Source #
Show dir => Show (InstallDirs dir) # |
Instance details Methods showsPrec :: Int -> InstallDirs dir -> ShowS Source # show :: InstallDirs dir -> String Source # showList :: [InstallDirs dir] -> ShowS Source #
Generic (InstallDirs dir) # |
Instance details Associated Types type Rep (InstallDirs dir) :: * -> * Source # Methods from :: InstallDirs dir -> Rep (InstallDirs dir) x Source # to :: Rep (InstallDirs dir) x -> InstallDirs dir Source #
Semigroup dir => Semigroup (InstallDirs dir) # |
Instance details Methods (<>) :: InstallDirs dir -> InstallDirs dir -> InstallDirs dir Source # sconcat :: NonEmpty (InstallDirs dir) -> InstallDirs dir Source # stimes :: Integral b => b -> InstallDirs dir -> InstallDirs dir Source #
(Semigroup dir, Monoid dir) => Monoid (InstallDirs dir) # |
Instance details Methods mempty :: InstallDirs dir Source # mappend :: InstallDirs dir -> InstallDirs dir -> InstallDirs dir Source # mconcat :: [InstallDirs dir] -> InstallDirs dir Source #
Binary dir => Binary (InstallDirs dir) # |
Instance details Methods put :: InstallDirs dir -> Put Source # get :: Get (InstallDirs dir) Source # putList :: [InstallDirs dir] -> Put Source #
type Rep (InstallDirs dir) # |
Instance details type Rep (InstallDirs dir) = D1 (MetaData "InstallDirs" "Distribution.Simple.InstallDirs" "Cabal-2.1.0.0" 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))))))

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

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

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

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 `PathTemplate`s 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

combinePathTemplate :: PathTemplate -> PathTemplate -> PathTemplate Source #

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

The initial environment has all the static stuff but no paths

packageTemplateEnv :: PackageIdentifier -> UnitId -> PathTemplateEnv Source #

compilerTemplateEnv :: CompilerInfo -> PathTemplateEnv Source #

platformTemplateEnv :: Platform -> PathTemplateEnv Source #

abiTemplateEnv :: CompilerInfo -> Platform -> PathTemplateEnv Source #

installDirsTemplateEnv :: InstallDirs PathTemplate -> PathTemplateEnv Source #

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.

absoluteComponentInstallDirs :: PackageDescription -> LocalBuildInfo -> UnitId -> CopyDest -> InstallDirs FilePath Source #

See `absoluteInstallDirs`.

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

See `prefixRelativeInstallDirs`

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