IHaskell.Types

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

versionList :: [Int]

The version of the language, e.g. [7, 6, 3] for GHC 7.6.3

language :: String

The language name, e.g. haskell

ExecuteRequest

A request from a frontend to execute some code.

Fields

header :: MessageHeader

getCode :: Text

The entire block of text where the line is. This may be useful in the case of multiline completions where more context may be needed. Note: if in practice this field proves unnecessary, remove it to lighten the messages. json field block

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 :: String

The help string to show in the pager.

executionCounter :: Int

The execution count, i.e. which output this is.

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 input this is.

Which output this is for.

PublishInput

Fields

header :: MessageHeader

inCode :: String

Submitted input code.

executionCount :: Int

Which input this is.

Which output this is for.

CompleteRequest

Fields

header :: MessageHeader

getCode :: Text

The entire block of text where the line is. This may be useful in the case of multiline completions where more context may be needed. Note: if in practice this field proves unnecessary, remove it to lighten the messages. json field block

The code string.

getCodeLine :: Text

just the line with the cursor. json field line

getCursorPos :: Int

position of the cursor (index into the line?). json field cursor_pos

CompleteReply

Fields

header :: MessageHeader

completionMatches :: [Text]

completionMatchedText :: Text

completionText :: Text

completionStatus :: Bool

ObjectInfoRequest

Fields

header :: MessageHeader

objectName :: Text

Name of object which was searched for.

Name of object being searched for.

detailLevel :: Int

Level of detail desired (defaults to 0). 0 is equivalent to foo?, 1 is equivalent to foo??.

ObjectInfoReply

Fields

header :: MessageHeader

objectName :: Text

Name of object which was searched for.

Name of object being searched for.

objectFound :: Bool

Whether the object was found.

objectTypeString :: Text

Object type.

objectDocString :: Text

ShutdownRequest

Fields

header :: MessageHeader

restartPending :: Bool

Whether this shutdown precedes a restart.

Whether this shutdown precedes a restart.

ShutdownReply

Fields

header :: MessageHeader

restartPending :: Bool

Whether this shutdown precedes a restart.

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

commUuid :: UUID

commData :: Value

CommData

Fields

header :: MessageHeader

commUuid :: UUID

commData :: Value

CommClose

Fields

header :: MessageHeader

commUuid :: UUID

commData :: Value

SendNothing

Instances

Show Message

ToJSON Message

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

Show MessageHeader

ToJSON MessageHeader

data MessageType

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

Constructors

KernelInfoReplyMessage

KernelInfoRequestMessage

ExecuteReplyMessage

ExecuteRequestMessage

StatusMessage

StreamMessage

DisplayDataMessage

OutputMessage

InputMessage

CompleteRequestMessage

CompleteReplyMessage

ObjectInfoRequestMessage

ObjectInfoReplyMessage

ShutdownRequestMessage

ShutdownReplyMessage

ClearOutputMessage

InputRequestMessage

InputReplyMessage

CommOpenMessage

CommDataMessage

CommCloseMessage

Instances

Eq MessageType

Read MessageType

Show MessageType

FromJSON MessageType

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

ToJSON ExecutionState

Print an execution state as busy, idle, or starting.

data StreamType

Input and output streams.

Constructors

Stdin

Stdout

Instances

Show StreamType

ToJSON StreamType

Print a stream as stdin or stdout strings.

data MimeType

Constructors

PlainText

MimeHtml

MimePng Width Height

MimeJpg Width Height

MimeSvg

MimeLatex

MimeJavascript

Instances

Eq MimeType

Show MimeType

Typeable MimeType

Generic MimeType

Serialize MimeType

data DisplayData

Data for display: a string with associated MIME type.

Constructors

DisplayData MimeType Text

Instances

Show DisplayData

Typeable DisplayData

Generic DisplayData

Serialize DisplayData

IHaskellDisplay DisplayData

data EvaluationResult

Output of evaluation.

Constructors

IntermediateResult

An intermediate result which communicates what has been printed thus far.

Fields

outputs :: Display

Display outputs.

Display outputs.

FinalResult

Fields

outputs :: Display

Display outputs.

Display outputs.

pagerOut :: String

Text to display in the IPython pager.

startComms :: [CommInfo]

Comms to start.

data ExecuteReplyStatus

Possible statuses in the execution reply messages.

Constructors

Ok

Err

Abort

Instances

Show ExecuteReplyStatus

data InitInfo

Initialization information for the kernel.

Constructors

InitInfo

Fields

extensions :: [String]

Extensions to enable at start.

initCells :: [String]

Code blocks to run before start.

initDir :: String

Which directory this kernel should pretend to operate in.

frontend :: FrontendType

What frontend this serves.

Instances

Read InitInfo

Show InitInfo

data KernelState

All state stored in the kernel between executions.

Constructors

KernelState

Fields

getExecutionCounter :: Int

getLintStatus :: LintStatus

getFrontend :: FrontendType

useSvg :: Bool

useShowErrors :: Bool

useShowTypes :: Bool

usePager :: Bool

openComms :: Map UUID Widget

Instances

Show KernelState

data LintStatus

Current HLint status.

Constructors

LintOn

LintOff

Instances

Eq LintStatus

Show LintStatus

type Width = Int

Possible MIME types for the display data.

type Height = Int

data FrontendType

Constructors

IPythonConsole

IPythonNotebook

Instances

Eq FrontendType

Read FrontendType

Show FrontendType

data ViewFormat

Constructors

Pdf

Html

Ipynb

Markdown

Latex

Instances

Eq ViewFormat

Read ViewFormat

Show ViewFormat

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

Typeable Display

Generic Display

Monoid Display

Serialize Display

Semigroup Display

IHaskellDisplay 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

Methods

display :: a -> IO Display

Instances

IHaskellDisplay DisplayData

IHaskellDisplay Display

IHaskellDisplay Widget

IHaskellDisplay a => IHaskellDisplay [a]

IHaskellDisplay a => IHaskellDisplay (IO a)

these instances cause the image, html etc. which look like:

 Display
 [Display]
 IO [Display]
 IO (IO Display)

be run the IO and get rendered (if the frontend allows it) in the pretty form.

class IHaskellDisplay a => IHaskellWidget a where

Display as an interactive widget.

Methods

targetName :: a -> String

Output target name for this widget. The actual input parameter should be ignored.

open

Arguments

:: a

Widget to open a comm port with.

-> (Value -> IO ())

Way to respond to the message.

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

Sent data.

-> (Value -> IO ())

Way to respond to the message.

-> IO ()

Respond to a comm data message.

close

Arguments

:: a

Widget to close comm port with.

-> Value

Sent data.

-> IO ()

Close the comm, releasing any resources we might need to.

Instances

IHaskellWidget Widget

data Widget

Constructors

forall a . IHaskellWidget a => Widget a

Instances

Show Widget

Typeable Widget

IHaskellWidget Widget

IHaskellDisplay Widget

data CommInfo

Constructors

CommInfo Widget UUID String