GI.JavaScriptCore.Objects.Context

JSCContext represents a JavaScript execution context, where all operations take place and where the values will be associated.

When a new context is created, a global object is allocated and the built-in JavaScript objects (Object, Function, String, Array) are populated. You can execute JavaScript in the context by using contextEvaluate or contextEvaluateWithSourceUri. It's also possible to register custom objects in the context with contextRegisterClass.

Exported types

newtype Context

Memory-managed wrapper type.

Constructors

Context (ManagedPtr Context)

Instances

Eq Context

Defined in GI.JavaScriptCore.Objects.Context

Methods

(==) :: Context -> Context -> Bool

(/=) :: Context -> Context -> Bool

GObject Context

Defined in GI.JavaScriptCore.Objects.Context

ManagedPtrNewtype Context

Defined in GI.JavaScriptCore.Objects.Context

Methods

toManagedPtr :: Context -> ManagedPtr Context

TypedObject Context

Defined in GI.JavaScriptCore.Objects.Context

Methods

glibType :: IO GType

HasParentTypes Context

Defined in GI.JavaScriptCore.Objects.Context

IsGValue (Maybe Context)

Convert Context to and from GValue. See toGValue and fromGValue.

Defined in GI.JavaScriptCore.Objects.Context

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Context -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Context)

type ParentTypes Context

Defined in GI.JavaScriptCore.Objects.Context

type ParentTypes Context = '[Object]

class (GObject o, IsDescendantOf Context o) => IsContext o

Type class for types which can be safely cast to Context, for instance with toContext.

Instances

(GObject o, IsDescendantOf Context o) => IsContext o

Defined in GI.JavaScriptCore.Objects.Context

toContext :: (MonadIO m, IsContext o) => o -> m Context

Cast to Context, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, checkSyntax, clearException, evaluate, evaluateInObject, evaluateWithSourceUri, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, popExceptionHandler, pushExceptionHandler, ref, refSink, registerClass, runDispose, stealData, stealQdata, thawNotify, throw, throwException, throwWithName, unref, watchClosure.

Getters

getData, getException, getGlobalObject, getProperty, getQdata, getValue, getVirtualMachine.

Setters

setData, setDataFull, setProperty, setValue.

checkSyntax

contextCheckSyntax

Arguments

:: (HasCallStack, MonadIO m, IsContext a)

=> a

context: a Context

-> Text

code: a JavaScript script to check

-> Int64

length: length of code, or -1 if code is a nul-terminated string

-> CheckSyntaxMode

mode: a CheckSyntaxMode

-> Text

uri: the source URI

-> Word32

lineNumber: the starting line number

-> m (CheckSyntaxResult, Exception)

Returns: a CheckSyntaxResult

Check the given code in context for syntax errors. The lineNumber is the starting line number in uri; the value is one-based so the first line is 1. uri and lineNumber are only used to fill the exception. In case of errors exception will be set to a new Exception with the details. You can pass Nothing to exception to ignore the error details.

clearException

contextClearException

Arguments

:: (HasCallStack, MonadIO m, IsContext a)

=> a

context: a Context

-> m ()

Clear the uncaught exception in context if any.

evaluate

contextEvaluate

Arguments

:: (HasCallStack, MonadIO m, IsContext a)

=> a

context: a Context

-> Text

code: a JavaScript script to evaluate

-> Int64

length: length of code, or -1 if code is a nul-terminated string

-> m Value

Returns: a Value representing the last value generated by the script.

Evaluate code in context.

evaluateInObject

contextEvaluateInObject

Arguments

:: (HasCallStack, MonadIO m, IsContext a, IsClass b)

=> a

context: a Context

-> Text

code: a JavaScript script to evaluate

-> Int64

length: length of code, or -1 if code is a nul-terminated string

-> Ptr ()

objectInstance: an object instance

-> Maybe b

objectClass: a Class or Nothing to use the default

-> Text

uri: the source URI

-> Word32

lineNumber: the starting line number

-> m (Value, Value)

Returns: a Value representing the last value generated by the script.

Evaluate code and create an new object where symbols defined in code will be added as properties, instead of being added to context global object. The new object is returned as object parameter. Similar to how valueNewObject works, if objectInstance is not Nothing objectClass must be provided too. The lineNumber is the starting line number in uri; the value is one-based so the first line is 1. uri and lineNumber will be shown in exceptions and they don't affect the behavior of the script.

evaluateWithSourceUri

contextEvaluateWithSourceUri

Arguments

:: (HasCallStack, MonadIO m, IsContext a)

=> a

context: a Context

-> Text

code: a JavaScript script to evaluate

-> Int64

length: length of code, or -1 if code is a nul-terminated string

-> Text

uri: the source URI

-> Word32

lineNumber: the starting line number

-> m Value

Returns: a Value representing the last value generated by the script.

Evaluate code in context using uri as the source URI. The lineNumber is the starting line number in uri; the value is one-based so the first line is 1. uri and lineNumber will be shown in exceptions and they don't affect the behavior of the script.

