Ghcitui.Ghcid.Daemon

The interpreter state

data InterpState a

Instances

Show (InterpState a)

Defined in Ghcitui.Ghcid.Daemon

Methods

showsPrec :: Int -> InterpState a -> ShowS

show :: InterpState a -> String

showList :: [InterpState a] -> ShowS

emptyInterpreterState :: Monoid a => Ghci -> StartupConfig -> InterpState a

Create an empty/starting interpreter state. Usually you don't want to call this directly. Instead use startup.

Startup and shutdown

startup

Arguments

:: String

Command to run (e.g. "ghci" or "cabal repl")

-> FilePath

Working directory to run the start up command in.

-> StartupConfig

Where do we put the logging?

-> DaemonIO (InterpState ())

The newly created interpreter handle.

Start up the GHCi Daemon.

data StartupConfig

Configuration passed during Daemon startup

Constructors

StartupConfig

Fields

• logLevel :: !LogLevel

  How much do we want to log?

• logOutput :: !LogOutput

  Where do we log?

quit :: InterpState a -> IO (InterpState a)

Shut down the GHCi Daemon.

Base operations with the daemon

exec :: Monoid a => Text -> InterpState a -> ExceptT DaemonError IO (InterpState a, [Text])

Execute an arbitrary command, as if it was directly written in GHCi. It is unlikely you want to call this directly, and instead want to call one of the wrapped functions or execMuted or execCleaned.

execCleaned :: Monoid a => Text -> InterpState a -> ExceptT DaemonError IO (InterpState a, [Text])

exec, but fully clean the message from prompt.

execMuted :: Monoid a => Text -> InterpState a -> ExceptT DaemonError IO (InterpState a)

exec, but throw out any messages.

Wrapped operations with the daemon

step :: Monoid a => InterpState a -> ExceptT DaemonError IO (InterpState a)

Analogue to :step.

stepInto

Arguments

:: Monoid a

=> Text

-> InterpState a

Function name to jump to.

-> ExceptT DaemonError IO (InterpState a)

New interpreter state.

Analogue to :step func.

load :: Monoid a => FilePath -> InterpState a -> DaemonIO (InterpState a)

Analogue to :load filepath. Throws out any messages.

continue :: Monoid a => InterpState a -> DaemonIO (InterpState a)

Analogue to :continue. Throws out any messages.

Breakpoints

getBpInCurModule :: InterpState a -> [Int]

Return a list of breakpoint line numbers in the currently paused file.

getBpInFile :: FilePath -> InterpState a -> [Int]

Return a list of breakpoint line numbers in the given filepath.

toggleBreakpointLine :: Monoid a => BreakpointArg -> InterpState a -> DaemonIO (InterpState a)

Toggle a breakpoint (disable/enable) at a given location.

setBreakpointLine :: Monoid a => BreakpointArg -> InterpState a -> DaemonIO (InterpState a)

Set a breakpoint at a given line.

deleteBreakpointLine :: Monoid a => BreakpointArg -> InterpState a -> DaemonIO (InterpState a)

Delete a breakpoint at a given line.

Tracing

trace :: Monoid a => InterpState a -> DaemonIO (InterpState a)

Analogue to :trace, with no arguments. Throws out any messages.

history :: InterpState a -> DaemonIO (InterpState a, Either Text [Text])

Analogue to :history. Returns either a Left error message, or a Right list of trace breakpoints.

Tab completion

tabComplete

Arguments

:: Monoid a

=> Text

Text (prefix) to return autocompletions of. Does not need to be escaped.

-> InterpState a

Interpreter state to use.

-> DaemonIO (InterpState a, (Text, [Text]))

Resulting state, the prefix, and autocompletions.

Return tab completions for a given prefix. Analog to :complete repl "prefix" See https://downloads.haskell.org/ghc/latest/docs/users_guide/ghci.html#ghci-cmd-:complete

Misc

isExecuting :: InterpState a -> Bool

Is the daemon currently in the middle of an expression evaluation?

data BreakpointArg

Location info passed to breakpoint functions.

Constructors

LocalLine !Int

Location in the current file.

ModLoc !ModuleLoc

Location in a module.

Instances

Show BreakpointArg

Defined in Ghcitui.Ghcid.Daemon

Methods

showsPrec :: Int -> BreakpointArg -> ShowS

show :: BreakpointArg -> String

showList :: [BreakpointArg] -> ShowS

Eq BreakpointArg

Defined in Ghcitui.Ghcid.Daemon

Methods

(==) :: BreakpointArg -> BreakpointArg -> Bool

(/=) :: BreakpointArg -> BreakpointArg -> Bool

Ord BreakpointArg

Defined in Ghcitui.Ghcid.Daemon

Methods

compare :: BreakpointArg -> BreakpointArg -> Ordering

(<) :: BreakpointArg -> BreakpointArg -> Bool

(<=) :: BreakpointArg -> BreakpointArg -> Bool

(>) :: BreakpointArg -> BreakpointArg -> Bool

(>=) :: BreakpointArg -> BreakpointArg -> Bool

max :: BreakpointArg -> BreakpointArg -> BreakpointArg

min :: BreakpointArg -> BreakpointArg -> BreakpointArg

run :: DaemonIO r -> IO (Either DaemonError r)

Convert Daemon operation to an IO operation.

type DaemonIO r = ExceptT DaemonError IO r

An IO operation that can fail into a DaemonError. Execute them to IO through run.

data DaemonError

Instances

Show DaemonError

Defined in Ghcitui.Ghcid.Daemon

Methods

showsPrec :: Int -> DaemonError -> ShowS

show :: DaemonError -> String

showList :: [DaemonError] -> ShowS

Eq DaemonError

Defined in Ghcitui.Ghcid.Daemon

Methods

(==) :: DaemonError -> DaemonError -> Bool

(/=) :: DaemonError -> DaemonError -> Bool

data LogOutput

Determines where the daemon logs are written.

Constructors

LogOutputStdOut

LogOutputStdErr

LogOutputFile !FilePath

Instances

Show LogOutput

Defined in Ghcitui.Ghcid.LogConfig

Methods

showsPrec :: Int -> LogOutput -> ShowS

show :: LogOutput -> String

showList :: [LogOutput] -> ShowS