Safe Haskell	None
Language	GHC2021

GHC.Debugger.Interface.Messages

Contents

Orphan instances

Description

Types for sending and receiving messages to/from haskell-debugger

Synopsis

newtype AbsFilePath = MkAbsFilePath {
- unAbs :: FilePath
}
mkAbsolute :: FilePath -> AbsFilePath
(/>) :: AbsFilePath -> FilePath -> AbsFilePath
data Command
- = SetBreakpoint {
  - brk :: Breakpoint
  - hitCount :: Maybe Int
  - condition :: Maybe String
  - logMessage :: Maybe String
  }
- | DelBreakpoint Breakpoint
- | GetBreakpointsAt Breakpoint
- | ClearModBreakpoints {
  - file :: AbsFilePath
  }
- | ClearFunctionBreakpoints
- | GetThreads
- | GetStacktrace RemoteThreadId
- | GetScopes RemoteThreadId Int
- | GetVariables RemoteThreadId Int VariableReference
- | DoEval String
- | GetExceptionInfo RemoteThreadId
- | DoContinue
- | DoStepLocal
- | DoSingleStep
- | DoStepOut
- | DebugExecution {
  - entryPoint :: EntryPoint
  - entryFile :: AbsFilePath
  - runArgs :: [String]
  }
data EntryPoint
- = MainEntry {
  - mainName :: Maybe String
  }
- | FunctionEntry {
  - fnName :: String
  }
data Breakpoint
- = ModuleBreak {
  - path :: AbsFilePath
  - lineNum :: Int
  - columnNum :: Maybe Int
  }
- | FunctionBreak {
  - function :: String
  }
- | OnExceptionsBreak
- | OnUncaughtExceptionsBreak
data ScopeInfo = ScopeInfo {
- kind :: ScopeVariablesReference
- sourceSpan :: SourceSpan
- numVars :: Maybe Int
- expensive :: Bool
}
newtype VarFields = VarFields [VarInfo]
data VarInfo = VarInfo {
- varName :: String
- varType :: String
- varValue :: String
- isThunk :: Bool
- varRef :: VariableReference
}
data VariableResult
- = ForcedVariable VarInfo
- | VariableFields [VarInfo]
variableResultToList :: VariableResult -> [VarInfo]
data BreakpointKind
- = ModuleBreakpointKind
- | FunctionBreakpointKind
data ScopeVariablesReference
- = LocalVariablesScope
- | ModuleVariablesScope
- | GlobalVariablesScope
data VariableReference
- = NoVariables
- | LocalVariables
- | ModuleVariables
- | GlobalVariables
- | SpecificVariable TermKey
scopeToVarRef :: ScopeVariablesReference -> VariableReference
data SourceSpan = SourceSpan {
- file :: !AbsFilePath
- startLine :: !Int
- endLine :: !Int
- startCol :: !Int
- endCol :: !Int
}
unhelpfulSourceSpan :: SourceSpan
srcLocToSourceSpan :: AbsFilePath -> SrcLoc -> SourceSpan
data Response
- = DidEval EvalResult
- | DidSetBreakpoint BreakFound
- | DidRemoveBreakpoint BreakFound
- | DidGetBreakpoints (Maybe SourceSpan)
- | DidClearBreakpoints
- | DidContinue EvalResult
- | DidStep EvalResult
- | DidExec EvalResult
- | GotThreads [DebuggeeThread]
- | GotStacktrace [DbgStackFrame]
- | GotScopes [ScopeInfo]
- | GotVariables VariableResult
- | GotExceptionInfo ExceptionInfo
- | Aborted String
- | NonFatalError String
- | Initialised
data BreakFound
- = BreakFound {
  - changed :: !Bool
  - breakId :: [InternalBreakpointId]
  - sourceSpan :: SourceSpan
  }
- | BreakFoundNoLoc {
  - changed :: Bool
  }
- | BreakNotFound
- | ManyBreaksFound [BreakFound]
newtype RemoteThreadId = RemoteThreadId {
- remoteThreadIntRef :: Int
}
data SourceKind
- = IsExpr
- | IsStmt
data EvalResult
- = EvalCompleted {
  - resultVal :: String
  - resultType :: String
  - resultSourceKind :: Maybe SourceKind
  - resultStructureRef :: VariableReference
  }
- | EvalException {
  - resultVal :: String
  - resultType :: String
  }
