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

Distribution.Simple.Compiler

Contents

Haskell implementations
Support for package databases
Support for optimisation levels
Support for debug info levels
Support for language extensions
Support for profiling detail levels

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

Haskell implementations

module Distribution.Compiler

data Compiler #

Constructors

Compiler

Fields

compilerId :: CompilerId
Compiler flavour and version.
compilerAbiTag :: AbiTag
Tag for distinguishing incompatible ABI's on the same architecture/os.
compilerCompat :: [CompilerId]
Other implementations that this compiler claims to be compatible with.
compilerLanguages :: [(Language, Flag)]
Supported language standards.
compilerExtensions :: [(Extension, Maybe Flag)]
Supported extensions.
compilerProperties :: Map String String
A key-value map for properties not covered by the above fields.

Instances

Eq Compiler #
Methods (==) :: Compiler -> Compiler -> Bool # (/=) :: Compiler -> Compiler -> Bool #
Read Compiler #
Methods readsPrec :: Int -> ReadS Compiler # readList :: ReadS [Compiler] # readPrec :: ReadPrec Compiler # readListPrec :: ReadPrec [Compiler] #
Show Compiler #
Methods showsPrec :: Int -> Compiler -> ShowS # show :: Compiler -> String # showList :: [Compiler] -> ShowS #
Generic Compiler #
Associated Types type Rep Compiler :: * -> * # Methods from :: Compiler -> Rep Compiler x # to :: Rep Compiler x -> Compiler #
Binary Compiler #
Methods put :: Compiler -> Put # get :: Get Compiler # putList :: [Compiler] -> Put #
type Rep Compiler #
type Rep Compiler = D1 * (MetaData "Compiler" "Distribution.Simple.Compiler" "Cabal-2.2.0.0-KtVb5LuYqFjKrhxFyS8D9H" False) (C1 * (MetaCons "Compiler" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "compilerId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * CompilerId)) ((::) (S1 * (MetaSel (Just Symbol "compilerAbiTag") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * AbiTag)) (S1 * (MetaSel (Just Symbol "compilerCompat") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [CompilerId])))) ((::) (S1 * (MetaSel (Just Symbol "compilerLanguages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [(Language, Flag)])) ((::) (S1 * (MetaSel (Just Symbol "compilerExtensions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [(Extension, Maybe Flag)])) (S1 * (MetaSel (Just Symbol "compilerProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Map String String)))))))

showCompilerId :: Compiler -> String #

showCompilerIdWithAbi :: Compiler -> String #

compilerFlavor :: Compiler -> CompilerFlavor #

compilerVersion :: Compiler -> Version #

compilerCompatFlavor :: CompilerFlavor -> Compiler -> Bool #

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 #

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 #

Support for package databases

data PackageDB #

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 isloated environments of packages, for example to build a collection of related packages without installing them globally.

Constructors

GlobalPackageDB
UserPackageDB
SpecificPackageDB FilePath

Instances

Eq PackageDB #
Methods (==) :: PackageDB -> PackageDB -> Bool # (/=) :: PackageDB -> PackageDB -> Bool #
Ord PackageDB #
Methods compare :: PackageDB -> PackageDB -> Ordering # (<) :: PackageDB -> PackageDB -> Bool # (<=) :: PackageDB -> PackageDB -> Bool # (>) :: PackageDB -> PackageDB -> Bool # (>=) :: PackageDB -> PackageDB -> Bool # max :: PackageDB -> PackageDB -> PackageDB # min :: PackageDB -> PackageDB -> PackageDB #
Read PackageDB #
Methods readsPrec :: Int -> ReadS PackageDB # readList :: ReadS [PackageDB] # readPrec :: ReadPrec PackageDB # readListPrec :: ReadPrec [PackageDB] #
Show PackageDB #
Methods showsPrec :: Int -> PackageDB -> ShowS # show :: PackageDB -> String # showList :: [PackageDB] -> ShowS #
Generic PackageDB #
Associated Types type Rep PackageDB :: * -> * # Methods from :: PackageDB -> Rep PackageDB x # to :: Rep PackageDB x -> PackageDB #
Binary PackageDB #
Methods put :: PackageDB -> Put # get :: Get PackageDB # putList :: [PackageDB] -> Put #
type Rep PackageDB #
type Rep PackageDB = D1 * (MetaData "PackageDB" "Distribution.Simple.Compiler" "Cabal-2.2.0.0-KtVb5LuYqFjKrhxFyS8D9H" False) ((:+:) * (C1 * (MetaCons "GlobalPackageDB" PrefixI False) (U1 )) ((:+:) (C1 * (MetaCons "UserPackageDB" PrefixI False) (U1 )) (C1 (MetaCons "SpecificPackageDB" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * FilePath)))))

