| Copyright | Isaac Jones 2003-2004 |
|---|---|
| License | BSD3 |
| Maintainer | cabal-devel@haskell.org |
| Portability | portable |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Distribution.Simple.Compiler
Description
This should be a much more sophisticated abstraction than it is. Currently
it's just a bit of data about the compiler, like its flavour and name and
version. The reason it's just data is because currently it has to be in
Read and Show so it can be saved along with the LocalBuildInfo. The
only interesting bit of info it contains is a mapping between language
extensions and compiler command line flags. This module also defines a
PackageDB type which is used to refer to package databases. Most compilers
only know about a single global package collection but GHC has a global and
per-user one and it lets you create arbitrary other package databases. We do
not yet fully support this latter feature.
Synopsis
- data Compiler = Compiler {
- compilerId :: CompilerId
- compilerAbiTag :: AbiTag
- compilerCompat :: [CompilerId]
- compilerLanguages :: [(Language, CompilerFlag)]
- compilerExtensions :: [(Extension, Maybe CompilerFlag)]
- compilerProperties :: Map String String
- showCompilerId :: Compiler -> String
- showCompilerIdWithAbi :: Compiler -> String
- compilerFlavor :: Compiler -> CompilerFlavor
- compilerVersion :: Compiler -> Version
- compilerCompatFlavor :: CompilerFlavor -> Compiler -> Bool
- compilerCompatVersion :: CompilerFlavor -> Compiler -> Maybe Version
- compilerInfo :: Compiler -> CompilerInfo
- type PackageDB = PackageDBX (SymbolicPath Pkg (Dir PkgDB))
- type PackageDBStack = PackageDBStackX (SymbolicPath Pkg (Dir PkgDB))
- type PackageDBCWD = PackageDBX FilePath
- type PackageDBStackCWD = PackageDBStackX FilePath
- data PackageDBX fp
- type PackageDBStackX from = [PackageDBX from]
- type PackageDBS from = PackageDBX (SymbolicPath from (Dir PkgDB))
- type PackageDBStackS from = PackageDBStackX (SymbolicPath from (Dir PkgDB))
- registrationPackageDB :: PackageDBStackX from -> PackageDBX from
- absolutePackageDBPaths :: Maybe (SymbolicPath CWD (Dir Pkg)) -> PackageDBStack -> IO PackageDBStack
- absolutePackageDBPath :: Maybe (SymbolicPath CWD (Dir Pkg)) -> PackageDB -> IO PackageDB
- interpretPackageDB :: Maybe (SymbolicPath CWD (Dir Pkg)) -> PackageDB -> PackageDBCWD
- interpretPackageDBStack :: Maybe (SymbolicPath CWD (Dir Pkg)) -> PackageDBStack -> PackageDBStackCWD
- coercePackageDB :: PackageDBCWD -> PackageDBX (SymbolicPath CWD (Dir PkgDB))
- coercePackageDBStack :: [PackageDBCWD] -> [PackageDBX (SymbolicPath CWD (Dir PkgDB))]
- data OptimisationLevel
- flagToOptimisationLevel :: Maybe String -> OptimisationLevel
- data DebugInfoLevel
- flagToDebugInfoLevel :: Maybe String -> DebugInfoLevel
- type CompilerFlag = String
- languageToFlags :: Compiler -> Maybe Language -> [CompilerFlag]
- unsupportedLanguages :: Compiler -> [Language] -> [Language]
- extensionsToFlags :: Compiler -> [Extension] -> [CompilerFlag]
- unsupportedExtensions :: Compiler -> [Extension] -> [Extension]
- parmakeSupported :: Compiler -> Bool
- reexportedModulesSupported :: Compiler -> Bool
- renamingPackageFlagsSupported :: Compiler -> Bool
- unifiedIPIDRequired :: Compiler -> Bool
- packageKeySupported :: Compiler -> Bool
- unitIdSupported :: Compiler -> Bool
- coverageSupported :: Compiler -> Bool
- profilingSupported :: Compiler -> Bool
- profilingDynamicSupported :: Compiler -> Maybe Bool
- profilingDynamicSupportedOrUnknown :: Compiler -> Bool
- profilingVanillaSupported :: Compiler -> Maybe Bool
- profilingVanillaSupportedOrUnknown :: Compiler -> Bool
- dynamicSupported :: Compiler -> Maybe Bool
- backpackSupported :: Compiler -> Bool
- arResponseFilesSupported :: Compiler -> Bool
- arDashLSupported :: Compiler -> Bool
- libraryDynDirSupported :: Compiler -> Bool
- libraryVisibilitySupported :: Compiler -> Bool
- jsemSupported :: Compiler -> Bool
- data ProfDetailLevel
- knownProfDetailLevels :: [(String, [String], ProfDetailLevel)]
- flagToProfDetailLevel :: String -> ProfDetailLevel
- showProfDetailLevel :: ProfDetailLevel -> String
Haskell implementations
Constructors
| Compiler | |
Fields
| |
Instances
showCompilerId :: Compiler -> String Source #
compilerFlavor :: Compiler -> CompilerFlavor Source #
compilerVersion :: Compiler -> Version Source #
compilerCompatFlavor :: CompilerFlavor -> Compiler -> Bool Source #
Is this compiler compatible with the compiler flavour we're interested in?
For example this checks if the compiler is actually GHC or is another compiler that claims to be compatible with some version of GHC, e.g. GHCJS.
if compilerCompatFlavor GHC compiler then ... else ...
compilerCompatVersion :: CompilerFlavor -> Compiler -> Maybe Version Source #
Is this compiler compatible with the compiler flavour we're interested in, and if so what version does it claim to be compatible with.
For example this checks if the compiler is actually GHC-7.x or is another compiler that claims to be compatible with some GHC-7.x version.
case compilerCompatVersion GHC compiler of Just (Version (7:_)) -> ... _ -> ...
compilerInfo :: Compiler -> CompilerInfo Source #
Support for package databases
type PackageDB = PackageDBX (SymbolicPath Pkg (Dir PkgDB)) Source #
type PackageDBStack = PackageDBStackX (SymbolicPath Pkg (Dir PkgDB)) Source #
type PackageDBCWD = PackageDBX FilePath Source #
data PackageDBX fp Source #
Some compilers have a notion of a database of available packages. For some there is just one global db of packages, other compilers support a per-user or an arbitrary db specified at some location in the file system. This can be used to build isolated environments of packages, for example to build a collection of related packages without installing them globally.
Abstracted over
Constructors
| GlobalPackageDB | |
| UserPackageDB | |
| SpecificPackageDB fp | NB: the path might be relative or it might be absolute |
Instances
type PackageDBStackX from = [PackageDBX from] Source #
We typically get packages from several databases, and stack them together. This type lets us be explicit about that stacking. For example typical stacks include:
[GlobalPackageDB] [GlobalPackageDB, UserPackageDB] [GlobalPackageDB, SpecificPackageDB "package.conf.inplace"]
Note that the GlobalPackageDB is invariably at the bottom since it
contains the rts, base and other special compiler-specific packages.
We are not restricted to using just the above combinations. In particular we can use several custom package dbs and the user package db together.
When it comes to writing, the top most (last) package is used.
type PackageDBS from = PackageDBX (SymbolicPath from (Dir PkgDB)) Source #
type PackageDBStackS from = PackageDBStackX (SymbolicPath from (Dir PkgDB)) Source #
registrationPackageDB :: PackageDBStackX from -> PackageDBX from Source #
Return the package that we should register into. This is the package db at the top of the stack.
absolutePackageDBPaths :: Maybe (SymbolicPath CWD (Dir Pkg)) -> PackageDBStack -> IO PackageDBStack Source #
Make package paths absolute
interpretPackageDB :: Maybe (SymbolicPath CWD (Dir Pkg)) -> PackageDB -> PackageDBCWD Source #
interpretPackageDBStack :: Maybe (SymbolicPath CWD (Dir Pkg)) -> PackageDBStack -> PackageDBStackCWD Source #
coercePackageDB :: PackageDBCWD -> PackageDBX (SymbolicPath CWD (Dir PkgDB)) Source #
Transform a package db using a FilePath into one using symbolic paths.
coercePackageDBStack :: [PackageDBCWD] -> [PackageDBX (SymbolicPath CWD (Dir PkgDB))] Source #
Support for optimisation levels
data OptimisationLevel Source #
Some compilers support optimising. Some have different levels. For compilers that do not the level is just capped to the level they do support.
Constructors
| NoOptimisation | |
| NormalOptimisation | |
| MaximumOptimisation |
Instances
Support for debug info levels
data DebugInfoLevel Source #
Some compilers support emitting debug info. Some have different levels. For compilers that do not the level is just capped to the level they do support.
Constructors
| NoDebugInfo | |
| MinimalDebugInfo | |
| NormalDebugInfo | |
| MaximalDebugInfo |
Instances
Support for language extensions
type CompilerFlag = String Source #
languageToFlags :: Compiler -> Maybe Language -> [CompilerFlag] Source #
unsupportedLanguages :: Compiler -> [Language] -> [Language] Source #
extensionsToFlags :: Compiler -> [Extension] -> [CompilerFlag] Source #
For the given compiler, return the flags for the supported extensions.
unsupportedExtensions :: Compiler -> [Extension] -> [Extension] Source #
For the given compiler, return the extensions it does not support.
parmakeSupported :: Compiler -> Bool Source #
Does this compiler support parallel --make mode?
reexportedModulesSupported :: Compiler -> Bool Source #
Does this compiler support reexported-modules?
renamingPackageFlagsSupported :: Compiler -> Bool Source #
Does this compiler support thinning/renaming on package flags?
unifiedIPIDRequired :: Compiler -> Bool Source #
Does this compiler have unified IPIDs (so no package keys)
packageKeySupported :: Compiler -> Bool Source #
Does this compiler support package keys?
unitIdSupported :: Compiler -> Bool Source #
Does this compiler support unit IDs?
coverageSupported :: Compiler -> Bool Source #
Does this compiler support Haskell program coverage?
profilingSupported :: Compiler -> Bool Source #
Does this compiler support profiling?
profilingDynamicSupported :: Compiler -> Maybe Bool Source #
Is the compiler distributed with profiling dynamic libraries
profilingDynamicSupportedOrUnknown :: Compiler -> Bool Source #
Either profiling dynamic is definitely supported or we don't know (so assume it is)
profilingVanillaSupported :: Compiler -> Maybe Bool Source #
Is the compiler distributed with profiling libraries
profilingVanillaSupportedOrUnknown :: Compiler -> Bool Source #
Either profiling is definitely supported or we don't know (so assume it is)
dynamicSupported :: Compiler -> Maybe Bool Source #
Is the compiler distributed with dynamic libraries
backpackSupported :: Compiler -> Bool Source #
Does this compiler support Backpack?
arResponseFilesSupported :: Compiler -> Bool Source #
Does this compiler's "ar" command supports response file arguments (i.e. @file-style arguments).
arDashLSupported :: Compiler -> Bool Source #
Does this compiler's "ar" command support llvm-ar's -L flag, which compels the archiver to add an input archive's members rather than adding the archive itself.
libraryDynDirSupported :: Compiler -> Bool Source #
Does this compiler support a package database entry with: "dynamic-library-dirs"?
libraryVisibilitySupported :: Compiler -> Bool Source #
Does this compiler support a package database entry with: "visibility"?
jsemSupported :: Compiler -> Bool Source #
Does this compiler support the -jsem option?
Support for profiling detail levels
data ProfDetailLevel Source #
Some compilers (notably GHC) support profiling and can instrument programs so the system can account costs to different functions. There are different levels of detail that can be used for this accounting. For compilers that do not support this notion or the particular detail levels, this is either ignored or just capped to some similar level they do support.
Constructors
| ProfDetailNone | |
| ProfDetailDefault | |
| ProfDetailExportedFunctions | |
| ProfDetailToplevelFunctions | |
| ProfDetailAllFunctions | |
| ProfDetailTopLate | |
| ProfDetailOther String |
Instances
knownProfDetailLevels :: [(String, [String], ProfDetailLevel)] Source #