ModuleCabal-syntax-3.18.1.0Haskell2010

Distribution.Compiler

This has an enumeration of the various compilers that Cabal knows about. It also specifies the default compiler. Sadly you'll often see code that does case analysis on this compiler flavour enumeration like:

case compilerFlavor comp of
  GHC -> GHC.getInstalledPackages verbosity packageDb progdb

Obviously it would be better to use the proper Compiler abstraction because that would keep all the compiler-specific code together. Unfortunately we cannot make this change yet without breaking the UserHooks api, which would break all custom Setup.hs files, so for the moment we just have to live with this deficiency. If you're interested, see ticket #57.

Contents

Compiler flavor
Per compiler flavor
Compiler id
Compiler info

Synopsis

data CompilerFlavor
value buildCompilerId
value buildCompilerFlavor
value defaultCompilerFlavor
value classifyCompilerFlavor
value knownCompilerFlavors
data PerCompilerFlavor
value perCompilerFlavorToList
data CompilerId
data CompilerInfo
value unknownCompilerInfo
data AbiTag
value abiTagString

PackageCabal-syntax-3.18.1.0
Exports13
LanguageHaskell2010
LicenceBSD-3-Clause
SourceCompiler.hs

Compiler flavor

datadata CompilerFlavor

Constructors

GHC
GHCJS
NHC
YHC
Hugs
HBC
Helium
JHC
LHC
UHC
Eta
MHS
MicroHS, see https://github.com/augustss/MicroHs
OtherCompiler String

Instances13Eq, Data, Ord, Read, Show, Generic, …

Eq CompilerFlavorDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Data CompilerFlavorDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Ord CompilerFlavorDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Read CompilerFlavorDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Show CompilerFlavorDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Generic CompilerFlavorDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
NFData CompilerFlavorDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Binary CompilerFlavorDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Parsec CompilerFlavorDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Pretty CompilerFlavorDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Structured CompilerFlavorDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Newtype (CompilerFlavor, VersionRange) TestedWithDefined in Cabal-syntax-3.18.1.0 · Distribution.FieldGrammar.Newtypes
type Rep CompilerFlavor = D1 ('MetaData "CompilerFlavor" "Distribution.Compiler" "Cabal-syntax-3.18.1.0-046d" 'False) (((C1 ('MetaCons "GHC" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "GHCJS" 'PrefixI 'False) U1 :+: C1 ('MetaCons "NHC" 'PrefixI 'False) U1)) :+: (C1 ('MetaCons "YHC" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "Hugs" 'PrefixI 'False) U1 :+: C1 ('MetaCons "HBC" 'PrefixI 'False) U1))) :+: ((C1 ('MetaCons "Helium" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "JHC" 'PrefixI 'False) U1 :+: C1 ('MetaCons "LHC" 'PrefixI 'False) U1)) :+: ((C1 ('MetaCons "UHC" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Eta" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "MHS" 'PrefixI 'False) U1 :+: C1 ('MetaCons "OtherCompiler" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))))Defined in Cabal-syntax-3.18.1.0 · Distribution.Compiler

valuebuildCompilerId :: CompilerId

valuebuildCompilerFlavor :: CompilerFlavor

valuedefaultCompilerFlavor :: Maybe CompilerFlavor

Source#

The default compiler flavour to pick when compiling stuff. This defaults to the compiler used to build the Cabal lib.

However if it's not a recognised compiler then it's Nothing and the user will have to specify which compiler they want.

valueclassifyCompilerFlavor :: String -> CompilerFlavor

valueknownCompilerFlavors :: [CompilerFlavor]

Per compiler flavor

datadata PerCompilerFlavor v

Source#

PerCompilerFlavor carries only info per GHC and GHCJS

Cabal parses only ghc-options and ghcjs-options, others are omitted.

Constructors

PerCompilerFlavor v v

Instances15Functor, Foldable, Traversable, Eq, Data, Ord, …

