Safe Haskell	None
Language	Haskell2010

Language.Haskell.Ghcid

Description

Library for spawning and working with Ghci sessions.

Synopsis

data Ghci
data GhciError = UnexpectedExit String String
data Stream
- = Stdout
- | Stderr
data Load
- = Loading {
  - loadModule :: String
  - loadFile :: FilePath
  }
- | Message {
  - loadSeverity :: Severity
  - loadFile :: FilePath
  - loadFilePos :: (Int, Int)
  - loadFilePosEnd :: (Int, Int)
  - loadMessage :: [String]
  }
- | LoadConfig {
  - loadFile :: FilePath
  }
data Severity
- = Warning
- | Error
startGhci :: String -> Maybe FilePath -> (Stream -> String -> IO ()) -> IO (Ghci, [Load])
startGhciProcess :: CreateProcess -> (Stream -> String -> IO ()) -> IO (Ghci, [Load])
stopGhci :: Ghci -> IO ()
interrupt :: Ghci -> IO ()
process :: Ghci -> ProcessHandle
execStream :: Ghci -> String -> (Stream -> String -> IO ()) -> IO ()
showModules :: Ghci -> IO [(String, FilePath)]
showPaths :: Ghci -> IO (FilePath, [FilePath])
reload :: Ghci -> IO [Load]
exec :: Ghci -> String -> IO [String]
quit :: Ghci -> IO ()

Documentation

data Ghci #

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.

Instances

Eq Ghci #
Instance details Defined in Language.Haskell.Ghcid Methods (==) :: Ghci -> Ghci -> Bool # (/=) :: Ghci -> Ghci -> Bool #

data GhciError #

GHCi shut down

Constructors

UnexpectedExit String String

Instances

Eq GhciError #
Instance details Defined in Language.Haskell.Ghcid.Types Methods (==) :: GhciError -> GhciError -> Bool # (/=) :: GhciError -> GhciError -> Bool #
Data GhciError #
Instance details Defined in Language.Haskell.Ghcid.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GhciError -> c GhciError # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GhciError # toConstr :: GhciError -> Constr # dataTypeOf :: GhciError -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GhciError) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GhciError) # gmapT :: (forall b. Data b => b -> b) -> GhciError -> GhciError # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GhciError -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GhciError -> r # gmapQ :: (forall d. Data d => d -> u) -> GhciError -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GhciError -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GhciError -> m GhciError # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GhciError -> m GhciError # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GhciError -> m GhciError #
Ord GhciError #
Instance details Defined in Language.Haskell.Ghcid.Types Methods compare :: GhciError -> GhciError -> Ordering # (<) :: GhciError -> GhciError -> Bool # (<=) :: GhciError -> GhciError -> Bool # (>) :: GhciError -> GhciError -> Bool # (>=) :: GhciError -> GhciError -> Bool # max :: GhciError -> GhciError -> GhciError # min :: GhciError -> GhciError -> GhciError #
Show GhciError #
Instance details Defined in Language.Haskell.Ghcid.Types Methods showsPrec :: Int -> GhciError -> ShowS # show :: GhciError -> String # showList :: [GhciError] -> ShowS #
Exception GhciError #	Make GhciError an exception
Instance details Defined in Language.Haskell.Ghcid.Types Methods toException :: GhciError -> SomeException # fromException :: SomeException -> Maybe GhciError # displayException :: GhciError -> String #

data Stream #

The stream Ghci is talking over.

Constructors

Stdout
Stderr

Instances

Bounded Stream #
Instance details Defined in Language.Haskell.Ghcid.Types Methods minBound :: Stream # maxBound :: Stream #
Enum Stream #
Instance details Defined in Language.Haskell.Ghcid.Types Methods succ :: Stream -> Stream # pred :: Stream -> Stream # toEnum :: Int -> Stream # fromEnum :: Stream -> Int # enumFrom :: Stream -> [Stream] # enumFromThen :: Stream -> Stream -> [Stream] # enumFromTo :: Stream -> Stream -> [Stream] # enumFromThenTo :: Stream -> Stream -> Stream -> [Stream] #
Eq Stream #
Instance details Defined in Language.Haskell.Ghcid.Types Methods (==) :: Stream -> Stream -> Bool # (/=) :: Stream -> Stream -> Bool #
Data Stream #
Instance details Defined in Language.Haskell.Ghcid.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Stream -> c Stream # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Stream # toConstr :: Stream -> Constr # dataTypeOf :: Stream -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Stream) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Stream) # gmapT :: (forall b. Data b => b -> b) -> Stream -> Stream # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Stream -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Stream -> r # gmapQ :: (forall d. Data d => d -> u) -> Stream -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Stream -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Stream -> m Stream # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Stream -> m Stream # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Stream -> m Stream #
Ord Stream #
Instance details Defined in Language.Haskell.Ghcid.Types Methods compare :: Stream -> Stream -> Ordering # (<) :: Stream -> Stream -> Bool # (<=) :: Stream -> Stream -> Bool # (>) :: Stream -> Stream -> Bool # (>=) :: Stream -> Stream -> Bool # max :: Stream -> Stream -> Stream # min :: Stream -> Stream -> Stream #
Read Stream #
Instance details Defined in Language.Haskell.Ghcid.Types Methods readsPrec :: Int -> ReadS Stream # readList :: ReadS [Stream] # readPrec :: ReadPrec Stream # readListPrec :: ReadPrec [Stream] #
Show Stream #
Instance details Defined in Language.Haskell.Ghcid.Types Methods showsPrec :: Int -> Stream -> ShowS # show :: Stream -> String # showList :: [Stream] -> ShowS #

