Cabal-2.2.0.1: A framework for packaging Haskell software

CopyrightIsaac Jones 2003-2004
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Distribution.Compiler

Contents

Description

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

Synopsis

Compiler flavor

data CompilerFlavor #

Constructors

GHC 
GHCJS 
NHC 
YHC 
Hugs 
HBC 
Helium 
JHC 
LHC 
UHC 
HaskellSuite String 
OtherCompiler String 
Instances
Eq CompilerFlavor # 
Instance details

Methods

(==) :: CompilerFlavor -> CompilerFlavor -> Bool #

(/=) :: CompilerFlavor -> CompilerFlavor -> Bool #

Data CompilerFlavor # 
Instance details

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CompilerFlavor -> c CompilerFlavor #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CompilerFlavor #

toConstr :: CompilerFlavor -> Constr #

dataTypeOf :: CompilerFlavor -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CompilerFlavor) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CompilerFlavor) #

gmapT :: (forall b. Data b => b -> b) -> CompilerFlavor -> CompilerFlavor #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CompilerFlavor -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CompilerFlavor -> r #

gmapQ :: (forall d. Data d => d -> u) -> CompilerFlavor -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CompilerFlavor -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CompilerFlavor -> m CompilerFlavor #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CompilerFlavor -> m CompilerFlavor #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CompilerFlavor -> m CompilerFlavor #

Ord CompilerFlavor # 
Instance details

Methods

compare :: CompilerFlavor -> CompilerFlavor -> Ordering #

(<) :: CompilerFlavor -> CompilerFlavor -> Bool #

(<=) :: CompilerFlavor -> CompilerFlavor -> Bool #

(>) :: CompilerFlavor -> CompilerFlavor -> Bool #

(>=) :: CompilerFlavor -> CompilerFlavor -> Bool #

max :: CompilerFlavor -> CompilerFlavor -> CompilerFlavor #

min :: CompilerFlavor -> CompilerFlavor -> CompilerFlavor #

Read CompilerFlavor # 
Instance details

Methods

readsPrec :: Int -> ReadS CompilerFlavor #

readList :: ReadS [CompilerFlavor] #

readPrec :: ReadPrec CompilerFlavor #

readListPrec :: ReadPrec [CompilerFlavor] #

Show CompilerFlavor # 
Instance details

Methods

showsPrec :: Int -> CompilerFlavor -> ShowS #

show :: CompilerFlavor -> String #

showList :: [CompilerFlavor] -> ShowS #

Generic CompilerFlavor # 
Instance details

Associated Types

type Rep CompilerFlavor :: * -> * #

Methods

from :: CompilerFlavor -> Rep CompilerFlavor x #

to :: Rep CompilerFlavor x -> CompilerFlavor #

Binary CompilerFlavor # 
Instance details

Methods

put :: CompilerFlavor -> Put #

get :: Get CompilerFlavor #

putList :: [CompilerFlavor] -> Put #

NFData CompilerFlavor # 
Instance details

Methods

rnf :: CompilerFlavor -> () #

Pretty CompilerFlavor # 
Instance details

Methods

pretty :: CompilerFlavor -> Doc #

Parsec CompilerFlavor # 
Instance details

Methods

parsec :: CabalParsing m => m CompilerFlavor #

Text CompilerFlavor # 
Instance details

Methods

disp :: CompilerFlavor -> Doc #

parse :: ReadP r CompilerFlavor #

Newtype TestedWith (CompilerFlavor, VersionRange) # 
Instance details

Methods

pack :: (CompilerFlavor, VersionRange) -> TestedWith #

unpack :: TestedWith -> (CompilerFlavor, VersionRange) #

type Rep CompilerFlavor # 
Instance details
type Rep CompilerFlavor = D1 (MetaData "CompilerFlavor" "Distribution.Compiler" "Cabal-2.2.0.1-JS0vobxWxH7sbYKd0omMO" 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 "HaskellSuite" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: C1 (MetaCons "OtherCompiler" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))))

buildCompilerId :: CompilerId #

buildCompilerFlavor :: CompilerFlavor #

defaultCompilerFlavor :: Maybe CompilerFlavor #

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.

parseCompilerFlavorCompat :: ReadP r CompilerFlavor #

Like classifyCompilerFlavor but compatible with the old ReadS parser.

It is compatible in the sense that it accepts only the same strings, eg GHC but not "ghc". However other strings get mapped to OtherCompiler. The point of this is that we do not allow extra valid values that would upset older Cabal versions that had a stricter parser however we cope with new values more gracefully so that we'll be able to introduce new value in future without breaking things so much.

classifyCompilerFlavor :: String -> CompilerFlavor #

Compiler id

data CompilerId #

Constructors

CompilerId CompilerFlavor Version 
Instances
Eq CompilerId # 
Instance details

Methods

