Skip to content

Remove deprecated native handle support. #2496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 29, 2018
Merged

Remove deprecated native handle support. #2496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 0 additions & 114 deletions docs/02.API-REFERENCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,20 +334,6 @@ typedef jerry_value_t (*jerry_external_handler_t) (const jerry_value_t function_
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

**Summary**
Expand Down Expand Up @@ -4387,106 +4373,6 @@ jerry_set_prototype (const jerry_value_t obj_val,
- [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

**Summary**
Expand Down
72 changes: 4 additions & 68 deletions jerry-core/api/jerry.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2355,69 +2355,6 @@ jerry_set_prototype (const jerry_value_t obj_val, /**< object value */
return ECMA_VALUE_TRUE;
} /* 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.
*
Expand Down Expand Up @@ -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))
{
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
&& ((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))
{
return true;
Expand Down Expand Up @@ -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;
native_pointer_p = ecma_get_native_pointer_value (ecma_get_object_from_value (obj_val),
LIT_INTERNAL_MAGIC_STRING_NATIVE_POINTER);
native_pointer_p = ecma_get_native_pointer_value (ecma_get_object_from_value (obj_val));

if (native_pointer_p == NULL)
{
Expand All @@ -2524,7 +2460,7 @@ jerry_get_object_native_pointer (const jerry_value_t obj_val, /**< object to get

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;
Expand Down
31 changes: 8 additions & 23 deletions jerry-core/ecma/base/ecma-gc.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
static void
ecma_gc_free_native_pointer (ecma_property_t *property_p, /**< property */
lit_magic_string_id_t id) /**< identifier of internal property */
ecma_gc_free_native_pointer (ecma_property_t *property_p) /**< property */
{
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_native_pointer_t *native_pointer_p;

native_pointer_p = ECMA_GET_INTERNAL_VALUE_POINTER (ecma_native_pointer_t,
value_p->value);

if (id == LIT_INTERNAL_MAGIC_STRING_NATIVE_HANDLE)
{
if (native_pointer_p->u.callback_p != NULL)
{
native_pointer_p->u.callback_p ((uintptr_t) native_pointer_p->data_p);
}
}
else
if (native_pointer_p->info_p != NULL)
{
if (native_pointer_p->u.info_p != NULL)
{
ecma_object_native_free_callback_t free_cb = native_pointer_p->u.info_p->free_cb;
ecma_object_native_free_callback_t free_cb = native_pointer_p->info_p->free_cb;

if (free_cb != NULL)
{
free_cb (native_pointer_p->data_p);
}
if (free_cb != NULL)
{
free_cb (native_pointer_p->data_p);
}
}
} /* ecma_gc_free_native_pointer */
Expand Down Expand Up @@ -479,10 +465,9 @@ ecma_gc_free_object (ecma_object_t *object_p) /**< object to free */

/* Call the native's free callback. */
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)
Expand Down
11 changes: 1 addition & 10 deletions jerry-core/ecma/base/ecma-globals.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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_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.
*/
Expand All @@ -285,11 +280,7 @@ typedef struct
typedef struct
{
void *data_p; /**< points to the data of the object */
union
{
ecma_object_free_callback_t callback_p; /**< callback */
ecma_object_native_info_t *info_p; /**< native info */
} u;
ecma_object_native_info_t *info_p; /**< native info */
} ecma_native_pointer_t;

/**
Expand Down
Loading