Distribution.System

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.

Operating System

data OS

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

Constructors

Linux

Windows

OSX

FreeBSD

OpenBSD

NetBSD

DragonFly

Solaris

AIX

HPUX

IRIX

HaLVM

Hurd

IOS

Android

Ghcjs

Wasi

OtherOS String

Instances

Eq OS

Defined in Distribution.System

Methods

(==) :: OS -> OS -> Bool

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

Data OS

Defined in Distribution.System

Methods

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

toConstr :: OS -> Constr

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

Ord OS

Defined in Distribution.System

Methods

compare :: OS -> OS -> Ordering

(<) :: OS -> OS -> Bool

(<=) :: OS -> OS -> Bool

(>) :: OS -> OS -> Bool

(>=) :: OS -> OS -> Bool

max :: OS -> OS -> OS

min :: OS -> OS -> OS

Read OS

Defined in Distribution.System

Methods

readsPrec :: Int -> ReadS OS

readList :: ReadS [OS]

readPrec :: ReadPrec OS

readListPrec :: ReadPrec [OS]

Show OS

Defined in Distribution.System

Methods

showsPrec :: Int -> OS -> ShowS

show :: OS -> String

showList :: [OS] -> ShowS

Generic OS

Defined in Distribution.System

Associated Types

type Rep OS :: Type -> Type

Methods

from :: OS -> Rep OS x

to :: Rep OS x -> OS

Binary OS

Defined in Distribution.System

Methods

put :: OS -> Put

get :: Get OS

putList :: [OS] -> Put

NFData OS

Defined in Distribution.System

Methods

rnf :: OS -> ()

Structured OS

Defined in Distribution.System

Methods

structure :: Proxy OS -> Structure

structureHash' :: Tagged OS MD5

Pretty OS

Defined in Distribution.System

Methods

pretty :: OS -> Doc

prettyVersioned :: CabalSpecVersion -> OS -> Doc

Parsec OS

Defined in Distribution.System

Methods

parsec :: CabalParsing m => m OS

type Rep OS

Defined in Distribution.System

type Rep OS = D1 ('MetaData "OS" "Distribution.System" "Cabal-syntax-3.8.1.0-3wqkBKyVQKyGg3OBBvtt1F" '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 "OtherOS" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))))))

buildOS :: OS

Machine Architecture

data Arch

These are the known Arches: I386, X86_64, PPC, PPC64, Sparc, Arm, AArch64, Mips, SH, IA64, S390, S390X, Alpha, Hppa, Rs6000, M68k, Vax, JavaScript and Wasm32.

The following aliases can also be used: * PPC alias: powerpc * PPC64 alias : powerpc64, powerpc64le * Sparc aliases: sparc64, sun4 * Mips aliases: mipsel, mipseb * Arm aliases: armeb, armel * AArch64 aliases: arm64

Constructors

I386

X86_64

PPC

PPC64

Sparc

Arm

AArch64

Mips

SH

IA64

S390

S390X

Alpha

Hppa

Rs6000

M68k

Vax

JavaScript

Wasm32

OtherArch String

Instances

Eq Arch

Defined in Distribution.System

Methods

(==) :: Arch -> Arch -> Bool

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

Data Arch

Defined in Distribution.System

Methods

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

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

toConstr :: Arch -> Constr

dataTypeOf :: Arch -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> Arch -> Arch

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

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

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

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

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

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

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

Ord Arch

Defined in Distribution.System

Methods

compare :: Arch -> Arch -> Ordering

(<) :: Arch -> Arch -> Bool

(<=) :: Arch -> Arch -> Bool

(>) :: Arch -> Arch -> Bool

(>=) :: Arch -> Arch -> Bool

max :: Arch -> Arch -> Arch

min :: Arch -> Arch -> Arch

Read Arch

Defined in Distribution.System

Methods

readsPrec :: Int -> ReadS Arch

readList :: ReadS [Arch]

readPrec :: ReadPrec Arch

readListPrec :: ReadPrec [Arch]

Show Arch

Defined in Distribution.System

Methods

showsPrec :: Int -> Arch -> ShowS

