YourWishes/jerryscript
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Remove deprecated native handle support. (#2496)

Browse Source 
JerryScript-DCO-1.0-Signed-off-by: Zoltan Herczeg zherczeg.u-szeged@partner.samsung.com
This commit is contained in:
Zoltan Herczeg
2018-08-29 12:51:37 +02:00
committed by GitHub
parent b4dc6b0cbe
commit 7d41d38e3c
9 changed files with 32 additions and 295 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/02.API-REFERENCE.md
-114
View File
@@ -334,20 +334,6 @@ typedef jerry_value_t (*jerry_external_handler_t) (const jerry_value_t function_
const jerry_length_t args_count); const jerry_length_t args_count);
``` ```
## jerry_object_free_callback_t
**Summary**
**Deprecated: Please use jerry_object_native_free_callback_t instead.**
Native free callback of an object.
**Prototype**
```c
typedef void (*jerry_object_free_callback_t) (const uintptr_t native_p);
```
## jerry_object_native_free_callback_t ## jerry_object_native_free_callback_t
**Summary** **Summary**
@@ -4387,106 +4373,6 @@ jerry_set_prototype (const jerry_value_t obj_val,
- [jerry_get_prototype](#jerry_get_prototype) - [jerry_get_prototype](#jerry_get_prototype)
## jerry_get_object_native_handle
**Summary**
**Deprecated: Please use jerry_get_object_native_pointer instead.**
Get native handle, previously associated with specified object.
**Prototype**
```c
bool
jerry_get_object_native_handle (const jerry_value_t obj_val,
uintptr_t *out_handle_p);
```
- `obj_val` - object value
- `out_handle_p` - handle value (output parameter).
- return value
- true, if there is handle associated with the object
- false, otherwise
**Example**
```c
{
jerry_value_t object;
uintptr_t handle_set;
... // receive or construct object and handle_set value
jerry_set_object_native_handle (object, handle_set, NULL);
...
uintptr_t handle_get;
bool is_there_associated_handle = jerry_get_object_native_handle (object, &handle_get);
}
```
**See also**
- [jerry_create_object](#jerry_create_object)
- [jerry_set_object_native_handle](#jerry_set_object_native_handle)
- [jerry_get_object_native_pointer](#jerry_get_object_native_pointer)
## jerry_set_object_native_handle
**Summary**
**Deprecated: Please use jerry_set_object_native_pointer instead.**
Set native handle and an optional free callback for the specified object.
*Note*: If native handle was already set for the object, its value is updated.
*Note*: If a non-NULL free callback is specified, it will be called
by the garbage collector when the object is freed. The free
callback always overwrites the previous value, so passing
a NULL value deletes the current free callback.
**Prototype**
```c
void
jerry_set_object_native_handle (const jerry_value_t obj_val,
uintptr_t handle_p,
jerry_object_free_callback_t freecb_p);
```
- `obj_val` - object value to set handle in
- `handle_p` - handle value
- `freecb_p` - pointer to "free" callback or NULL
**Example**
```c
{
jerry_value_t object;
uintptr_t handle_set;
... // receive or construct object and handle_set value
jerry_set_object_native_handle (object, handle_set, NULL);
...
uintptr_t handle_get;
bool is_there_associated_handle = jerry_get_object_native_handle (object, &handle_get);
}
```
**See also**
- [jerry_create_object](#jerry_create_object)
- [jerry_get_object_native_handle](#jerry_get_object_native_handle)
- [jerry_set_object_native_pointer](#jerry_set_object_native_pointer)
## jerry_get_object_native_pointer ## jerry_get_object_native_pointer
**Summary** **Summary**
jerry-core/api/jerry.c
+4 -68
View File
@@ -2355,69 +2355,6 @@ jerry_set_prototype (const jerry_value_t obj_val, /**< object value */
return ECMA_VALUE_TRUE; return ECMA_VALUE_TRUE;
} /* jerry_set_prototype */ } /* jerry_set_prototype */
/**
* Get native handle, associated with specified object.
*
* Note: This API is deprecated, please use jerry_get_object_native_pointer instaed.
*
* @return true - if there is an associated handle (handle is returned through out_handle_p),
* false - otherwise
*/
bool
jerry_get_object_native_handle (const jerry_value_t obj_val, /**< object to get handle from */
uintptr_t *out_handle_p) /**< [out] handle value */
{
jerry_assert_api_available ();
if (!ecma_is_value_object (obj_val))
{
return false;
}
ecma_native_pointer_t *native_pointer_p;
native_pointer_p = ecma_get_native_pointer_value (ecma_get_object_from_value (obj_val),
LIT_INTERNAL_MAGIC_STRING_NATIVE_HANDLE);
if (native_pointer_p == NULL)
{
return false;
}
*out_handle_p = (uintptr_t) native_pointer_p->data_p;
return true;
} /* jerry_get_object_native_handle */
/**
* Set native handle and an optional free callback for the specified object.
*
* Note: This API is deprecated, please use jerry_set_object_native_pointer instaed.
*
* Note:
* If native handle was already set for the object, its value is updated.
*
* Note:
* If a non-NULL free callback is specified, it will be called
* by the garbage collector when the object is freed. The free
* callback always overwrites the previous value, so passing
* a NULL value deletes the current free callback.
*/
void
jerry_set_object_native_handle (const jerry_value_t obj_val, /**< object to set handle in */
uintptr_t handle_p, /**< handle value */
jerry_object_free_callback_t freecb_p) /**< object free callback or NULL */
{
jerry_assert_api_available ();
if (ecma_is_value_object (obj_val))
{
ecma_object_t *object_p = ecma_get_object_from_value (obj_val);
ecma_create_native_handle_property (object_p,
(void *) handle_p,
(void *) (ecma_external_pointer_t) freecb_p);
}
} /* jerry_set_object_native_handle */
/** /**
* Traverse objects. * Traverse objects.
* *
@@ -2472,9 +2409,9 @@ jerry_objects_foreach_by_native_info (const jerry_object_native_info_t *native_i
{ {
if (!ecma_is_lexical_environment (iter_p)) if (!ecma_is_lexical_environment (iter_p))
{ {
native_pointer_p = ecma_get_native_pointer_value (iter_p, LIT_INTERNAL_MAGIC_STRING_NATIVE_POINTER); native_pointer_p = ecma_get_native_pointer_value (iter_p);
if (native_pointer_p if (native_pointer_p
&& ((const jerry_object_native_info_t *) native_pointer_p->u.info_p) == native_info_p && ((const jerry_object_native_info_t *) native_pointer_p->info_p) == native_info_p
&& !foreach_p (ecma_make_object_value (iter_p), native_pointer_p->data_p, user_data_p)) && !foreach_p (ecma_make_object_value (iter_p), native_pointer_p->data_p, user_data_p))
{ {
return true; return true;
@@ -2509,8 +2446,7 @@ jerry_get_object_native_pointer (const jerry_value_t obj_val, /**< object to get
} }
ecma_native_pointer_t *native_pointer_p; ecma_native_pointer_t *native_pointer_p;
native_pointer_p = ecma_get_native_pointer_value (ecma_get_object_from_value (obj_val), native_pointer_p = ecma_get_native_pointer_value (ecma_get_object_from_value (obj_val));
LIT_INTERNAL_MAGIC_STRING_NATIVE_POINTER);
if (native_pointer_p == NULL) if (native_pointer_p == NULL)
{ {
@@ -2524,7 +2460,7 @@ jerry_get_object_native_pointer (const jerry_value_t obj_val, /**< object to get
if (out_native_info_p != NULL) if (out_native_info_p != NULL)
{ {
*out_native_info_p = (const jerry_object_native_info_t *) native_pointer_p->u.info_p; *out_native_info_p = (const jerry_object_native_info_t *) native_pointer_p->info_p;
} }
return true; return true;
jerry-core/ecma/base/ecma-gc.c
+8 -23
View File
@@ -404,37 +404,23 @@ ecma_gc_mark (ecma_object_t *object_p) /**< object to mark from */
* Free the native handle/pointer by calling its free callback. * Free the native handle/pointer by calling its free callback.
*/ */
static void static void
ecma_gc_free_native_pointer (ecma_property_t *property_p, /**< property */ ecma_gc_free_native_pointer (ecma_property_t *property_p) /**< property */
lit_magic_string_id_t id) /**< identifier of internal property */
{ {
JERRY_ASSERT (property_p != NULL); JERRY_ASSERT (property_p != NULL);
JERRY_ASSERT (id == LIT_INTERNAL_MAGIC_STRING_NATIVE_HANDLE
|| id == LIT_INTERNAL_MAGIC_STRING_NATIVE_POINTER);
ecma_property_value_t *value_p = ECMA_PROPERTY_VALUE_PTR (property_p); ecma_property_value_t *value_p = ECMA_PROPERTY_VALUE_PTR (property_p);
ecma_native_pointer_t *native_pointer_p; ecma_native_pointer_t *native_pointer_p;
native_pointer_p = ECMA_GET_INTERNAL_VALUE_POINTER (ecma_native_pointer_t, native_pointer_p = ECMA_GET_INTERNAL_VALUE_POINTER (ecma_native_pointer_t,
value_p->value); value_p->value);
if (id == LIT_INTERNAL_MAGIC_STRING_NATIVE_HANDLE) if (native_pointer_p->info_p != NULL)
{ {
if (native_pointer_p->u.callback_p != NULL) ecma_object_native_free_callback_t free_cb = native_pointer_p->info_p->free_cb;
{
native_pointer_p->u.callback_p ((uintptr_t) native_pointer_p->data_p);
}
}
else
{
if (native_pointer_p->u.info_p != NULL)
{
ecma_object_native_free_callback_t free_cb = native_pointer_p->u.info_p->free_cb;
if (free_cb != NULL) if (free_cb != NULL)
{ {
free_cb (native_pointer_p->data_p); free_cb (native_pointer_p->data_p);
}
} }
} }
} /* ecma_gc_free_native_pointer */ } /* ecma_gc_free_native_pointer */
@@ -479,10 +465,9 @@ ecma_gc_free_object (ecma_object_t *object_p) /**< object to free */
/* Call the native's free callback. */ /* Call the native's free callback. */
if (ECMA_PROPERTY_GET_NAME_TYPE (*property_p) == ECMA_DIRECT_STRING_MAGIC if (ECMA_PROPERTY_GET_NAME_TYPE (*property_p) == ECMA_DIRECT_STRING_MAGIC
&& (name_cp == LIT_INTERNAL_MAGIC_STRING_NATIVE_HANDLE && (name_cp == LIT_INTERNAL_MAGIC_STRING_NATIVE_POINTER))
|| name_cp == LIT_INTERNAL_MAGIC_STRING_NATIVE_POINTER))
{ {
ecma_gc_free_native_pointer (property_p, (lit_magic_string_id_t) name_cp); ecma_gc_free_native_pointer (property_p);
} }
if (prop_iter_p->types[i] != ECMA_PROPERTY_TYPE_DELETED) if (prop_iter_p->types[i] != ECMA_PROPERTY_TYPE_DELETED)
jerry-core/ecma/base/ecma-globals.h
+1 -10
View File
@@ -261,11 +261,6 @@ typedef ecma_value_t (*ecma_external_handler_t) (const ecma_value_t function_obj
const ecma_value_t args_p[], const ecma_value_t args_p[],
const ecma_length_t args_count); const ecma_length_t args_count);
/**
* Native free callback of an object (deprecated).
*/
typedef void (*ecma_object_free_callback_t) (const uintptr_t native_p);
/** /**
* Native free callback of an object. * Native free callback of an object.
*/ */
@@ -285,11 +280,7 @@ typedef struct
typedef struct typedef struct
{ {
void *data_p; /**< points to the data of the object */ void *data_p; /**< points to the data of the object */
union ecma_object_native_info_t *info_p; /**< native info */
{
ecma_object_free_callback_t callback_p; /**< callback */
ecma_object_native_info_t *info_p; /**< native info */
} u;
} ecma_native_pointer_t; } ecma_native_pointer_t;
/** /**
jerry-core/ecma/base/ecma-helpers-external-pointers.c
+11 -59
View File
@@ -25,27 +25,17 @@
*/ */
/** /**
* Create internal property with specified identifier and store native handle/pointer of the object. * Create a native pointer property to store the native pointer and its type info.
*
* Note:
* property identifier should be one of the following:
* - LIT_INTERNAL_MAGIC_STRING_NATIVE_HANDLE
* - LIT_INTERNAL_MAGIC_STRING_NATIVE_POINTER
* *
* @return true - if property was just created with specified value, * @return true - if property was just created with specified value,
* false - otherwise, if property existed before the call, it's value was updated * false - otherwise, if property existed before the call, it's value was updated
*/ */
static bool bool
ecma_create_native_property (ecma_object_t *obj_p, /**< object to create property in */ ecma_create_native_pointer_property (ecma_object_t *obj_p, /**< object to create property in */
lit_magic_string_id_t id, /**< identifier of internal void *native_p, /**< native pointer */
* property to create */ void *info_p) /**< native pointer's type info */
void *data_p, /**< native pointer data */
void *info_p) /**< native pointer's info */
{ {
JERRY_ASSERT (id == LIT_INTERNAL_MAGIC_STRING_NATIVE_HANDLE ecma_string_t *name_p = ecma_get_magic_string (LIT_INTERNAL_MAGIC_STRING_NATIVE_POINTER);
|| id == LIT_INTERNAL_MAGIC_STRING_NATIVE_POINTER);
ecma_string_t *name_p = ecma_get_magic_string (id);
ecma_property_t *property_p = ecma_find_named_property (obj_p, name_p); ecma_property_t *property_p = ecma_find_named_property (obj_p, name_p);
bool is_new = (property_p == NULL); bool is_new = (property_p == NULL);
@@ -68,44 +58,10 @@ ecma_create_native_property (ecma_object_t *obj_p, /**< object to create propert
native_pointer_p = ECMA_GET_INTERNAL_VALUE_POINTER (ecma_native_pointer_t, value_p->value); native_pointer_p = ECMA_GET_INTERNAL_VALUE_POINTER (ecma_native_pointer_t, value_p->value);
} }
native_pointer_p->data_p = data_p; native_pointer_p->data_p = native_p;
native_pointer_p->u.info_p = info_p; native_pointer_p->info_p = info_p;
return is_new; return is_new;
} /* ecma_create_native_property */
/**
* Create a native handle property to store the native handle and its free callback.
*
* @return true - if property was just created with specified value,
* false - otherwise, if property existed before the call, it's value was updated
*/
bool
ecma_create_native_handle_property (ecma_object_t *obj_p, /**< object to create property in */
void *handle_p, /**< native handle */
void *free_cb) /**< native handle's free callback*/
{
return ecma_create_native_property (obj_p,
LIT_INTERNAL_MAGIC_STRING_NATIVE_HANDLE,
handle_p,
free_cb);
} /* ecma_create_native_handle_property */
/**
* Create a native pointer property to store the native pointer and its type info.
*
* @return true - if property was just created with specified value,
* false - otherwise, if property existed before the call, it's value was updated
*/
bool
ecma_create_native_pointer_property (ecma_object_t *obj_p, /**< object to create property in */
void *native_p, /**< native pointer */
void *info_p) /**< native pointer's type info */
{
return ecma_create_native_property (obj_p,
LIT_INTERNAL_MAGIC_STRING_NATIVE_POINTER,
native_p,
info_p);
} /* ecma_create_native_pointer_property */ } /* ecma_create_native_pointer_property */
/** /**
@@ -120,14 +76,10 @@ ecma_create_native_pointer_property (ecma_object_t *obj_p, /**< object to create
* NULL otherwise * NULL otherwise
*/ */
ecma_native_pointer_t * ecma_native_pointer_t *
ecma_get_native_pointer_value (ecma_object_t *obj_p, /**< object to get property value from */ ecma_get_native_pointer_value (ecma_object_t *obj_p) /**< object to get property value from */
lit_magic_string_id_t id) /**< identifier of internal property
* to get value from */
{ {
JERRY_ASSERT (id == LIT_INTERNAL_MAGIC_STRING_NATIVE_HANDLE ecma_string_t *name_p = ecma_get_magic_string (LIT_INTERNAL_MAGIC_STRING_NATIVE_POINTER);
|| id == LIT_INTERNAL_MAGIC_STRING_NATIVE_POINTER); ecma_property_t *property_p = ecma_find_named_property (obj_p, name_p);
ecma_property_t *property_p = ecma_find_named_property (obj_p, ecma_get_magic_string (id));
if (property_p == NULL) if (property_p == NULL)
{ {
jerry-core/ecma/base/ecma-helpers.c
+1 -2
View File
@@ -744,8 +744,7 @@ ecma_free_property (ecma_object_t *object_p, /**< object the property belongs to
case ECMA_PROPERTY_TYPE_NAMEDDATA: case ECMA_PROPERTY_TYPE_NAMEDDATA:
{ {
if (ECMA_PROPERTY_GET_NAME_TYPE (*property_p) == ECMA_DIRECT_STRING_MAGIC if (ECMA_PROPERTY_GET_NAME_TYPE (*property_p) == ECMA_DIRECT_STRING_MAGIC
&& (name_cp == LIT_INTERNAL_MAGIC_STRING_NATIVE_HANDLE && (name_cp == LIT_INTERNAL_MAGIC_STRING_NATIVE_POINTER))
|| name_cp == LIT_INTERNAL_MAGIC_STRING_NATIVE_POINTER))
{ {
ecma_free_native_pointer (property_p); ecma_free_native_pointer (property_p);
break; break;
jerry-core/ecma/base/ecma-helpers.h
+1 -2
View File
@@ -355,9 +355,8 @@ void ecma_bytecode_ref (ecma_compiled_code_t *bytecode_p);
void ecma_bytecode_deref (ecma_compiled_code_t *bytecode_p); void ecma_bytecode_deref (ecma_compiled_code_t *bytecode_p);
/* ecma-helpers-external-pointers.c */ /* ecma-helpers-external-pointers.c */
bool ecma_create_native_handle_property (ecma_object_t *obj_p, void *handle_p, void *free_cb);
bool ecma_create_native_pointer_property (ecma_object_t *obj_p, void *native_p, void *info_p); bool ecma_create_native_pointer_property (ecma_object_t *obj_p, void *native_p, void *info_p);
ecma_native_pointer_t *ecma_get_native_pointer_value (ecma_object_t *obj_p, lit_magic_string_id_t id); ecma_native_pointer_t *ecma_get_native_pointer_value (ecma_object_t *obj_p);
void ecma_free_native_pointer (ecma_property_t *prop_p); void ecma_free_native_pointer (ecma_property_t *prop_p);
/* ecma-helpers-conversion.c */ /* ecma-helpers-conversion.c */
jerry-core/include/jerryscript-core.h
+4 -14
View File
@@ -203,11 +203,6 @@ typedef jerry_value_t (*jerry_external_handler_t) (const jerry_value_t function_
const jerry_value_t args_p[], const jerry_value_t args_p[],
const jerry_length_t args_count); const jerry_length_t args_count);
/**
* Native free callback of an object (deprecated).
*/
typedef void (*jerry_object_free_callback_t) (const uintptr_t native_p);
/** /**
* Native free callback of an object. * Native free callback of an object.
*/ */
@@ -497,23 +492,18 @@ jerry_value_t jerry_get_object_keys (const jerry_value_t obj_val);
jerry_value_t jerry_get_prototype (const jerry_value_t obj_val); jerry_value_t jerry_get_prototype (const jerry_value_t obj_val);
jerry_value_t jerry_set_prototype (const jerry_value_t obj_val, const jerry_value_t proto_obj_val); jerry_value_t jerry_set_prototype (const jerry_value_t obj_val, const jerry_value_t proto_obj_val);
JERRY_ATTR_DEPRECATED
bool jerry_get_object_native_handle (const jerry_value_t obj_val, uintptr_t *out_handle_p);
JERRY_ATTR_DEPRECATED
void jerry_set_object_native_handle (const jerry_value_t obj_val, uintptr_t handle_p,
jerry_object_free_callback_t freecb_p);
bool jerry_get_object_native_pointer (const jerry_value_t obj_val, bool jerry_get_object_native_pointer (const jerry_value_t obj_val,
void **out_native_pointer_p, void **out_native_pointer_p,
const jerry_object_native_info_t **out_pointer_info_p); const jerry_object_native_info_t **out_pointer_info_p);
void jerry_set_object_native_pointer (const jerry_value_t obj_val,
void *native_pointer_p,
const jerry_object_native_info_t *native_info_p);
bool jerry_objects_foreach (jerry_objects_foreach_t foreach_p, bool jerry_objects_foreach (jerry_objects_foreach_t foreach_p,
void *user_data); void *user_data);
bool jerry_objects_foreach_by_native_info (const jerry_object_native_info_t *native_info_p, bool jerry_objects_foreach_by_native_info (const jerry_object_native_info_t *native_info_p,
jerry_objects_foreach_by_native_info_t foreach_p, jerry_objects_foreach_by_native_info_t foreach_p,
void *user_data_p); void *user_data_p);
void jerry_set_object_native_pointer (const jerry_value_t obj_val,
void *native_pointer_p,
const jerry_object_native_info_t *native_info_p);
bool jerry_foreach_object_property (const jerry_value_t obj_val, jerry_object_property_foreach_t foreach_p, bool jerry_foreach_object_property (const jerry_value_t obj_val, jerry_object_property_foreach_t foreach_p,
void *user_data_p); void *user_data_p);
jerry-core/lit/lit-magic-strings.h
+2 -3
View File
@@ -39,9 +39,8 @@ typedef enum
LIT_INTERNAL_MAGIC_STRING_REJECT_FUNCTION, /**< the reject function of the promise object */ LIT_INTERNAL_MAGIC_STRING_REJECT_FUNCTION, /**< the reject function of the promise object */
LIT_NEED_MARK_MAGIC_STRING__COUNT, /**< number of internal magic strings which will be used as properties' names, LIT_NEED_MARK_MAGIC_STRING__COUNT, /**< number of internal magic strings which will be used as properties' names,
* and the properties need to be marked during gc. */ * and the properties need to be marked during gc. */
LIT_INTERNAL_MAGIC_STRING_NATIVE_HANDLE = LIT_NEED_MARK_MAGIC_STRING__COUNT, /**< native handle package LIT_INTERNAL_MAGIC_STRING_NATIVE_POINTER = LIT_NEED_MARK_MAGIC_STRING__COUNT, /**< native pointer info associated
* associated with an object */ * with an object */
LIT_INTERNAL_MAGIC_STRING_NATIVE_POINTER, /**< native pointer package associated with an object */
LIT_MAGIC_STRING__COUNT /**< number of magic strings */ LIT_MAGIC_STRING__COUNT /**< number of magic strings */
} lit_magic_string_id_t; } lit_magic_string_id_t;