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 javascriptcore.context.Context.evaluate or javascriptcore.context.Context.evaluateWithSourceUri. It's also possible to register custom objects in the context with javascriptcore.context.Context.registerClass.

class Context : ObjectG {

this(void* ptr, Flag!"Take" take);

static GType getGType();

GType gType [@property getter];

Context self();

this();

static javascriptcore.context.Context newWithVirtualMachine(javascriptcore.virtual_machine.VirtualMachine vm);

static javascriptcore.context.Context getCurrent();

javascriptcore.types.CheckSyntaxResult checkSyntax(string code, ptrdiff_t length, javascriptcore.types.CheckSyntaxMode mode, string uri, uint lineNumber, javascriptcore.exception.ExceptionJSC exception);

void clearException();

javascriptcore.value.Value evaluate(string code, ptrdiff_t length);

javascriptcore.value.Value evaluateInObject(string code, ptrdiff_t length, void* objectInstance, javascriptcore.class_.Class objectClass, string uri, uint lineNumber, javascriptcore.value.Value object);

javascriptcore.value.Value evaluateWithSourceUri(string code, ptrdiff_t length, string uri, uint lineNumber);

javascriptcore.exception.ExceptionJSC getException();

javascriptcore.value.Value getGlobalObject();

javascriptcore.value.Value getValue(string name);

javascriptcore.virtual_machine.VirtualMachine getVirtualMachine();

void popExceptionHandler();

void pushExceptionHandler(javascriptcore.types.ExceptionHandler handler);

javascriptcore.class_.Class registerClass(string name, javascriptcore.class_.Class parentClass, javascriptcore.types.ClassVTable vtable, glib.types.DestroyNotify destroyNotify);

void setValue(string name, javascriptcore.value.Value value);

void throw_(string errorMessage);

void throwException(javascriptcore.exception.ExceptionJSC exception);

void throwWithName(string errorName, string errorMessage);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Create a new #JSCContext. The context is created in a new #JSCVirtualMachine. Use javascriptcore.context.Context.newWithVirtualMachine to create a new #JSCContext in an existing #JSCVirtualMachine.

Members

Functions

checkSyntax javascriptcore.types.CheckSyntaxResult checkSyntax(string code, ptrdiff_t length, javascriptcore.types.CheckSyntaxMode mode, string uri, uint lineNumber, javascriptcore.exception.ExceptionJSC exception): Check the given code in context for syntax errors. The line_number is the starting line number in uri; the value is one-based so the first line is 1. uri and line_number are only used to fill the exception. In case of errors exception will be set to a new #JSCException with the details. You can pass null to exception to ignore the error details.
clearException void clearException(): Clear the uncaught exception in context if any.
evaluate javascriptcore.value.Value evaluate(string code, ptrdiff_t length): Evaluate code in context.
evaluateInObject javascriptcore.value.Value evaluateInObject(string code, ptrdiff_t length, void* objectInstance, javascriptcore.class_.Class objectClass, string uri, uint lineNumber, javascriptcore.value.Value object): 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 javascriptcore.value.Value.newObject works, if object_instance is not null object_class must be provided too. The line_number is the starting line number in uri; the value is one-based so the first line is 1. uri and line_number will be shown in exceptions and they don't affect the behavior of the script.
evaluateWithSourceUri javascriptcore.value.Value evaluateWithSourceUri(string code, ptrdiff_t length, string uri, uint lineNumber): Evaluate code in context using uri as the source URI. The line_number is the starting line number in uri; the value is one-based so the first line is 1. uri and line_number will be shown in exceptions and they don't affect the behavior of the script.
getException javascriptcore.exception.ExceptionJSC getException(): Get the last unhandled exception thrown in context by API functions calls.
getGlobalObject javascriptcore.value.Value getGlobalObject(): Get a #JSCValue referencing the context global object
getValue javascriptcore.value.Value getValue(string name): Get a property of context global object with name.
getVirtualMachine javascriptcore.virtual_machine.VirtualMachine getVirtualMachine(): Get the #JSCVirtualMachine where context was created.
popExceptionHandler void popExceptionHandler(): Remove the last #JSCExceptionHandler previously pushed to context with javascriptcore.context.Context.pushExceptionHandler.
pushExceptionHandler void pushExceptionHandler(javascriptcore.types.ExceptionHandler handler): Push an exception handler in context. Whenever a JavaScript exception happens in the #JSCContext, the given handler will be called. The default #JSCExceptionHandler simply calls javascriptcore.context.Context.throwException to throw the exception to the #JSCContext. If you don't want to catch the exception, but only get notified about it, call javascriptcore.context.Context.throwException in handler like the default one does. The last exception handler pushed is the only one used by the #JSCContext, use javascriptcore.context.Context.popExceptionHandler to remove it and set the previous one. When handler is removed from the context, destroy_notify i called with user_data as parameter.
registerClass javascriptcore.class_.Class registerClass(string name, javascriptcore.class_.Class parentClass, javascriptcore.types.ClassVTable vtable, glib.types.DestroyNotify destroyNotify): Register a custom class in context using the given name. If the new class inherits from another #JSCClass, the parent should be passed as parent_class, otherwise null 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 #JSCClass is cleared in the context, destroy_notify is called with the instance as parameter.
self Context self(): Returns this, for use in with statements.
setValue void setValue(string name, javascriptcore.value.Value value): Set a property of context global object with name and value.
throwException void throwException(javascriptcore.exception.ExceptionJSC exception): Throw exception to context.
throwWithName void throwWithName(string errorName, string errorMessage): Throw an exception to context using the given error name and message. The created #JSCException can be retrieved with javascriptcore.context.Context.getException.
throw_ void throw_(string errorMessage): Throw an exception to context using the given error message. The created #JSCException can be retrieved with javascriptcore.context.Context.getException.

Properties

gType GType gType [@property getter]

Static functions

getCurrent javascriptcore.context.Context getCurrent(): Get the #JSCContext that is currently executing a function. This should only be called within a function or method callback, otherwise null will be returned.
getGType GType getGType()
newWithVirtualMachine javascriptcore.context.Context newWithVirtualMachine(javascriptcore.virtual_machine.VirtualMachine vm): Create a new #JSCContext in virtual_machine.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

javascriptcore context classes

Context