type PackageDBStack = [PackageDB] #

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.

registrationPackageDB :: PackageDBStack -> PackageDB #

Return the package that we should register into. This is the package db at the top of the stack.

absolutePackageDBPaths :: PackageDBStack -> NoCallStackIO PackageDBStack #

Make package paths absolute

absolutePackageDBPath :: PackageDB -> NoCallStackIO PackageDB #

Support for optimisation levels

data OptimisationLevel #

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

Bounded OptimisationLevel #
Methods minBound :: OptimisationLevel # maxBound :: OptimisationLevel #
Enum OptimisationLevel #
Methods succ :: OptimisationLevel -> OptimisationLevel # pred :: OptimisationLevel -> OptimisationLevel # toEnum :: Int -> OptimisationLevel # fromEnum :: OptimisationLevel -> Int # enumFrom :: OptimisationLevel -> [OptimisationLevel] # enumFromThen :: OptimisationLevel -> OptimisationLevel -> [OptimisationLevel] # enumFromTo :: OptimisationLevel -> OptimisationLevel -> [OptimisationLevel] # enumFromThenTo :: OptimisationLevel -> OptimisationLevel -> OptimisationLevel -> [OptimisationLevel] #
Eq OptimisationLevel #
Methods (==) :: OptimisationLevel -> OptimisationLevel -> Bool # (/=) :: OptimisationLevel -> OptimisationLevel -> Bool #
Read OptimisationLevel #
Methods readsPrec :: Int -> ReadS OptimisationLevel # readList :: ReadS [OptimisationLevel] # readPrec :: ReadPrec OptimisationLevel # readListPrec :: ReadPrec [OptimisationLevel] #
Show OptimisationLevel #
Methods showsPrec :: Int -> OptimisationLevel -> ShowS # show :: OptimisationLevel -> String # showList :: [OptimisationLevel] -> ShowS #
Generic OptimisationLevel #
Associated Types type Rep OptimisationLevel :: * -> * # Methods from :: OptimisationLevel -> Rep OptimisationLevel x # to :: Rep OptimisationLevel x -> OptimisationLevel #
Binary OptimisationLevel #
Methods put :: OptimisationLevel -> Put # get :: Get OptimisationLevel # putList :: [OptimisationLevel] -> Put #
type Rep OptimisationLevel #
type Rep OptimisationLevel = D1 * (MetaData "OptimisationLevel" "Distribution.Simple.Compiler" "Cabal-2.2.0.0-KtVb5LuYqFjKrhxFyS8D9H" False) ((:+:) * (C1 * (MetaCons "NoOptimisation" PrefixI False) (U1 )) ((:+:) (C1 * (MetaCons "NormalOptimisation" PrefixI False) (U1 )) (C1 (MetaCons "MaximumOptimisation" PrefixI False) (U1 *))))

flagToOptimisationLevel :: Maybe String -> OptimisationLevel #

Support for debug info levels

data DebugInfoLevel #

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

Bounded DebugInfoLevel #
Methods minBound :: DebugInfoLevel # maxBound :: DebugInfoLevel #
Enum DebugInfoLevel #
Methods succ :: DebugInfoLevel -> DebugInfoLevel # pred :: DebugInfoLevel -> DebugInfoLevel # toEnum :: Int -> DebugInfoLevel # fromEnum :: DebugInfoLevel -> Int # enumFrom :: DebugInfoLevel -> [DebugInfoLevel] # enumFromThen :: DebugInfoLevel -> DebugInfoLevel -> [DebugInfoLevel] # enumFromTo :: DebugInfoLevel -> DebugInfoLevel -> [DebugInfoLevel] # enumFromThenTo :: DebugInfoLevel -> DebugInfoLevel -> DebugInfoLevel -> [DebugInfoLevel] #
Eq DebugInfoLevel #
Methods (==) :: DebugInfoLevel -> DebugInfoLevel -> Bool # (/=) :: DebugInfoLevel -> DebugInfoLevel -> Bool #
Read DebugInfoLevel #
Methods readsPrec :: Int -> ReadS DebugInfoLevel # readList :: ReadS [DebugInfoLevel] # readPrec :: ReadPrec DebugInfoLevel # readListPrec :: ReadPrec [DebugInfoLevel] #
Show DebugInfoLevel #
Methods showsPrec :: Int -> DebugInfoLevel -> ShowS # show :: DebugInfoLevel -> String # showList :: [DebugInfoLevel] -> ShowS #
Generic DebugInfoLevel #
Associated Types type Rep DebugInfoLevel :: * -> * # Methods from :: DebugInfoLevel -> Rep DebugInfoLevel x # to :: Rep DebugInfoLevel x -> DebugInfoLevel #
Binary DebugInfoLevel #
Methods put :: DebugInfoLevel -> Put # get :: Get DebugInfoLevel # putList :: [DebugInfoLevel] -> Put #
type Rep DebugInfoLevel #
type Rep DebugInfoLevel = D1 * (MetaData "DebugInfoLevel" "Distribution.Simple.Compiler" "Cabal-2.2.0.0-KtVb5LuYqFjKrhxFyS8D9H" False) ((:+:) * ((:+:) * (C1 * (MetaCons "NoDebugInfo" PrefixI False) (U1 )) (C1 (MetaCons "MinimalDebugInfo" PrefixI False) (U1 ))) ((:+:) (C1 * (MetaCons "NormalDebugInfo" PrefixI False) (U1 )) (C1 (MetaCons "MaximalDebugInfo" PrefixI False) (U1 *))))

