Safe Haskell	None
Language	Haskell2010

IHaskell.Types

Description

Synopsis

Documentation

data Message :: * #

A message used to communicate with the IPython frontend.

Constructors

KernelInfoRequest	A request from a frontend for information about the kernel.
Fields header :: MessageHeader
KernelInfoReply	A response to a KernelInfoRequest.
Fields header :: MessageHeader protocolVersion :: String current protocol version, major and minor banner :: String Kernel information description e.g. (IHaskell 0.8.3.0 GHC 7.10.2) implementation :: String e.g. IHaskell implementationVersion :: String The version of the implementation languageInfo :: LanguageInfo
CommInfoRequest	A request from a frontend for information about the comms.
Fields header :: MessageHeader
CommInfoReply	A response to a CommInfoRequest.
Fields header :: MessageHeader commInfo :: Map String String A dictionary of the comms, indexed by uuids.
ExecuteInput	A request from a frontend to execute some code.
Fields header :: MessageHeader getCode :: Text The code string. executionCounter :: Int The execution count, i.e. which output this is.
ExecuteRequest	A request from a frontend to execute some code.
Fields header :: MessageHeader getCode :: Text The code string. getSilent :: Bool Whether this should be silently executed. getStoreHistory :: Bool Whether to store this in history. getAllowStdin :: Bool Whether this code can use stdin. getUserVariables :: [Text] Unused. getUserExpressions :: [Text] Unused.
ExecuteReply	A reply to an execute request.
Fields header :: MessageHeader status :: ExecuteReplyStatus The status of the output. pagerOutput :: [DisplayData] The mimebundles to display in the pager. executionCounter :: Int The execution count, i.e. which output this is.
ExecuteResult	A reply to an execute request.
Fields header :: MessageHeader dataResult :: [DisplayData] Key/value pairs (keys are MIME types) metadataResult :: Map String String Any metadata that describes the data executionCounter :: Int The execution count, i.e. which output this is.
ExecuteError	An error reply to an execute request
Fields header :: MessageHeader pagerOutput :: [DisplayData] The mimebundles to display in the pager. traceback :: [Text] ename :: Text evalue :: Text
PublishStatus
Fields header :: MessageHeader executionState :: ExecutionState The execution state of the kernel.
PublishStream
Fields header :: MessageHeader streamType :: StreamType Which stream to publish to. streamContent :: String What to publish.
PublishDisplayData
Fields header :: MessageHeader source :: String The name of the data source. displayData :: [DisplayData] A list of data representations.
PublishOutput
Fields header :: MessageHeader reprText :: String Printed output text. executionCount :: Int Which output this is for.
PublishInput
Fields header :: MessageHeader inCode :: String Submitted input code. executionCount :: Int Which output this is for.
Input
Fields header :: MessageHeader getCode :: Text The code string. executionCount :: Int Which output this is for.
Output
Fields header :: MessageHeader getText :: [DisplayData] executionCount :: Int Which output this is for.
IsCompleteRequest
Fields header :: MessageHeader inputToReview :: String The code entered in the repl.
IsCompleteReply
Fields header :: MessageHeader reviewResult :: CodeReview The result of reviewing the code.
CompleteRequest
Fields header :: MessageHeader getCode :: Text The code string. getCursorPos :: Int Position of the cursor in unicode characters. json field `cursor_pos`
CompleteReply
Fields header :: MessageHeader completionMatches :: [Text] completionCursorStart :: Int completionCursorEnd :: Int completionMetadata :: Metadata completionStatus :: Bool
InspectRequest
Fields header :: MessageHeader inspectCode :: Text The code context in which introspection is requested inspectCursorPos :: Int Position of the cursor in unicode characters. json field `cursor_pos` detailLevel :: Int Level of detail desired (defaults to 0). 0 is equivalent to foo?, 1 is equivalent to foo??.
InspectReply
Fields header :: MessageHeader inspectStatus :: Bool whether the request succeeded or failed inspectData :: [DisplayData] `inspectData` can be empty if nothing is found
ShutdownRequest
Fields header :: MessageHeader restartPending :: Bool Whether this shutdown precedes a restart.
ShutdownReply
Fields header :: MessageHeader restartPending :: Bool Whether this shutdown precedes a restart.
ClearOutput
Fields header :: MessageHeader wait :: Bool Whether to wait to redraw until there is more output.
RequestInput
Fields header :: MessageHeader inputPrompt :: String
InputReply
Fields header :: MessageHeader inputValue :: String
CommOpen
Fields header :: MessageHeader commTargetName :: String commTargetModule :: String commUuid :: UUID commData :: Value
CommData
Fields header :: MessageHeader commUuid :: UUID commData :: Value
CommClose
Fields header :: MessageHeader commUuid :: UUID commData :: Value
HistoryRequest
Fields header :: MessageHeader historyGetOutput :: Bool If True, also return output history in the resulting dict. historyRaw :: Bool If True, return the raw input history, else the transformed input. historyAccessType :: HistoryAccessType What history is being requested.
HistoryReply
Fields header :: MessageHeader historyReply :: [HistoryReplyElement]
SendNothing