- | EvalStopped {
  - breakId :: Maybe InternalBreakpointId
  - breakThread :: RemoteThreadId
  }
- | EvalAbortedWith String
data DebuggeeThread = DebuggeeThread {
- tId :: !RemoteThreadId
- tName :: !(Maybe String)
}
data DbgStackFrameBCOArgs (ref :: Type -> Type) = DbgStackFrameBCOArgs {
- bcoArgs :: NoShow (ref [StackField])
- bcoArgsOffset :: Maybe Word
}
data DbgStackFrame = DbgStackFrame {
- name :: String
- sourceSpan :: SourceSpan
- breakId :: Maybe InternalBreakpointId
- args :: Maybe (DbgStackFrameBCOArgs ForeignRef)
}
data ExceptionInfo = ExceptionInfo {
- exceptionInfoTypeName :: String
- exceptionInfoFullTypeName :: String
- exceptionInfoMessage :: String
- exceptionInfoContext :: Maybe String
- exceptionInfoSourceSpan :: Maybe SourceSpan
- exceptionInfoInner :: [ExceptionInfo]
}
newtype NoShow a = NoShow a

Documentation

newtype AbsFilePath Source #

See Note [Paths should be made absolute at the source]

Constructors

MkAbsFilePath
Fields unAbs :: FilePath

Instances

Instances details

Eq AbsFilePath Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods (==) :: AbsFilePath -> AbsFilePath -> Bool # (/=) :: AbsFilePath -> AbsFilePath -> Bool #
Show AbsFilePath Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods showsPrec :: Int -> AbsFilePath -> ShowS # show :: AbsFilePath -> String # showList :: [AbsFilePath] -> ShowS #

mkAbsolute :: FilePath -> AbsFilePath Source #

(/>) :: AbsFilePath -> FilePath -> AbsFilePath Source #

data Command Source #

The commands sent to the debugger

Constructors

SetBreakpoint	Set a breakpoint on a given function, or module by line number
Fields brk :: Breakpoint hitCount :: Maybe Int Stop after N hits (if `isJust condition`, count down only when `eval condition == True`) condition :: Maybe String Stop if condition evalutes to True logMessage :: Maybe String Log only if `condition` (and `hitCondition` when supported) are `True`.
DelBreakpoint Breakpoint	Delete a breakpoint on a given function, or module by line number
GetBreakpointsAt Breakpoint	Find the valid breakpoints locations for the given module Breakpoint
ClearModBreakpoints	Clear all breakpoints in the specified file. This is useful because DAP's `setBreakpoints` re-sets all breakpoints from zero for a source rather than incrementally.
Fields file :: AbsFilePath
ClearFunctionBreakpoints	Clear all function breakpoints
GetThreads	Get all threads
GetStacktrace RemoteThreadId	Get the evaluation stacktrace until the current breakpoint.
GetScopes RemoteThreadId Int	Get the list of available scopes at the current breakpoint
GetVariables RemoteThreadId Int VariableReference	Get the variables in scope for the current breakpoint. Note: for GHCs <9.16 this only reports the variables free in the expression we're stopped at rather than all variables in scope.
DoEval String	Evaluate an expression at the current breakpoint.
GetExceptionInfo RemoteThreadId	Get information about the current exception (if any) on a thread.
DoContinue	Continue executing from the current breakpoint
DoStepLocal	Step local, which executes until next breakpoint in the same function.
DoSingleStep	Single step always to the next breakpoint. Used for "step-in".
DoStepOut	Step out to the breakpoint immediately following a return.
DebugExecution	Execute a prog with debugging enabled. Breaks on the existing breakpoints. Constructed with an entry point function name and the arguments to pass it. When the `EntryPoint` is `Main`, `runArgs` are set as process invocation arguments (as in `argv`) rather than passed directly as a Haskell function arguments.
Fields entryPoint :: EntryPoint entryFile :: AbsFilePath runArgs :: [String]

data EntryPoint Source #

An entry point for program execution.

Constructors

MainEntry
Fields mainName :: Maybe String
FunctionEntry
Fields fnName :: String

Instances

Instances details

Show EntryPoint Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods showsPrec :: Int -> EntryPoint -> ShowS # show :: EntryPoint -> String # showList :: [EntryPoint] -> ShowS #

data Breakpoint Source #

A breakpoint can be set/removed on functions by name, or in modules by line number. And, globally, for all exceptions, or just uncaught exceptions.

Constructors

