Clash.Driver.BrokenGhcs

Utilities to detect and report GHC / operating system combinations that are known to be buggy.

Documentation

fullCompilerVersion :: Version

os :: OS

Current OS. Currently only recognizes Linux, Windows, and macOS.

data BrokenOn

What OS GHC is broken on (or all)

Constructors

All

SomeOs OS

data GhcVersion

Constructors

Ghc

Fields

• major0 :: Int
• major1 :: Int
• patch :: Int

Instances

Eq GhcVersion

Defined in Clash.Driver.BrokenGhcs

Methods

(==) :: GhcVersion -> GhcVersion -> Bool

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

Ord GhcVersion

Defined in Clash.Driver.BrokenGhcs

Methods

compare :: GhcVersion -> GhcVersion -> Ordering

(<) :: GhcVersion -> GhcVersion -> Bool

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

(>) :: GhcVersion -> GhcVersion -> Bool

(>=) :: GhcVersion -> GhcVersion -> Bool

max :: GhcVersion -> GhcVersion -> GhcVersion

min :: GhcVersion -> GhcVersion -> GhcVersion

data GhcRange

Constructors

GhcRange

Fields

• from :: GhcVersion

  Start of range, inclusive

• to :: GhcVersion

  End of range, exclusive

ghcInRange :: GhcVersion -> GhcRange -> Bool

Check if a GhcVersion is within a GhcRange

ghcMajor :: Int -> Int -> GhcRange

Construct a range of all GHC versions matching a major version

data Why

Constructors

Why

Fields

• what :: String

  What is broken

• solution :: String

  What can be done to work around or solve the issue

• issue :: String

  Link to issue

• brokenOn :: [(BrokenOn, GhcRange)]

  What operation systems are affected

ghcVersion :: GhcVersion

Get current GHC version expressed as a triple. It probably does something non-sensible on unreleased GHCs.

whyPp :: Why -> String

Pretty print Why into an error message

brokenGhcs :: [Why]

Which GHCs are broken and why

matchOs :: BrokenOn -> Bool

Given a BrokenOn, determine whether current OS matches

matchBroken :: (BrokenOn, GhcRange) -> Bool

Given a BrokenOn and GhcVersion, determine whether it matches current OS and GHC

broken :: Maybe Why

Get first reason for GHC/OS being broken, if any

assertWorking :: IO ()

Throw an error if current OS / GHC version is known to be buggy