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

Rework the public API (#4829)

Browse Source 
Related to #4186.

Some notable changes:
  - The term 'Error' now strictly refers to native Error objects defined in
    the ECMA standard, which are ordinary objects. All other uses of
    'error' or 'error reference' where the term refers to a thrown value is
    now called 'exception'.

  - Simplified the naming scheme of many String API functions. These functions
    will now also take an 'encoding' argument to specify the desired
    encoding in which to operate.

  - Removed the substring-copy-to-buffer functions. These functions
    behaved awkwardly, as they use character index to specify the
    start/end positions, and were mostly used incorrectly with byte
    offsets instead. The functionality can still be replicated with
    other functions if necessary.

  - String-to-buffer functions will no longer fail if the buffer is not
    sufficiently large, the string will instead be cropped.

  - Fixed the usage of the '_sz' prefix in many API functions. The term
    'sz' means zero-terminated string in hungarian notation, this was
    used incorrectly in many cases.

  - Renamed most of the public API functions to have shorter, more on-point
    names, rather than the often too long descriptive names. Functions are now
    also grouped by the type of value they operate on, where this makes
    sense.

JerryScript-DCO-1.0-Signed-off-by: Dániel Bátyai dbatyai@inf.u-szeged.hu
This commit is contained in:
Dániel Bátyai
2021-12-06 10:20:09 +01:00
committed by GitHub
parent 81d2319144
commit 9860d66a56
180 changed files with 10738 additions and 11025 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/unit-ext/test-ext-method-register.c
+60 -60
View File
@@ -31,7 +31,7 @@ method_hello (const jerry_call_info_t *call_info_p, /**< call information */
{
(void) call_info_p;
(void) jargv;
return jerry_create_number (jargc);
return jerry_number (jargc);
} /* method_hello */
/**
@@ -42,14 +42,14 @@ freeze_property (jerry_value_t target_obj, /**< target object */
const char *target_prop) /**< target property name */
{
// "freeze" property
jerry_property_descriptor_t prop_desc = jerry_property_descriptor_create ();
jerry_property_descriptor_t prop_desc = jerry_property_descriptor ();
prop_desc.flags |= JERRY_PROP_IS_CONFIGURABLE_DEFINED;
jerry_value_t prop_name = jerry_create_string ((const jerry_char_t *) target_prop);
jerry_value_t return_value = jerry_define_own_property (target_obj, prop_name, &prop_desc);
jerry_value_t prop_name = jerry_string_sz (target_prop);
jerry_value_t return_value = jerry_object_define_own_prop (target_obj, prop_name, &prop_desc);
TEST_ASSERT (jerry_value_is_boolean (return_value));
jerry_release_value (return_value);
jerry_release_value (prop_name);
jerry_value_free (return_value);
jerry_value_free (prop_name);
jerry_property_descriptor_free (&prop_desc);
} /* freeze_property */
@@ -62,14 +62,14 @@ test_simple_registration (void)
{
jerry_init (JERRY_INIT_EMPTY);
jerry_value_t target_object = jerry_create_object ();
jerry_value_t target_object = jerry_object ();
// Test simple registration
jerryx_property_entry methods[] = {
JERRYX_PROPERTY_FUNCTION ("hello", method_hello), JERRYX_PROPERTY_NUMBER ("my_number", 42.5),
JERRYX_PROPERTY_STRING ("my_str", "super_str"), JERRYX_PROPERTY_STRING_SZ ("my_str_sz", "super_str", 6),
JERRYX_PROPERTY_BOOLEAN ("my_bool", true), JERRYX_PROPERTY_BOOLEAN ("my_bool_false", false),
JERRYX_PROPERTY_UNDEFINED ("my_non_value"), JERRYX_PROPERTY_LIST_END (),
JERRYX_PROPERTY_FUNCTION ("hello", method_hello), JERRYX_PROPERTY_NUMBER ("my_number", 42.5),
JERRYX_PROPERTY_STRING_SZ ("my_str", "super_str"), JERRYX_PROPERTY_STRING ("my_str_sz", "super_str", 6),
JERRYX_PROPERTY_BOOLEAN ("my_bool", true), JERRYX_PROPERTY_BOOLEAN ("my_bool_false", false),
JERRYX_PROPERTY_UNDEFINED ("my_non_value"), JERRYX_PROPERTY_LIST_END (),
};
jerryx_register_result register_result = jerryx_set_properties (target_object, methods);
@@ -78,19 +78,19 @@ test_simple_registration (void)
TEST_ASSERT (jerry_value_is_undefined (register_result.result));
jerryx_release_property_entry (methods, register_result);
jerry_release_value (register_result.result);
jerry_value_free (register_result.result);
jerry_value_t global_obj = jerry_get_global_object ();
jerry_value_t global_obj = jerry_current_realm ();
jerryx_set_property_str (global_obj, "test", target_object);
jerry_release_value (target_object);
jerry_release_value (global_obj);
jerry_value_free (target_object);
jerry_value_free (global_obj);
{
const char *test_A = "test.my_number";
jerry_value_t result = jerry_eval ((const jerry_char_t *) test_A, strlen (test_A), 0);
TEST_ASSERT (jerry_value_is_number (result));
TEST_ASSERT (jerry_get_number_value (result) == 42.5);
jerry_release_value (result);
TEST_ASSERT (jerry_value_as_number (result) == 42.5);
jerry_value_free (result);
}
{
@@ -98,7 +98,7 @@ test_simple_registration (void)
jerry_value_t result = jerry_eval ((const jerry_char_t *) test_A, strlen (test_A), 0);
TEST_ASSERT (jerry_value_is_boolean (result));
TEST_ASSERT (jerry_value_is_true (result));
jerry_release_value (result);
jerry_value_free (result);
}
{
@@ -106,7 +106,7 @@ test_simple_registration (void)
jerry_value_t result = jerry_eval ((const jerry_char_t *) test_A, strlen (test_A), 0);
TEST_ASSERT (jerry_value_is_boolean (result));
TEST_ASSERT (jerry_value_is_true (result));
jerry_release_value (result);
jerry_value_free (result);
}
{
@@ -114,7 +114,7 @@ test_simple_registration (void)
jerry_value_t result = jerry_eval ((const jerry_char_t *) test_A, strlen (test_A), 0);
TEST_ASSERT (jerry_value_is_boolean (result));
TEST_ASSERT (jerry_value_is_true (result));
jerry_release_value (result);
jerry_value_free (result);
}
{
@@ -122,30 +122,30 @@ test_simple_registration (void)
jerry_value_t result = jerry_eval ((const jerry_char_t *) test_A, strlen (test_A), 0);
TEST_ASSERT (jerry_value_is_boolean (result));
TEST_ASSERT (jerry_value_is_true (result) == false);
jerry_release_value (result);
jerry_value_free (result);
}
{
const char *test_A = "test.my_non_value";
jerry_value_t result = jerry_eval ((const jerry_char_t *) test_A, strlen (test_A), 0);
TEST_ASSERT (jerry_value_is_undefined (result));
jerry_release_value (result);
jerry_value_free (result);
}
{
const char *test_A = "test.hello(33, 42, 2);";
jerry_value_t result = jerry_eval ((const jerry_char_t *) test_A, strlen (test_A), 0);
TEST_ASSERT (jerry_value_is_number (result));
TEST_ASSERT ((uint32_t) jerry_get_number_value (result) == 3u);
jerry_release_value (result);
TEST_ASSERT ((uint32_t) jerry_value_as_number (result) == 3u);
jerry_value_free (result);
}
{
const char *test_A = "test.hello();";
jerry_value_t result = jerry_eval ((const jerry_char_t *) test_A, strlen (test_A), 0);
TEST_ASSERT (jerry_value_is_number (result));
TEST_ASSERT ((uint32_t) jerry_get_number_value (result) == 0u);
jerry_release_value (result);
TEST_ASSERT ((uint32_t) jerry_value_as_number (result) == 0u);
jerry_value_free (result);
}
jerry_cleanup ();
@@ -163,16 +163,16 @@ test_error_setvalue (void)
jerry_init (JERRY_INIT_EMPTY);
const char *target_prop = "test_err";
jerry_value_t global_obj = jerry_get_global_object ();
jerry_value_t global_obj = jerry_current_realm ();
freeze_property (global_obj, target_prop);
jerry_value_t new_object = jerry_create_object ();
jerry_value_t new_object = jerry_object ();
jerry_value_t set_result = jerryx_set_property_str (global_obj, target_prop, new_object);
TEST_ASSERT (jerry_value_is_error (set_result));
TEST_ASSERT (jerry_value_is_exception (set_result));
jerry_release_value (set_result);
jerry_release_value (new_object);
jerry_release_value (global_obj);
jerry_value_free (set_result);
jerry_value_free (new_object);
jerry_value_free (global_obj);
jerry_cleanup ();
} /* test_error_setvalue */
@@ -189,7 +189,7 @@ test_error_single_function (void)
jerry_init (JERRY_INIT_EMPTY);
const char *target_prop = "test_err";
jerry_value_t target_object = jerry_create_object ();
jerry_value_t target_object = jerry_object ();
freeze_property (target_object, target_prop);
jerryx_property_entry methods[] = {
@@ -200,11 +200,11 @@ test_error_single_function (void)
jerryx_register_result register_result = jerryx_set_properties (target_object, methods);
TEST_ASSERT (register_result.registered == 0);
TEST_ASSERT (jerry_value_is_error (register_result.result));
TEST_ASSERT (jerry_value_is_exception (register_result.result));
jerryx_release_property_entry (methods, register_result);
jerry_release_value (register_result.result);
jerry_value_free (register_result.result);
jerry_release_value (target_object);
jerry_value_free (target_object);
jerry_cleanup ();
} /* test_error_single_function */
@@ -220,7 +220,7 @@ test_error_multiple_functions (void)
const char *prop_ok = "prop_ok";
const char *prop_err = "prop_err";
const char *prop_not = "prop_not";
jerry_value_t target_object = jerry_create_object ();
jerry_value_t target_object = jerry_object ();
freeze_property (target_object, prop_err);
jerryx_property_entry methods[] = {
@@ -233,59 +233,59 @@ test_error_multiple_functions (void)
jerryx_register_result register_result = jerryx_set_properties (target_object, methods);
TEST_ASSERT (register_result.registered == 1);
TEST_ASSERT (jerry_value_is_error (register_result.result));
TEST_ASSERT (jerry_value_is_exception (register_result.result));
jerryx_release_property_entry (methods, register_result);
jerry_release_value (register_result.result);
jerry_value_free (register_result.result);
{
// Test if property "prop_ok" is correctly registered.
jerry_value_t prop_ok_val = jerry_create_string ((const jerry_char_t *) prop_ok);
jerry_value_t prop_ok_exists = jerry_has_own_property (target_object, prop_ok_val);
jerry_value_t prop_ok_val = jerry_string_sz (prop_ok);
jerry_value_t prop_ok_exists = jerry_object_has_own (target_object, prop_ok_val);
TEST_ASSERT (jerry_value_is_true (prop_ok_exists));
jerry_release_value (prop_ok_exists);
jerry_value_free (prop_ok_exists);
// Try calling the method
jerry_value_t prop_ok_func = jerry_get_property (target_object, prop_ok_val);
jerry_value_t prop_ok_func = jerry_object_get (target_object, prop_ok_val);
TEST_ASSERT (jerry_value_is_function (prop_ok_func) == true);
jerry_value_t args[2] = {
jerry_create_number (22),
jerry_create_number (-3),
jerry_number (22),
jerry_number (-3),
};
jerry_size_t args_cnt = sizeof (args) / sizeof (jerry_value_t);
jerry_value_t func_result = jerry_call_function (prop_ok_func, jerry_create_undefined (), args, args_cnt);
jerry_value_t func_result = jerry_call (prop_ok_func, jerry_undefined (), args, args_cnt);
TEST_ASSERT (jerry_value_is_number (func_result) == true);
TEST_ASSERT ((uint32_t) jerry_get_number_value (func_result) == 2u);
jerry_release_value (func_result);
TEST_ASSERT ((uint32_t) jerry_value_as_number (func_result) == 2u);
jerry_value_free (func_result);
for (jerry_size_t idx = 0; idx < args_cnt; idx++)
{
jerry_release_value (args[idx]);
jerry_value_free (args[idx]);
}
jerry_release_value (prop_ok_func);
jerry_release_value (prop_ok_val);
jerry_value_free (prop_ok_func);
jerry_value_free (prop_ok_val);
}
{
// The "prop_err" should exist - as it was "freezed" - but it should not be a function
jerry_value_t prop_err_val = jerry_create_string ((const jerry_char_t *) prop_err);
jerry_value_t prop_err_exists = jerry_has_own_property (target_object, prop_err_val);
jerry_value_t prop_err_val = jerry_string_sz (prop_err);
jerry_value_t prop_err_exists = jerry_object_has_own (target_object, prop_err_val);
TEST_ASSERT (jerry_value_is_true (prop_err_exists));
jerry_release_value (prop_err_exists);
jerry_value_free (prop_err_exists);
jerry_value_t prop_err_func = jerry_value_is_function (prop_err_val);
TEST_ASSERT (jerry_value_is_function (prop_err_func) == false);
jerry_release_value (prop_err_val);
jerry_value_free (prop_err_val);
}
{ // The "prop_not" is not available on the target object
jerry_value_t prop_not_val = jerry_create_string ((const jerry_char_t *) prop_not);
jerry_value_t prop_not_exists = jerry_has_own_property (target_object, prop_not_val);
jerry_value_t prop_not_val = jerry_string_sz (prop_not);
jerry_value_t prop_not_exists = jerry_object_has_own (target_object, prop_not_val);
TEST_ASSERT (jerry_value_is_true (prop_not_exists) == false);
jerry_release_value (prop_not_exists);
jerry_release_value (prop_not_val);
jerry_value_free (prop_not_exists);
jerry_value_free (prop_not_val);
}
jerry_release_value (target_object);
jerry_value_free (target_object);
jerry_cleanup ();
} /* test_error_multiple_functions */