Safe Haskell	None
Language	Haskell2010

Language.Javascript.JSaddle.Types

Contents

JavaScript Context
The JSM Monad
JavaScript Value Types
JavaScript Context Commands

Description

Synopsis

JavaScript Context

data JSContextRef Source #

Identifies a JavaScript execution context. When using GHCJS this is just '()' since their is only one context. When using GHC it includes the functions JSaddle needs to communicate with the JavaScript context.

Constructors

JSContextRef
Fields startTime :: UTCTime doSendCommand :: Command -> IO Result doSendAsyncCommand :: AsyncCommand -> IO () addCallback :: Object -> JSCallAsFunction -> IO () freeCallback :: Object -> IO () nextRef :: TVar JSValueRef

The JSM Monad

newtype JSM a Source #

The JSM monad keeps track of the JavaScript execution context.

When using GHCJS it is IO.

Given a JSM function and a JSContextRef you can run the function like this...

runJSM jsmFunction javaScriptContext

Constructors

JSM
Fields unJSM :: ReaderT JSContextRef IO a

Instances

Monad JSM Source #
Methods (>>=) :: JSM a -> (a -> JSM b) -> JSM b # (>>) :: JSM a -> JSM b -> JSM b # return :: a -> JSM a # fail :: String -> JSM a #
Functor JSM Source #
Methods fmap :: (a -> b) -> JSM a -> JSM b # (<$) :: a -> JSM b -> JSM a #
MonadFix JSM Source #
Methods mfix :: (a -> JSM a) -> JSM a #
Applicative JSM Source #
Methods pure :: a -> JSM a # (<>) :: JSM (a -> b) -> JSM a -> JSM b # (>) :: JSM a -> JSM b -> JSM b # (<*) :: JSM a -> JSM b -> JSM a #
MonadIO JSM Source #
Methods liftIO :: IO a -> JSM a #
MonadJSM JSM Source #
Methods liftJSM' :: JSM a -> JSM a Source #
MakeArgs arg => MakeArgs (JSM arg) Source #
Methods makeArgs :: JSM arg -> JSM [JSVal] Source #

class (Applicative m, MonadIO m) => MonadJSM m where Source #

The MonadJSM is to JSM what MonadIO is to IO. When using GHCJS it is MonadIO.

Minimal complete definition

liftJSM'

Methods

liftJSM' :: JSM a -> m a Source #

Instances

MonadJSM JSM Source #
Methods liftJSM' :: JSM a -> JSM a Source #
MonadJSM m => MonadJSM (ReaderT * e m) Source #
Methods liftJSM' :: JSM a -> ReaderT * e m a Source #

liftJSM :: MonadJSM m => JSM a -> m a Source #

The liftJSM is to JSM what liftIO is to IO. When using GHCJS it is liftIO.

JavaScript Value Types

newtype JSVal Source #

See JSVal

Constructors

JSVal JSValueRef

Instances

Show JSVal Source #
Methods showsPrec :: Int -> JSVal -> ShowS # show :: JSVal -> String # showList :: [JSVal] -> ShowS #
ToJSON JSVal Source #
Methods toJSON :: JSVal -> Value # toEncoding :: JSVal -> Encoding # toJSONList :: [JSVal] -> Value # toEncodingList :: [JSVal] -> Encoding #
FromJSON JSVal Source #
Methods parseJSON :: Value -> Parser JSVal # parseJSONList :: Value -> Parser [JSVal] #

newtype MutableJSArray Source #

See MutableJSArray

Constructors

MutableJSArray JSValueRef

Instances

Show MutableJSArray Source #
Methods showsPrec :: Int -> MutableJSArray -> ShowS # show :: MutableJSArray -> String # showList :: [MutableJSArray] -> ShowS #
ToJSON MutableJSArray Source #
Methods toJSON :: MutableJSArray -> Value # toEncoding :: MutableJSArray -> Encoding # toJSONList :: [MutableJSArray] -> Value # toEncodingList :: [MutableJSArray] -> Encoding #
FromJSON MutableJSArray Source #
Methods parseJSON :: Value -> Parser MutableJSArray # parseJSONList :: Value -> Parser [MutableJSArray] #

newtype Object Source #

See Object

Constructors

Object JSVal

Instances

