Language.Javascript.JSaddle.Types

JavaScript Context

data JSContextRef

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

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

Methods

(>>=) :: JSM a -> (a -> JSM b) -> JSM b

(>>) :: JSM a -> JSM b -> JSM b

return :: a -> JSM a

fail :: String -> JSM a

Functor JSM

Methods

fmap :: (a -> b) -> JSM a -> JSM b

(<$) :: a -> JSM b -> JSM a

MonadFix JSM

Methods

mfix :: (a -> JSM a) -> JSM a

Applicative JSM

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

Methods

liftIO :: IO a -> JSM a

MonadRef JSM

Associated Types

type Ref (JSM :: * -> *) :: * -> *

Methods

newRef :: a -> JSM (Ref JSM a)

readRef :: Ref JSM a -> JSM a

writeRef :: Ref JSM a -> a -> JSM ()

modifyRef :: Ref JSM a -> (a -> a) -> JSM ()

modifyRef' :: Ref JSM a -> (a -> a) -> JSM ()

MonadAtomicRef JSM

Methods

atomicModifyRef :: Ref JSM a -> (a -> (a, b)) -> JSM b

atomicModifyRef' :: Ref JSM a -> (a -> (a, b)) -> JSM b

MonadJSM JSM

Methods

liftJSM' :: JSM a -> JSM a

MakeArgs arg => MakeArgs (JSM arg)

Methods

makeArgs :: JSM arg -> JSM [JSVal]

type Ref JSM

type Ref JSM = Ref IO

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

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

Instances

MonadJSM JSM

Methods

liftJSM' :: JSM a -> JSM a

MonadJSM m => MonadJSM (StateT r m)

Methods

liftJSM' :: JSM a -> StateT r m a

MonadJSM m => MonadJSM (StateT r m)

Methods

liftJSM' :: JSM a -> StateT r m a

MonadJSM m => MonadJSM (ReaderT * e m)

Methods

liftJSM' :: JSM a -> ReaderT * e m a

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

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

JavaScript Value Types

newtype JSVal

See JSVal

Constructors

JSVal JSValueRef

Instances

Show JSVal

Methods

showsPrec :: Int -> JSVal -> ShowS

show :: JSVal -> String

showList :: [JSVal] -> ShowS

ToJSON JSVal

Methods

toJSON :: JSVal -> Value

toEncoding :: JSVal -> Encoding

toJSONList :: [JSVal] -> Value

toEncodingList :: [JSVal] -> Encoding

FromJSON JSVal

Methods

parseJSON :: Value -> Parser JSVal

parseJSONList :: Value -> Parser [JSVal]

NFData JSVal

Methods

rnf :: JSVal -> ()

newtype SomeJSArray m

Constructors

SomeJSArray JSVal

type JSArray = SomeJSArray Immutable

See JSArray

type MutableJSArray = SomeJSArray Mutable

See MutableJSArray

newtype Object

See Object

Constructors

Object JSVal

Instances

Show Object

Methods

showsPrec :: Int -> Object -> ShowS

show :: Object -> String

showList :: [Object] -> ShowS

ToJSON Object

Methods

toJSON :: Object -> Value

toEncoding :: Object -> Encoding

toJSONList :: [Object] -> Value

toEncodingList :: [Object] -> Encoding

FromJSON Object

Methods

parseJSON :: Value -> Parser Object

parseJSONList :: Value -> Parser [Object]

MakeObject Object

If we already have a Object we are fine

Methods

makeObject :: Object -> JSM Object

newtype JSString

See Type

Constructors

JSString Text

Instances

Show JSString

Methods

showsPrec :: Int -> JSString -> ShowS

show :: JSString -> String

showList :: [JSString] -> ShowS

ToJSON JSString

Methods

toJSON :: JSString -> Value

toEncoding :: JSString -> Encoding

toJSONList :: [JSString] -> Value

toEncodingList :: [JSString] -> Encoding

FromJSON JSString

Methods

parseJSON :: Value -> Parser JSString

parseJSONList :: Value -> Parser [JSString]

newtype Nullable a

See Nullable

Constructors

Nullable a

type JSCallAsFunction

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

Wrapper used when receiving a JSVal from the JavaScript context

Constructors

JSValueReceived JSValueRef

Instances

Show JSValueReceived

