ModuleCabal-syntax-3.12.1.0Haskell2010

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.

4 types
8 values

PackageCabal-syntax-3.12.1.0
Exports12
LanguageHaskell2010
LicenceBSD-3-Clause
SourceSystem.hs

Operating System

2 declarations

datadata 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
Haiku
OtherOS String

Instances12Eq, Data, Ord, Read, Show, Generic, …

Eq OSDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Data OSDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Ord OSDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Read OSDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Show OSDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Generic OSDefined in Cabal-syntax-3.12.1.0 · Distribution.System
NFData OSDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Binary OSDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Parsec OSDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Pretty OSDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Structured OSDefined in Cabal-syntax-3.12.1.0 · Distribution.System
type Rep OS = D1 ('MetaData "OS" "Distribution.System" "Cabal-syntax-3.12.1.0-3adc" 'False) ((((C1 ('MetaCons "Linux" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Windows" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "OSX" 'PrefixI 'False) U1 :+: C1 ('MetaCons "FreeBSD" 'PrefixI 'False) U1)) :+: ((C1 ('MetaCons "OpenBSD" 'PrefixI 'False) U1 :+: C1 ('MetaCons "NetBSD" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "DragonFly" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "Solaris" 'PrefixI 'False) U1 :+: C1 ('MetaCons "AIX" 'PrefixI 'False) U1)))) :+: (((C1 ('MetaCons "HPUX" 'PrefixI 'False) U1 :+: C1 ('MetaCons "IRIX" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "HaLVM" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "Hurd" 'PrefixI 'False) U1 :+: C1 ('MetaCons "IOS" 'PrefixI 'False) U1))) :+: ((C1 ('MetaCons "Android" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Ghcjs" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "Wasi" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "Haiku" 'PrefixI 'False) U1 :+: C1 ('MetaCons "OtherOS" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))))))Defined in Cabal-syntax-3.12.1.0 · Distribution.System

valuebuildOS :: OS

Machine Architecture

2 declarations

datadata Arch

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

Constructors

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

Instances12Eq, Data, Ord, Read, Show, Generic, …

Eq ArchDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Data ArchDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Ord ArchDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Read ArchDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Show ArchDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Generic ArchDefined in Cabal-syntax-3.12.1.0 · Distribution.System
NFData ArchDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Binary ArchDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Parsec ArchDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Pretty ArchDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Structured ArchDefined in Cabal-syntax-3.12.1.0 · Distribution.System
type Rep Arch = D1 ('MetaData "Arch" "Distribution.System" "Cabal-syntax-3.12.1.0-3adc" 'False) ((((C1 ('MetaCons "I386" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "X86_64" 'PrefixI 'False) U1 :+: C1 ('MetaCons "PPC" 'PrefixI 'False) U1)) :+: (C1 ('MetaCons "PPC64" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "PPC64LE" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Sparc" 'PrefixI 'False) U1))) :+: ((C1 ('MetaCons "Sparc64" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "Arm" 'PrefixI 'False) U1 :+: C1 ('MetaCons "AArch64" 'PrefixI 'False) U1)) :+: (C1 ('MetaCons "Mips" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "SH" 'PrefixI 'False) U1 :+: C1 ('MetaCons "IA64" 'PrefixI 'False) U1)))) :+: (((C1 ('MetaCons "S390" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "S390X" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Alpha" 'PrefixI 'False) U1)) :+: (C1 ('MetaCons "Hppa" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "Rs6000" 'PrefixI 'False) U1 :+: C1 ('MetaCons "M68k" 'PrefixI 'False) U1))) :+: ((C1 ('MetaCons "Vax" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "RISCV64" 'PrefixI 'False) U1 :+: C1 ('MetaCons "LoongArch64" 'PrefixI 'False) U1)) :+: (C1 ('MetaCons "JavaScript" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "Wasm32" 'PrefixI 'False) U1 :+: C1 ('MetaCons "OtherArch" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))))))Defined in Cabal-syntax-3.12.1.0 · Distribution.System

valuebuildArch :: Arch

Platform is a pair of arch and OS

3 declarations

datadata Platform

Constructors

Platform Arch OS

Instances12Eq, Data, Ord, Read, Show, Generic, …

Eq PlatformDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Data PlatformDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Ord PlatformDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Read PlatformDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Show PlatformDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Generic PlatformDefined in Cabal-syntax-3.12.1.0 · Distribution.System
NFData PlatformDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Binary PlatformDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Parsec PlatformDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Pretty PlatformDefined in Cabal-syntax-3.12.1.0 · Distribution.System
Structured PlatformDefined in Cabal-syntax-3.12.1.0 · Distribution.System
type Rep Platform = D1 ('MetaData "Platform" "Distribution.System" "Cabal-syntax-3.12.1.0-3adc" 'False) (C1 ('MetaCons "Platform" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Arch) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OS)))Defined in Cabal-syntax-3.12.1.0 · Distribution.System

valuebuildPlatform :: Platform

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

valueplatformFromTriple :: String -> Maybe Platform

Internal

2 declarations

valueknownOSs :: [OS]

valueknownArches :: [Arch]

Classification

3 declarations

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

Permissive Compat Strict

valueclassifyOS :: ClassificationStrictness -> String -> OS

valueclassifyArch :: ClassificationStrictness -> String -> Arch