ghc-lib-parser-0.20190703: The GHC API, decoupled from GHC versions

Safe HaskellNone
LanguageHaskell2010

GHCi.Message

Contents

Description

Remote GHCi message types and serialization.

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

Synopsis

Documentation

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

RtsRevertCAFs :: Message () 
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 -> ByteString -> 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
Show (Message a) Source # 
Instance details

Defined in GHCi.Message

Methods

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

show :: Message a -> String #

showList :: [Message a] -> ShowS #

data Msg Source #

Constructors

(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.

Instances
Show (THMessage a) Source # 
Instance details

Defined in GHCi.Message

data THMsg Source #

Constructors

(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
Show a => Show (QResult a) Source # 
Instance details

Defined in GHCi.Message

Methods

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

show :: QResult a -> String #

showList :: [QResult a] -> ShowS #

Generic (QResult a) Source # 
Instance details

Defined in GHCi.Message

Associated Types

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

Methods

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

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

Binary a => Binary (QResult a) Source # 
Instance details

Defined in GHCi.Message

Methods

put :: QResult a -> Put #

get :: Get (QResult a) #

putList :: [QResult a] -> Put #

type Rep (QResult a) Source # 
Instance details

Defined in GHCi.Message

data EvalStatus_ a b Source #

Instances
Show a => Show (EvalStatus_ a b) Source # 
Instance details

Defined in GHCi.Message

Methods

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

show :: EvalStatus_ a b -> String #

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

Generic (EvalStatus_ a b) Source # 
Instance details

Defined in GHCi.Message

Associated Types

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

Methods

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

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

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

Defined in GHCi.Message

Methods

put :: EvalStatus_ a b -> Put #

get :: Get (EvalStatus_ a b) #

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

type Rep (EvalStatus_ a b) Source # 
Instance details

Defined in GHCi.Message

data EvalResult a Source #

Instances
Show a => Show (EvalResult a) Source # 
Instance details

Defined in GHCi.Message

Generic (EvalResult a) Source # 
Instance details

Defined in GHCi.Message

Associated Types

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

Methods

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

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

Binary a => Binary (EvalResult a) Source # 
Instance details

Defined in GHCi.Message

Methods

put :: EvalResult a -> Put #

get :: Get (EvalResult a) #

putList :: [EvalResult a] -> Put #

type Rep (EvalResult a) Source # 
Instance details

Defined in GHCi.Message

type Rep (EvalResult a) = D1 (MetaData "EvalResult" "GHCi.Message" "ghc-lib-parser-0.20190703-EYyOyVSmwt09kvHBj628V4" 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 #

Instances
Show EvalOpts Source # 
Instance details

Defined in GHCi.Message

Generic EvalOpts Source # 
Instance details

Defined in GHCi.Message

Associated Types

type Rep EvalOpts :: Type -> Type #

Methods

from :: EvalOpts -> Rep EvalOpts x #

to :: Rep EvalOpts x -> EvalOpts #

Binary EvalOpts Source # 
Instance details

Defined in GHCi.Message

Methods

put :: EvalOpts -> Put #

get :: Get EvalOpts #

putList :: [EvalOpts] -> Put #

type Rep EvalOpts Source # 
Instance details

Defined in GHCi.Message

type Rep EvalOpts = D1 (MetaData "EvalOpts" "GHCi.Message" "ghc-lib-parser-0.20190703-EYyOyVSmwt09kvHBj628V4" 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
Show a => Show (EvalExpr a) Source # 
Instance details

Defined in GHCi.Message

Methods

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

show :: EvalExpr a -> String #

showList :: [EvalExpr a] -> ShowS #

Generic (EvalExpr a) Source # 
Instance details

Defined in GHCi.Message

Associated Types

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

Methods

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

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

Binary a => Binary (EvalExpr a) Source # 
Instance details

Defined in GHCi.Message

Methods

put :: EvalExpr a -> Put #

get :: Get (EvalExpr a) #

putList :: [EvalExpr a] -> Put #

type Rep (EvalExpr a) Source # 
Instance details

Defined in GHCi.Message

data THResult a Source #

Constructors

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

Defined in GHCi.Message

Methods

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

show :: THResult a -> String #

showList :: [THResult a] -> ShowS #

Generic (THResult a) Source # 
Instance details

Defined in GHCi.Message

Associated Types

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

Methods

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

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

Binary a => Binary (THResult a) Source # 
Instance details

Defined in GHCi.Message

Methods

put :: THResult a -> Put #

get :: Get (THResult a) #

putList :: [THResult a] -> Put #

type Rep (THResult a) Source # 
Instance details

Defined in GHCi.Message

type Rep (THResult a) = D1 (MetaData "THResult" "GHCi.Message" "ghc-lib-parser-0.20190703-EYyOyVSmwt09kvHBj628V4" 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
Enum THResultType Source # 
Instance details

Defined in GHCi.Message

Show THResultType Source # 
Instance details

Defined in GHCi.Message

Generic THResultType Source # 
Instance details

Defined in GHCi.Message

Associated Types

type Rep THResultType :: Type -> Type #

Binary THResultType Source # 
Instance details

Defined in GHCi.Message

type Rep THResultType Source # 
Instance details

Defined in GHCi.Message

type Rep THResultType = D1 (MetaData "THResultType" "GHCi.Message" "ghc-lib-parser-0.20190703-EYyOyVSmwt09kvHBj628V4" 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 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
Show QState Source # 
Instance details

Defined in GHCi.Message

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

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

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

Orphan instances

Binary ExitCode Source # 
Instance details

Methods

put :: ExitCode -> Put #

get :: Get ExitCode #

putList :: [ExitCode] -> Put #

Binary ClosureType Source # 
Instance details

Binary StgInfoTable Source # 
Instance details

Binary PrimType Source # 
Instance details

Methods

put :: PrimType -> Put #

get :: Get PrimType #

putList :: [PrimType] -> Put #

Binary (Ptr a) Source # 
Instance details

Methods

put :: Ptr a -> Put #

get :: Get (Ptr a) #

putList :: [Ptr a] -> Put #

Binary (FunPtr a) Source # 
Instance details

Methods

put :: FunPtr a -> Put #

get :: Get (FunPtr a) #

putList :: [FunPtr a] -> Put #

Binary a => Binary (GenClosure a) Source # 
Instance details

Methods

put :: GenClosure a -> Put #

get :: Get (GenClosure a) #

putList :: [GenClosure a] -> Put #