Instances

Show Message
Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #

data MessageHeader :: * #

A message header with some metadata.

Constructors

MessageHeader
Fields identifiers :: [ByteString] The identifiers sent with the message. parentHeader :: Maybe MessageHeader The parent header, if present. metadata :: Metadata A dict of metadata. messageId :: UUID A unique message UUID. sessionId :: UUID A unique session UUID. username :: Username The user who sent this message. msgType :: MessageType The message type.

Instances

Read MessageHeader
Methods readsPrec :: Int -> ReadS MessageHeader # readList :: ReadS [MessageHeader] # readPrec :: ReadPrec MessageHeader # readListPrec :: ReadPrec [MessageHeader] #
Show MessageHeader
Methods showsPrec :: Int -> MessageHeader -> ShowS # show :: MessageHeader -> String # showList :: [MessageHeader] -> ShowS #
ToJSON MessageHeader
Methods toJSON :: MessageHeader -> Value # toEncoding :: MessageHeader -> Encoding # toJSONList :: [MessageHeader] -> Value # toEncodingList :: [MessageHeader] -> Encoding #

data MessageType :: * #

The type of a message, corresponding to IPython message types.

Instances

Eq MessageType
Methods (==) :: MessageType -> MessageType -> Bool # (/=) :: MessageType -> MessageType -> Bool #
Read MessageType
Methods readsPrec :: Int -> ReadS MessageType # readList :: ReadS [MessageType] # readPrec :: ReadPrec MessageType # readListPrec :: ReadPrec [MessageType] #
Show MessageType
Methods showsPrec :: Int -> MessageType -> ShowS # show :: MessageType -> String # showList :: [MessageType] -> ShowS #
FromJSON MessageType
Methods parseJSON :: Value -> Parser MessageType # parseJSONList :: Value -> Parser [MessageType] #

dupHeader :: MessageHeader -> MessageType -> IO MessageHeader #

Duplicate a message header, giving it a new UUID and message type.

type Username = Text #

A username for the source of a message.

type Metadata = Map Text Text #

A metadata dictionary.

replyType :: MessageType -> Maybe MessageType #

Get the reply message type for a request message type.

data ExecutionState :: * #

The execution state of the kernel.

Constructors

Busy
Idle
Starting

Instances

Show ExecutionState
Methods showsPrec :: Int -> ExecutionState -> ShowS # show :: ExecutionState -> String # showList :: [ExecutionState] -> ShowS #
FromJSON ExecutionState
Methods parseJSON :: Value -> Parser ExecutionState # parseJSONList :: Value -> Parser [ExecutionState] #

data StreamType :: * #

Input and output streams.

Constructors

Stdin
Stdout
Stderr

Instances

Show StreamType
Methods showsPrec :: Int -> StreamType -> ShowS # show :: StreamType -> String # showList :: [StreamType] -> ShowS #
FromJSON StreamType
Methods parseJSON :: Value -> Parser StreamType # parseJSONList :: Value -> Parser [StreamType] #

data MimeType :: * #

Constructors

