W3cubDocs

/Haskell 8

GHCi.Message

Safe Haskell None
Language Haskell2010

Contents

Description

Remote GHCi message types and serialization.

For details on Remote GHCi, see Note [Remote GHCi] in compilerghciGHCi.hs.

data Message a where Source

A Message a is a message that returns a value of type a. These are requests sent from GHC to the server.

Constructors

Shutdown :: Message ()

Exit the iserv process
InitLinker :: Message ()
LookupSymbol :: String -> Message (Maybe (RemotePtr ()))
LookupClosure :: String -> Message (Maybe HValueRef)
LoadDLL :: String -> Message (Maybe String)
LoadArchive :: String -> Message ()
LoadObj :: String -> Message ()
UnloadObj :: String -> Message ()
AddLibrarySearchPath :: String -> Message (RemotePtr ())
RemoveLibrarySearchPath :: RemotePtr () -> Message Bool
ResolveObjs :: Message Bool
FindSystemLibrary :: String -> Message (Maybe String)
CreateBCOs :: [ByteString] -> Message [HValueRef]

Create a set of BCO objects, and return HValueRefs to them Note: Each ByteString contains a Binary-encoded [ResolvedBCO], not a ResolvedBCO. The list is to allow us to serialise the ResolvedBCOs in parallel. See createBCOs in compilerghciGHCi.hsc.
FreeHValueRefs :: [HValueRef] -> Message ()

Release HValueRefs
AddSptEntry :: Fingerprint -> HValueRef -> Message ()

Add entries to the Static Pointer Table
MallocData :: ByteString -> Message (RemotePtr ())

Malloc some data and return a RemotePtr to it
MallocStrings :: [ByteString] -> Message [RemotePtr ()]
PrepFFI :: FFIConv -> [FFIType] -> FFIType -> Message (RemotePtr C_ffi_cif)

Calls prepareForeignCall
FreeFFI :: RemotePtr C_ffi_cif -> Message ()

Free data previously created by PrepFFI
MkConInfoTable :: Int -> Int -> Int -> Int -> [Word8] -> Message (RemotePtr StgInfoTable)

Create an info table for a constructor
EvalStmt :: EvalOpts -> EvalExpr HValueRef -> Message (EvalStatus [HValueRef])

Evaluate a statement
ResumeStmt :: EvalOpts -> RemoteRef (ResumeContext [HValueRef]) -> Message (EvalStatus [HValueRef])

Resume evaluation of a statement after a breakpoint
AbandonStmt :: RemoteRef (ResumeContext [HValueRef]) -> Message ()

Abandon evaluation of a statement after a breakpoint
EvalString :: HValueRef -> Message (EvalResult String)

Evaluate something of type IO String
EvalStringToString :: HValueRef -> String -> Message (EvalResult String)

Evaluate something of type String -> IO String
EvalIO :: HValueRef -> Message (EvalResult ())

Evaluate something of type IO ()
MkCostCentres :: String -> [(String, String)] -> Message [RemotePtr CostCentre]

Create a set of CostCentres with the same module name
CostCentreStackInfo :: RemotePtr CostCentreStack -> Message [String]

Show a CostCentreStack as a [String]
NewBreakArray :: Int -> Message (RemoteRef BreakArray)

Create a new array of breakpoint flags
EnableBreakpoint :: RemoteRef BreakArray -> Int -> Bool -> Message ()

Enable a breakpoint
BreakpointStatus :: RemoteRef BreakArray -> Int -> Message Bool

Query the status of a breakpoint (True = enabled)
GetBreakpointVar :: HValueRef -> Int -> Message (Maybe HValueRef)

Get a reference to a free variable at a breakpoint
StartTH :: Message (RemoteRef (IORef QState))

Start a new TH module, return a state token that should be
RunTH :: RemoteRef (IORef QState) -> HValueRef -> THResultType -> Maybe Loc -> Message (QResult ByteString)

Evaluate a TH computation.

