Copyright	(c) Alice Rixte 2024
License	BSD 3
Maintainer	alice.rixte@u-bordeaux.fr
Stability	unstable
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

System.Process.Ghci

Description

Run GHCi as a process, and execute commands.

Usage

>>> ghci <- startGhci Quiet "ghci" []
>>> execGhciCmd ghci Quiet "1+2"
GhciResult {ghciErr = "", ghciOut = "3"}

Synopsis

data Ghci = Ghci {
- ghciIn :: Handle
- ghciErrVar :: TMVar String
- ghciOutVar :: TMVar String
- ghciProcess :: ProcessHandle
- ghciErrId :: ThreadId
- ghciOutId :: ThreadId
}
startGhci :: Verbosity -> String -> [String] -> IO Ghci
data GhciResult = GhciResult {
- ghciErr :: Text
- ghciOut :: Text
}
execGhciCmd :: Ghci -> Verbosity -> String -> IO GhciResult

Documentation

data Ghci Source #

A GHCi process

Constructors

Ghci
Fields ghciIn :: Handle Standard input ghciErrVar :: TMVar String Current line on stderr ghciOutVar :: TMVar String Current line on stdout ghciProcess :: ProcessHandle Process handle ghciErrId :: ThreadId Stderr listener thread ghciOutId :: ThreadId Stdout listener thread

startGhci Source #

Arguments

:: Verbosity	When `verbosity >= Normal`, the entire output of GHCi is printed
-> String	The command to run (e.g. "ghci", "cabal" or "stack")
-> [String]	The list of the command's arguments (e.g. "repl" for "cabal" or "ghci" for "stack")
-> IO Ghci

Start a GHCi process.

>>> ghci = startGhci Normal "ghci" []

>>> ghci = startGhci Loud "stack" ["ghci"]

data GhciResult Source #

The result printed by GHCi.

Constructors

GhciResult
Fields ghciErr :: Text ghciOut :: Text

Instances

Instances details

FromJSON GhciResult Source #

Instance details

Defined in System.Process.Ghci

Methods

parseJSON :: Value -> Parser GhciResult #

parseJSONList :: Value -> Parser [GhciResult] #

omittedField :: Maybe GhciResult #

ToJSON GhciResult Source #

Instance details

Defined in System.Process.Ghci

Methods

toJSON :: GhciResult -> Value #

toEncoding :: GhciResult -> Encoding #

toJSONList :: [GhciResult] -> Value #

toEncodingList :: [GhciResult] -> Encoding #

omitField :: GhciResult -> Bool #

Monoid GhciResult Source #

Instance details

Defined in System.Process.Ghci

Methods

mempty :: GhciResult #

mappend :: GhciResult -> GhciResult -> GhciResult #

mconcat :: [GhciResult] -> GhciResult #

Semigroup GhciResult Source #

Instance details

Defined in System.Process.Ghci

Methods

(<>) :: GhciResult -> GhciResult -> GhciResult #

sconcat :: NonEmpty GhciResult -> GhciResult #

stimes :: Integral b => b -> GhciResult -> GhciResult #

Generic GhciResult Source #

Instance details

Defined in System.Process.Ghci

Associated Types

type Rep GhciResult

Instance details

Defined in System.Process.Ghci

type Rep GhciResult = D1 ('MetaData "GhciResult" "System.Process.Ghci" "ghci4luatex-0.0-Jv5SPIpPTHrKSXMY8q8YbO" 'False) (C1 ('MetaCons "GhciResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "ghciErr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "ghciOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: GhciResult -> Rep GhciResult x #

to :: Rep GhciResult x -> GhciResult #

Show GhciResult Source #

Instance details

Defined in System.Process.Ghci

Methods

showsPrec :: Int -> GhciResult -> ShowS #

show :: GhciResult -> String #

showList :: [GhciResult] -> ShowS #

type Rep GhciResult Source #

Instance details

Defined in System.Process.Ghci

type Rep GhciResult = D1 ('MetaData "GhciResult" "System.Process.Ghci" "ghci4luatex-0.0-Jv5SPIpPTHrKSXMY8q8YbO" 'False) (C1 ('MetaCons "GhciResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "ghciErr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "ghciOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

execGhciCmd Source #

Arguments

:: Ghci	A GHCi process
-> Verbosity	When `verbosity >= Normal`, the entire output of GHCi is printed
-> String	The command to execute
-> IO GhciResult	The result of the execution

Sends a command to ghci and wait for its result.

>>> execGhciCmd ghci Normal "1+2"
GhciResult {ghciErr = "", ghciOut = "3"}