Safe Haskell	None
Language	GHC2021

GHC.Runtime.Eval

Synopsis

data Resume = Resume {
- resumeStmt :: String
- resumeContext :: ForeignRef (ResumeContext [HValueRef])
- resumeBindings :: ResumeBindings
- resumeFinalIds :: [Id]
- resumeApStack :: ForeignHValue
- resumeBreakpointId :: Maybe InternalBreakpointId
- resumeSpan :: SrcSpan
- resumeDecl :: String
- resumeCCS :: RemotePtr CostCentreStack
- resumeHistory :: [History]
- resumeHistoryIx :: Int
}
data History = History {
- historyApStack :: ForeignHValue
- historyBreakpointId :: InternalBreakpointId
- historyEnclosingDecls :: [String]
}
execStmt :: GhcMonad m => String -> ExecOptions -> m ExecResult
execStmt' :: GhcMonad m => GhciLStmt GhcPs -> String -> ExecOptions -> m ExecResult
data ExecOptions = ExecOptions {
- execSingleStep :: SingleStep
- execSourceFile :: String
- execLineNumber :: Int
- execWrap :: ForeignHValue -> EvalExpr ForeignHValue
}
execOptions :: ExecOptions
data ExecResult
- = ExecComplete {
  - execResult :: Either SomeException [Name]
  - execAllocation :: Word64
  }
- | ExecBreak {
  - breakNames :: [Name]
  - breakPointId :: Maybe InternalBreakpointId
  }
resumeExec :: GhcMonad m => SingleStep -> Maybe Int -> m ExecResult
runDecls :: GhcMonad m => String -> m [Name]
runDeclsWithLocation :: GhcMonad m => String -> Int -> String -> m [Name]
runParsedDecls :: GhcMonad m => [LHsDecl GhcPs] -> m [Name]
parseImportDecl :: GhcMonad m => String -> m (ImportDecl GhcPs)
data SingleStep
- = RunToCompletion
- | RunAndLogSteps
- | SingleStep
- | StepOut {
  - initiatedFrom :: Maybe SrcSpan
  }
- | LocalStep {
  - breakAt :: SrcSpan
  }
- | ModuleStep {
  - breakAt :: SrcSpan
  }
abandon :: GhcMonad m => m Bool
abandonAll :: GhcMonad m => m Bool
getResumeContext :: GhcMonad m => m [Resume]
getHistorySpan :: HomeUnitGraph -> History -> IO SrcSpan
getModBreaks :: HomeModInfo -> Maybe InternalModBreaks
readIModBreaks :: HomeUnitGraph -> InternalBreakpointId -> IO InternalModBreaks
readIModModBreaks :: HomeUnitGraph -> Module -> IO ModBreaks
getHistoryModule :: HomeUnitGraph -> History -> IO Module
setupBreakpoint :: GhcMonad m => Interp -> InternalBreakpointId -> Int -> m ()
back :: GhcMonad m => Int -> m ([Name], Int, SrcSpan)
forward :: GhcMonad m => Int -> m ([Name], Int, SrcSpan)
setContext :: GhcMonad m => [InteractiveImport] -> m ()
getContext :: GhcMonad m => m [InteractiveImport]
mkTopLevEnv :: HscEnv -> Module -> IO (Either String GlobalRdrEnv)
mkTopLevImportedEnv :: HscEnv -> HomeModInfo -> IO GlobalRdrEnv
getNamesInScope :: GhcMonad m => m [Name]
getRdrNamesInScope :: GhcMonad m => m [RdrName]
moduleIsInterpreted :: GhcMonad m => Module -> m Bool
getInfo :: GhcMonad m => Bool -> Name -> m (Maybe (TyThing, Fixity, [ClsInst], [FamInst], SDoc))
exprType :: GhcMonad m => TcRnExprMode -> String -> m Type
typeKind :: GhcMonad m => Bool -> String -> m (Type, Kind)
parseName :: GhcMonad m => String -> m (NonEmpty Name)
parseInstanceHead :: GhcMonad m => String -> m Type
getInstancesForType :: GhcMonad m => Type -> m [ClsInst]
getDocs :: GhcMonad m => Name -> m (Either GetDocsFailure (Maybe [HsDoc GhcRn], IntMap (HsDoc GhcRn)))
data GetDocsFailure
- = NameHasNoModule Name
- | NoDocsInIface Module Bool
- | InteractiveName
showModule :: GhcMonad m => ModuleNodeInfo -> m String
moduleIsBootOrNotObjectLinkable :: GhcMonad m => Module -> m Bool
parseExpr :: GhcMonad m => String -> m (LHsExpr GhcPs)
compileParsedExpr :: GhcMonad m => LHsExpr GhcPs -> m HValue
compileExpr :: GhcMonad m => String -> m HValue
dynCompileExpr :: GhcMonad m => String -> m Dynamic
compileExprRemote :: GhcMonad m => String -> m ForeignHValue
compileParsedExprRemote :: GhcMonad m => LHsExpr GhcPs -> m ForeignHValue
data Term
- = Term {
  - ty :: RttiType
  - dc :: Either String DataCon
  - val :: ForeignHValue
  - subTerms :: [Term]
  }