PlainText
MimeHtml
MimePng Width Height
MimeJpg Width Height
MimeSvg
MimeLatex
MimeJavascript

Instances

Eq MimeType
Methods (==) :: MimeType -> MimeType -> Bool # (/=) :: MimeType -> MimeType -> Bool #
Read MimeType
Methods readsPrec :: Int -> ReadS MimeType # readList :: ReadS [MimeType] # readPrec :: ReadPrec MimeType # readListPrec :: ReadPrec [MimeType] #
Show MimeType
Methods showsPrec :: Int -> MimeType -> ShowS # show :: MimeType -> String # showList :: [MimeType] -> ShowS #
Generic MimeType
Associated Types type Rep MimeType :: * -> * # Methods from :: MimeType -> Rep MimeType x # to :: Rep MimeType x -> MimeType #
Serialize MimeType
Methods put :: Putter MimeType # get :: Get MimeType #
type Rep MimeType
type Rep MimeType = D1 * (MetaData "MimeType" "IHaskell.IPython.Types" "ipython-kernel-0.9.0.2-4FlWAG810mB4pMpbq2O76B" False) ((:+:) * ((:+:) * (C1 * (MetaCons "PlainText" PrefixI False) (U1 )) ((:+:) (C1 * (MetaCons "MimeHtml" PrefixI False) (U1 )) (C1 (MetaCons "MimePng" PrefixI False) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Width)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Height)))))) ((:+:) * ((:+:) * (C1 * (MetaCons "MimeJpg" PrefixI False) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Width)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Height)))) (C1 * (MetaCons "MimeSvg" PrefixI False) (U1 ))) ((:+:) (C1 * (MetaCons "MimeLatex" PrefixI False) (U1 )) (C1 (MetaCons "MimeJavascript" PrefixI False) (U1 *)))))

data DisplayData :: * #

Data for display: a string with associated MIME type.

Constructors

DisplayData MimeType Text

Instances

Show DisplayData
Methods showsPrec :: Int -> DisplayData -> ShowS # show :: DisplayData -> String # showList :: [DisplayData] -> ShowS #
Generic DisplayData
Associated Types type Rep DisplayData :: * -> * # Methods from :: DisplayData -> Rep DisplayData x # to :: Rep DisplayData x -> DisplayData #
Serialize DisplayData
Methods put :: Putter DisplayData # get :: Get DisplayData #
type Rep DisplayData
type Rep DisplayData = D1 * (MetaData "DisplayData" "IHaskell.IPython.Types" "ipython-kernel-0.9.0.2-4FlWAG810mB4pMpbq2O76B" False) (C1 * (MetaCons "DisplayData" PrefixI False) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * MimeType)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text))))

data EvaluationResult #

Output of evaluation.

Constructors

IntermediateResult	An intermediate result which communicates what has been printed thus far.
Fields outputs :: Display Display outputs.
FinalResult
Fields outputs :: Display Display outputs. pagerOut :: [DisplayData] Mimebundles to display in the IPython pager. commMsgs :: [WidgetMsg] Comm operations

Instances

Show EvaluationResult #
Methods showsPrec :: Int -> EvaluationResult -> ShowS # show :: EvaluationResult -> String # showList :: [EvaluationResult] -> ShowS #

data ExecuteReplyStatus :: * #

Possible statuses in the execution reply messages.

Constructors

Ok
Err
Abort

Instances

Show ExecuteReplyStatus
Methods showsPrec :: Int -> ExecuteReplyStatus -> ShowS # show :: ExecuteReplyStatus -> String # showList :: [ExecuteReplyStatus] -> ShowS #
FromJSON ExecuteReplyStatus
Methods parseJSON :: Value -> Parser ExecuteReplyStatus # parseJSONList :: Value -> Parser [ExecuteReplyStatus] #

data KernelState #

All state stored in the kernel between executions.

Constructors

KernelState
Fields getExecutionCounter :: Int getLintStatus :: LintStatus useSvg :: Bool useShowErrors :: Bool useShowTypes :: Bool usePager :: Bool openComms :: Map UUID Widget kernelDebug :: Bool supportLibrariesAvailable :: Bool

