Rework the public API (#4829)

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
@@ -37,7 +37,7 @@ my_constructor (const jerry_call_info_t *call_info_p, /**< call information */
(void) call_info_p;
(void) argv;
(void) argc;
return jerry_create_undefined ();
return jerry_undefined ();
} /* my_constructor */
int
@@ -47,68 +47,64 @@ main (void)
jerry_init (JERRY_INIT_EMPTY);
jerry_value_t base_obj = jerry_create_object ();
jerry_value_t constructor = jerry_create_external_function (my_constructor);
jerry_value_t base_obj = jerry_object ();
jerry_value_t constructor = jerry_function_external (my_constructor);
jerry_value_t no_proto_instance_val = jerry_construct_object (constructor, NULL, 0);
jerry_value_t no_proto_instance_val = jerry_construct (constructor, NULL, 0);
jerry_value_t prototype_str = jerry_create_string ((const jerry_char_t *) "prototype");
jerry_value_t res = jerry_set_property (constructor, prototype_str, base_obj);
jerry_release_value (prototype_str);
TEST_ASSERT (!jerry_value_is_error (res));
jerry_release_value (res);
jerry_value_t prototype_str = jerry_string_sz ("prototype");
jerry_value_t res = jerry_object_set (constructor, prototype_str, base_obj);
jerry_value_free (prototype_str);
TEST_ASSERT (!jerry_value_is_exception (res));
jerry_value_free (res);
jerry_value_t instance_val = jerry_construct_object (constructor, NULL, 0);
jerry_value_t instance_val = jerry_construct (constructor, NULL, 0);
jerry_value_t error = jerry_create_error_from_value (base_obj, false);
jerry_value_t error = jerry_throw_value (base_obj, false);
test_entry_t bool_tests[] = {
T (jerry_acquire_value (instance_val), jerry_acquire_value (constructor), true),
T (jerry_acquire_value (no_proto_instance_val), jerry_acquire_value (constructor), false),
T (jerry_acquire_value (base_obj), jerry_acquire_value (constructor), false)
};
test_entry_t bool_tests[] = { T (jerry_value_copy (instance_val), jerry_value_copy (constructor), true),
T (jerry_value_copy (no_proto_instance_val), jerry_value_copy (constructor), false),
T (jerry_value_copy (base_obj), jerry_value_copy (constructor), false) };
for (uint32_t idx = 0; idx < sizeof (bool_tests) / sizeof (test_entry_t); idx++)
{
jerry_value_t result = jerry_binary_operation (JERRY_BIN_OP_INSTANCEOF, bool_tests[idx].lhs, bool_tests[idx].rhs);
TEST_ASSERT (!jerry_value_is_error (result));
jerry_value_t result = jerry_binary_op (JERRY_BIN_OP_INSTANCEOF, bool_tests[idx].lhs, bool_tests[idx].rhs);
TEST_ASSERT (!jerry_value_is_exception (result));
TEST_ASSERT (jerry_value_is_true (result) == bool_tests[idx].expected);
jerry_release_value (bool_tests[idx].lhs);
jerry_release_value (bool_tests[idx].rhs);
jerry_release_value (result);
jerry_value_free (bool_tests[idx].lhs);
jerry_value_free (bool_tests[idx].rhs);
jerry_value_free (result);
}
test_entry_t error_tests[] = {
T (jerry_acquire_value (constructor), jerry_acquire_value (instance_val), true),
T (jerry_create_undefined (), jerry_acquire_value (constructor), true),
T (jerry_acquire_value (instance_val), jerry_create_undefined (), true),
T (jerry_acquire_value (instance_val), jerry_acquire_value (base_obj), true),
T (jerry_acquire_value (error), jerry_acquire_value (constructor), true),
T (jerry_acquire_value (instance_val), jerry_acquire_value (error), true),
T (jerry_create_string ((const jerry_char_t *) ""), jerry_create_string ((const jerry_char_t *) ""), true),
T (jerry_create_string ((const jerry_char_t *) ""), jerry_create_number (5.0), true),
T (jerry_create_number (5.0), jerry_create_string ((const jerry_char_t *) ""), true),
T (jerry_create_array (1), jerry_create_array (1), true),
T (jerry_create_array (1), jerry_create_object (), true),
T (jerry_create_object (), jerry_create_array (1), true),
T (jerry_create_null (), jerry_create_object (), true),
T (jerry_create_object (), jerry_create_string ((const jerry_char_t *) ""), true)
};
test_entry_t error_tests[] = { T (jerry_value_copy (constructor), jerry_value_copy (instance_val), true),
T (jerry_undefined (), jerry_value_copy (constructor), true),
T (jerry_value_copy (instance_val), jerry_undefined (), true),
T (jerry_value_copy (instance_val), jerry_value_copy (base_obj), true),
T (jerry_value_copy (error), jerry_value_copy (constructor), true),
T (jerry_value_copy (instance_val), jerry_value_copy (error), true),
T (jerry_string_sz (""), jerry_string_sz (""), true),
T (jerry_string_sz (""), jerry_number (5.0), true),
T (jerry_number (5.0), jerry_string_sz (""), true),
T (jerry_array (1), jerry_array (1), true),
T (jerry_array (1), jerry_object (), true),
T (jerry_object (), jerry_array (1), true),
T (jerry_null (), jerry_object (), true),
T (jerry_object (), jerry_string_sz (""), true) };
for (uint32_t idx = 0; idx < sizeof (error_tests) / sizeof (test_entry_t); idx++)
{
jerry_value_t result = jerry_binary_operation (JERRY_BIN_OP_INSTANCEOF, error_tests[idx].lhs, error_tests[idx].rhs);
TEST_ASSERT (jerry_value_is_error (result) == error_tests[idx].expected);
jerry_release_value (error_tests[idx].lhs);
jerry_release_value (error_tests[idx].rhs);
jerry_release_value (result);
jerry_value_t result = jerry_binary_op (JERRY_BIN_OP_INSTANCEOF, error_tests[idx].lhs, error_tests[idx].rhs);
TEST_ASSERT (jerry_value_is_exception (result) == error_tests[idx].expected);
jerry_value_free (error_tests[idx].lhs);
jerry_value_free (error_tests[idx].rhs);
jerry_value_free (result);
}
jerry_release_value (base_obj);
jerry_release_value (constructor);
jerry_release_value (error);
jerry_release_value (instance_val);
jerry_release_value (no_proto_instance_val);
jerry_value_free (base_obj);
jerry_value_free (constructor);
jerry_value_free (error);
jerry_value_free (instance_val);
jerry_value_free (no_proto_instance_val);
jerry_cleanup ();