- | Prim {
  - ty :: RttiType
  - valRaw :: [Word]
  }
- | Suspension {
  - ctype :: ClosureType
  - ty :: RttiType
  - val :: ForeignHValue
  - bound_to :: Maybe Name
  - infoprov :: Maybe InfoProv
  }
- | NewtypeWrap {
  - ty :: RttiType
  - dc :: Either String DataCon
  - wrapped_term :: Term
  }
- | RefWrap {
  - ty :: RttiType
  - wrapped_term :: Term
  }
obtainTermFromId :: HscEnv -> Int -> Bool -> Id -> IO Term
obtainTermFromVal :: HscEnv -> Int -> Bool -> Type -> a -> IO Term
reconstructType :: HscEnv -> Int -> Id -> IO (Maybe Type)

Documentation

data Resume Source #

Constructors

Resume

Fields

resumeStmt :: String
resumeContext :: ForeignRef (ResumeContext [HValueRef])
resumeBindings :: ResumeBindings
resumeFinalIds :: [Id]
resumeApStack :: ForeignHValue
resumeBreakpointId :: Maybe InternalBreakpointId
the internal breakpoint we stopped at (Nothing = exception)
resumeSpan :: SrcSpan
resumeDecl :: String
resumeCCS :: RemotePtr CostCentreStack
resumeHistory :: [History]
resumeHistoryIx :: Int

data History Source #

Constructors

History
Fields historyApStack :: ForeignHValue historyBreakpointId :: InternalBreakpointId breakpoint identifier historyEnclosingDecls :: [String] declarations enclosing the breakpoint

execStmt Source #

Arguments

:: GhcMonad m
=> String	a statement (bind or expression)
-> ExecOptions
-> m ExecResult

Run a statement in the current interactive context.

execStmt' :: GhcMonad m => GhciLStmt GhcPs -> String -> ExecOptions -> m ExecResult Source #

Like execStmt, but takes a parsed statement as argument. Useful when doing preprocessing on the AST before execution, e.g. in GHCi (see GHCi.UI.runStmt).

data ExecOptions Source #

Constructors

ExecOptions
Fields execSingleStep :: SingleStep stepping mode execSourceFile :: String filename (for errors) execLineNumber :: Int line number (for errors) execWrap :: ForeignHValue -> EvalExpr ForeignHValue

execOptions :: ExecOptions Source #

default ExecOptions

data ExecResult Source #

Constructors

