HIE.Bios.Ghc.Api

These functions are for conveniently implementing the simple CLI

Documentation

initializeFlagsWithCradle

Arguments

:: GhcMonad m

=> FilePath

The file we are loading the Cradle because of

-> Cradle a

The cradle we want to load

-> m (CradleLoadResult (m SuccessFlag, ComponentOptions))

Initialize a GHC session by loading a given file into a given cradle.

initializeFlagsWithCradleWithMessage

Arguments

:: GhcMonad m

=> Maybe Messager

-> FilePath

The file we are loading the Cradle because of

-> Cradle a

The cradle we want to load

-> m (CradleLoadResult (m SuccessFlag, ComponentOptions))

Whether we actually loaded the cradle or not.

The same as initializeFlagsWithCradle but with an additional argument to control how the loading progress messages are displayed to the user. In haskell-ide-engine the module loading progress is displayed in the UI by using a progress notification.

data SuccessFlag

Constructors

Succeeded

Failed

Instances

Outputable SuccessFlag

Defined in GHC.Types.Basic

Methods

ppr :: SuccessFlag -> SDoc

withDynFlags :: GhcMonad m => (DynFlags -> DynFlags) -> m a -> m a

initSessionWithMessage :: GhcMonad m => Maybe Messager -> ComponentOptions -> (m SuccessFlag, ComponentOptions)

Actually perform the initialisation of the session. Initialising the session corresponds to parsing the command line flags, setting the targets for the session and then attempting to load all the targets.