Returns a ByteString, because we have to force the result before returning it to ensure there are no errors lurking in it. The TH types don't have NFData instances, and even if they did, we have to serialize the value anyway, so we might as well serialize it to force it.
RunModFinalizers :: RemoteRef (IORef QState) -> [RemoteRef (Q ())] -> Message (QResult ())

Run the given mod finalizers.
GetClosure :: HValueRef -> Message (GenClosure HValueRef)

Remote interface to GHC.Exts.Heap.getClosureData. This is used by the GHCi debugger to inspect values in the heap for :print and type reconstruction.
Seq :: HValueRef -> Message (EvalResult ())

Evaluate something. This is used to support :force in GHCi.
Instances
Instances details
Show (Message a)
Instance details

Defined in GHCi.Message

Methods

showsPrec :: Int -> Message a -> ShowS Source

show :: Message a -> String Source

showList :: [Message a] -> ShowS Source

data Msg Source

Constructors

forall a.(Binary a, Show a) => Msg (Message a)

data THMessage a where Source

Messages sent back to GHC from GHCi.TH, to implement the methods of Quasi. For an overview of how TH works with Remote GHCi, see Note [Remote Template Haskell] in GHCi.TH.

Constructors

NewName :: String -> THMessage (THResult Name)
Report :: Bool -> String -> THMessage (THResult ())
LookupName :: Bool -> String -> THMessage (THResult (Maybe Name))
Reify :: Name -> THMessage (THResult Info)
ReifyFixity :: Name -> THMessage (THResult (Maybe Fixity))
ReifyInstances :: Name -> [Type] -> THMessage (THResult [Dec])
ReifyRoles :: Name -> THMessage (THResult [Role])
ReifyAnnotations :: AnnLookup -> TypeRep -> THMessage (THResult [ByteString])
ReifyModule :: Module -> THMessage (THResult ModuleInfo)
ReifyConStrictness :: Name -> THMessage (THResult [DecidedStrictness])
AddDependentFile :: FilePath -> THMessage (THResult ())
AddTempFile :: String -> THMessage (THResult FilePath)
AddModFinalizer :: RemoteRef (Q ()) -> THMessage (THResult ())
AddCorePlugin :: String -> THMessage (THResult ())
AddTopDecls :: [Dec] -> THMessage (THResult ())
AddForeignFilePath :: ForeignSrcLang -> FilePath -> THMessage (THResult ())
IsExtEnabled :: Extension -> THMessage (THResult Bool)
ExtsEnabled :: THMessage (THResult [Extension])
StartRecover :: THMessage ()
EndRecover :: Bool -> THMessage ()
FailIfErrs :: THMessage (THResult ())
RunTHDone :: THMessage ()

Indicates that this RunTH is finished, and the next message will be the result of RunTH (a QResult).
Instances
Instances details
Show (THMessage a)
Instance details

Defined in GHCi.Message

Methods

showsPrec :: Int -> THMessage a -> ShowS Source

show :: THMessage a -> String Source

showList :: [THMessage a] -> ShowS Source

data THMsg Source

Constructors

forall a.(Binary a, Show a) => THMsg (THMessage a)

data QResult a Source

Template Haskell return values

Constructors

QDone a

RunTH finished successfully; return value follows
QException String

RunTH threw an exception
QFail String

RunTH called fail
Instances
Instances details
Show a => Show (QResult a)
Instance details

Defined in GHCi.Message

Methods

showsPrec :: Int -> QResult a -> ShowS Source

show :: QResult a -> String Source

showList :: [QResult a] -> ShowS Source

Generic (QResult a)
Instance details

Defined in GHCi.Message

Associated Types

type Rep (QResult a) :: Type -> Type Source

Methods

from :: QResult a -> Rep (QResult a) x Source

to :: Rep (QResult a) x -> QResult a Source

Binary a => Binary (QResult a)
Instance details

Defined in GHCi.Message

Methods

put :: QResult a -> Put Source

get :: Get (QResult a) Source

putList :: [QResult a] -> Put Source

type Rep (QResult a)
Instance details

Defined in GHCi.Message