Methods

showsPrec :: Int -> JSValueReceived -> ShowS

show :: JSValueReceived -> String

showList :: [JSValueReceived] -> ShowS

ToJSON JSValueReceived

Methods

toJSON :: JSValueReceived -> Value

toEncoding :: JSValueReceived -> Encoding

toJSONList :: [JSValueReceived] -> Value

toEncodingList :: [JSValueReceived] -> Encoding

FromJSON JSValueReceived

Methods

parseJSON :: Value -> Parser JSValueReceived

parseJSONList :: Value -> Parser [JSValueReceived]

newtype JSValueForSend

Wrapper used when sending a JSVal to the JavaScript context

Constructors

JSValueForSend JSValueRef

Instances

Show JSValueForSend

Methods

showsPrec :: Int -> JSValueForSend -> ShowS

show :: JSValueForSend -> String

showList :: [JSValueForSend] -> ShowS

ToJSON JSValueForSend

Methods

toJSON :: JSValueForSend -> Value

toEncoding :: JSValueForSend -> Encoding

toJSONList :: [JSValueForSend] -> Value

toEncodingList :: [JSValueForSend] -> Encoding

FromJSON JSValueForSend

Methods

parseJSON :: Value -> Parser JSValueForSend

parseJSONList :: Value -> Parser [JSValueForSend]

newtype JSStringReceived

Wrapper used when receiving a JSString from the JavaScript context

Constructors

JSStringReceived Text

Instances

Show JSStringReceived

Methods

showsPrec :: Int -> JSStringReceived -> ShowS

show :: JSStringReceived -> String

showList :: [JSStringReceived] -> ShowS

ToJSON JSStringReceived

Methods

toJSON :: JSStringReceived -> Value

toEncoding :: JSStringReceived -> Encoding

toJSONList :: [JSStringReceived] -> Value

toEncodingList :: [JSStringReceived] -> Encoding

FromJSON JSStringReceived

Methods

parseJSON :: Value -> Parser JSStringReceived

parseJSONList :: Value -> Parser [JSStringReceived]

newtype JSStringForSend

Wrapper used when sending a JString to the JavaScript context

Constructors

JSStringForSend Text

Instances

Show JSStringForSend

Methods

showsPrec :: Int -> JSStringForSend -> ShowS

show :: JSStringForSend -> String

showList :: [JSStringForSend] -> ShowS

ToJSON JSStringForSend

Methods

toJSON :: JSStringForSend -> Value

toEncoding :: JSStringForSend -> Encoding

toJSONList :: [JSStringForSend] -> Value

toEncodingList :: [JSStringForSend] -> Encoding

FromJSON JSStringForSend

Methods

parseJSON :: Value -> Parser JSStringForSend

parseJSONList :: Value -> Parser [JSStringForSend]

newtype JSObjectForSend

Wrapper used when sending a Object to the JavaScript context

Constructors

JSObjectForSend JSValueForSend

Instances

Show JSObjectForSend

Methods

showsPrec :: Int -> JSObjectForSend -> ShowS

show :: JSObjectForSend -> String

showList :: [JSObjectForSend] -> ShowS

ToJSON JSObjectForSend

Methods

toJSON :: JSObjectForSend -> Value

toEncoding :: JSObjectForSend -> Encoding

toJSONList :: [JSObjectForSend] -> Value

toEncodingList :: [JSObjectForSend] -> Encoding

FromJSON JSObjectForSend

Methods

parseJSON :: Value -> Parser JSObjectForSend

parseJSONList :: Value -> Parser [JSObjectForSend]

data AsyncCommand

Command sent to a JavaScript context for execution asynchronously

Constructors

FreeRef JSValueForSend

SetPropertyByName JSObjectForSend JSStringForSend JSValueForSend

SetPropertyAtIndex JSObjectForSend Int JSValueForSend

StringToValue JSStringForSend JSValueForSend

NumberToValue Double JSValueForSend

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

Instances

Show AsyncCommand

Methods

showsPrec :: Int -> AsyncCommand -> ShowS

show :: AsyncCommand -> String

showList :: [AsyncCommand] -> ShowS

Generic AsyncCommand

Associated Types

type Rep AsyncCommand :: * -> *

Methods

from :: AsyncCommand -> Rep AsyncCommand x

