Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Haskell.Ghcid

Description

Library for spawning and working with Ghci sessions.

Synopsis

data Ghci
data GhciError = UnexpectedExit {
- ghciErrorCmd :: String
- ghciErrorMsg :: String
- ghciErrorLastStdErr :: Maybe 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
  }
- | Eval EvalResult
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 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.

Instances

Instances details

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

data GhciError Source #

GHCi shut down

Constructors

UnexpectedExit
Fields ghciErrorCmd :: String ghciErrorMsg :: String ghciErrorLastStdErr :: Maybe String

Instances

Instances details

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

data Stream Source #

The stream Ghci is talking over.

Constructors

Stdout
Stderr

Instances

Instances details

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

data Load Source #

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`.
Eval EvalResult	A response to an eval comment

Instances

Instances details

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

data Severity Source #

Severity of messages

Constructors

Warning
Error

Instances

Instances details

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

startGhci Source #

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]) Source #

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: 0.6.11

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.

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

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

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.