type Rep (QResult a) = D1 ('MetaData "QResult" "GHCi.Message" "ghci-8.8.3" 'False) (C1 ('MetaCons "QDone" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: (C1 ('MetaCons "QException" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :+: C1 ('MetaCons "QFail" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

data EvalStatus_ a b Source

Constructors

EvalComplete Word64 (EvalResult a)
EvalBreak Bool HValueRef Int Int (RemoteRef (ResumeContext b)) (RemotePtr CostCentreStack)
Instances
Instances details
Show a => Show (EvalStatus_ a b)
Instance details

Defined in GHCi.Message

Methods

showsPrec :: Int -> EvalStatus_ a b -> ShowS Source

show :: EvalStatus_ a b -> String Source

showList :: [EvalStatus_ a b] -> ShowS Source

Generic (EvalStatus_ a b)
Instance details

Defined in GHCi.Message

Associated Types

type Rep (EvalStatus_ a b) :: Type -> Type Source

Methods

from :: EvalStatus_ a b -> Rep (EvalStatus_ a b) x Source

to :: Rep (EvalStatus_ a b) x -> EvalStatus_ a b Source

Binary a => Binary (EvalStatus_ a b)
Instance details

Defined in GHCi.Message

Methods

put :: EvalStatus_ a b -> Put Source

get :: Get (EvalStatus_ a b) Source

putList :: [EvalStatus_ a b] -> Put Source

type Rep (EvalStatus_ a b)
Instance details

Defined in GHCi.Message

type Rep (EvalStatus_ a b) = D1 ('MetaData "EvalStatus_" "GHCi.Message" "ghci-8.8.3" 'False) (C1 ('MetaCons "EvalComplete" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (EvalResult a))) :+: C1 ('MetaCons "EvalBreak" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HValueRef) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RemoteRef (ResumeContext b))) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RemotePtr CostCentreStack))))))

type EvalStatus a = EvalStatus_ a a Source

data EvalResult a Source

Constructors

EvalException SerializableException
EvalSuccess a
Instances
Instances details
Show a => Show (EvalResult a)
Instance details

Defined in GHCi.Message

Methods

showsPrec :: Int -> EvalResult a -> ShowS Source

show :: EvalResult a -> String Source

showList :: [EvalResult a] -> ShowS Source

Generic (EvalResult a)
Instance details

Defined in GHCi.Message

Associated Types

type Rep (EvalResult a) :: Type -> Type Source

Methods

from :: EvalResult a -> Rep (EvalResult a) x Source

to :: Rep (EvalResult a) x -> EvalResult a Source

Binary a => Binary (EvalResult a)
Instance details

Defined in GHCi.Message

Methods

put :: EvalResult a -> Put Source

get :: Get (EvalResult a) Source

putList :: [EvalResult a] -> Put Source

type Rep (EvalResult a)
Instance details

Defined in GHCi.Message

