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
+61 -62
View File
@@ -22,135 +22,134 @@
static void
test_promise_resolve_success (void)
{
jerry_value_t my_promise = jerry_create_promise ();
jerry_value_t my_promise = jerry_promise ();
// A created promise has an undefined promise result by default and a pending state
{
jerry_value_t promise_result = jerry_get_promise_result (my_promise);
jerry_value_t promise_result = jerry_promise_result (my_promise);
TEST_ASSERT (jerry_value_is_undefined (promise_result));
jerry_promise_state_t promise_state = jerry_get_promise_state (my_promise);
jerry_promise_state_t promise_state = jerry_promise_state (my_promise);
TEST_ASSERT (promise_state == JERRY_PROMISE_STATE_PENDING);
jerry_release_value (promise_result);
jerry_value_free (promise_result);
}
jerry_value_t resolve_value = jerry_create_object ();
jerry_value_t resolve_value = jerry_object ();
{
jerry_value_t obj_key = jerry_create_string ((const jerry_char_t *) "key_one");
jerry_value_t set_result = jerry_set_property (resolve_value, obj_key, jerry_create_number (3));
jerry_value_t obj_key = jerry_string_sz ("key_one");
jerry_value_t set_result = jerry_object_set (resolve_value, obj_key, jerry_number (3));
TEST_ASSERT (jerry_value_is_boolean (set_result) && (jerry_value_is_true (set_result)));
jerry_release_value (set_result);
jerry_release_value (obj_key);
jerry_value_free (set_result);
jerry_value_free (obj_key);
}
// A resolved promise should have the result of from the resolve call and a fulfilled state
{
jerry_value_t resolve_result = jerry_resolve_or_reject_promise (my_promise, resolve_value, true);
jerry_value_t resolve_result = jerry_promise_resolve (my_promise, resolve_value);
// Release "old" value of resolve.
jerry_release_value (resolve_value);
jerry_value_free (resolve_value);
jerry_value_t promise_result = jerry_get_promise_result (my_promise);
jerry_value_t promise_result = jerry_promise_result (my_promise);
{
TEST_ASSERT (jerry_value_is_object (promise_result));
jerry_value_t obj_key = jerry_create_string ((const jerry_char_t *) "key_one");
jerry_value_t get_result = jerry_get_property (promise_result, obj_key);
jerry_value_t obj_key = jerry_string_sz ("key_one");
jerry_value_t get_result = jerry_object_get (promise_result, obj_key);
TEST_ASSERT (jerry_value_is_number (get_result));
TEST_ASSERT (jerry_get_number_value (get_result) == 3.0);
TEST_ASSERT (jerry_value_as_number (get_result) == 3.0);
jerry_release_value (get_result);
jerry_release_value (obj_key);
jerry_value_free (get_result);
jerry_value_free (obj_key);
}
jerry_promise_state_t promise_state = jerry_get_promise_state (my_promise);
jerry_promise_state_t promise_state = jerry_promise_state (my_promise);
TEST_ASSERT (promise_state == JERRY_PROMISE_STATE_FULFILLED);
jerry_release_value (promise_result);
jerry_value_free (promise_result);
jerry_release_value (resolve_result);
jerry_value_free (resolve_result);
}
// Resolvind a promise again does not change the result/state
{
jerry_value_t resolve_result = jerry_resolve_or_reject_promise (my_promise, jerry_create_number (50), false);
jerry_value_t resolve_result = jerry_promise_reject (my_promise, jerry_number (50));
jerry_value_t promise_result = jerry_get_promise_result (my_promise);
jerry_value_t promise_result = jerry_promise_result (my_promise);
{
TEST_ASSERT (jerry_value_is_object (promise_result));
jerry_value_t obj_key = jerry_create_string ((const jerry_char_t *) "key_one");
jerry_value_t get_result = jerry_get_property (promise_result, obj_key);
jerry_value_t obj_key = jerry_string_sz ("key_one");
jerry_value_t get_result = jerry_object_get (promise_result, obj_key);
TEST_ASSERT (jerry_value_is_number (get_result));
TEST_ASSERT (jerry_get_number_value (get_result) == 3.0);
TEST_ASSERT (jerry_value_as_number (get_result) == 3.0);
jerry_release_value (get_result);
jerry_release_value (obj_key);
jerry_value_free (get_result);
jerry_value_free (obj_key);
}
jerry_promise_state_t promise_state = jerry_get_promise_state (my_promise);
jerry_promise_state_t promise_state = jerry_promise_state (my_promise);
TEST_ASSERT (promise_state == JERRY_PROMISE_STATE_FULFILLED);
jerry_release_value (promise_result);
jerry_value_free (promise_result);
jerry_release_value (resolve_result);
jerry_value_free (resolve_result);
}
jerry_release_value (my_promise);
jerry_value_free (my_promise);
} /* test_promise_resolve_success */
static void
test_promise_resolve_fail (void)
{
jerry_value_t my_promise = jerry_create_promise ();
jerry_value_t my_promise = jerry_promise ();
// A created promise has an undefined promise result by default and a pending state
{
jerry_value_t promise_result = jerry_get_promise_result (my_promise);
jerry_value_t promise_result = jerry_promise_result (my_promise);
TEST_ASSERT (jerry_value_is_undefined (promise_result));
jerry_promise_state_t promise_state = jerry_get_promise_state (my_promise);
jerry_promise_state_t promise_state = jerry_promise_state (my_promise);
TEST_ASSERT (promise_state == JERRY_PROMISE_STATE_PENDING);
jerry_release_value (promise_result);
jerry_value_free (promise_result);
}
// A resolved promise should have the result of from the resolve call and a fulfilled state
{
jerry_value_t error_value = jerry_create_error (JERRY_ERROR_TYPE, (const jerry_char_t *) "resolve_fail");
jerry_value_t error_obj = jerry_get_value_from_error (error_value, true);
jerry_value_t resolve_result = jerry_resolve_or_reject_promise (my_promise, error_obj, false);
jerry_release_value (error_obj);
jerry_value_t error_obj = jerry_error_sz (JERRY_ERROR_TYPE, "resolve_fail");
jerry_value_t resolve_result = jerry_promise_reject (my_promise, error_obj);
jerry_value_free (error_obj);
jerry_value_t promise_result = jerry_get_promise_result (my_promise);
jerry_value_t promise_result = jerry_promise_result (my_promise);
// The error is not throw that's why it is only an error object.
TEST_ASSERT (jerry_value_is_object (promise_result));
TEST_ASSERT (jerry_get_error_type (promise_result) == JERRY_ERROR_TYPE);
TEST_ASSERT (jerry_error_type (promise_result) == JERRY_ERROR_TYPE);
jerry_promise_state_t promise_state = jerry_get_promise_state (my_promise);
jerry_promise_state_t promise_state = jerry_promise_state (my_promise);
TEST_ASSERT (promise_state == JERRY_PROMISE_STATE_REJECTED);
jerry_release_value (promise_result);
jerry_value_free (promise_result);
jerry_release_value (resolve_result);
jerry_value_free (resolve_result);
}
// Resolvind a promise again does not change the result/state
{
jerry_value_t resolve_result = jerry_resolve_or_reject_promise (my_promise, jerry_create_number (50), true);
jerry_value_t resolve_result = jerry_promise_resolve (my_promise, jerry_number (50));
jerry_value_t promise_result = jerry_get_promise_result (my_promise);
jerry_value_t promise_result = jerry_promise_result (my_promise);
TEST_ASSERT (jerry_value_is_object (promise_result));
TEST_ASSERT (jerry_get_error_type (promise_result) == JERRY_ERROR_TYPE);
TEST_ASSERT (jerry_error_type (promise_result) == JERRY_ERROR_TYPE);
jerry_promise_state_t promise_state = jerry_get_promise_state (my_promise);
jerry_promise_state_t promise_state = jerry_promise_state (my_promise);
TEST_ASSERT (promise_state == JERRY_PROMISE_STATE_REJECTED);
jerry_release_value (promise_result);
jerry_value_free (promise_result);
jerry_release_value (resolve_result);
jerry_value_free (resolve_result);
}
jerry_release_value (my_promise);
jerry_value_free (my_promise);
} /* test_promise_resolve_fail */
static void
@@ -159,31 +158,31 @@ test_promise_from_js (void)
const jerry_char_t test_source[] = "(new Promise(function(rs, rj) { rs(30); })).then(function(v) { return v + 1; })";
jerry_value_t parsed_code_val = jerry_parse (test_source, sizeof (test_source) - 1, NULL);
TEST_ASSERT (!jerry_value_is_error (parsed_code_val));
TEST_ASSERT (!jerry_value_is_exception (parsed_code_val));
jerry_value_t res = jerry_run (parsed_code_val);
TEST_ASSERT (jerry_value_is_promise (res));
TEST_ASSERT (jerry_get_promise_state (res) == JERRY_PROMISE_STATE_PENDING);
TEST_ASSERT (jerry_promise_state (res) == JERRY_PROMISE_STATE_PENDING);
jerry_value_t run_result = jerry_run_all_enqueued_jobs ();
jerry_value_t run_result = jerry_run_jobs ();
TEST_ASSERT (jerry_value_is_undefined (run_result));
jerry_release_value (run_result);
jerry_value_free (run_result);
TEST_ASSERT (jerry_get_promise_state (res) == JERRY_PROMISE_STATE_FULFILLED);
jerry_value_t promise_result = jerry_get_promise_result (res);
TEST_ASSERT (jerry_promise_state (res) == JERRY_PROMISE_STATE_FULFILLED);
jerry_value_t promise_result = jerry_promise_result (res);
TEST_ASSERT (jerry_value_is_number (promise_result));
TEST_ASSERT (jerry_get_number_value (promise_result) == 31.0);
TEST_ASSERT (jerry_value_as_number (promise_result) == 31.0);
jerry_release_value (promise_result);
jerry_release_value (res);
jerry_release_value (parsed_code_val);
jerry_value_free (promise_result);
jerry_value_free (res);
jerry_value_free (parsed_code_val);
} /* test_promise_from_js */
int
main (void)
{
if (!jerry_is_feature_enabled (JERRY_FEATURE_PROMISE))
if (!jerry_feature_enabled (JERRY_FEATURE_PROMISE))
{
jerry_port_log (JERRY_LOG_LEVEL_ERROR, "Promise is disabled!\n");
return 0;