Top |
JSCValue represents a reference to a value in a JSCContext. The JSCValue protects the referenced value from being garbage collected.
JSCContext *
jsc_value_get_context (JSCValue *value
);
Get the JSCContext in which value
was created.
JSCValue *
jsc_value_new_undefined (JSCContext *context
);
Create a new JSCValue referencing undefined
in context
.
gboolean
jsc_value_is_undefined (JSCValue *value
);
Get whether the value referenced by value
is undefined
.
JSCValue *
jsc_value_new_null (JSCContext *context
);
Create a new JSCValue referencing null
in context
.
gboolean
jsc_value_is_null (JSCValue *value
);
Get whether the value referenced by value
is null
.
JSCValue * jsc_value_new_number (JSCContext *context
,double number
);
Create a new JSCValue from number
.
gboolean
jsc_value_is_number (JSCValue *value
);
Get whether the value referenced by value
is a number.
JSCValue * jsc_value_new_boolean (JSCContext *context
,gboolean value
);
Create a new JSCValue from value
gboolean
jsc_value_is_boolean (JSCValue *value
);
Get whether the value referenced by value
is a boolean.
gboolean
jsc_value_to_boolean (JSCValue *value
);
Convert value
to a boolean.
JSCValue * jsc_value_new_string (JSCContext *context
,const char *string
);
Create a new JSCValue from string
. If you need to create a JSCValue from a
string containing null characters, use jsc_value_new_string_from_bytes()
instead.
JSCValue * jsc_value_new_string_from_bytes (JSCContext *context
,GBytes *bytes
);
Create a new JSCValue from bytes
.
gboolean
jsc_value_is_string (JSCValue *value
);
Get whether the value referenced by value
is a string
char *
jsc_value_to_string (JSCValue *value
);
Convert value
to a string. Use jsc_value_to_string_as_bytes()
instead, if you need to
handle strings containing null characters.
GBytes *
jsc_value_to_string_as_bytes (JSCValue *value
);
Convert value
to a string and return the results as GBytes. This is needed
to handle strings with null characters.
JSCValue * jsc_value_new_array (JSCContext *context
,GType first_item_type
,...
);
Create a new JSCValue referencing an array with the given items. If first_item_type
is G_TYPE_NONE
an empty array is created.
[skip]
JSCValue * jsc_value_new_array_from_garray (JSCContext *context
,GPtrArray *array
);
Create a new JSCValue referencing an array with the items from array
. If array
is NULL
or empty a new empty array will be created. Elements of array
should be
pointers to a JSCValue.
JSCValue * jsc_value_new_array_from_strv (JSCContext *context
,const char *const *strv
);
Create a new JSCValue referencing an array of strings with the items from strv
. If array
is NULL
or empty a new empty array will be created.
gboolean
jsc_value_is_array (JSCValue *value
);
Get whether the value referenced by value
is an array.
JSCValue * jsc_value_new_object (JSCContext *context
,gpointer instance
,JSCClass *jsc_class
);
Create a new JSCValue from instance
. If instance
is NULL
a new empty object is created.
When instance
is provided, jsc_class
must be provided too. jsc_class
takes ownership of
instance
that will be freed by the GDestroyNotify passed to jsc_context_register_class()
.
context |
||
instance |
an object instance or |
[nullable][transfer full] |
jsc_class |
the JSCClass of |
[nullable] |
gboolean
jsc_value_is_object (JSCValue *value
);
Get whether the value referenced by value
is an object.
gboolean jsc_value_object_is_instance_of (JSCValue *value
,const char *name
);
Get whether the value referenced by value
is an instance of class name
.
void jsc_value_object_set_property (JSCValue *value
,const char *name
,JSCValue *property
);
Set property
with name
on value
.
JSCValue * jsc_value_object_get_property (JSCValue *value
,const char *name
);
Get property with name
from value
.
void jsc_value_object_set_property_at_index (JSCValue *value
,guint index
,JSCValue *property
);
Set property
at index
on value
.
JSCValue * jsc_value_object_get_property_at_index (JSCValue *value
,guint index
);
Get property at index
from value
.
gboolean jsc_value_object_has_property (JSCValue *value
,const char *name
);
Get whether value
has property with name
.
gboolean jsc_value_object_delete_property (JSCValue *value
,const char *name
);
Try to delete property with name
from value
. This function will return FALSE
if
the property was defined without JSC_VALUE_PROPERTY_CONFIGURABLE
flag.
gchar **
jsc_value_object_enumerate_properties (JSCValue *value
);
Get the list of property names of value
. Only properties defined with JSC_VALUE_PROPERTY_ENUMERABLE
flag will be collected.
JSCValue * jsc_value_object_invoke_method (JSCValue *value
,const char *name
,GType first_parameter_type
,...
);
Invoke method with name
on object referenced by value
, passing the given parameters. If
first_parameter_type
is G_TYPE_NONE
no parameters will be passed to the method.
The object instance will be handled automatically even when the method is a custom one
registered with jsc_class_add_method()
, so it should never be passed explicitly as parameter
of this function.
This function always returns a JSCValue, in case of void methods a JSCValue referencing
undefined
is returned.
[skip]
value |
a JSCValue |
|
name |
the method name |
|
first_parameter_type |
GType of first parameter, or |
|
... |
value of the first parameter, followed optionally by more type/value pairs, followed by |
JSCValue * jsc_value_object_invoke_methodv (JSCValue *value
,const char *name
,guint n_parameters
,JSCValue **parameters
);
Invoke method with name
on object referenced by value
, passing the given parameters
. If
n_parameters
is 0 no parameters will be passed to the method.
The object instance will be handled automatically even when the method is a custom one
registered with jsc_class_add_method()
, so it should never be passed explicitly as parameter
of this function.
This function always returns a JSCValue, in case of void methods a JSCValue referencing
undefined
is returned.
[rename-to jsc_value_object_invoke_method]
void jsc_value_object_define_property_data (JSCValue *value
,const char *property_name
,JSCValuePropertyFlags flags
,JSCValue *property_value
);
Define or modify a property with property_name
in object referenced by value
. This is equivalent to
JavaScript Object.defineProperty()
when used with a data descriptor.
value |
a JSCValue |
|
property_name |
the name of the property to define |
|
flags |
||
property_value |
the default property value. |
[nullable] |
void jsc_value_object_define_property_accessor (JSCValue *value
,const char *property_name
,JSCValuePropertyFlags flags
,GType property_type
,GCallback getter
,GCallback setter
,gpointer user_data
,GDestroyNotify destroy_notify
);
Define or modify a property with property_name
in object referenced by value
. When the
property value needs to be getted or set, getter
and setter
callbacks will be called.
When the property is cleared in the JSCClass context, destroy_notify
is called with
user_data
as parameter. This is equivalent to JavaScript Object.defineProperty()
when used with an accessor descriptor.
Note that the value returned by getter
must be fully transferred. In case of boxed types, you could use
G_TYPE_POINTER
instead of the actual boxed GType to ensure that the instance owned by JSCClass is used.
If you really want to return a new copy of the boxed type, use JSC_TYPE_VALUE and return a JSCValue created
with jsc_value_new_object()
that receives the copy as instance parameter.
Note that getter
and setter
are called as functions and not methods, so they don't receive an instance as
first parameter. Use jsc_class_add_property()
if you want to add property accessor invoked as a method.
value |
a JSCValue |
|
property_name |
the name of the property to define |
|
flags |
||
property_type |
the GType of the property |
|
getter |
a GCallback to be called to get the property value. |
[scope async][nullable] |
setter |
a GCallback to be called to set the property value. |
[scope async][nullable] |
user_data |
user data to pass to |
[closure] |
destroy_notify |
destroy notifier for |
[nullable] |
JSCValue * jsc_value_new_function (JSCContext *context
,const char *name
,GCallback callback
,gpointer user_data
,GDestroyNotify destroy_notify
,GType return_type
,guint n_params
,...
);
Create a function in context
. If name
is NULL
an anonymous function will be created.
When the function is called by JavaScript or jsc_value_function_call()
, callback
is called
receiving the function parameters and then user_data
as last parameter. When the function is
cleared in context
, destroy_notify
is called with user_data
as parameter.
Note that the value returned by callback
must be fully transferred. In case of boxed types, you could use
G_TYPE_POINTER
instead of the actual boxed GType to ensure that the instance owned by JSCClass is used.
If you really want to return a new copy of the boxed type, use JSC_TYPE_VALUE and return a JSCValue created
with jsc_value_new_object()
that receives the copy as instance parameter.
[skip]
context |
a JSCContext: |
|
name |
the function name or |
[nullable] |
callback |
a GCallback. |
[scope async] |
user_data |
user data to pass to |
[closure] |
destroy_notify |
destroy notifier for |
[nullable] |
return_type |
the GType of the function return value, or |
|
n_params |
the number of parameter types to follow or 0 if the function doesn't receive parameters. |
|
... |
a list of GTypes, one for each parameter. |
JSCValue * jsc_value_new_functionv (JSCContext *context
,const char *name
,GCallback callback
,gpointer user_data
,GDestroyNotify destroy_notify
,GType return_type
,guint n_parameters
,GType *parameter_types
);
Create a function in context
. If name
is NULL
an anonymous function will be created.
When the function is called by JavaScript or jsc_value_function_call()
, callback
is called
receiving the function parameters and then user_data
as last parameter. When the function is
cleared in context
, destroy_notify
is called with user_data
as parameter.
Note that the value returned by callback
must be fully transferred. In case of boxed types, you could use
G_TYPE_POINTER
instead of the actual boxed GType to ensure that the instance owned by JSCClass is used.
If you really want to return a new copy of the boxed type, use JSC_TYPE_VALUE and return a JSCValue created
with jsc_value_new_object()
that receives the copy as instance parameter.
[rename-to jsc_value_new_function]
context |
||
name |
the function name or |
[nullable] |
callback |
a GCallback. |
[scope async] |
user_data |
user data to pass to |
[closure] |
destroy_notify |
destroy notifier for |
[nullable] |
return_type |
the GType of the function return value, or |
|
n_parameters |
the number of parameters |
|
parameter_types |
a list of GTypes, one for each parameter, or |
[nullable][array length=n_parameters][element-type GType] |
JSCValue * jsc_value_new_function_variadic (JSCContext *context
,const char *name
,GCallback callback
,gpointer user_data
,GDestroyNotify destroy_notify
,GType return_type
);
Create a function in context
. If name
is NULL
an anonymous function will be created.
When the function is called by JavaScript or jsc_value_function_call()
, callback
is called
receiving an GPtrArray of JSCValues with the arguments and then user_data
as last parameter.
When the function is cleared in context
, destroy_notify
is called with user_data
as parameter.
Note that the value returned by callback
must be fully transferred. In case of boxed types, you could use
G_TYPE_POINTER
instead of the actual boxed GType to ensure that the instance owned by JSCClass is used.
If you really want to return a new copy of the boxed type, use JSC_TYPE_VALUE and return a JSCValue created
with jsc_value_new_object()
that receives the copy as instance parameter.
context |
||
name |
the function name or |
[nullable] |
callback |
a GCallback. |
[scope async] |
user_data |
user data to pass to |
[closure] |
destroy_notify |
destroy notifier for |
[nullable] |
return_type |
the GType of the function return value, or |
gboolean
jsc_value_is_function (JSCValue *value
);
Get whether the value referenced by value
is a function
JSCValue * jsc_value_function_call (JSCValue *value
,GType first_parameter_type
,...
);
Call function referenced by value
, passing the given parameters. If first_parameter_type
is G_TYPE_NONE
no parameters will be passed to the function.
This function always returns a JSCValue, in case of void functions a JSCValue referencing
undefined
is returned
[skip]
value |
a JSCValue |
|
first_parameter_type |
GType of first parameter, or |
|
... |
value of the first parameter, followed optionally by more type/value pairs, followed by |
JSCValue * jsc_value_function_callv (JSCValue *value
,guint n_parameters
,JSCValue **parameters
);
Call function referenced by value
, passing the given parameters
. If n_parameters
is 0 no parameters will be passed to the function.
This function always returns a JSCValue, in case of void functions a JSCValue referencing
undefined
is returned
[rename-to jsc_value_function_call]
gboolean
jsc_value_is_constructor (JSCValue *value
);
Get whether the value referenced by value
is a constructor.
JSCValue * jsc_value_constructor_call (JSCValue *value
,GType first_parameter_type
,...
);
Invoke new
with constructor referenced by value
. If first_parameter_type
is G_TYPE_NONE
no parameters will be passed to the constructor.
[skip]
value |
a JSCValue |
|
first_parameter_type |
GType of first parameter, or |
|
... |
value of the first parameter, followed optionally by more type/value pairs, followed by |
JSCValue * jsc_value_constructor_callv (JSCValue *value
,guint n_parameters
,JSCValue **parameters
);
Invoke new
with constructor referenced by value
. If n_parameters
is 0 no parameters will be passed to the constructor.
[rename-to jsc_value_constructor_call]
JSCValue * jsc_value_new_from_json (JSCContext *context
,const char *json
);
Create a new JSCValue referencing a new value created by parsing json
.
Since: 2.28
Flags used when defining properties with jsc_value_object_define_property_data()
and
jsc_value_object_define_property_accessor()
.
the type of the property descriptor may be changed and the property may be deleted from the corresponding object. |
||
the property shows up during enumeration of the properties on the corresponding object. |
||
the value associated with the property may be changed with an
assignment operator. This doesn't have any effect when passed to |
“context”
property“context” JSCContext *
The JSCContext in which the value was created.
Owner: JSCValue
Flags: Read / Write / Construct Only