Copyright | Duncan Coutts 2007-2008 |
---|---|
Maintainer | cabal-devel@haskell.org |
Portability | portable |
Safe Haskell | None |
Language | Haskell2010 |
Cabal often needs to do slightly different things on specific platforms. You
probably know about the os
however using that is very
inconvenient because it is a string and different Haskell implementations
do not agree on using the same strings for the same platforms! (In
particular see the controversy over "windows" vs "mingw32"). So to make it
more consistent and easy to use we have an OS
enumeration.
Synopsis
- data OS
- buildOS :: OS
- data Arch
- buildArch :: Arch
- data Platform = Platform Arch OS
- buildPlatform :: Platform
- platformFromTriple :: String -> Maybe Platform
- knownOSs :: [OS]
- knownArches :: [Arch]
- data ClassificationStrictness
- = Permissive
- | Compat
- | Strict
- classifyOS :: ClassificationStrictness -> String -> OS
- classifyArch :: ClassificationStrictness -> String -> Arch
Operating System
These are the known OS names: Linux, Windows, OSX ,FreeBSD, OpenBSD, NetBSD, DragonFly ,Solaris, AIX, HPUX, IRIX ,HaLVM ,Hurd ,IOS, Android, Ghcjs, Wasi
The following aliases can also be used:, * Windows aliases: mingw32, win32, cygwin32 * OSX alias: darwin * Hurd alias: gnu * FreeBSD alias: kfreebsdgnu * Solaris alias: solaris2
Linux | |
Windows | |
OSX | |
FreeBSD | |
OpenBSD | |
NetBSD | |
DragonFly | |
Solaris | |
AIX | |
HPUX | |
IRIX | |
HaLVM | |
Hurd | |
IOS | |
Android | |
Ghcjs | |
Wasi | |
Haiku | |
OtherOS String |
Instances
Parsec OS Source # | |
Defined in Distribution.System parsec :: CabalParsing m => m OS Source # | |
Pretty OS Source # | |
Defined in Distribution.System | |
Structured OS Source # | |
Defined in Distribution.System | |
Binary OS Source # | |
NFData OS Source # | |
Defined in Distribution.System | |
Data OS Source # | |
Defined in Distribution.System gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OS -> c OS # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OS # dataTypeOf :: OS -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OS) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OS) # gmapT :: (forall b. Data b => b -> b) -> OS -> OS # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OS -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OS -> r # gmapQ :: (forall d. Data d => d -> u) -> OS -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OS -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OS -> m OS # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OS -> m OS # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OS -> m OS # | |
Generic OS Source # | |
Defined in Distribution.System | |
Read OS Source # | |
Show OS Source # | |
Eq OS Source # | |
Ord OS Source # | |
type Rep OS Source # | |
Defined in Distribution.System type Rep OS = D1 ('MetaData "OS" "Distribution.System" "Cabal-syntax-3.14.0.0-5292" 'False) ((((C1 ('MetaCons "Linux" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Windows" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "OSX" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FreeBSD" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "OpenBSD" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NetBSD" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "DragonFly" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Solaris" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AIX" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: (((C1 ('MetaCons "HPUX" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IRIX" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "HaLVM" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Hurd" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IOS" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "Android" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Ghcjs" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Wasi" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Haiku" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OtherOS" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))))) |
Machine Architecture
These are the known Arches: I386, X86_64, PPC, PPC64, PPC64LE, Sparc, Sparc64, Arm, AArch64, Mips, SH, IA64, S390, S390X, Alpha, Hppa, Rs6000, M68k, Vax, RISCV64, LoongArch64, JavaScript and Wasm32.
The following aliases can also be used: * PPC alias: powerpc * PPC64 alias : powerpc64 * PPC64LE alias : powerpc64le * Mips aliases: mipsel, mipseb * Arm aliases: armeb, armel * AArch64 aliases: arm64
I386 | |
X86_64 | |
PPC | |
PPC64 | |
PPC64LE | |
Sparc | |
Sparc64 | |
Arm | |
AArch64 | |
Mips | |
SH | |
IA64 | |
S390 | |
S390X | |
Alpha | |
Hppa | |
Rs6000 | |
M68k | |
Vax | |
RISCV64 | |
LoongArch64 | |
JavaScript | |
Wasm32 | |
OtherArch String |
Instances
Platform is a pair of arch and OS
Instances
Parsec Platform Source # | |||||
Defined in Distribution.System parsec :: CabalParsing m => m Platform Source # | |||||
Pretty Platform Source # | |||||
Defined in Distribution.System | |||||
Structured Platform Source # | |||||
Defined in Distribution.System | |||||
Binary Platform Source # | |||||
NFData Platform Source # | |||||
Defined in Distribution.System | |||||
Data Platform Source # | |||||
Defined in Distribution.System gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Platform -> c Platform # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Platform # toConstr :: Platform -> Constr # dataTypeOf :: Platform -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Platform) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Platform) # gmapT :: (forall b. Data b => b -> b) -> Platform -> Platform # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Platform -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Platform -> r # gmapQ :: (forall d. Data d => d -> u) -> Platform -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Platform -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Platform -> m Platform # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Platform -> m Platform # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Platform -> m Platform # | |||||
Generic Platform Source # | |||||
Defined in Distribution.System
| |||||
Read Platform Source # | |||||
Show Platform Source # | |||||
Eq Platform Source # | |||||
Ord Platform Source # | |||||
Defined in Distribution.System | |||||
type Rep Platform Source # | |||||
Defined in Distribution.System type Rep Platform = D1 ('MetaData "Platform" "Distribution.System" "Cabal-syntax-3.14.0.0-5292" 'False) (C1 ('MetaCons "Platform" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Arch) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OS))) |
buildPlatform :: Platform Source #
The platform Cabal was compiled on. In most cases,
LocalBuildInfo.hostPlatform
should be used instead (the platform we're
targeting).
Internal
knownArches :: [Arch] Source #
Classification
data ClassificationStrictness Source #
How strict to be when classifying strings into the OS
and Arch
enums.
The reason we have multiple ways to do the classification is because there are two situations where we need to do it.
For parsing OS and arch names in .cabal files we really want everyone to be referring to the same or arch by the same name. Variety is not a virtue in this case. We don't mind about case though.
For the System.Info.os/arch different Haskell implementations use different names for the same or/arch. Also they tend to distinguish versions of an OS/arch which we just don't care about.
The Compat
classification allows us to recognise aliases that are already
in common use but it allows us to distinguish them from the canonical name
which enables us to warn about such deprecated aliases.
classifyOS :: ClassificationStrictness -> String -> OS Source #
classifyArch :: ClassificationStrictness -> String -> Arch Source #