Distribution.Simple.Compiler

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.

Haskell implementations

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, CompilerFlag)]

  Supported language standards.

• compilerExtensions :: [(Extension, Maybe CompilerFlag)]

  Supported extensions.

• compilerProperties :: Map String String

  A key-value map for properties not covered by the above fields.

Instances

Structured Compiler

Defined in Distribution.Simple.Compiler

Methods

structure :: Proxy Compiler -> Structure

structureHash' :: Tagged Compiler MD5

Generic Compiler

Defined in Distribution.Simple.Compiler

Associated Types

type Rep Compiler :: Type -> Type

Methods

from :: Compiler -> Rep Compiler x

to :: Rep Compiler x -> Compiler

Read Compiler

Defined in Distribution.Simple.Compiler

Methods

readsPrec :: Int -> ReadS Compiler

readList :: ReadS [Compiler]

readPrec :: ReadPrec Compiler

readListPrec :: ReadPrec [Compiler]

Show Compiler

Defined in Distribution.Simple.Compiler

Methods

showsPrec :: Int -> Compiler -> ShowS

show :: Compiler -> String

showList :: [Compiler] -> ShowS

Binary Compiler

Defined in Distribution.Simple.Compiler

Methods

put :: Compiler -> Put

get :: Get Compiler

putList :: [Compiler] -> Put

Eq Compiler

Defined in Distribution.Simple.Compiler

Methods

(==) :: Compiler -> Compiler -> Bool

(/=) :: Compiler -> Compiler -> Bool

type Rep Compiler

Defined in Distribution.Simple.Compiler