ExecComplete	Execution is complete with either an exception or the list of user-visible names that were brought into scope.
Fields execResult :: Either SomeException [Name] execAllocation :: Word64
ExecBreak	Execution stopped at a breakpoint. Note: `ExecBreak` is only returned by `handleRunStatus` when GHCi should definitely stop at this breakpoint. GHCi is not responsible for subsequently deciding whether to really stop here. `ExecBreak` always means GHCi breaks.
Fields breakNames :: [Name] breakPointId :: Maybe InternalBreakpointId

resumeExec :: GhcMonad m => SingleStep -> Maybe Int -> m ExecResult Source #

runDecls :: GhcMonad m => String -> m [Name] Source #

runDeclsWithLocation :: GhcMonad m => String -> Int -> String -> m [Name] Source #

Run some declarations and return any user-visible names that were brought into scope.

runParsedDecls :: GhcMonad m => [LHsDecl GhcPs] -> m [Name] Source #

Like runDeclsWithLocation, but takes parsed declarations as argument. Useful when doing preprocessing on the AST before execution, e.g. in GHCi (see GHCi.UI.runStmt).

parseImportDecl :: GhcMonad m => String -> m (ImportDecl GhcPs) Source #

data SingleStep Source #

What kind of stepping are we doing?

Constructors

RunToCompletion
RunAndLogSteps	:trace [expr]
SingleStep	:step [expr]
StepOut	:stepout
Fields initiatedFrom :: Maybe SrcSpan Step-out locations are filtered to make sure we don't stop at a continuation that is within the function from which step-out was initiated. See Note [Debugger: Step-out]
LocalStep	:steplocal [expr]
Fields breakAt :: SrcSpan
ModuleStep	:stepmodule [expr]
Fields breakAt :: SrcSpan

abandon :: GhcMonad m => m Bool Source #

abandonAll :: GhcMonad m => m Bool Source #

getResumeContext :: GhcMonad m => m [Resume] Source #

getHistorySpan :: HomeUnitGraph -> History -> IO SrcSpan Source #

getModBreaks :: HomeModInfo -> Maybe InternalModBreaks Source #

Get the breakpoint information from the ByteCode object associated to this HomeModInfo.

readIModBreaks :: HomeUnitGraph -> InternalBreakpointId -> IO InternalModBreaks Source #

Read the InternalModBreaks of the given home Module (via InternalBreakpointId) from the HomeUnitGraph.

readIModModBreaks :: HomeUnitGraph -> Module -> IO ModBreaks Source #

Read the ModBreaks from the given module's InternalModBreaks

getHistoryModule :: HomeUnitGraph -> History -> IO Module Source #

setupBreakpoint :: GhcMonad m => Interp -> InternalBreakpointId -> Int -> m () Source #

back :: GhcMonad m => Int -> m ([Name], Int, SrcSpan) Source #

forward :: GhcMonad m => Int -> m ([Name], Int, SrcSpan) Source #

setContext :: GhcMonad m => [InteractiveImport] -> m () Source #

Set the interactive evaluation context.

(setContext imports) sets the ic_imports field (which in turn determines what is in scope at the prompt) to imports, and updates the icReaderEnv environment to reflect it.

We retain in scope all the things defined at the prompt, and kept in ic_tythings. (Indeed, they shadow stuff from ic_imports.)

getContext :: GhcMonad m => m [InteractiveImport] Source #

Get the interactive evaluation context, consisting of a pair of the set of modules from which we take the full top-level scope, and the set of modules from which we take just the exports respectively.

mkTopLevEnv :: HscEnv -> Module -> IO (Either String GlobalRdrEnv) Source #

mkTopLevImportedEnv :: HscEnv -> HomeModInfo -> IO GlobalRdrEnv Source #

Make the top-level environment with all bindings imported by this module. Exported bindings from this module are not included in the result.

getNamesInScope :: GhcMonad m => m [Name] Source #

Returns all names in scope in the current interactive context

getRdrNamesInScope :: GhcMonad m => m [RdrName] Source #

Returns all RdrNames in scope in the current interactive context, excluding any that are internally-generated.

