Safe Haskell	None
Language	Haskell2010

Language.Haskell.Ghcid

Description

Library for spawning and working with Ghci sessions.

Synopsis

Documentation

data Ghci Source

A GHCi session. Created with startGhci, closed with stopGhci.

The interactions with a Ghci session must all occur single-threaded, or an error will be raised. The only exception is interrupt, which aborts a running computation, or does nothing if no computation is running.

data GhciError Source

GHCi shut down

Constructors

UnexpectedExit String String

Instances

Eq GhciError Source
Data GhciError Source
Ord GhciError Source
Show GhciError Source
Exception GhciError Source	Make GhciError an exception

data Stream Source

The stream Ghci is talking over.

Constructors

Stdout
Stderr

Instances

Bounded Stream Source
Enum Stream Source
Eq Stream Source
Data Stream Source
Ord Stream Source
Read Stream Source
Show Stream Source

data Load Source

Load messages

Constructors

Loading
Fields loadModule :: String loadFile :: FilePath
Message
Fields loadSeverity :: Severity loadFile :: FilePath loadFilePos :: (Int, Int) loadMessage :: [String]

Instances

Eq Load Source
Ord Load Source
Show Load Source

data Severity Source

Severity of messages

Constructors

Warning
Error

Instances

Bounded Severity Source
Enum Severity Source
Eq Severity Source
Data Severity Source
Ord Severity Source
Read Severity Source
Show Severity Source

startGhci :: String -> Maybe FilePath -> (Stream -> String -> IO ()) -> IO (Ghci, [Load]) Source

Start GHCi, returning a function to perform further operation, as well as the result of the initial loading. If you do not call stopGhci then the underlying process may be leaked. The callback will be given the messages produced while loading, useful if invoking something like "cabal repl" which might compile dependent packages before really loading.

stopGhci :: Ghci -> IO () Source

Stop GHCi. Attempts to interrupt and execute :quit:, but if that doesn't complete within 5 seconds it just terminates the process.

interrupt :: Ghci -> IO () Source

Interrupt Ghci, stopping the current computation (if any), but leaving the process open to new input.

process :: Ghci -> ProcessHandle Source

Obtain the progress handle behind a GHCi instance.

execStream :: Ghci -> String -> (Stream -> String -> IO ()) -> IO () Source

Execute a command, calling a callback on each response. The callback will be called single threaded.

showModules :: Ghci -> IO [(String, FilePath)] Source

List the modules currently loaded, with module name and source file.

reload :: Ghci -> IO [Load] Source

Perform a reload, list the messages that reload generated.

exec :: Ghci -> String -> IO [String] Source

Send a command, get lines of result. Must be called single-threaded.

quit :: Ghci -> IO () Source

Send :quit and wait for the process to quit.