getCurrent

contextGetCurrent

Arguments

:: (HasCallStack, MonadIO m)

=> m (Maybe Context)

Returns: the Context that is currently executing.

Get the Context that is currently executing a function. This should only be called within a function or method callback, otherwise Nothing will be returned.

getException

contextGetException

Arguments

:: (HasCallStack, MonadIO m, IsContext a)

=> a

context: a Context

-> m (Maybe Exception)

Returns: a Exception or Nothing if there isn't any unhandled exception in the Context.

Get the last unhandled exception thrown in context by API functions calls.

getGlobalObject

contextGetGlobalObject

Arguments

:: (HasCallStack, MonadIO m, IsContext a)

=> a

context: a Context

-> m Value

Returns: a Value

Get a Value referencing the context global object

getValue

contextGetValue

Arguments

:: (HasCallStack, MonadIO m, IsContext a)

=> a

context: a Context

-> Text

name: the value name

-> m Value

Returns: a Value

Get a property of context global object with name.

getVirtualMachine

contextGetVirtualMachine

Arguments

:: (HasCallStack, MonadIO m, IsContext a)

=> a

context: a Context

-> m VirtualMachine

Returns: the VirtualMachine where the Context was created.

Get the VirtualMachine where context was created.

new

contextNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Context

Returns: the newly created Context.

Create a new Context. The context is created in a new VirtualMachine. Use contextNewWithVirtualMachine to create a new Context in an existing VirtualMachine.

newWithVirtualMachine

contextNewWithVirtualMachine

Arguments

:: (HasCallStack, MonadIO m, IsVirtualMachine a)

=> a

vm: a VirtualMachine

-> m Context

Returns: the newly created Context.

Create a new Context in virtualMachine.

popExceptionHandler

contextPopExceptionHandler

Arguments

:: (HasCallStack, MonadIO m, IsContext a)

=> a

context: a Context

-> m ()

Remove the last ExceptionHandler previously pushed to context with contextPushExceptionHandler.

pushExceptionHandler

contextPushExceptionHandler

Arguments

:: (HasCallStack, MonadIO m, IsContext a)

=> a

context: a Context

-> ExceptionHandler

handler: a ExceptionHandler

-> m ()

Push an exception handler in context. Whenever a JavaScript exception happens in the Context, the given handler will be called. The default ExceptionHandler simply calls contextThrowException to throw the exception to the Context. If you don't want to catch the exception, but only get notified about it, call contextThrowException in handler like the default one does. The last exception handler pushed is the only one used by the Context, use contextPopExceptionHandler to remove it and set the previous one. When handler is removed from the context, destroyNotify i called with userData as parameter.

registerClass

contextRegisterClass

Arguments

:: (HasCallStack, MonadIO m, IsContext a, IsClass b)

=> a

context: a Context

-> Text

name: the class name

-> Maybe b

parentClass: a Class or Nothing

-> Maybe ClassVTable

vtable: an optional ClassVTable or Nothing

-> Maybe DestroyNotify

destroyNotify: a destroy notifier for class instances

-> m Class

Returns: a Class

Register a custom class in context using the given name. If the new class inherits from another Class, the parent should be passed as parentClass, otherwise Nothing should be used. The optional vtable parameter allows to provide a custom implementation for handling the class, for example, to handle external properties not added to the prototype. When an instance of the Class is cleared in the context, destroyNotify is called with the instance as parameter.

setValue

contextSetValue

Arguments

:: (HasCallStack, MonadIO m, IsContext a, IsValue b)

=> a

context: a Context

-> Text

name: the value name

-> b

value: a Value

-> m ()

Set a property of context global object with name and value.

throw

contextThrow

Arguments

:: (HasCallStack, MonadIO m, IsContext a)

=> a

context: a Context

-> Text

errorMessage: an error message

-> m ()

Throw an exception to context using the given error message. The created Exception can be retrieved with contextGetException.

throwException

contextThrowException

Arguments

:: (HasCallStack, MonadIO m, IsContext a, IsException b)

=> a

context: a Context

-> b

exception: a Exception

-> m ()

Throw exception to context.

throwWithName

contextThrowWithName

Arguments

:: (HasCallStack, MonadIO m, IsContext a)

=> a

context: a Context

-> Text

errorName: the error name

-> Text

errorMessage: an error message

-> m ()

Throw an exception to context using the given error name and message. The created Exception can be retrieved with contextGetException.

Properties

virtualMachine

The VirtualMachine in which the context was created.

constructContextVirtualMachine :: (IsContext o, MonadIO m, IsVirtualMachine a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “virtual-machine” property. This is rarely needed directly, but it is used by new.

getContextVirtualMachine :: (MonadIO m, IsContext o) => o -> m VirtualMachine

Get the value of the “virtual-machine” property. When overloading is enabled, this is equivalent to

get context #virtualMachine