Show Object Source #
Methods showsPrec :: Int -> Object -> ShowS # show :: Object -> String # showList :: [Object] -> ShowS #
ToJSON Object Source #
Methods toJSON :: Object -> Value # toEncoding :: Object -> Encoding # toJSONList :: [Object] -> Value # toEncodingList :: [Object] -> Encoding #
FromJSON Object Source #
Methods parseJSON :: Value -> Parser Object # parseJSONList :: Value -> Parser [Object] #
MakeObject Object Source #	If we already have a Object we are fine
Methods makeObject :: Object -> JSM Object Source #
ToJSVal Object Source #
Methods toJSVal :: Object -> JSM JSVal Source #

newtype JSString Source #

See Type

Constructors

JSString Text

Instances

Show JSString Source #
Methods showsPrec :: Int -> JSString -> ShowS # show :: JSString -> String # showList :: [JSString] -> ShowS #
ToJSON JSString Source #
Methods toJSON :: JSString -> Value # toEncoding :: JSString -> Encoding # toJSONList :: [JSString] -> Value # toEncodingList :: [JSString] -> Encoding #
FromJSON JSString Source #
Methods parseJSON :: Value -> Parser JSString # parseJSONList :: Value -> Parser [JSString] #

newtype Nullable a Source #

See Nullable

Constructors

Nullable a

type JSCallAsFunction Source #

Arguments

= JSVal	Function object
-> JSVal	this
-> [JSVal]	Function arguments
-> JSM ()	Only () (aka `JSUndefined`) can be returned because the function may need to be executed in a different thread. If you need to get a value out pass in a continuation function as an argument and invoke it from haskell.

Type used for Haskell functions called from JavaScript.

JavaScript Context Commands

newtype JSValueReceived Source #

Wrapper used when receiving a JSVal from the JavaScript context

Constructors

JSValueReceived JSValueRef

Instances

Show JSValueReceived Source #
Methods showsPrec :: Int -> JSValueReceived -> ShowS # show :: JSValueReceived -> String # showList :: [JSValueReceived] -> ShowS #
ToJSON JSValueReceived Source #
Methods toJSON :: JSValueReceived -> Value # toEncoding :: JSValueReceived -> Encoding # toJSONList :: [JSValueReceived] -> Value # toEncodingList :: [JSValueReceived] -> Encoding #
FromJSON JSValueReceived Source #
Methods parseJSON :: Value -> Parser JSValueReceived # parseJSONList :: Value -> Parser [JSValueReceived] #

newtype JSValueForSend Source #

Wrapper used when sending a JSVal to the JavaScript context

Constructors

JSValueForSend JSValueRef

Instances

Show JSValueForSend Source #
Methods showsPrec :: Int -> JSValueForSend -> ShowS # show :: JSValueForSend -> String # showList :: [JSValueForSend] -> ShowS #
ToJSON JSValueForSend Source #
Methods toJSON :: JSValueForSend -> Value # toEncoding :: JSValueForSend -> Encoding # toJSONList :: [JSValueForSend] -> Value # toEncodingList :: [JSValueForSend] -> Encoding #
FromJSON JSValueForSend Source #
Methods parseJSON :: Value -> Parser JSValueForSend # parseJSONList :: Value -> Parser [JSValueForSend] #

newtype JSStringReceived Source #

Wrapper used when receiving a JSString from the JavaScript context

Constructors

JSStringReceived Text

Instances

Show JSStringReceived Source #
Methods showsPrec :: Int -> JSStringReceived -> ShowS # show :: JSStringReceived -> String # showList :: [JSStringReceived] -> ShowS #
ToJSON JSStringReceived Source #
Methods toJSON :: JSStringReceived -> Value # toEncoding :: JSStringReceived -> Encoding # toJSONList :: [JSStringReceived] -> Value # toEncodingList :: [JSStringReceived] -> Encoding #
FromJSON JSStringReceived Source #
Methods parseJSON :: Value -> Parser JSStringReceived # parseJSONList :: Value -> Parser [JSStringReceived] #

newtype JSStringForSend Source #

Wrapper used when sending a JString to the JavaScript context

Constructors

JSStringForSend Text

Instances

Show JSStringForSend Source #
Methods showsPrec :: Int -> JSStringForSend -> ShowS # show :: JSStringForSend -> String # showList :: [JSStringForSend] -> ShowS #
ToJSON JSStringForSend Source #
Methods toJSON :: JSStringForSend -> Value # toEncoding :: JSStringForSend -> Encoding # toJSONList :: [JSStringForSend] -> Value # toEncodingList :: [JSStringForSend] -> Encoding #
FromJSON JSStringForSend Source #
Methods parseJSON :: Value -> Parser JSStringForSend # parseJSONList :: Value -> Parser [JSStringForSend] #

