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 BasicTypes

Methods

ppr :: SuccessFlag -> SDoc

pprPrec :: Rational -> SuccessFlag -> SDoc

Utility functions for running the GHC monad and implementing internal utilities

withGHC

Arguments

:: FilePath

A target file displayed in an error message.

-> Ghc a

Ghc actions created by the Ghc utilities.

-> IO a

Converting the Ghc monad to the IO monad. All exceptions are ignored and logged.

withGHC' :: Ghc a -> IO a

Run a Ghc monad computation with an automatically discovered libdir. It calculates the lib dir by calling ghc with the `--print-libdir` flag.

withGhcT :: (ExceptionMonad m, MonadIO m, Monad m) => GhcT m a -> m a

getSystemLibDir :: IO (Maybe FilePath)

Obtain the directory for system libraries.

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