type Rep Compiler = D1 ('MetaData "Compiler" "Distribution.Simple.Compiler" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "Compiler" 'PrefixI 'True) ((S1 ('MetaSel ('Just "compilerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CompilerId) :*: (S1 ('MetaSel ('Just "compilerAbiTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AbiTag) :*: S1 ('MetaSel ('Just "compilerCompat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [CompilerId]))) :*: (S1 ('MetaSel ('Just "compilerLanguages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Language, CompilerFlag)]) :*: (S1 ('MetaSel ('Just "compilerExtensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Extension, Maybe CompilerFlag)]) :*: S1 ('MetaSel ('Just "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

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

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

Foldable PackageDBX

Defined in Distribution.Simple.Compiler

Methods

fold :: Monoid m => PackageDBX m -> m

foldMap :: Monoid m => (a -> m) -> PackageDBX a -> m

foldMap' :: Monoid m => (a -> m) -> PackageDBX a -> m

foldr :: (a -> b -> b) -> b -> PackageDBX a -> b

foldr' :: (a -> b -> b) -> b -> PackageDBX a -> b

foldl :: (b -> a -> b) -> b -> PackageDBX a -> b

foldl' :: (b -> a -> b) -> b -> PackageDBX a -> b

foldr1 :: (a -> a -> a) -> PackageDBX a -> a

foldl1 :: (a -> a -> a) -> PackageDBX a -> a

toList :: PackageDBX a -> [a]

null :: PackageDBX a -> Bool

length :: PackageDBX a -> Int

elem :: Eq a => a -> PackageDBX a -> Bool

maximum :: Ord a => PackageDBX a -> a

minimum :: Ord a => PackageDBX a -> a

sum :: Num a => PackageDBX a -> a

product :: Num a => PackageDBX a -> a

Traversable PackageDBX

Defined in Distribution.Simple.Compiler

Methods

traverse :: Applicative f => (a -> f b) -> PackageDBX a -> f (PackageDBX b)

sequenceA :: Applicative f => PackageDBX (f a) -> f (PackageDBX a)

mapM :: Monad m => (a -> m b) -> PackageDBX a -> m (PackageDBX b)

sequence :: Monad m => PackageDBX (m a) -> m (PackageDBX a)

Functor PackageDBX

Defined in Distribution.Simple.Compiler

Methods

fmap :: (a -> b) -> PackageDBX a -> PackageDBX b

(<$) :: a -> PackageDBX b -> PackageDBX a

Structured fp => Structured (PackageDBX fp)

Defined in Distribution.Simple.Compiler

Methods

structure :: Proxy (PackageDBX fp) -> Structure

structureHash' :: Tagged (PackageDBX fp) MD5

Generic (PackageDBX fp)

Defined in Distribution.Simple.Compiler

Associated Types

type Rep (PackageDBX fp) :: Type -> Type

Methods

from :: PackageDBX fp -> Rep (PackageDBX fp) x

to :: Rep (PackageDBX fp) x -> PackageDBX fp

Read fp => Read (PackageDBX fp)

Defined in Distribution.Simple.Compiler

Methods

readsPrec :: Int -> ReadS (PackageDBX fp)

readList :: ReadS [PackageDBX fp]

readPrec :: ReadPrec (PackageDBX fp)

readListPrec :: ReadPrec [PackageDBX fp]

Show fp => Show (PackageDBX fp)

Defined in Distribution.Simple.Compiler

Methods

showsPrec :: Int -> PackageDBX fp -> ShowS

show :: PackageDBX fp -> String

showList :: [PackageDBX fp] -> ShowS

Binary fp => Binary (PackageDBX fp)

Defined in Distribution.Simple.Compiler

Methods

put :: PackageDBX fp -> Put

get :: Get (PackageDBX fp)

putList :: [PackageDBX fp] -> Put

Eq fp => Eq (PackageDBX fp)

Defined in Distribution.Simple.Compiler

Methods

(==) :: PackageDBX fp -> PackageDBX fp -> Bool

(/=) :: PackageDBX fp -> PackageDBX fp -> Bool

Ord fp => Ord (PackageDBX fp)

Defined in Distribution.Simple.Compiler

Methods

compare :: PackageDBX fp -> PackageDBX fp -> Ordering

(<) :: PackageDBX fp -> PackageDBX fp -> Bool

(<=) :: PackageDBX fp -> PackageDBX fp -> Bool

(>) :: PackageDBX fp -> PackageDBX fp -> Bool

(>=) :: PackageDBX fp -> PackageDBX fp -> Bool

max :: PackageDBX fp -> PackageDBX fp -> PackageDBX fp

min :: PackageDBX fp -> PackageDBX fp -> PackageDBX fp

type Rep (PackageDBX fp)

Defined in Distribution.Simple.Compiler

type Rep (PackageDBX fp) = D1 ('MetaData "PackageDBX" "Distribution.Simple.Compiler" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "GlobalPackageDB" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UserPackageDB" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SpecificPackageDB" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 fp))))

type PackageDBStackX from = [PackageDBX from]

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

type PackageDBStackS from = PackageDBStackX (SymbolicPath from (Dir PkgDB))

registrationPackageDB :: PackageDBStackX from -> PackageDBX from

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

Make package paths absolute

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

Transform a package db using a FilePath into one using symbolic paths.

coercePackageDBStack :: [PackageDBCWD] -> [PackageDBX (SymbolicPath CWD (Dir PkgDB))]

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

Structured OptimisationLevel

Defined in Distribution.Simple.Compiler

Methods

structure :: Proxy OptimisationLevel -> Structure

structureHash' :: Tagged OptimisationLevel MD5

Bounded OptimisationLevel

Defined in Distribution.Simple.Compiler

Methods

minBound :: OptimisationLevel

maxBound :: OptimisationLevel

Enum OptimisationLevel

Defined in Distribution.Simple.Compiler

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]

Generic OptimisationLevel

Defined in Distribution.Simple.Compiler

Associated Types

type Rep OptimisationLevel :: Type -> Type

Methods

from :: OptimisationLevel -> Rep OptimisationLevel x

to :: Rep OptimisationLevel x -> OptimisationLevel

Read OptimisationLevel

Defined in Distribution.Simple.Compiler

Methods

readsPrec :: Int -> ReadS OptimisationLevel

readList :: ReadS [OptimisationLevel]

readPrec :: ReadPrec OptimisationLevel

readListPrec :: ReadPrec [OptimisationLevel]

Show OptimisationLevel

Defined in Distribution.Simple.Compiler

Methods

showsPrec :: Int -> OptimisationLevel -> ShowS

show :: OptimisationLevel -> String

showList :: [OptimisationLevel] -> ShowS

Binary OptimisationLevel

Defined in Distribution.Simple.Compiler

Methods

put :: OptimisationLevel -> Put

get :: Get OptimisationLevel

putList :: [OptimisationLevel] -> Put

Eq OptimisationLevel

Defined in Distribution.Simple.Compiler

Methods

(==) :: OptimisationLevel -> OptimisationLevel -> Bool

(/=) :: OptimisationLevel -> OptimisationLevel -> Bool

type Rep OptimisationLevel

Defined in Distribution.Simple.Compiler

type Rep OptimisationLevel = D1 ('MetaData "OptimisationLevel" "Distribution.Simple.Compiler" "Cabal-3.14.0.0-inplace" 'False) (C1 ('MetaCons "NoOptimisation" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "NormalOptimisation" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MaximumOptimisation" 'PrefixI 'False) (U1 :: Type -> Type)))

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

Structured DebugInfoLevel

Defined in Distribution.Simple.Compiler

Methods

structure :: Proxy DebugInfoLevel -> Structure

structureHash' :: Tagged DebugInfoLevel MD5

Bounded DebugInfoLevel

Defined in Distribution.Simple.Compiler

Methods

minBound :: DebugInfoLevel

maxBound :: DebugInfoLevel

Enum DebugInfoLevel

Defined in Distribution.Simple.Compiler

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]

Generic DebugInfoLevel

Defined in Distribution.Simple.Compiler

Associated Types

type Rep DebugInfoLevel :: Type -> Type

Methods

from :: DebugInfoLevel -> Rep DebugInfoLevel x

to :: Rep DebugInfoLevel x -> DebugInfoLevel

Read DebugInfoLevel

Defined in Distribution.Simple.Compiler

Methods

readsPrec :: Int -> ReadS DebugInfoLevel

readList :: ReadS [DebugInfoLevel]

readPrec :: ReadPrec DebugInfoLevel

readListPrec :: ReadPrec [DebugInfoLevel]

Show DebugInfoLevel

Defined in Distribution.Simple.Compiler

Methods

showsPrec :: Int -> DebugInfoLevel -> ShowS

show :: DebugInfoLevel -> String

showList :: [DebugInfoLevel] -> ShowS

Binary DebugInfoLevel

Defined in Distribution.Simple.Compiler

Methods

put :: DebugInfoLevel -> Put

get :: Get DebugInfoLevel

putList :: [DebugInfoLevel] -> Put

Eq DebugInfoLevel

Defined in Distribution.Simple.Compiler

Methods

(==) :: DebugInfoLevel -> DebugInfoLevel -> Bool

(/=) :: DebugInfoLevel -> DebugInfoLevel -> Bool

type Rep DebugInfoLevel

Defined in Distribution.Simple.Compiler

type Rep DebugInfoLevel = D1 ('MetaData "DebugInfoLevel" "Distribution.Simple.Compiler" "Cabal-3.14.0.0-inplace" 'False) ((C1 ('MetaCons "NoDebugInfo" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MinimalDebugInfo" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NormalDebugInfo" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MaximalDebugInfo" 'PrefixI 'False) (U1 :: Type -> Type)))

flagToDebugInfoLevel :: Maybe String -> DebugInfoLevel

Support for language extensions

type CompilerFlag = String

languageToFlags :: Compiler -> Maybe Language -> [CompilerFlag]

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

extensionsToFlags :: Compiler -> [Extension] -> [CompilerFlag]

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?

profilingDynamicSupported :: Compiler -> Maybe Bool

Is the compiler distributed with profiling dynamic libraries

profilingDynamicSupportedOrUnknown :: Compiler -> Bool

Either profiling dynamic is definitely supported or we don't know (so assume it is)

profilingVanillaSupported :: Compiler -> Maybe Bool

Is the compiler distributed with profiling libraries

profilingVanillaSupportedOrUnknown :: Compiler -> Bool

Either profiling is definitely supported or we don't know (so assume it is)

dynamicSupported :: Compiler -> Maybe Bool

Is the compiler distributed with dynamic libraries

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).

arDashLSupported :: Compiler -> Bool

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

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

libraryVisibilitySupported :: Compiler -> Bool

Does this compiler support a package database entry with: "visibility"?

jsemSupported :: Compiler -> Bool

Does this compiler support the -jsem option?

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

ProfDetailTopLate

ProfDetailOther String

Instances

Structured ProfDetailLevel

Defined in Distribution.Simple.Compiler

Methods

structure :: Proxy ProfDetailLevel -> Structure

structureHash' :: Tagged ProfDetailLevel MD5

Generic ProfDetailLevel

Defined in Distribution.Simple.Compiler

Associated Types

type Rep ProfDetailLevel :: Type -> Type

Methods

from :: ProfDetailLevel -> Rep ProfDetailLevel x

to :: Rep ProfDetailLevel x -> ProfDetailLevel

Read ProfDetailLevel

Defined in Distribution.Simple.Compiler

Methods

readsPrec :: Int -> ReadS ProfDetailLevel

readList :: ReadS [ProfDetailLevel]

readPrec :: ReadPrec ProfDetailLevel

readListPrec :: ReadPrec [ProfDetailLevel]

Show ProfDetailLevel

Defined in Distribution.Simple.Compiler

Methods

showsPrec :: Int -> ProfDetailLevel -> ShowS

show :: ProfDetailLevel -> String

showList :: [ProfDetailLevel] -> ShowS

Binary ProfDetailLevel

Defined in Distribution.Simple.Compiler

Methods

put :: ProfDetailLevel -> Put

get :: Get ProfDetailLevel

putList :: [ProfDetailLevel] -> Put

Eq ProfDetailLevel

Defined in Distribution.Simple.Compiler

Methods

(==) :: ProfDetailLevel -> ProfDetailLevel -> Bool

(/=) :: ProfDetailLevel -> ProfDetailLevel -> Bool

type Rep ProfDetailLevel

Defined in Distribution.Simple.Compiler

type Rep ProfDetailLevel = D1 ('MetaData "ProfDetailLevel" "Distribution.Simple.Compiler" "Cabal-3.14.0.0-inplace" 'False) ((C1 ('MetaCons "ProfDetailNone" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ProfDetailDefault" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ProfDetailExportedFunctions" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "ProfDetailToplevelFunctions" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ProfDetailAllFunctions" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ProfDetailTopLate" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ProfDetailOther" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))))

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

flagToProfDetailLevel :: String -> ProfDetailLevel

showProfDetailLevel :: ProfDetailLevel -> String