newtype JSObjectForSend Source #

Wrapper used when sending a Object to the JavaScript context

Constructors

JSObjectForSend JSValueForSend

Instances

Show JSObjectForSend Source #
Methods showsPrec :: Int -> JSObjectForSend -> ShowS # show :: JSObjectForSend -> String # showList :: [JSObjectForSend] -> ShowS #
ToJSON JSObjectForSend Source #
Methods toJSON :: JSObjectForSend -> Value # toEncoding :: JSObjectForSend -> Encoding # toJSONList :: [JSObjectForSend] -> Value # toEncodingList :: [JSObjectForSend] -> Encoding #
FromJSON JSObjectForSend Source #
Methods parseJSON :: Value -> Parser JSObjectForSend # parseJSONList :: Value -> Parser [JSObjectForSend] #

data AsyncCommand Source #

Command sent to a JavaScript context for execution asynchronously

Instances

Show AsyncCommand Source #
Methods showsPrec :: Int -> AsyncCommand -> ShowS # show :: AsyncCommand -> String # showList :: [AsyncCommand] -> ShowS #
Generic AsyncCommand Source #
Associated Types type Rep AsyncCommand :: * -> * # Methods from :: AsyncCommand -> Rep AsyncCommand x # to :: Rep AsyncCommand x -> AsyncCommand #
ToJSON AsyncCommand Source #
Methods toJSON :: AsyncCommand -> Value # toEncoding :: AsyncCommand -> Encoding # toJSONList :: [AsyncCommand] -> Value # toEncodingList :: [AsyncCommand] -> Encoding #
FromJSON AsyncCommand Source #
Methods parseJSON :: Value -> Parser AsyncCommand # parseJSONList :: Value -> Parser [AsyncCommand] #
type Rep AsyncCommand Source #
type Rep AsyncCommand = D1 (MetaData "AsyncCommand" "Language.Javascript.JSaddle.Types" "jsaddle-0.5.1.0-9MWZA7Wz8qdIZLURWC6nfM" False) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "FreeRef" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend))) ((:+:) (C1 (MetaCons "SetPropertyByName" PrefixI False) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSObjectForSend)) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSStringForSend)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend))))) (C1 (MetaCons "SetPropertyAtIndex" PrefixI False) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSObjectForSend)) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend))))))) ((:+:) ((:+:) (C1 (MetaCons "StringToValue" PrefixI False) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSStringForSend)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend)))) (C1 (MetaCons "NumberToValue" PrefixI False) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Double)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend))))) ((:+:) (C1 (MetaCons "GetPropertyByName" PrefixI False) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSObjectForSend)) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSStringForSend)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend))))) (C1 (MetaCons "GetPropertyAtIndex" PrefixI False) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSObjectForSend)) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend)))))))) ((:+:) ((:+:) (C1 (MetaCons "CallAsFunction" PrefixI False) ((::) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSObjectForSend)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSObjectForSend))) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [JSValueForSend])) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend))))) ((:+:) (C1 (MetaCons "CallAsConstructor" PrefixI False) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSObjectForSend)) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [JSValueForSend])) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend))))) (C1 (MetaCons "NewEmptyObject" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend))))) ((:+:) ((:+:) (C1 (MetaCons "NewCallback" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend))) (C1 (MetaCons "NewArray" PrefixI False) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [JSValueForSend])) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend))))) ((:+:) (C1 (MetaCons "EvaluateScript" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSStringForSend)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend)))) (C1 (MetaCons "SyncWithAnimationFrame" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend)))))))

data Command Source #

Command sent to a JavaScript context for execution synchronously

Instances