type Rep (EvalResult a) = D1 ('MetaData "EvalResult" "GHCi.Message" "ghci-8.8.3" 'False) (C1 ('MetaCons "EvalException" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SerializableException)) :+: C1 ('MetaCons "EvalSuccess" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

data EvalOpts Source

Constructors

EvalOpts

Fields

Instances
Instances details
Show EvalOpts
Instance details

Defined in GHCi.Message

Methods

showsPrec :: Int -> EvalOpts -> ShowS Source

show :: EvalOpts -> String Source

showList :: [EvalOpts] -> ShowS Source

Generic EvalOpts
Instance details

Defined in GHCi.Message

Associated Types

type Rep EvalOpts :: Type -> Type Source

Methods

from :: EvalOpts -> Rep EvalOpts x Source

to :: Rep EvalOpts x -> EvalOpts Source

Binary EvalOpts
Instance details

Defined in GHCi.Message

Methods

put :: EvalOpts -> Put Source

get :: Get EvalOpts Source

putList :: [EvalOpts] -> Put Source

type Rep EvalOpts
Instance details

Defined in GHCi.Message

type Rep EvalOpts = D1 ('MetaData "EvalOpts" "GHCi.Message" "ghci-8.8.3" 'False) (C1 ('MetaCons "EvalOpts" 'PrefixI 'True) ((S1 ('MetaSel ('Just "useSandboxThread") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "singleStep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "breakOnException") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "breakOnError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

data EvalExpr a Source

We can pass simple expressions to EvalStmt, consisting of values and application. This allows us to wrap the statement to be executed in another function, which is used by GHCi to implement :set args and :set prog. It might be worthwhile to extend this little language in the future.

Constructors

EvalThis a
EvalApp (EvalExpr a) (EvalExpr a)
Instances
Instances details
Show a => Show (EvalExpr a)
Instance details

Defined in GHCi.Message

Methods

showsPrec :: Int -> EvalExpr a -> ShowS Source

show :: EvalExpr a -> String Source

showList :: [EvalExpr a] -> ShowS Source

Generic (EvalExpr a)
Instance details

Defined in GHCi.Message

Associated Types

type Rep (EvalExpr a) :: Type -> Type Source

Methods

from :: EvalExpr a -> Rep (EvalExpr a) x Source

to :: Rep (EvalExpr a) x -> EvalExpr a Source

Binary a => Binary (EvalExpr a)
Instance details

Defined in GHCi.Message

Methods

put :: EvalExpr a -> Put Source

get :: Get (EvalExpr a) Source

putList :: [EvalExpr a] -> Put Source

type Rep (EvalExpr a)
Instance details

Defined in GHCi.Message

type Rep (EvalExpr a) = D1 ('MetaData "EvalExpr" "GHCi.Message" "ghci-8.8.3" 'False) (C1 ('MetaCons "EvalThis" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: C1 ('MetaCons "EvalApp" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (EvalExpr a)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (EvalExpr a))))

data SerializableException Source

Constructors

EUserInterrupt
EExitCode ExitCode
EOtherException String
Instances
Instances details
Show SerializableException
Instance details

Defined in GHCi.Message

Methods

showsPrec :: Int -> SerializableException -> ShowS Source

show :: SerializableException -> String Source

showList :: [SerializableException] -> ShowS Source

Generic SerializableException
Instance details

Defined in GHCi.Message

Associated Types

type Rep SerializableException :: Type -> Type Source

Methods

from :: SerializableException -> Rep SerializableException x Source

to :: Rep SerializableException x -> SerializableException Source

Binary SerializableException
Instance details

Defined in GHCi.Message

Methods

put :: SerializableException -> Put Source

get :: Get SerializableException Source

putList :: [SerializableException] -> Put Source

type Rep SerializableException
Instance details

Defined in GHCi.Message

type Rep SerializableException = D1 ('MetaData "SerializableException" "GHCi.Message" "ghci-8.8.3" 'False) (C1 ('MetaCons "EUserInterrupt" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "EExitCode" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ExitCode)) :+: C1 ('MetaCons "EOtherException" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

toSerializableException :: SomeException -> SerializableException Source

fromSerializableException :: SerializableException -> SomeException Source

data THResult a Source

Constructors

THException String
THComplete a
Instances
Instances details
Show a => Show (THResult a)
Instance details

Defined in GHCi.Message

Methods

showsPrec :: Int -> THResult a -> ShowS Source

show :: THResult a -> String Source

showList :: [THResult a] -> ShowS Source

Generic (THResult a)
Instance details

Defined in GHCi.Message

Associated Types

type Rep (THResult a) :: Type -> Type Source

Methods

from :: THResult a -> Rep (THResult a) x Source

to :: Rep (THResult a) x -> THResult a Source

Binary a => Binary (THResult a)
Instance details

Defined in GHCi.Message

Methods

put :: THResult a -> Put Source

get :: Get (THResult a) Source

putList :: [THResult a] -> Put Source

type Rep (THResult a)
Instance details

Defined in GHCi.Message

type Rep (THResult a) = D1 ('MetaData "THResult" "GHCi.Message" "ghci-8.8.3" 'False) (C1 ('MetaCons "THException" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :+: C1 ('MetaCons "THComplete" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

data THResultType Source

Constructors

THExp
THPat
THType
THDec
THAnnWrapper
Instances
Instances details
Enum THResultType
Instance details

Defined in GHCi.Message

Methods

succ :: THResultType -> THResultType Source

pred :: THResultType -> THResultType Source

toEnum :: Int -> THResultType Source

fromEnum :: THResultType -> Int Source

enumFrom :: THResultType -> [THResultType] Source

enumFromThen :: THResultType -> THResultType -> [THResultType] Source

enumFromTo :: THResultType -> THResultType -> [THResultType] Source

enumFromThenTo :: THResultType -> THResultType -> THResultType -> [THResultType] Source

Show THResultType
Instance details

Defined in GHCi.Message

Methods

showsPrec :: Int -> THResultType -> ShowS Source

show :: THResultType -> String Source

showList :: [THResultType] -> ShowS Source

Generic THResultType
Instance details

Defined in GHCi.Message

Associated Types

type Rep THResultType :: Type -> Type Source

Methods

from :: THResultType -> Rep THResultType x Source

to :: Rep THResultType x -> THResultType Source

Binary THResultType
Instance details

Defined in GHCi.Message

Methods

put :: THResultType -> Put Source

get :: Get THResultType Source

putList :: [THResultType] -> Put Source

type Rep THResultType
Instance details

Defined in GHCi.Message

type Rep THResultType = D1 ('MetaData "THResultType" "GHCi.Message" "ghci-8.8.3" 'False) ((C1 ('MetaCons "THExp" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "THPat" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "THType" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "THDec" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "THAnnWrapper" 'PrefixI 'False) (U1 :: Type -> Type))))

data ResumeContext a Source

Constructors

ResumeContext

Fields

data QState Source

The server-side Template Haskell state. This is created by the StartTH message. A new one is created per module that GHC typechecks.

Constructors

QState

Fields

Instances
Instances details
Show QState
Instance details

Defined in GHCi.Message

Methods

showsPrec :: Int -> QState -> ShowS Source

show :: QState -> String Source

showList :: [QState] -> ShowS Source

getMessage :: Get Msg Source

putMessage :: Message a -> Put Source

getTHMessage :: Get THMsg Source

putTHMessage :: THMessage a -> Put Source

data Pipe Source

Constructors

Pipe

Fields

remoteCall :: Binary a => Pipe -> Message a -> IO a Source

remoteTHCall :: Binary a => Pipe -> THMessage a -> IO a Source

readPipe :: Pipe -> Get a -> IO a Source

writePipe :: Pipe -> Put -> IO () Source

Orphan instances

Binary ExitCode
Instance details

Methods

put :: ExitCode -> Put Source

get :: Get ExitCode Source

putList :: [ExitCode] -> Put Source

Binary PrimType
Instance details

Methods

put :: PrimType -> Put Source

get :: Get PrimType Source

putList :: [PrimType] -> Put Source

Binary StgInfoTable
Instance details

Methods

put :: StgInfoTable -> Put Source

get :: Get StgInfoTable Source

putList :: [StgInfoTable] -> Put Source

Binary ClosureType
Instance details

Methods

put :: ClosureType -> Put Source

get :: Get ClosureType Source

putList :: [ClosureType] -> Put Source

Binary (Ptr a)
Instance details

Methods

put :: Ptr a -> Put Source

get :: Get (Ptr a) Source

putList :: [Ptr a] -> Put Source

Binary (FunPtr a)
Instance details

Methods

put :: FunPtr a -> Put Source

get :: Get (FunPtr a) Source

putList :: [FunPtr a] -> Put Source

Binary a => Binary (GenClosure a)
Instance details

Methods

put :: GenClosure a -> Put Source

get :: Get (GenClosure a) Source

putList :: [GenClosure a] -> Put Source

© The University of Glasgow and others
Licensed under a BSD-style license (see top of the page).
https://downloads.haskell.org/~ghc/8.8.3/docs/html/libraries/ghci-8.8.3/GHCi-Message.html