to :: Rep AsyncCommand x -> AsyncCommand

ToJSON AsyncCommand

Methods

toJSON :: AsyncCommand -> Value

toEncoding :: AsyncCommand -> Encoding

toJSONList :: [AsyncCommand] -> Value

toEncodingList :: [AsyncCommand] -> Encoding

FromJSON AsyncCommand

Methods

parseJSON :: Value -> Parser AsyncCommand

parseJSONList :: Value -> Parser [AsyncCommand]

type Rep AsyncCommand

type Rep AsyncCommand = D1 (MetaData "AsyncCommand" "Language.Javascript.JSaddle.Types" "jsaddle-0.7.0.0-5XKPQBKn8wZLUoUmTm2fAn" 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 "JSONValueToValue" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Value)) (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

Command sent to a JavaScript context for execution synchronously

Constructors

DeRefVal JSValueForSend

ValueToBool JSValueForSend

ValueToNumber JSValueForSend

ValueToString JSValueForSend

ValueToJSON JSValueForSend

ValueToJSONValue JSValueForSend

IsNull JSValueForSend

IsUndefined JSValueForSend

StrictEqual JSValueForSend JSValueForSend

InstanceOf JSValueForSend JSObjectForSend

PropertyNames JSObjectForSend

Sync

Instances

Show Command

Methods

showsPrec :: Int -> Command -> ShowS

show :: Command -> String

showList :: [Command] -> ShowS

Generic Command

Associated Types

type Rep Command :: * -> *

Methods

from :: Command -> Rep Command x

to :: Rep Command x -> Command

ToJSON Command

Methods

toJSON :: Command -> Value

toEncoding :: Command -> Encoding

toJSONList :: [Command] -> Value

toEncodingList :: [Command] -> Encoding

FromJSON Command

Methods

parseJSON :: Value -> Parser Command

parseJSONList :: Value -> Parser [Command]

type Rep Command

type Rep Command = D1 (MetaData "Command" "Language.Javascript.JSaddle.Types" "jsaddle-0.7.0.0-5XKPQBKn8wZLUoUmTm2fAn" 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 "ValueToJSONValue" 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

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

Constructors

Batch [AsyncCommand] Command Bool

Instances

Show Batch

Methods

showsPrec :: Int -> Batch -> ShowS

show :: Batch -> String

showList :: [Batch] -> ShowS

Generic Batch

Associated Types

type Rep Batch :: * -> *

Methods

from :: Batch -> Rep Batch x

to :: Rep Batch x -> Batch

ToJSON Batch

Methods

toJSON :: Batch -> Value

toEncoding :: Batch -> Encoding

toJSONList :: [Batch] -> Value

toEncodingList :: [Batch] -> Encoding

FromJSON Batch

Methods

parseJSON :: Value -> Parser Batch

parseJSONList :: Value -> Parser [Batch]

type Rep Batch

type Rep Batch = D1 (MetaData "Batch" "Language.Javascript.JSaddle.Types" "jsaddle-0.7.0.0-5XKPQBKn8wZLUoUmTm2fAn" 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

Result of a Command returned from the JavaScript context

Constructors

DeRefValResult JSValueRef Text

ValueToBoolResult Bool

ValueToNumberResult Double

ValueToStringResult JSStringReceived

ValueToJSONResult JSStringReceived

ValueToJSONValueResult Value

IsNullResult Bool

IsUndefinedResult Bool

StrictEqualResult Bool

InstanceOfResult Bool

Callback JSValueReceived JSValueReceived [JSValueReceived]

PropertyNamesResult [JSStringReceived]

ThrowJSValue JSValueReceived

ProtocolError Text

SyncResult

Instances

Show Result

Methods

showsPrec :: Int -> Result -> ShowS

show :: Result -> String

showList :: [Result] -> ShowS

Generic Result

Associated Types

type Rep Result :: * -> *

Methods

from :: Result -> Rep Result x

to :: Rep Result x -> Result

ToJSON Result

Methods

toJSON :: Result -> Value

toEncoding :: Result -> Encoding

toJSONList :: [Result] -> Value

toEncodingList :: [Result] -> Encoding

FromJSON Result

Methods

parseJSON :: Value -> Parser Result

parseJSONList :: Value -> Parser [Result]

type Rep Result

type Rep Result