data Load #

Load messages

Constructors

Loading	A module/file was being loaded.
Fields loadModule :: String The module that was being loaded, `Foo.Bar`. loadFile :: FilePath The file that was being loaded, `Foo/Bar.hs`.
Message	An error/warning was emitted.
Fields loadSeverity :: Severity The severity of the message, either `Warning` or `Error`. loadFile :: FilePath The file that was being loaded, `Foo/Bar.hs`. loadFilePos :: (Int, Int) The position in the file, `(line,col)`, both 1-based. Uses `(0,0)` for no position information. loadFilePosEnd :: (Int, Int) The end position in the file, `(line,col)`, both 1-based. If not present will be the same as `loadFilePos`. loadMessage :: [String] The message, split into separate lines, may contain ANSI Escape codes.
LoadConfig	A config file was loaded, usually a .ghci file (GHC 8.2 and above only)
Fields loadFile :: FilePath The file that was being loaded, `Foo/Bar.hs`.

Instances

Eq Load #
Instance details Defined in Language.Haskell.Ghcid.Types Methods (==) :: Load -> Load -> Bool # (/=) :: Load -> Load -> Bool #
Ord Load #
Instance details Defined in Language.Haskell.Ghcid.Types Methods compare :: Load -> Load -> Ordering # (<) :: Load -> Load -> Bool # (<=) :: Load -> Load -> Bool # (>) :: Load -> Load -> Bool # (>=) :: Load -> Load -> Bool # max :: Load -> Load -> Load # min :: Load -> Load -> Load #
Show Load #
Instance details Defined in Language.Haskell.Ghcid.Types Methods showsPrec :: Int -> Load -> ShowS # show :: Load -> String # showList :: [Load] -> ShowS #

data Severity #

Severity of messages

Constructors

Warning
Error

Instances

Bounded Severity #
Instance details Defined in Language.Haskell.Ghcid.Types Methods minBound :: Severity # maxBound :: Severity #
Enum Severity #
Instance details Defined in Language.Haskell.Ghcid.Types Methods succ :: Severity -> Severity # pred :: Severity -> Severity # toEnum :: Int -> Severity # fromEnum :: Severity -> Int # enumFrom :: Severity -> [Severity] # enumFromThen :: Severity -> Severity -> [Severity] # enumFromTo :: Severity -> Severity -> [Severity] # enumFromThenTo :: Severity -> Severity -> Severity -> [Severity] #
Eq Severity #
Instance details Defined in Language.Haskell.Ghcid.Types Methods (==) :: Severity -> Severity -> Bool # (/=) :: Severity -> Severity -> Bool #
Data Severity #
Instance details Defined in Language.Haskell.Ghcid.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Severity -> c Severity # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Severity # toConstr :: Severity -> Constr # dataTypeOf :: Severity -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Severity) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Severity) # gmapT :: (forall b. Data b => b -> b) -> Severity -> Severity # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Severity -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Severity -> r # gmapQ :: (forall d. Data d => d -> u) -> Severity -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Severity -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Severity -> m Severity # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Severity -> m Severity # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Severity -> m Severity #
Ord Severity #
Instance details Defined in Language.Haskell.Ghcid.Types Methods compare :: Severity -> Severity -> Ordering # (<) :: Severity -> Severity -> Bool # (<=) :: Severity -> Severity -> Bool # (>) :: Severity -> Severity -> Bool # (>=) :: Severity -> Severity -> Bool # max :: Severity -> Severity -> Severity # min :: Severity -> Severity -> Severity #
Read Severity #
Instance details Defined in Language.Haskell.Ghcid.Types Methods readsPrec :: Int -> ReadS Severity # readList :: ReadS [Severity] # readPrec :: ReadPrec Severity # readListPrec :: ReadPrec [Severity] #
Show Severity #
Instance details Defined in Language.Haskell.Ghcid.Types Methods showsPrec :: Int -> Severity -> ShowS # show :: Severity -> String # showList :: [Severity] -> ShowS #

startGhci #

Arguments

:: String	Shell command
-> Maybe FilePath	Working directory
-> (Stream -> String -> IO ())	Output callback
-> IO (Ghci, [Load])

Start GHCi by running the given shell command, a helper around startGhciProcess.

startGhciProcess :: CreateProcess -> (Stream -> String -> IO ()) -> IO (Ghci, [Load]) #

Start GHCi by running the described process, returning 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.

To create a CreateProcess use the functions in System.Process, particularly shell and proc.

Since: ghcid-0.6.11

stopGhci :: Ghci -> IO () #

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 () #

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

process :: Ghci -> ProcessHandle #

Obtain the progress handle behind a GHCi instance.

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

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

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

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

showPaths :: Ghci -> IO (FilePath, [FilePath]) #

Return the current working directory, and a list of module import paths

reload :: Ghci -> IO [Load] #

Perform a reload, list the messages that reload generated.

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

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

quit :: Ghci -> IO () #

Send :quit and wait for the process to quit.