hie-bios-0.1.1: Set up a GHC API session

Safe Haskell	None
Language	Haskell2010

HIE.Bios

Contents

Initialise a session
Load a module into a session
Eliminate a session to IO

Description

The HIE Bios

Synopsis

data Cradle = Cradle {
- cradleRootDir :: FilePath
- cradleOptsProg :: CradleAction
}
findCradle :: FilePath -> IO Cradle
defaultCradle :: FilePath -> Cradle
initializeFlagsWithCradle :: GhcMonad m => FilePath -> Cradle -> m ()
initializeFlagsWithCradleWithMessage :: GhcMonad m => Maybe Messager -> FilePath -> Cradle -> m ()
loadFile :: GhcMonad m => (FilePath, FilePath) -> m (Maybe TypecheckedModule, [TypecheckedModule])
loadFileWithMessage :: GhcMonad m => Maybe Messager -> (FilePath, FilePath) -> m (Maybe TypecheckedModule, [TypecheckedModule])
withGhcT :: (ExceptionMonad m, MonadIO m, Monad m) => GhcT m a -> m a

Initialise a session

data Cradle Source #

The environment where this library is used.

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 Source #
Instance details Defined in HIE.Bios.Types Methods showsPrec :: Int -> Cradle -> ShowS # show :: Cradle -> String # showList :: [Cradle] -> ShowS #

findCradle :: FilePath -> IO Cradle Source #

defaultCradle :: FilePath -> Cradle Source #

initializeFlagsWithCradle :: GhcMonad m => FilePath -> Cradle -> m () Source #

initializeFlagsWithCradleWithMessage :: GhcMonad m => Maybe Messager -> FilePath -> Cradle -> m () Source #

Initialize the DynFlags relating to the compilation of a single file or GHC session according to the Cradle and Options provided.

Load a module into a session

loadFile :: GhcMonad m => (FilePath, FilePath) -> m (Maybe TypecheckedModule, [TypecheckedModule]) Source #

loadFileWithMessage Source #

Arguments

:: GhcMonad m
=> Maybe Messager
-> (FilePath, FilePath)	A target file.
-> m (Maybe TypecheckedModule, [TypecheckedModule])

Obtaining type of a target expression. (GHCi's type:)

Eliminate a session to IO

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