flagToDebugInfoLevel :: Maybe String -> DebugInfoLevel #

Support for language extensions

type Flag = String #

languageToFlags :: Compiler -> Maybe Language -> [Flag] #

unsupportedLanguages :: Compiler -> [Language] -> [Language] #

extensionsToFlags :: Compiler -> [Extension] -> [Flag] #

For the given compiler, return the flags for the supported extensions.

unsupportedExtensions :: Compiler -> [Extension] -> [Extension] #

For the given compiler, return the extensions it does not support.

parmakeSupported :: Compiler -> Bool #

Does this compiler support parallel --make mode?

reexportedModulesSupported :: Compiler -> Bool #

Does this compiler support reexported-modules?

renamingPackageFlagsSupported :: Compiler -> Bool #

Does this compiler support thinning/renaming on package flags?

unifiedIPIDRequired :: Compiler -> Bool #

Does this compiler have unified IPIDs (so no package keys)

packageKeySupported :: Compiler -> Bool #

Does this compiler support package keys?

unitIdSupported :: Compiler -> Bool #

Does this compiler support unit IDs?

coverageSupported :: Compiler -> Bool #

Does this compiler support Haskell program coverage?

profilingSupported :: Compiler -> Bool #

Does this compiler support profiling?

backpackSupported :: Compiler -> Bool #

Does this compiler support Backpack?

arResponseFilesSupported :: Compiler -> Bool #

Does this compiler's "ar" command supports response file arguments (i.e. @file-style arguments).

libraryDynDirSupported :: Compiler -> Bool #

Does this compiler support a package database entry with: "dynamic-library-dirs"?

Support for profiling detail levels

data ProfDetailLevel #

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
ProfDetailOther String

Instances

Eq ProfDetailLevel #
Methods (==) :: ProfDetailLevel -> ProfDetailLevel -> Bool # (/=) :: ProfDetailLevel -> ProfDetailLevel -> Bool #
Read ProfDetailLevel #
Methods readsPrec :: Int -> ReadS ProfDetailLevel # readList :: ReadS [ProfDetailLevel] # readPrec :: ReadPrec ProfDetailLevel # readListPrec :: ReadPrec [ProfDetailLevel] #
Show ProfDetailLevel #
Methods showsPrec :: Int -> ProfDetailLevel -> ShowS # show :: ProfDetailLevel -> String # showList :: [ProfDetailLevel] -> ShowS #
Generic ProfDetailLevel #
Associated Types type Rep ProfDetailLevel :: * -> * # Methods from :: ProfDetailLevel -> Rep ProfDetailLevel x # to :: Rep ProfDetailLevel x -> ProfDetailLevel #
Binary ProfDetailLevel #
Methods put :: ProfDetailLevel -> Put # get :: Get ProfDetailLevel # putList :: [ProfDetailLevel] -> Put #
type Rep ProfDetailLevel #
type Rep ProfDetailLevel = D1 * (MetaData "ProfDetailLevel" "Distribution.Simple.Compiler" "Cabal-2.2.0.0-KtVb5LuYqFjKrhxFyS8D9H" False) ((:+:) * ((:+:) * (C1 * (MetaCons "ProfDetailNone" PrefixI False) (U1 )) ((:+:) (C1 * (MetaCons "ProfDetailDefault" PrefixI False) (U1 )) (C1 (MetaCons "ProfDetailExportedFunctions" PrefixI False) (U1 )))) ((:+:) (C1 * (MetaCons "ProfDetailToplevelFunctions" PrefixI False) (U1 )) ((:+:) (C1 * (MetaCons "ProfDetailAllFunctions" PrefixI False) (U1 )) (C1 (MetaCons "ProfDetailOther" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * String))))))

knownProfDetailLevels :: [(String, [String], ProfDetailLevel)] #

flagToProfDetailLevel :: String -> ProfDetailLevel #

showProfDetailLevel :: ProfDetailLevel -> String #