Instances

Show KernelState #
Methods showsPrec :: Int -> KernelState -> ShowS # show :: KernelState -> String # showList :: [KernelState] -> ShowS #

data LintStatus #

Current HLint status.

Constructors

LintOn
LintOff

Instances

Eq LintStatus #
Methods (==) :: LintStatus -> LintStatus -> Bool # (/=) :: LintStatus -> LintStatus -> Bool #
Show LintStatus #
Methods showsPrec :: Int -> LintStatus -> ShowS # show :: LintStatus -> String # showList :: [LintStatus] -> ShowS #

type Width = Int #

Possible MIME types for the display data.

type Height = Int #

data Display #

Wrapper for ipython-kernel's DisplayData which allows sending multiple results from the same expression.

Constructors

Display [DisplayData]
ManyDisplay [Display]

Instances

Show Display #
Methods showsPrec :: Int -> Display -> ShowS # show :: Display -> String # showList :: [Display] -> ShowS #
Generic Display #
Associated Types type Rep Display :: * -> * # Methods from :: Display -> Rep Display x # to :: Rep Display x -> Display #
Semigroup Display #
Methods (<>) :: Display -> Display -> Display # sconcat :: NonEmpty Display -> Display # stimes :: Integral b => b -> Display -> Display #
Monoid Display #
Methods mempty :: Display # mappend :: Display -> Display -> Display # mconcat :: [Display] -> Display #
Serialize Display #
Methods put :: Putter Display # get :: Get Display #
type Rep Display #
type Rep Display = D1 * (MetaData "Display" "IHaskell.Types" "ihaskell-0.9.0.3-AYQwkWwnnIu5NLOYOaOxjB" False) ((:+:) * (C1 * (MetaCons "Display" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [DisplayData]))) (C1 * (MetaCons "ManyDisplay" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Display]))))

defaultKernelState :: KernelState #

extractPlain :: [DisplayData] -> String #

kernelOpts :: [KernelOpt] #

data KernelOpt #

Kernel options to be set via `:set` and `:option`.

Constructors

KernelOpt
Fields getOptionName :: [String] Ways to set this option via `:option` getSetName :: [String] Ways to set this option via `:set` getUpdateKernelState :: KernelState -> KernelState Function to update the kernel state.

class IHaskellDisplay a where #

A class for displayable Haskell types.

IHaskell's displaying of results behaves as if these two overlapping/undecidable instances also existed:

instance (Show a) => IHaskellDisplay a
instance Show a where shows _ = id

Minimal complete definition

display

Methods

display :: a -> IO Display #

Instances

IHaskellDisplay Widget #
Methods display :: Widget -> IO Display #

class IHaskellDisplay a => IHaskellWidget a where #

Display as an interactive widget.

Minimal complete definition

getCommUUID

Methods

targetName :: a -> String #

Target name for this widget. The actual input parameter should be ignored. By default evaluate to "jupyter.widget", which is used by IPython for its backbone widgets.

targetModule :: a -> String #

Target module for this widget. Evaluates to an empty string by default.

getCommUUID :: a -> UUID #

Get the uuid for comm associated with this widget. The widget is responsible for storing the UUID during initialization.

open #

Arguments

:: a	Widget to open a comm port with.
-> (Value -> IO ())	A function for sending messages.
-> IO ()

Called when the comm is opened. Allows additional messages to be sent after comm open.

comm #

Arguments

:: a	Widget which is being communicated with.
-> Value	Data recieved from the frontend.
-> (Value -> IO ())	Way to respond to the message.
-> IO ()

Respond to a comm data message. Called when a message is recieved on the comm associated with the widget.

close #

Arguments

:: a	Widget to close comm port with.
-> Value	Data recieved from the frontend.
-> IO ()

Called when a comm_close is recieved from the frontend.

Instances

IHaskellWidget Widget #
Methods targetName :: Widget -> String # targetModule :: Widget -> String # getCommUUID :: Widget -> UUID # open :: Widget -> (Value -> IO ()) -> IO () # comm :: Widget -> Value -> (Value -> IO ()) -> IO () # close :: Widget -> Value -> IO () #