Functor PerCompilerFlavorDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Foldable PerCompilerFlavorDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Traversable PerCompilerFlavorDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Eq v => Eq (PerCompilerFlavor v)Defined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Data v => Data (PerCompilerFlavor v)Defined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Ord v => Ord (PerCompilerFlavor v)Defined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Read v => Read (PerCompilerFlavor v)Defined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Show v => Show (PerCompilerFlavor v)Defined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Generic (PerCompilerFlavor v)Defined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Semigroup a => Semigroup (PerCompilerFlavor a)Defined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Monoid a => Monoid (PerCompilerFlavor a)Defined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
NFData a => NFData (PerCompilerFlavor a)Defined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Binary a => Binary (PerCompilerFlavor a)Defined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Structured a => Structured (PerCompilerFlavor a)Defined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
type Rep (PerCompilerFlavor v) = D1 ('MetaData "PerCompilerFlavor" "Distribution.Compiler" "Cabal-syntax-3.18.1.0-046d" 'False) (C1 ('MetaCons "PerCompilerFlavor" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 v) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 v)))Defined in Cabal-syntax-3.18.1.0 · Distribution.Compiler

valueperCompilerFlavorToList :: PerCompilerFlavor v -> [(CompilerFlavor, v)]

Compiler id

datadata CompilerId

Constructors

CompilerId CompilerFlavor Version

Instances11Eq, Ord, Read, Show, Generic, NFData, …

Eq CompilerIdDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Ord CompilerIdDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Read CompilerIdDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Show CompilerIdDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Generic CompilerIdDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
NFData CompilerIdDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Binary CompilerIdDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Parsec CompilerIdDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Pretty CompilerIdDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Structured CompilerIdDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
type Rep CompilerId = D1 ('MetaData "CompilerId" "Distribution.Compiler" "Cabal-syntax-3.18.1.0-046d" 'False) (C1 ('MetaCons "CompilerId" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CompilerFlavor) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)))Defined in Cabal-syntax-3.18.1.0 · Distribution.Compiler

Compiler info

datadata CompilerInfo

Source#

Compiler information used for resolving configurations. Some fields can be set to Nothing to indicate that the information is unknown.

Constructors

CompilerInfo
- compilerInfoId :: CompilerId
  Compiler flavour and version.
- compilerInfoAbiTag :: AbiTag
  Tag for distinguishing incompatible ABI's on the same architecture/os.
- compilerInfoCompat :: Maybe [CompilerId]
  Other implementations that this compiler claims to be compatible with, if known.
- compilerInfoLanguages :: Maybe [Language]
  Supported language standards, if known.
- compilerInfoExtensions :: Maybe [Extension]
  Supported extensions, if known.
- compilerInfoWiredInUnitIds :: Maybe [(PackageName, UnitId)]
  UnitIds that the compiler doesn't support reinstalling. Nothing indicates that the compiler hasn't supplied this information and that we should act pessimistically. For instance, when using GHC plugins, one wants to use the exact same version of the ghc package as the one the compiler was linked against.

Instances5Read, Show, Generic, Binary, Rep

Read CompilerInfoDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Show CompilerInfoDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Generic CompilerInfoDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Binary CompilerInfoDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
type Rep CompilerInfo = D1 ('MetaData "CompilerInfo" "Distribution.Compiler" "Cabal-syntax-3.18.1.0-046d" 'False) (C1 ('MetaCons "CompilerInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "compilerInfoId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CompilerId) :*: (S1 ('MetaSel ('Just "compilerInfoAbiTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AbiTag) :*: S1 ('MetaSel ('Just "compilerInfoCompat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [CompilerId])))) :*: (S1 ('MetaSel ('Just "compilerInfoLanguages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Language])) :*: (S1 ('MetaSel ('Just "compilerInfoExtensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Extension])) :*: S1 ('MetaSel ('Just "compilerInfoWiredInUnitIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [(PackageName, UnitId)]))))))Defined in Cabal-syntax-3.18.1.0 · Distribution.Compiler

valueunknownCompilerInfo :: CompilerId -> AbiTag -> CompilerInfo

Source#

Make a CompilerInfo of which only the known information is its CompilerId, its AbiTag and that it does not claim to be compatible with other compiler id's.

datadata AbiTag

Constructors

NoAbiTag
AbiTag String

Instances10Eq, Read, Show, Generic, NFData, Binary, …

Eq AbiTagDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Read AbiTagDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Show AbiTagDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Generic AbiTagDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
NFData AbiTagDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Binary AbiTagDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Parsec AbiTagDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Pretty AbiTagDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
Structured AbiTagDefined in Cabal-syntax-3.18.1.0 · Distribution.Compiler
type Rep AbiTag = D1 ('MetaData "AbiTag" "Distribution.Compiler" "Cabal-syntax-3.18.1.0-046d" 'False) (C1 ('MetaCons "NoAbiTag" 'PrefixI 'False) U1 :+: C1 ('MetaCons "AbiTag" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))Defined in Cabal-syntax-3.18.1.0 · Distribution.Compiler

valueabiTagString :: AbiTag -> String