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 -61
View File
@@ -30,24 +30,24 @@ global_assert (const jerry_call_info_t *call_info_p, /**< call information */
JERRY_UNUSED (call_info_p);
TEST_ASSERT (args_cnt == 1 && jerry_value_is_true (args_p[0]));
return jerry_create_boolean (true);
return jerry_boolean (true);
} /* global_assert */
static void
register_assert (void)
{
jerry_value_t global_object_value = jerry_get_global_object ();
jerry_value_t global_object_value = jerry_current_realm ();
jerry_value_t function_value = jerry_create_external_function (global_assert);
jerry_value_t function_name_value = jerry_create_string ((const jerry_char_t *) "assert");
jerry_value_t result_value = jerry_set_property (global_object_value, function_name_value, function_value);
jerry_value_t function_value = jerry_function_external (global_assert);
jerry_value_t function_name_value = jerry_string_sz ("assert");
jerry_value_t result_value = jerry_object_set (global_object_value, function_name_value, function_value);
jerry_release_value (function_name_value);
jerry_release_value (function_value);
jerry_release_value (global_object_value);
jerry_value_free (function_name_value);
jerry_value_free (function_value);
jerry_value_free (global_object_value);
TEST_ASSERT (jerry_value_is_true (result_value));
jerry_release_value (result_value);
jerry_value_free (result_value);
} /* register_assert */
static void
@@ -65,9 +65,9 @@ compare_specifier (jerry_value_t specifier, /* string value */
jerry_char_t buffer[sizeof (string) - 1];
TEST_ASSERT (jerry_value_is_string (specifier));
TEST_ASSERT (jerry_get_string_size (specifier) == length);
TEST_ASSERT (jerry_string_size (specifier, JERRY_ENCODING_CESU8) == length);
TEST_ASSERT (jerry_string_to_char_buffer (specifier, buffer, length) == length);
TEST_ASSERT (jerry_string_to_buffer (specifier, JERRY_ENCODING_CESU8, buffer, length) == length);
TEST_ASSERT (memcmp (buffer, string, length) == 0);
} /* compare_specifier */
@@ -80,10 +80,10 @@ module_import_callback (const jerry_value_t specifier, /* string value */
if (mode != 3)
{
jerry_value_t compare_value = jerry_binary_operation (JERRY_BIN_OP_STRICT_EQUAL, user_value, global_user_value);
jerry_value_t compare_value = jerry_binary_op (JERRY_BIN_OP_STRICT_EQUAL, user_value, global_user_value);
TEST_ASSERT (jerry_value_is_true (compare_value));
jerry_release_value (compare_value);
jerry_value_free (compare_value);
}
switch (mode)
@@ -91,22 +91,22 @@ module_import_callback (const jerry_value_t specifier, /* string value */
case 0:
{
compare_specifier (specifier, 1);
return jerry_create_error (JERRY_ERROR_RANGE, (const jerry_char_t *) "Err01");
return jerry_throw_sz (JERRY_ERROR_RANGE, "Err01");
}
case 1:
{
compare_specifier (specifier, 2);
return jerry_create_null ();
return jerry_null ();
}
case 2:
{
compare_specifier (specifier, 3);
jerry_value_t promise_value = jerry_create_promise ();
jerry_value_t promise_value = jerry_promise ();
/* Normally this should be a namespace object. */
jerry_value_t object_value = jerry_create_object ();
jerry_resolve_or_reject_promise (promise_value, object_value, true);
jerry_release_value (object_value);
jerry_value_t object_value = jerry_object ();
jerry_promise_resolve (promise_value, object_value);
jerry_value_free (object_value);
return promise_value;
}
case 3:
@@ -114,12 +114,12 @@ module_import_callback (const jerry_value_t specifier, /* string value */
compare_specifier (specifier, 28);
TEST_ASSERT (jerry_value_is_object (user_value));
jerry_value_t property_name = jerry_create_string ((const jerry_char_t *) "MyProp1");
jerry_value_t result = jerry_get_property (user_value, property_name);
TEST_ASSERT (jerry_value_is_number (result) && jerry_get_number_value (result) == 3.5);
jerry_release_value (result);
jerry_release_value (property_name);
return jerry_create_undefined ();
jerry_value_t property_name = jerry_string_sz ("MyProp1");
jerry_value_t result = jerry_object_get (user_value, property_name);
TEST_ASSERT (jerry_value_is_number (result) && jerry_value_as_number (result) == 3.5);
jerry_value_free (result);
jerry_value_free (property_name);
return jerry_undefined ();
}
}
@@ -129,17 +129,17 @@ module_import_callback (const jerry_value_t specifier, /* string value */
parse_options.options = JERRY_PARSE_MODULE;
jerry_value_t parse_result_value = jerry_parse ((const jerry_char_t *) "", 0, &parse_options);
TEST_ASSERT (!jerry_value_is_error (parse_result_value));
TEST_ASSERT (!jerry_value_is_exception (parse_result_value));
jerry_value_t result_value = jerry_module_link (parse_result_value, NULL, NULL);
TEST_ASSERT (!jerry_value_is_error (result_value));
jerry_release_value (result_value);
TEST_ASSERT (!jerry_value_is_exception (result_value));
jerry_value_free (result_value);
if (mode == 4)
{
result_value = jerry_module_evaluate (parse_result_value);
TEST_ASSERT (!jerry_value_is_error (result_value));
jerry_release_value (result_value);
TEST_ASSERT (!jerry_value_is_exception (result_value));
jerry_value_free (result_value);
}
return parse_result_value;
@@ -153,20 +153,20 @@ run_script (const char *source_p, /* source code */
jerry_value_t parse_result_value;
parse_result_value = jerry_parse ((const jerry_char_t *) source_p, strlen (source_p), parse_options_p);
TEST_ASSERT (!jerry_value_is_error (parse_result_value));
TEST_ASSERT (!jerry_value_is_exception (parse_result_value));
if (release_user_value)
{
jerry_release_value (parse_options_p->user_value);
jerry_gc (JERRY_GC_PRESSURE_HIGH);
jerry_value_free (parse_options_p->user_value);
jerry_heap_gc (JERRY_GC_PRESSURE_HIGH);
}
jerry_value_t result_value;
if (parse_options_p->options & JERRY_PARSE_MODULE)
{
result_value = jerry_module_link (parse_result_value, NULL, NULL);
TEST_ASSERT (!jerry_value_is_error (result_value));
jerry_release_value (result_value);
TEST_ASSERT (!jerry_value_is_exception (result_value));
jerry_value_free (result_value);
result_value = jerry_module_evaluate (parse_result_value);
}
@@ -175,14 +175,14 @@ run_script (const char *source_p, /* source code */
result_value = jerry_run (parse_result_value);
}
jerry_release_value (parse_result_value);
jerry_value_free (parse_result_value);
TEST_ASSERT (!jerry_value_is_error (result_value));
jerry_release_value (result_value);
TEST_ASSERT (!jerry_value_is_exception (result_value));
jerry_value_free (result_value);
result_value = jerry_run_all_enqueued_jobs ();
TEST_ASSERT (!jerry_value_is_error (result_value));
jerry_release_value (result_value);
result_value = jerry_run_jobs ();
TEST_ASSERT (!jerry_value_is_exception (result_value));
jerry_value_free (result_value);
} /* run_script */
int
@@ -190,7 +190,7 @@ main (void)
{
jerry_init (JERRY_INIT_EMPTY);
if (!jerry_is_feature_enabled (JERRY_FEATURE_MODULE))
if (!jerry_feature_enabled (JERRY_FEATURE_MODULE))
{
jerry_port_log (JERRY_LOG_LEVEL_ERROR, "Module is disabled!\n");
jerry_cleanup ();
@@ -198,12 +198,12 @@ main (void)
}
register_assert ();
jerry_module_set_import_callback (module_import_callback, (void *) &mode);
jerry_module_on_import (module_import_callback, (void *) &mode);
jerry_parse_options_t parse_options;
parse_options.options = JERRY_PARSE_NO_OPTS;
if (jerry_is_feature_enabled (JERRY_FEATURE_ERROR_MESSAGES))
if (jerry_feature_enabled (JERRY_FEATURE_ERROR_MESSAGES))
{
run_script ("var expected_message = 'Module cannot be instantiated'", &parse_options, false);
}
@@ -212,7 +212,7 @@ main (void)
run_script ("var expected_message = ''", &parse_options, false);
}
global_user_value = jerry_create_object ();
global_user_value = jerry_object ();
const char *source_p = TEST_STRING_LITERAL ("import('01_module.mjs').then(\n"
" function(resolve) { assert(false) },\n"
" function(reject) {\n"
@@ -225,9 +225,9 @@ main (void)
parse_options.options = JERRY_PARSE_HAS_USER_VALUE;
parse_options.user_value = global_user_value;
run_script (source_p, &parse_options, false);
jerry_release_value (global_user_value);
jerry_value_free (global_user_value);
global_user_value = jerry_create_null ();
global_user_value = jerry_null ();
source_p = TEST_STRING_LITERAL ("var src = \"import('02_module.mjs').then(\\\n"
" function(resolve) { assert(false) },\\\n"
" function(reject) {\\\n"
@@ -241,9 +241,9 @@ main (void)
parse_options.options = JERRY_PARSE_HAS_USER_VALUE;
parse_options.user_value = global_user_value;
run_script (source_p, &parse_options, false);
jerry_release_value (global_user_value);
jerry_value_free (global_user_value);
global_user_value = jerry_create_number (5.6);
global_user_value = jerry_number (5.6);
source_p = TEST_STRING_LITERAL ("function f() {\n"
" return function () {\n"
" return import('03_module.mjs')\n"
@@ -258,9 +258,9 @@ main (void)
parse_options.options = JERRY_PARSE_HAS_USER_VALUE | JERRY_PARSE_MODULE;
parse_options.user_value = global_user_value;
run_script (source_p, &parse_options, false);
jerry_release_value (global_user_value);
jerry_value_free (global_user_value);
global_user_value = jerry_create_string ((const jerry_char_t *) "Any string...");
global_user_value = jerry_string_sz ("Any string...");
source_p = TEST_STRING_LITERAL ("var src = \"import('02_module.mjs').then(\\\n"
" function(resolve) { assert(typeof resolve == 'object') },\\\n"
" function(reject) { assert(false) }\\\n"
@@ -274,14 +274,14 @@ main (void)
{
mode = 3;
parse_options.options = JERRY_PARSE_HAS_USER_VALUE | (i == 1 ? JERRY_PARSE_MODULE : 0);
parse_options.user_value = jerry_create_object ();
jerry_value_t property_name = jerry_create_string ((const jerry_char_t *) "MyProp1");
jerry_value_t property_value = jerry_create_number (3.5);
jerry_value_t result = jerry_set_property (parse_options.user_value, property_name, property_value);
parse_options.user_value = jerry_object ();
jerry_value_t property_name = jerry_string_sz ("MyProp1");
jerry_value_t property_value = jerry_number (3.5);
jerry_value_t result = jerry_object_set (parse_options.user_value, property_name, property_value);
TEST_ASSERT (jerry_value_is_true (result));
jerry_release_value (result);
jerry_release_value (property_value);
jerry_release_value (property_name);
jerry_value_free (result);
jerry_value_free (property_value);
jerry_value_free (property_name);
source_p = TEST_STRING_LITERAL ("import('28_module.mjs')");
run_script (source_p, &parse_options, true);
@@ -291,9 +291,9 @@ main (void)
parse_options.options = JERRY_PARSE_HAS_USER_VALUE;
parse_options.user_value = global_user_value;
run_script (source_p, &parse_options, false);
jerry_release_value (global_user_value);
jerry_value_free (global_user_value);
global_user_value = jerry_create_external_function (global_assert);
global_user_value = jerry_function_external (global_assert);
source_p = TEST_STRING_LITERAL ("var src = \"import('02_module.mjs').then(\\\n"
" function(resolve) { assert(false) },\\\n"
" function(reject) {\\\n"
@@ -310,7 +310,7 @@ main (void)
parse_options.options = JERRY_PARSE_HAS_USER_VALUE | JERRY_PARSE_MODULE;
parse_options.user_value = global_user_value;
run_script (source_p, &parse_options, false);
jerry_release_value (global_user_value);
jerry_value_free (global_user_value);
jerry_cleanup ();
return 0;