ModuleBreak
Fields path :: AbsFilePath lineNum :: Int columnNum :: Maybe Int
FunctionBreak
Fields function :: String
OnExceptionsBreak
OnUncaughtExceptionsBreak

Instances

Instances details

Show Breakpoint Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods showsPrec :: Int -> Breakpoint -> ShowS # show :: Breakpoint -> String # showList :: [Breakpoint] -> ShowS #

data ScopeInfo Source #

Information about a scope

Constructors

ScopeInfo
Fields kind :: ScopeVariablesReference sourceSpan :: SourceSpan numVars :: Maybe Int expensive :: Bool

Instances

Instances details

Show ScopeInfo Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods showsPrec :: Int -> ScopeInfo -> ShowS # show :: ScopeInfo -> String # showList :: [ScopeInfo] -> ShowS #

newtype VarFields Source #

Constructors

VarFields [VarInfo]

data VarInfo Source #

Information about a variable

Constructors

VarInfo
Fields varName :: String varType :: String varValue :: String isThunk :: Bool varRef :: VariableReference A reference back to this variable

data VariableResult Source #

Result of requesting variables.

If the variable you requested is a thunk then ForcedVariable is returned, which is the variable you requested but forced.

If the variable you requested is not a thunk, then VariableFields is returned which contains the subfields of the variable.

Constructors

ForcedVariable VarInfo
VariableFields [VarInfo]

variableResultToList :: VariableResult -> [VarInfo] Source #

data BreakpointKind Source #

What kind of breakpoint are we referring to, module or function breakpoints? Used e.g. in the ClearBreakpoints request

Constructors

ModuleBreakpointKind	Module breakpoints
FunctionBreakpointKind	Function breakpoints

Instances

Instances details

Outputable BreakpointKind Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods ppr :: BreakpointKind -> SDoc #
Eq BreakpointKind Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods (==) :: BreakpointKind -> BreakpointKind -> Bool # (/=) :: BreakpointKind -> BreakpointKind -> Bool #
Show BreakpointKind Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods showsPrec :: Int -> BreakpointKind -> ShowS # show :: BreakpointKind -> String # showList :: [BreakpointKind] -> ShowS #

data ScopeVariablesReference Source #

Referring to existing scopes

Constructors

LocalVariablesScope
ModuleVariablesScope
GlobalVariablesScope

Instances

Instances details

Eq ScopeVariablesReference Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods (==) :: ScopeVariablesReference -> ScopeVariablesReference -> Bool # (/=) :: ScopeVariablesReference -> ScopeVariablesReference -> Bool #
Ord ScopeVariablesReference Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods compare :: ScopeVariablesReference -> ScopeVariablesReference -> Ordering # (<) :: ScopeVariablesReference -> ScopeVariablesReference -> Bool # (<=) :: ScopeVariablesReference -> ScopeVariablesReference -> Bool # (>) :: ScopeVariablesReference -> ScopeVariablesReference -> Bool # (>=) :: ScopeVariablesReference -> ScopeVariablesReference -> Bool # max :: ScopeVariablesReference -> ScopeVariablesReference -> ScopeVariablesReference # min :: ScopeVariablesReference -> ScopeVariablesReference -> ScopeVariablesReference #
Show ScopeVariablesReference Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods showsPrec :: Int -> ScopeVariablesReference -> ShowS # show :: ScopeVariablesReference -> String # showList :: [ScopeVariablesReference] -> ShowS #

data VariableReference Source #

The type of variables referenced, or a particular variable referenced for its fields or value (when inspecting a thunk)

Constructors

NoVariables	A void reference to nothing at all. Used e.g. for ty cons and data cons
LocalVariables	Variables in the local context (includes arguments, previous bindings)
ModuleVariables	Variables in the module where we're stopped
GlobalVariables	Variables in the global context
SpecificVariable TermKey	A reference to a specific variable. Used to force its result or get its structured children

scopeToVarRef :: ScopeVariablesReference -> VariableReference Source #

data SourceSpan Source #

A source span type for the interface. Like RealSrcSpan.

Constructors

SourceSpan
Fields file :: !AbsFilePath Path to file where this span is located. See Note [Paths should be made absolute at the source] startLine :: !Int RealSrcSpan start line endLine :: !Int RealSrcSpan end line startCol :: !Int RealSrcSpan start col endCol :: !Int RealSrcSpan end col

Instances

Instances details

