Safe Haskell	Safe-Inferred
Language	Haskell2010

GHC.Runtime.Eval

Synopsis

data Resume = Resume {
- resumeStmt :: String
- resumeContext :: ForeignRef (ResumeContext [HValueRef])
- resumeBindings :: ([TyThing], GlobalRdrEnv)
- resumeFinalIds :: [Id]
- resumeApStack :: ForeignHValue
- resumeBreakInfo :: Maybe BreakInfo
- resumeSpan :: SrcSpan
- resumeDecl :: String
- resumeCCS :: RemotePtr CostCentreStack
- resumeHistory :: [History]
- resumeHistoryIx :: Int
}
data History = History {
- historyApStack :: ForeignHValue
- historyBreakInfo :: BreakInfo
- 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]
  - breakInfo :: Maybe BreakInfo
  }
resumeExec :: GhcMonad m => (SrcSpan -> Bool) -> SingleStep -> m ExecResult
runDecls :: GhcMonad m => String -> m [Name]
runDeclsWithLocation :: GhcMonad m => String -> Int -> String -> m [Name]
runParsedDecls :: GhcMonad m => [LHsDecl GhcPs] -> m [Name]
isStmt :: ParserFlags -> String -> Bool
hasImport :: ParserFlags -> String -> Bool
isImport :: ParserFlags -> String -> Bool
isDecl :: ParserFlags -> String -> Bool
parseImportDecl :: GhcMonad m => String -> m (ImportDecl GhcPs)
data SingleStep
- = RunToCompletion
- | SingleStep
- | RunAndLogSteps
abandon :: GhcMonad m => m Bool
abandonAll :: GhcMonad m => m Bool
getResumeContext :: GhcMonad m => m [Resume]
getHistorySpan :: HscEnv -> History -> SrcSpan
getModBreaks :: HomeModInfo -> ModBreaks
getHistoryModule :: History -> Module
back :: GhcMonad m => Int -> m ([Name], Int, SrcSpan, String)
forward :: GhcMonad m => Int -> m ([Name], Int, SrcSpan, String)
setContext :: GhcMonad m => [InteractiveImport] -> m ()
getContext :: GhcMonad m => m [InteractiveImport]
availsToGlobalRdrEnv :: ModuleName -> [AvailInfo] -> 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 [Name]
parseInstanceHead :: GhcMonad m => String -> m Type
getInstancesForType :: GhcMonad m => Type -> m [ClsInst]
getDocs :: GhcMonad m => Name -> m (Either GetDocsFailure (Maybe HsDocString, Map Int HsDocString))
data GetDocsFailure
- = NameHasNoModule Name
- | NoDocsInIface Module Bool
- | InteractiveName
showModule :: GhcMonad m => ModSummary -> m String
moduleIsBootOrNotObjectLinkable :: GhcMonad m => ModSummary -> 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
  }
- | 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 :: ([TyThing], GlobalRdrEnv) resumeFinalIds :: [Id] resumeApStack :: ForeignHValue resumeBreakInfo :: Maybe BreakInfo resumeSpan :: SrcSpan resumeDecl :: String resumeCCS :: RemotePtr CostCentreStack resumeHistory :: [History] resumeHistoryIx :: Int

data History Source #

Constructors

History
Fields historyApStack :: ForeignHValue historyBreakInfo :: BreakInfo historyEnclosingDecls :: [String]

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
Fields execResult :: Either SomeException [Name] execAllocation :: Word64
ExecBreak
Fields breakNames :: [Name] breakInfo :: Maybe BreakInfo

resumeExec :: GhcMonad m => (SrcSpan -> Bool) -> SingleStep -> 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).

isStmt :: ParserFlags -> String -> Bool Source #

Returns True if passed string is a statement.

hasImport :: ParserFlags -> String -> Bool Source #

Returns True if passed string has an import declaration.

isImport :: ParserFlags -> String -> Bool Source #

Returns True if passed string is an import declaration.

isDecl :: ParserFlags -> String -> Bool Source #

Returns True if passed string is a declaration but not a splice.

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

data SingleStep Source #

Constructors

RunToCompletion
SingleStep
RunAndLogSteps

abandon :: GhcMonad m => m Bool Source #

abandonAll :: GhcMonad m => m Bool Source #

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

getHistorySpan :: HscEnv -> History -> SrcSpan Source #

getModBreaks :: HomeModInfo -> ModBreaks Source #

getHistoryModule :: History -> Module Source #

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

forward :: GhcMonad m => Int -> m ([Name], Int, SrcSpan, String) 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 constructs the ic_rn_glb_env 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.

availsToGlobalRdrEnv :: ModuleName -> [AvailInfo] -> GlobalRdrEnv Source #

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 clases 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 [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 HsDocString, Map Int HsDocString)) Source #

data GetDocsFailure Source #

Failure modes for getDocs.

Constructors

NameHasNoModule Name	`nameModule_maybe` returned `Nothing`.
NoDocsInIface	This is probably because the module was loaded without `-haddock`, but it's also possible that the entire module contains no documentation.
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 # pprPrec :: Rational -> GetDocsFailure -> SDoc Source #

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

moduleIsBootOrNotObjectLinkable :: GhcMonad m => ModSummary -> 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
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 # pprPrec :: Rational -> 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 #