HIE.Bios.Types

Documentation

data BIOSVerbosity

Constructors

Silent

Verbose

data CradleOpts

Constructors

CradleOpts

Fields

• cradleOptsVerbosity :: BIOSVerbosity
• cradleOptsHandle :: Maybe Handle

  The handle where to send output to, if not set, stderr.

defaultCradleOpts :: CradleOpts

data Cradle

The environment of a single Cradle. A Cradle is a unit for the respective build-system.

It contains the root directory of the Cradle, the name of the Cradle (for debugging purposes), and knows how to set up a GHC session that is able to compile files that are part of this Cradle.

A Cradle may be a single unit in the "cabal-install" context, or the whole package, comparable to how "stack" works.

Constructors

Cradle

Fields

• cradleRootDir :: FilePath

  The project root directory.

• cradleOptsProg :: CradleAction

  The action which needs to be executed to get the correct command line arguments.

Instances

Show Cradle

Defined in HIE.Bios.Types

Methods

showsPrec :: Int -> Cradle -> ShowS

show :: Cradle -> String

showList :: [Cradle] -> ShowS

type LoggingFunction = String -> IO ()

data CradleAction

Constructors

CradleAction

Fields

• actionName :: String

  Name of the action.

• runCradle :: LoggingFunction -> FilePath -> IO (CradleLoadResult ComponentOptions)

  Options to compile the given file with.

Instances

Show CradleAction

Defined in HIE.Bios.Types

Methods

showsPrec :: Int -> CradleAction -> ShowS

show :: CradleAction -> String

showList :: [CradleAction] -> ShowS

data CradleLoadResult r

Result of an attempt to set up a GHC session for a Cradle. This is the go-to error handling mechanism. When possible, this should be preferred over throwing exceptions.

Constructors

CradleSuccess r

The cradle succeeded and returned these options.

CradleFail CradleError

We tried to load the cradle and it failed.

CradleNone

No attempt was made to load the cradle.

Instances

Functor CradleLoadResult

Defined in HIE.Bios.Types

Methods

fmap :: (a -> b) -> CradleLoadResult a -> CradleLoadResult b

(<$) :: a -> CradleLoadResult b -> CradleLoadResult a

data CradleError

Constructors

CradleError ExitCode [String]

Instances

Show CradleError

Defined in HIE.Bios.Types

Methods

showsPrec :: Int -> CradleError -> ShowS

show :: CradleError -> String

showList :: [CradleError] -> ShowS

Exception CradleError

Defined in HIE.Bios.Types

Methods

toException :: CradleError -> SomeException

fromException :: SomeException -> Maybe CradleError

displayException :: CradleError -> String

data ComponentOptions

Option information for GHC

Constructors

ComponentOptions

Fields

• componentOptions :: [String]

  Command line options.

• componentDependencies :: [FilePath]

  Dependencies of a cradle that might change the cradle. Contains both files specified in hie.yaml as well as specified by the build-tool if there is any. FilePaths are expected to be relative to the cradleRootDir to which this CradleAction belongs to. Files returned by this action might not actually exist. This is useful, because, sometimes, adding specific files changes the options that a Cradle may return, thus, needs reload as soon as these files are created.

Instances

Eq ComponentOptions

Defined in HIE.Bios.Types

Methods

(==) :: ComponentOptions -> ComponentOptions -> Bool

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

Show ComponentOptions

Defined in HIE.Bios.Types

Methods

showsPrec :: Int -> ComponentOptions -> ShowS

show :: ComponentOptions -> String

showList :: [ComponentOptions] -> ShowS