(==) :: CompilerId -> CompilerId -> Bool #

(/=) :: CompilerId -> CompilerId -> Bool #

Ord CompilerId # 
Instance details

Methods

compare :: CompilerId -> CompilerId -> Ordering #

(<) :: CompilerId -> CompilerId -> Bool #

(<=) :: CompilerId -> CompilerId -> Bool #

(>) :: CompilerId -> CompilerId -> Bool #

(>=) :: CompilerId -> CompilerId -> Bool #

max :: CompilerId -> CompilerId -> CompilerId #

min :: CompilerId -> CompilerId -> CompilerId #

Read CompilerId # 
Instance details

Methods

readsPrec :: Int -> ReadS CompilerId #

readList :: ReadS [CompilerId] #

readPrec :: ReadPrec CompilerId #

readListPrec :: ReadPrec [CompilerId] #

Show CompilerId # 
Instance details

Methods

showsPrec :: Int -> CompilerId -> ShowS #

show :: CompilerId -> String #

showList :: [CompilerId] -> ShowS #

Generic CompilerId # 
Instance details

Associated Types

type Rep CompilerId :: * -> * #

Methods

from :: CompilerId -> Rep CompilerId x #

to :: Rep CompilerId x -> CompilerId #

Binary CompilerId # 
Instance details

Methods

put :: CompilerId -> Put #

get :: Get CompilerId #

putList :: [CompilerId] -> Put #

NFData CompilerId # 
Instance details

Methods

rnf :: CompilerId -> () #

Text CompilerId # 
Instance details

Methods

disp :: CompilerId -> Doc #

parse :: ReadP r CompilerId #

type Rep CompilerId # 
Instance details
type Rep CompilerId = D1 (MetaData "CompilerId" "Distribution.Compiler" "Cabal-2.2.0.1-JS0vobxWxH7sbYKd0omMO" False) (C1 (MetaCons "CompilerId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CompilerFlavor) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Version)))

Compiler info

data CompilerInfo #

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

Constructors

CompilerInfo 

Fields

Instances
Read CompilerInfo # 
Instance details

Methods

readsPrec :: Int -> ReadS CompilerInfo #

readList :: ReadS [CompilerInfo] #

readPrec :: ReadPrec CompilerInfo #

readListPrec :: ReadPrec [CompilerInfo] #

Show CompilerInfo # 
Instance details

Methods

showsPrec :: Int -> CompilerInfo -> ShowS #

show :: CompilerInfo -> String #

showList :: [CompilerInfo] -> ShowS #

Generic CompilerInfo # 
Instance details

Associated Types

type Rep CompilerInfo :: * -> * #

Methods

from :: CompilerInfo -> Rep CompilerInfo x #

to :: Rep CompilerInfo x -> CompilerInfo #

Binary CompilerInfo # 
Instance details

Methods

put :: CompilerInfo -> Put #

get :: Get CompilerInfo #

putList :: [CompilerInfo] -> Put #

type Rep CompilerInfo # 
Instance details
type Rep CompilerInfo = D1 (MetaData "CompilerInfo" "Distribution.Compiler" "Cabal-2.2.0.1-JS0vobxWxH7sbYKd0omMO" 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]))))))

unknownCompilerInfo :: CompilerId -> AbiTag -> CompilerInfo #

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.

data AbiTag #

Constructors

NoAbiTag 
AbiTag String 
Instances
Eq AbiTag # 
Instance details

Methods

(==) :: AbiTag -> AbiTag -> Bool #

(/=) :: AbiTag -> AbiTag -> Bool #

Read AbiTag # 
Instance details

Methods

readsPrec :: Int -> ReadS AbiTag #

readList :: ReadS [AbiTag] #

readPrec :: ReadPrec AbiTag #

readListPrec :: ReadPrec [AbiTag] #

Show AbiTag # 
Instance details

Methods

showsPrec :: Int -> AbiTag -> ShowS #

show :: AbiTag -> String #

showList :: [AbiTag] -> ShowS #

Generic AbiTag # 
Instance details

Associated Types

type Rep AbiTag :: * -> * #

Methods

from :: AbiTag -> Rep AbiTag x #

to :: Rep AbiTag x -> AbiTag #

Binary AbiTag # 
Instance details

Methods

put :: AbiTag -> Put #

get :: Get AbiTag #

putList :: [AbiTag] -> Put #

Text AbiTag # 
Instance details

Methods

disp :: AbiTag -> Doc #

parse :: ReadP r AbiTag #

type Rep AbiTag # 
Instance details
type Rep AbiTag = D1 (MetaData "AbiTag" "Distribution.Compiler" "Cabal-2.2.0.1-JS0vobxWxH7sbYKd0omMO" False) (C1 (MetaCons "NoAbiTag" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "AbiTag" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))

abiTagString :: AbiTag -> String #