Show Command Source #
Methods showsPrec :: Int -> Command -> ShowS # show :: Command -> String # showList :: [Command] -> ShowS #
Generic Command Source #
Associated Types type Rep Command :: * -> * # Methods from :: Command -> Rep Command x # to :: Rep Command x -> Command #
ToJSON Command Source #
Methods toJSON :: Command -> Value # toEncoding :: Command -> Encoding # toJSONList :: [Command] -> Value # toEncodingList :: [Command] -> Encoding #
FromJSON Command Source #
Methods parseJSON :: Value -> Parser Command # parseJSONList :: Value -> Parser [Command] #
type Rep Command Source #
type Rep Command = D1 (MetaData "Command" "Language.Javascript.JSaddle.Types" "jsaddle-0.5.1.0-9MWZA7Wz8qdIZLURWC6nfM" False) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "DeRefVal" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend))) (C1 (MetaCons "ValueToBool" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend)))) ((:+:) (C1 (MetaCons "ValueToNumber" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend))) ((:+:) (C1 (MetaCons "ValueToString" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend))) (C1 (MetaCons "ValueToJSON" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend)))))) ((:+:) ((:+:) (C1 (MetaCons "IsNull" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend))) ((:+:) (C1 (MetaCons "IsUndefined" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend))) (C1 (MetaCons "StrictEqual" PrefixI False) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend)))))) ((:+:) (C1 (MetaCons "InstanceOf" PrefixI False) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSValueForSend)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSObjectForSend)))) ((:+:) (C1 (MetaCons "PropertyNames" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSObjectForSend))) (C1 (MetaCons "Sync" PrefixI False) U1)))))

data Batch Source #

Batch of commands that can be sent together to the JavaScript context

Constructors

Batch [AsyncCommand] Command Bool

Instances

Show Batch Source #
Methods showsPrec :: Int -> Batch -> ShowS # show :: Batch -> String # showList :: [Batch] -> ShowS #
Generic Batch Source #
Associated Types type Rep Batch :: * -> * # Methods from :: Batch -> Rep Batch x # to :: Rep Batch x -> Batch #
ToJSON Batch Source #
Methods toJSON :: Batch -> Value # toEncoding :: Batch -> Encoding # toJSONList :: [Batch] -> Value # toEncodingList :: [Batch] -> Encoding #
FromJSON Batch Source #
Methods parseJSON :: Value -> Parser Batch # parseJSONList :: Value -> Parser [Batch] #
type Rep Batch Source #
type Rep Batch = D1 (MetaData "Batch" "Language.Javascript.JSaddle.Types" "jsaddle-0.5.1.0-9MWZA7Wz8qdIZLURWC6nfM" False) (C1 (MetaCons "Batch" PrefixI False) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [AsyncCommand])) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Command)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))))

data Result Source #

Result of a Command returned from the JavaScript context

Instances

Show Result Source #
Methods showsPrec :: Int -> Result -> ShowS # show :: Result -> String # showList :: [Result] -> ShowS #
Generic Result Source #
Associated Types type Rep Result :: * -> * # Methods from :: Result -> Rep Result x # to :: Rep Result x -> Result #
ToJSON Result Source #
Methods toJSON :: Result -> Value # toEncoding :: Result -> Encoding # toJSONList :: [Result] -> Value # toEncodingList :: [Result] -> Encoding #
FromJSON Result Source #
Methods parseJSON :: Value -> Parser Result # parseJSONList :: Value -> Parser [Result] #
type Rep Result Source #
type Rep Result

FreeRef JSValueForSend
SetPropertyByName JSObjectForSend JSStringForSend JSValueForSend
SetPropertyAtIndex JSObjectForSend Int JSValueForSend
StringToValue JSStringForSend JSValueForSend
NumberToValue Double JSValueForSend
GetPropertyByName JSObjectForSend JSStringForSend JSValueForSend
GetPropertyAtIndex JSObjectForSend Int JSValueForSend
CallAsFunction JSObjectForSend JSObjectForSend [JSValueForSend] JSValueForSend
CallAsConstructor JSObjectForSend [JSValueForSend] JSValueForSend
NewEmptyObject JSValueForSend
NewCallback JSValueForSend
NewArray [JSValueForSend] JSValueForSend
EvaluateScript JSStringForSend JSValueForSend
SyncWithAnimationFrame JSValueForSend

DeRefVal JSValueForSend
ValueToBool JSValueForSend
ValueToNumber JSValueForSend
ValueToString JSValueForSend
ValueToJSON JSValueForSend
IsNull JSValueForSend
IsUndefined JSValueForSend
StrictEqual JSValueForSend JSValueForSend
InstanceOf JSValueForSend JSObjectForSend
PropertyNames JSObjectForSend
Sync

DeRefValResult JSValueRef Text
ValueToBoolResult Bool
ValueToNumberResult Double
ValueToStringResult JSStringReceived
ValueToJSONResult JSStringReceived
IsNullResult Bool
IsUndefinedResult Bool
StrictEqualResult Bool
InstanceOfResult Bool
Callback JSValueReceived JSValueReceived [JSValueReceived]
PropertyNamesResult [JSStringReceived]
ThrowJSValue JSValueReceived
ProtocolError Text
SyncResult