moduleIsInterpreted :: GhcMonad m => Module -> m Bool Source #

Returns True if the specified module is interpreted, and hence has its full top-level scope available.

getInfo :: GhcMonad m => Bool -> Name -> m (Maybe (TyThing, Fixity, [ClsInst], [FamInst], SDoc)) Source #

Looks up an identifier in the current interactive context (for :info) Filter the instances by the ones whose tycons (or classes resp) are in scope (qualified or otherwise). Otherwise we list a whole lot too many! The exact choice of which ones to show, and which to hide, is a judgement call. (see #1581)

exprType :: GhcMonad m => TcRnExprMode -> String -> m Type Source #

Get the type of an expression Returns the type as described by TcRnExprMode

typeKind :: GhcMonad m => Bool -> String -> m (Type, Kind) Source #

Get the kind of a type

parseName :: GhcMonad m => String -> m (NonEmpty Name) Source #

Parses a string as an identifier, and returns the list of Names that the identifier can refer to in the current interactive context.

parseInstanceHead :: GhcMonad m => String -> m Type Source #

getInstancesForType :: GhcMonad m => Type -> m [ClsInst] Source #

getDocs :: GhcMonad m => Name -> m (Either GetDocsFailure (Maybe [HsDoc GhcRn], IntMap (HsDoc GhcRn))) Source #

data GetDocsFailure Source #

Failure modes for getDocs.

Constructors

NameHasNoModule Name	`nameModule_maybe` returned `Nothing`.
NoDocsInIface	The module was loaded without `-haddock`,
Fields Module Bool `True`: The module was compiled. `False`: The module was :loaded.
InteractiveName	The `Name` was defined interactively.

Instances

Instances details

Outputable GetDocsFailure Source #
Instance details Defined in GHC.Runtime.Eval Methods ppr :: GetDocsFailure -> SDoc Source #

showModule :: GhcMonad m => ModuleNodeInfo -> m String Source #

moduleIsBootOrNotObjectLinkable :: GhcMonad m => Module -> m Bool Source #

parseExpr :: GhcMonad m => String -> m (LHsExpr GhcPs) Source #

Parse an expression, the parsed expression can be further processed and passed to compileParsedExpr.

compileParsedExpr :: GhcMonad m => LHsExpr GhcPs -> m HValue Source #

compileExpr :: GhcMonad m => String -> m HValue Source #

Compile an expression, run it, and deliver the resulting HValue.

dynCompileExpr :: GhcMonad m => String -> m Dynamic Source #

Compile an expression, run it and return the result as a Dynamic.

compileExprRemote :: GhcMonad m => String -> m ForeignHValue Source #

Compile an expression, run it, and deliver the resulting HValue.

compileParsedExprRemote :: GhcMonad m => LHsExpr GhcPs -> m ForeignHValue Source #

Compile a parsed expression (before renaming), run it, and deliver the resulting HValue.

data Term Source #

Constructors

Term
Fields ty :: RttiType dc :: Either String DataCon val :: ForeignHValue subTerms :: [Term]
Prim
Fields ty :: RttiType valRaw :: [Word]
Suspension
Fields ctype :: ClosureType ty :: RttiType val :: ForeignHValue bound_to :: Maybe Name infoprov :: Maybe InfoProv
NewtypeWrap
Fields ty :: RttiType dc :: Either String DataCon wrapped_term :: Term
RefWrap
Fields ty :: RttiType wrapped_term :: Term

Instances

Instances details

Outputable Term Source #
Instance details Defined in GHC.Runtime.Heap.Inspect Methods ppr :: Term -> SDoc Source #

obtainTermFromId :: HscEnv -> Int -> Bool -> Id -> IO Term Source #

obtainTermFromVal :: HscEnv -> Int -> Bool -> Type -> a -> IO Term Source #

reconstructType :: HscEnv -> Int -> Id -> IO (Maybe Type) Source #