show :: Arch -> String

showList :: [Arch] -> ShowS

Generic Arch

Defined in Distribution.System

Associated Types

type Rep Arch :: Type -> Type

Methods

from :: Arch -> Rep Arch x

to :: Rep Arch x -> Arch

Binary Arch

Defined in Distribution.System

Methods

put :: Arch -> Put

get :: Get Arch

putList :: [Arch] -> Put

NFData Arch

Defined in Distribution.System

Methods

rnf :: Arch -> ()

Structured Arch

Defined in Distribution.System

Methods

structure :: Proxy Arch -> Structure

structureHash' :: Tagged Arch MD5

Pretty Arch

Defined in Distribution.System

Methods

pretty :: Arch -> Doc

prettyVersioned :: CabalSpecVersion -> Arch -> Doc

Parsec Arch

Defined in Distribution.System

Methods

parsec :: CabalParsing m => m Arch

type Rep Arch

Defined in Distribution.System

type Rep Arch = D1 ('MetaData "Arch" "Distribution.System" "Cabal-syntax-3.8.1.0-3wqkBKyVQKyGg3OBBvtt1F" 'False) ((((C1 ('MetaCons "I386" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "X86_64" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PPC" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PPC64" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Sparc" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "Arm" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AArch64" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Mips" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SH" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IA64" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: (((C1 ('MetaCons "S390" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "S390X" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Alpha" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Hppa" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Rs6000" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "M68k" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Vax" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "JavaScript" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Wasm32" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OtherArch" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))))))

buildArch :: Arch

Platform is a pair of arch and OS

data Platform

Constructors

Platform Arch OS

Instances

Eq Platform

Defined in Distribution.System

Methods

(==) :: Platform -> Platform -> Bool

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

Data Platform

Defined in Distribution.System

Methods

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

Ord Platform

Defined in Distribution.System

Methods

compare :: Platform -> Platform -> Ordering

(<) :: Platform -> Platform -> Bool

(<=) :: Platform -> Platform -> Bool

(>) :: Platform -> Platform -> Bool

(>=) :: Platform -> Platform -> Bool

max :: Platform -> Platform -> Platform

min :: Platform -> Platform -> Platform

Read Platform

Defined in Distribution.System

Methods

readsPrec :: Int -> ReadS Platform

readList :: ReadS [Platform]

readPrec :: ReadPrec Platform

readListPrec :: ReadPrec [Platform]

Show Platform

Defined in Distribution.System

Methods

showsPrec :: Int -> Platform -> ShowS

show :: Platform -> String

showList :: [Platform] -> ShowS

Generic Platform

Defined in Distribution.System

Associated Types

type Rep Platform :: Type -> Type

Methods

from :: Platform -> Rep Platform x

to :: Rep Platform x -> Platform

Binary Platform

Defined in Distribution.System

Methods

put :: Platform -> Put

get :: Get Platform

putList :: [Platform] -> Put

NFData Platform

Defined in Distribution.System

Methods

rnf :: Platform -> ()

Structured Platform

Defined in Distribution.System

Methods

structure :: Proxy Platform -> Structure

structureHash' :: Tagged Platform MD5

Pretty Platform

Defined in Distribution.System

Methods

pretty :: Platform -> Doc

prettyVersioned :: CabalSpecVersion -> Platform -> Doc

Parsec Platform

Defined in Distribution.System

Methods

parsec :: CabalParsing m => m Platform

type Rep Platform

Defined in Distribution.System

type Rep Platform = D1 ('MetaData "Platform" "Distribution.System" "Cabal-syntax-3.8.1.0-3wqkBKyVQKyGg3OBBvtt1F" '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

The platform Cabal was compiled on. In most cases, LocalBuildInfo.hostPlatform should be used instead (the platform we're targeting).

platformFromTriple :: String -> Maybe Platform

Internal

knownOSs :: [OS]

knownArches :: [Arch]

Classification

data ClassificationStrictness

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.

Constructors

Permissive

Compat

Strict

classifyOS :: ClassificationStrictness -> String -> OS

classifyArch :: ClassificationStrictness -> String -> Arch