Eq SourceSpan Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods (==) :: SourceSpan -> SourceSpan -> Bool # (/=) :: SourceSpan -> SourceSpan -> Bool #
Show SourceSpan Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods showsPrec :: Int -> SourceSpan -> ShowS # show :: SourceSpan -> String # showList :: [SourceSpan] -> ShowS #

unhelpfulSourceSpan :: SourceSpan Source #

This is a completely unhelpful source span! It doesn't point to anything and is of no help to the user whatsoever.

Use this only as a last resort if no other source span can be provided.

srcLocToSourceSpan :: AbsFilePath -> SrcLoc -> SourceSpan Source #

See Note [Paths should be made absolute at the source]

data Response Source #

The responses sent by `haskell-debugger` to the client

data BreakFound Source #

Constructors

BreakFound
Fields changed :: !Bool Did the status of the found breakpoint change? breakId :: [InternalBreakpointId] Internal breakpoint identifier (module + ix) (TODO: Don't expose GHC) sourceSpan :: SourceSpan Source span for interface
BreakFoundNoLoc	Breakpoint found but without location info. This happens when setting breakpoints on exceptions.
Fields changed :: Bool Did the status of the found breakpoint change?
BreakNotFound	No breakpoints found
ManyBreaksFound [BreakFound]	Found many breakpoints. Caused by setting breakpoint on a name with multiple matches or many equations.

Instances

Instances details

Show BreakFound Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods showsPrec :: Int -> BreakFound -> ShowS # show :: BreakFound -> String # showList :: [BreakFound] -> ShowS #

newtype RemoteThreadId Source #

A reference to a remote thread by remote id See getRemoteThreadId.

Constructors

RemoteThreadId
Fields remoteThreadIntRef :: Int The number identifier of the thread on the (remote) interpreter. To find the proper remote `ThreadId` corresponding to this numeric identifier, lookup the `remoteThreadIntRef` in the `ThreadMap`

Instances

Instances details

Binary RemoteThreadId Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods put :: RemoteThreadId -> Put # get :: Get RemoteThreadId # putList :: [RemoteThreadId] -> Put #
Eq RemoteThreadId Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods (==) :: RemoteThreadId -> RemoteThreadId -> Bool # (/=) :: RemoteThreadId -> RemoteThreadId -> Bool #
Ord RemoteThreadId Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods compare :: RemoteThreadId -> RemoteThreadId -> Ordering # (<) :: RemoteThreadId -> RemoteThreadId -> Bool # (<=) :: RemoteThreadId -> RemoteThreadId -> Bool # (>) :: RemoteThreadId -> RemoteThreadId -> Bool # (>=) :: RemoteThreadId -> RemoteThreadId -> Bool # max :: RemoteThreadId -> RemoteThreadId -> RemoteThreadId # min :: RemoteThreadId -> RemoteThreadId -> RemoteThreadId #
Show RemoteThreadId Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods showsPrec :: Int -> RemoteThreadId -> ShowS # show :: RemoteThreadId -> String # showList :: [RemoteThreadId] -> ShowS #

data SourceKind Source #

Constructors

IsExpr
IsStmt

data EvalResult Source #

Constructors

EvalCompleted
Fields resultVal :: String resultType :: String resultSourceKind :: Maybe SourceKind resultStructureRef :: VariableReference A structured representation of the result of evaluating the expression given as a "virtual" `VariableReference` that the user can use to refer to the result and inspect interactively and expand it.
EvalException
Fields resultVal :: String resultType :: String
EvalStopped
Fields breakId :: Maybe InternalBreakpointId Did we stop at an exception (`Nothing`) or at a breakpoint (`Just`)? breakThread :: RemoteThreadId In which thread did we hit the breakpoint?
EvalAbortedWith String	Evaluation failed for some reason other than completedcompleted-with-exceptionstopped.

data DebuggeeThread Source #

Constructors

DebuggeeThread
Fields tId :: !RemoteThreadId An identifier for a thread on the (possibly remote) debuggee process tName :: !(Maybe String) Thread label, if there is one

Instances

Instances details

Show DebuggeeThread Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods showsPrec :: Int -> DebuggeeThread -> ShowS # show :: DebuggeeThread -> String # showList :: [DebuggeeThread] -> ShowS #

data DbgStackFrameBCOArgs (ref :: Type -> Type) Source #

Constructors

DbgStackFrameBCOArgs
Fields bcoArgs :: NoShow (ref [StackField]) payload of the frame, c.f. `Heap.RetBCO`. bcoArgsOffset :: Maybe Word offset of bcoArgs in an hypotethical AP_STACK closure, see Note [Ask the RTS for memory layout of AP_STACK].

Instances

Instances details

Generic (DbgStackFrameBCOArgs ref) Source #

Instance details

Defined in GHC.Debugger.Interface.Messages

Associated Types

type Rep (DbgStackFrameBCOArgs ref)

Instance details

Defined in GHC.Debugger.Interface.Messages

type Rep (DbgStackFrameBCOArgs ref) = D1 ('MetaData "DbgStackFrameBCOArgs" "GHC.Debugger.Interface.Messages" "haskell-debugger-0.13.2.0-inplace" 'False) (C1 ('MetaCons "DbgStackFrameBCOArgs" 'PrefixI 'True) (S1 ('MetaSel ('Just "bcoArgs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NoShow (ref [StackField]))) :*: S1 ('MetaSel ('Just "bcoArgsOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Word))))

Methods

from :: DbgStackFrameBCOArgs ref -> Rep (DbgStackFrameBCOArgs ref) x #

to :: Rep (DbgStackFrameBCOArgs ref) x -> DbgStackFrameBCOArgs ref #

Show (DbgStackFrameBCOArgs ref) Source #

Instance details

Defined in GHC.Debugger.Interface.Messages

Methods

showsPrec :: Int -> DbgStackFrameBCOArgs ref -> ShowS #

show :: DbgStackFrameBCOArgs ref -> String #

showList :: [DbgStackFrameBCOArgs ref] -> ShowS #

type Rep (DbgStackFrameBCOArgs ref) Source #

Instance details

Defined in GHC.Debugger.Interface.Messages

type Rep (DbgStackFrameBCOArgs ref) = D1 ('MetaData "DbgStackFrameBCOArgs" "GHC.Debugger.Interface.Messages" "haskell-debugger-0.13.2.0-inplace" 'False) (C1 ('MetaCons "DbgStackFrameBCOArgs" 'PrefixI 'True) (S1 ('MetaSel ('Just "bcoArgs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NoShow (ref [StackField]))) :*: S1 ('MetaSel ('Just "bcoArgsOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Word))))

data DbgStackFrame Source #

Constructors

DbgStackFrame
Fields name :: String Title of stack frame sourceSpan :: SourceSpan Source span for this stack frame breakId :: Maybe InternalBreakpointId Is this a BCO continuation frame with a breakpoint? If yes, we can leverage the breakpoint info to report scopes. args :: Maybe (DbgStackFrameBCOArgs ForeignRef)

Instances

Instances details

Show DbgStackFrame Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods showsPrec :: Int -> DbgStackFrame -> ShowS # show :: DbgStackFrame -> String # showList :: [DbgStackFrame] -> ShowS #

data ExceptionInfo Source #

Constructors

ExceptionInfo
Fields exceptionInfoTypeName :: String exceptionInfoFullTypeName :: String exceptionInfoMessage :: String exceptionInfoContext :: Maybe String exceptionInfoSourceSpan :: Maybe SourceSpan exceptionInfoInner :: [ExceptionInfo]

Instances

Instances details

Show ExceptionInfo Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods showsPrec :: Int -> ExceptionInfo -> ShowS # show :: ExceptionInfo -> String # showList :: [ExceptionInfo] -> ShowS #

newtype NoShow a Source #

Constructors

NoShow a

Instances

Instances details

Show (NoShow a) Source #
Instance details Defined in GHC.Debugger.Interface.Messages Methods showsPrec :: Int -> NoShow a -> ShowS # show :: NoShow a -> String # showList :: [NoShow a] -> ShowS #

Orphan instances

Show InternalBreakpointId Source #
Instance details Methods showsPrec :: Int -> InternalBreakpointId -> ShowS # show :: InternalBreakpointId -> String # showList :: [InternalBreakpointId] -> ShowS #

DidEval EvalResult
DidSetBreakpoint BreakFound
DidRemoveBreakpoint BreakFound
DidGetBreakpoints (Maybe SourceSpan)
DidClearBreakpoints
DidContinue EvalResult
DidStep EvalResult
DidExec EvalResult
GotThreads [DebuggeeThread]
GotStacktrace [DbgStackFrame]
GotScopes [ScopeInfo]
GotVariables VariableResult
GotExceptionInfo ExceptionInfo
Aborted String
NonFatalError String
Initialised