data Widget #

Constructors

IHaskellWidget a => a

data WidgetMsg #

Send JSON objects with specific formats

Constructors

Open Widget Value	Cause the interpreter to open a new comm, and register the associated widget in the kernelState. Also sends an initial state Value with comm_open.
Update Widget Value	Cause the interpreter to send a comm_msg containing a state update for the widget. Can be used to send fragments of state for update. Also updates the value of widget stored in the kernelState
View Widget	Cause the interpreter to send a comm_msg containing a display command for the frontend.
Close Widget Value	Cause the interpreter to close the comm associated with the widget. Also sends data with comm_close.
Custom Widget Value	A [method .= custom, content = value] message
JSONValue Widget Value	A json object that is sent to the widget without modifications.
DispMsg Widget Display	A `display_data` message, sent as a [method .= custom] comm_msg
ClrOutput Widget Bool	A `clear_output` message, sent as a [method .= custom] comm_msg

Instances

Show WidgetMsg #
Methods showsPrec :: Int -> WidgetMsg -> ShowS # show :: WidgetMsg -> String # showList :: [WidgetMsg] -> ShowS #

data WidgetMethod #

Constructors

UpdateState Value
CustomContent Value
DisplayWidget

Instances

ToJSON WidgetMethod #
Methods toJSON :: WidgetMethod -> Value # toEncoding :: WidgetMethod -> Encoding # toJSONList :: [WidgetMethod] -> Value # toEncodingList :: [WidgetMethod] -> Encoding #

data KernelSpec :: * #

Constructors

KernelSpec
Fields kernelDisplayName :: String Name shown to users to describe this kernel (e.g. Haskell) kernelLanguage :: String Name for the kernel; unique kernel identifier (e.g. "haskell") kernelCommand :: [String] Command to run to start the kernel. One of the strings maybe `"{connection_file}"`, which will be replaced by the path to a kernel profile file (see `Profile`) when the command is run.

Instances

Eq KernelSpec
Methods (==) :: KernelSpec -> KernelSpec -> Bool # (/=) :: KernelSpec -> KernelSpec -> Bool #
Show KernelSpec
Methods showsPrec :: Int -> KernelSpec -> ShowS # show :: KernelSpec -> String # showList :: [KernelSpec] -> ShowS #
ToJSON KernelSpec
Methods toJSON :: KernelSpec -> Value # toEncoding :: KernelSpec -> Encoding # toJSONList :: [KernelSpec] -> Value # toEncodingList :: [KernelSpec] -> Encoding #

KernelInfoReplyMessage
KernelInfoRequestMessage
ExecuteInputMessage
ExecuteReplyMessage
ExecuteErrorMessage
ExecuteRequestMessage
ExecuteResultMessage
StatusMessage
StreamMessage
DisplayDataMessage
OutputMessage
InputMessage
IsCompleteRequestMessage
IsCompleteReplyMessage
CompleteRequestMessage
CompleteReplyMessage
InspectRequestMessage
InspectReplyMessage
ShutdownRequestMessage
ShutdownReplyMessage
ClearOutputMessage
InputRequestMessage
InputReplyMessage
CommOpenMessage
CommDataMessage
CommInfoRequestMessage
CommInfoReplyMessage
CommCloseMessage
HistoryRequestMessage
HistoryReplyMessage

Eq Widget #
Methods (==) :: Widget -> Widget -> Bool # (/=) :: Widget -> Widget -> Bool #
Show Widget #
Methods showsPrec :: Int -> Widget -> ShowS # show :: Widget -> String # showList :: [Widget] -> ShowS #
IHaskellWidget Widget #
Methods targetName :: Widget -> String # targetModule :: Widget -> String # getCommUUID :: Widget -> UUID # open :: Widget -> (Value -> IO ()) -> IO () # comm :: Widget -> Value -> (Value -> IO ()) -> IO () # close :: Widget -> Value -> IO () #
IHaskellDisplay Widget #
Methods display :: Widget -> IO Display #