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
+85 -85
View File
@@ -76,7 +76,7 @@ native_references_free_callback (void *native_p, /**< native pointer */
uint32_t check = refs_p->check_before;
jerry_native_pointer_release_references (native_p, info_p);
jerry_native_ptr_free (native_p, info_p);
TEST_ASSERT (jerry_value_is_undefined (refs_p->a));
TEST_ASSERT (jerry_value_is_undefined (refs_p->b));
@@ -104,7 +104,7 @@ init_references (test_references_t *refs_p, /**< native pointer */
refs_p->c = 3;
refs_p->check_after = check;
jerry_native_pointer_init_references ((void *) refs_p, &native_info_4);
jerry_native_ptr_init ((void *) refs_p, &native_info_4);
TEST_ASSERT (jerry_value_is_undefined (refs_p->a));
TEST_ASSERT (jerry_value_is_undefined (refs_p->b));
@@ -119,9 +119,9 @@ set_references (test_references_t *refs_p, /**< native pointer */
jerry_value_t value2, /**< second value to be set */
jerry_value_t value3) /**< third value to be set */
{
jerry_native_pointer_set_reference (&refs_p->a, value1);
jerry_native_pointer_set_reference (&refs_p->b, value2);
jerry_native_pointer_set_reference (&refs_p->c, value3);
jerry_native_ptr_set (&refs_p->a, value1);
jerry_native_ptr_set (&refs_p->b, value2);
jerry_native_ptr_set (&refs_p->c, value3);
TEST_ASSERT (jerry_value_is_object (value1) ? jerry_value_is_object (refs_p->a) : jerry_value_is_string (refs_p->a));
TEST_ASSERT (jerry_value_is_object (value2) ? jerry_value_is_object (refs_p->b) : jerry_value_is_string (refs_p->b));
@@ -133,8 +133,8 @@ check_native_info (jerry_value_t object_value, /**< object value */
const jerry_object_native_info_t *native_info_p, /**< native info */
void *expected_pointer_p) /**< expected pointer */
{
void *native_pointer_p;
TEST_ASSERT (jerry_get_object_native_pointer (object_value, &native_pointer_p, native_info_p));
TEST_ASSERT (jerry_object_has_native_ptr (object_value, native_info_p));
void *native_pointer_p = jerry_object_get_native_ptr (object_value, native_info_p);
TEST_ASSERT (native_pointer_p == expected_pointer_p);
} /* check_native_info */
@@ -144,189 +144,189 @@ main (void)
TEST_INIT ();
jerry_init (JERRY_INIT_EMPTY);
jerry_value_t object_value = jerry_create_object ();
jerry_value_t object_value = jerry_object ();
jerry_set_object_native_pointer (object_value, global_p, &native_info_1);
jerry_set_object_native_pointer (object_value, NULL, &native_info_2);
jerry_object_set_native_ptr (object_value, &native_info_1, global_p);
jerry_object_set_native_ptr (object_value, &native_info_2, NULL);
check_native_info (object_value, &native_info_1, global_p);
check_native_info (object_value, &native_info_2, NULL);
jerry_release_value (object_value);
jerry_value_free (object_value);
jerry_gc (JERRY_GC_PRESSURE_HIGH);
jerry_heap_gc (JERRY_GC_PRESSURE_HIGH);
TEST_ASSERT (global_counter == 1);
global_counter = 0;
object_value = jerry_create_object ();
object_value = jerry_object ();
jerry_set_object_native_pointer (object_value, global_p, &native_info_1);
jerry_set_object_native_pointer (object_value, NULL, &native_info_2);
jerry_object_set_native_ptr (object_value, &native_info_1, global_p);
jerry_object_set_native_ptr (object_value, &native_info_2, NULL);
TEST_ASSERT (jerry_delete_object_native_pointer (object_value, &native_info_1));
TEST_ASSERT (jerry_object_delete_native_ptr (object_value, &native_info_1));
TEST_ASSERT (!jerry_get_object_native_pointer (object_value, NULL, &native_info_1));
TEST_ASSERT (!jerry_object_has_native_ptr (object_value, &native_info_1));
check_native_info (object_value, &native_info_2, NULL);
TEST_ASSERT (!jerry_delete_object_native_pointer (object_value, &native_info_1));
TEST_ASSERT (!jerry_object_delete_native_ptr (object_value, &native_info_1));
TEST_ASSERT (!jerry_get_object_native_pointer (object_value, NULL, &native_info_1));
TEST_ASSERT (!jerry_object_has_native_ptr (object_value, &native_info_1));
check_native_info (object_value, &native_info_2, NULL);
TEST_ASSERT (jerry_delete_object_native_pointer (object_value, &native_info_2));
TEST_ASSERT (jerry_object_delete_native_ptr (object_value, &native_info_2));
TEST_ASSERT (!jerry_get_object_native_pointer (object_value, NULL, &native_info_1));
TEST_ASSERT (!jerry_get_object_native_pointer (object_value, NULL, &native_info_2));
TEST_ASSERT (!jerry_object_has_native_ptr (object_value, &native_info_1));
TEST_ASSERT (!jerry_object_has_native_ptr (object_value, &native_info_2));
jerry_set_object_native_pointer (object_value, NULL, &native_info_1);
jerry_object_set_native_ptr (object_value, &native_info_1, NULL);
check_native_info (object_value, &native_info_1, NULL);
TEST_ASSERT (!jerry_get_object_native_pointer (object_value, NULL, &native_info_2));
TEST_ASSERT (!jerry_object_has_native_ptr (object_value, &native_info_2));
jerry_set_object_native_pointer (object_value, global_p, &native_info_2);
jerry_object_set_native_ptr (object_value, &native_info_2, global_p);
check_native_info (object_value, &native_info_1, NULL);
check_native_info (object_value, &native_info_2, global_p);
jerry_set_object_native_pointer (object_value, global_p, &native_info_1);
jerry_object_set_native_ptr (object_value, &native_info_1, global_p);
check_native_info (object_value, &native_info_1, global_p);
check_native_info (object_value, &native_info_2, global_p);
TEST_ASSERT (jerry_delete_object_native_pointer (object_value, &native_info_1));
TEST_ASSERT (jerry_delete_object_native_pointer (object_value, &native_info_2));
TEST_ASSERT (jerry_object_delete_native_ptr (object_value, &native_info_1));
TEST_ASSERT (jerry_object_delete_native_ptr (object_value, &native_info_2));
TEST_ASSERT (!jerry_get_object_native_pointer (object_value, NULL, &native_info_1));
TEST_ASSERT (!jerry_get_object_native_pointer (object_value, NULL, &native_info_2));
TEST_ASSERT (!jerry_object_has_native_ptr (object_value, &native_info_1));
TEST_ASSERT (!jerry_object_has_native_ptr (object_value, &native_info_2));
jerry_set_object_native_pointer (object_value, global_p, &native_info_1);
jerry_set_object_native_pointer (object_value, NULL, &native_info_2);
jerry_set_object_native_pointer (object_value, global_p, &native_info_3);
jerry_object_set_native_ptr (object_value, &native_info_1, global_p);
jerry_object_set_native_ptr (object_value, &native_info_2, NULL);
jerry_object_set_native_ptr (object_value, &native_info_3, global_p);
check_native_info (object_value, &native_info_1, global_p);
check_native_info (object_value, &native_info_2, NULL);
check_native_info (object_value, &native_info_3, global_p);
TEST_ASSERT (jerry_delete_object_native_pointer (object_value, &native_info_1));
TEST_ASSERT (jerry_delete_object_native_pointer (object_value, &native_info_2));
TEST_ASSERT (jerry_delete_object_native_pointer (object_value, &native_info_3));
TEST_ASSERT (jerry_object_delete_native_ptr (object_value, &native_info_1));
TEST_ASSERT (jerry_object_delete_native_ptr (object_value, &native_info_2));
TEST_ASSERT (jerry_object_delete_native_ptr (object_value, &native_info_3));
TEST_ASSERT (!jerry_get_object_native_pointer (object_value, NULL, &native_info_1));
TEST_ASSERT (!jerry_get_object_native_pointer (object_value, NULL, &native_info_2));
TEST_ASSERT (!jerry_get_object_native_pointer (object_value, NULL, &native_info_3));
TEST_ASSERT (!jerry_object_has_native_ptr (object_value, &native_info_1));
TEST_ASSERT (!jerry_object_has_native_ptr (object_value, &native_info_2));
TEST_ASSERT (!jerry_object_has_native_ptr (object_value, &native_info_3));
jerry_set_object_native_pointer (object_value, NULL, &native_info_1);
jerry_set_object_native_pointer (object_value, global_p, &native_info_2);
jerry_set_object_native_pointer (object_value, NULL, &native_info_3);
jerry_object_set_native_ptr (object_value, &native_info_1, NULL);
jerry_object_set_native_ptr (object_value, &native_info_2, global_p);
jerry_object_set_native_ptr (object_value, &native_info_3, NULL);
check_native_info (object_value, &native_info_1, NULL);
check_native_info (object_value, &native_info_2, global_p);
check_native_info (object_value, &native_info_3, NULL);
/* Reversed delete order. */
TEST_ASSERT (jerry_delete_object_native_pointer (object_value, &native_info_3));
TEST_ASSERT (jerry_delete_object_native_pointer (object_value, &native_info_2));
TEST_ASSERT (jerry_delete_object_native_pointer (object_value, &native_info_1));
TEST_ASSERT (jerry_object_delete_native_ptr (object_value, &native_info_3));
TEST_ASSERT (jerry_object_delete_native_ptr (object_value, &native_info_2));
TEST_ASSERT (jerry_object_delete_native_ptr (object_value, &native_info_1));
TEST_ASSERT (!jerry_get_object_native_pointer (object_value, NULL, &native_info_1));
TEST_ASSERT (!jerry_get_object_native_pointer (object_value, NULL, &native_info_2));
TEST_ASSERT (!jerry_get_object_native_pointer (object_value, NULL, &native_info_3));
TEST_ASSERT (!jerry_object_has_native_ptr (object_value, &native_info_1));
TEST_ASSERT (!jerry_object_has_native_ptr (object_value, &native_info_2));
TEST_ASSERT (!jerry_object_has_native_ptr (object_value, &native_info_3));
/* Test value references */
jerry_value_t string1_value = jerry_create_string ((const jerry_char_t *) "String1");
jerry_value_t string2_value = jerry_create_string ((const jerry_char_t *) "String2");
jerry_value_t string1_value = jerry_string_sz ("String1");
jerry_value_t string2_value = jerry_string_sz ("String2");
jerry_value_t object1_value = jerry_create_object ();
jerry_value_t object2_value = jerry_create_object ();
jerry_value_t object1_value = jerry_object ();
jerry_value_t object2_value = jerry_object ();
init_references (&test_references1, 0x12345678);
init_references (&test_references2, 0x87654321);
jerry_set_object_native_pointer (object1_value, (void *) &test_references1, &native_info_4);
jerry_set_object_native_pointer (object2_value, (void *) &test_references2, &native_info_4);
jerry_object_set_native_ptr (object1_value, &native_info_4, (void *) &test_references1);
jerry_object_set_native_ptr (object2_value, &native_info_4, (void *) &test_references2);
/* Assign values (cross reference between object1 and object2). */
set_references (&test_references1, string1_value, object2_value, string2_value);
set_references (&test_references2, string2_value, object1_value, string1_value);
jerry_gc (JERRY_GC_PRESSURE_HIGH);
jerry_heap_gc (JERRY_GC_PRESSURE_HIGH);
/* Reassign values. */
set_references (&test_references1, object2_value, string2_value, string1_value);
set_references (&test_references2, object1_value, string1_value, string2_value);
jerry_gc (JERRY_GC_PRESSURE_HIGH);
jerry_heap_gc (JERRY_GC_PRESSURE_HIGH);
jerry_release_value (object1_value);
jerry_release_value (object2_value);
jerry_value_free (object1_value);
jerry_value_free (object2_value);
object1_value = jerry_create_object ();
object2_value = jerry_create_object ();
object1_value = jerry_object ();
object2_value = jerry_object ();
init_references (&test_references3, 0x12344321);
/* Assign the same native pointer to multiple objects. */
jerry_set_object_native_pointer (object1_value, (void *) &test_references3, &native_info_4);
jerry_set_object_native_pointer (object2_value, (void *) &test_references3, &native_info_4);
jerry_object_set_native_ptr (object1_value, &native_info_4, (void *) &test_references3);
jerry_object_set_native_ptr (object2_value, &native_info_4, (void *) &test_references3);
set_references (&test_references3, object1_value, object2_value, string1_value);
jerry_gc (JERRY_GC_PRESSURE_HIGH);
jerry_heap_gc (JERRY_GC_PRESSURE_HIGH);
init_references (&test_references4, 0x87655678);
/* Re-assign reference */
jerry_set_object_native_pointer (object1_value, (void *) &test_references4, &native_info_4);
jerry_object_set_native_ptr (object1_value, &native_info_4, (void *) &test_references4);
set_references (&test_references4, string1_value, string2_value, string1_value);
jerry_set_object_native_pointer (object1_value, NULL, &native_info_4);
jerry_object_set_native_ptr (object1_value, &native_info_4, NULL);
jerry_native_pointer_release_references ((void *) &test_references4, &native_info_4);
jerry_native_ptr_free ((void *) &test_references4, &native_info_4);
/* Calling jerry_native_pointer_init_references with test_references4 is optional here. */
/* Calling jerry_native_ptr_init with test_references4 is optional here. */
jerry_set_object_native_pointer (object1_value, (void *) &test_references4, &native_info_4);
jerry_object_set_native_ptr (object1_value, &native_info_4, (void *) &test_references4);
set_references (&test_references4, string2_value, string1_value, string2_value);
TEST_ASSERT (jerry_delete_object_native_pointer (object1_value, &native_info_4));
TEST_ASSERT (jerry_object_delete_native_ptr (object1_value, &native_info_4));
jerry_native_pointer_release_references ((void *) &test_references4, &native_info_4);
jerry_native_ptr_free ((void *) &test_references4, &native_info_4);
jerry_release_value (object1_value);
jerry_release_value (object2_value);
jerry_value_free (object1_value);
jerry_value_free (object2_value);
/* Delete references */
for (int i = 0; i < 3; i++)
{
object1_value = jerry_create_object ();
object1_value = jerry_object ();
jerry_set_object_native_pointer (object1_value, global_p, NULL);
jerry_set_object_native_pointer (object1_value, (void *) &test_references4, &native_info_4);
jerry_set_object_native_pointer (object1_value, global_p, &native_info_2);
jerry_object_set_native_ptr (object1_value, NULL, global_p);
jerry_object_set_native_ptr (object1_value, &native_info_4, (void *) &test_references4);
jerry_object_set_native_ptr (object1_value, &native_info_2, global_p);
set_references (&test_references4, string1_value, string2_value, object1_value);
jerry_gc (JERRY_GC_PRESSURE_HIGH);
jerry_heap_gc (JERRY_GC_PRESSURE_HIGH);
if (i == 1)
{
TEST_ASSERT (jerry_delete_object_native_pointer (object1_value, NULL));
TEST_ASSERT (jerry_object_delete_native_ptr (object1_value, NULL));
}
else if (i == 2)
{
TEST_ASSERT (jerry_delete_object_native_pointer (object1_value, &native_info_2));
TEST_ASSERT (jerry_object_delete_native_ptr (object1_value, &native_info_2));
}
TEST_ASSERT (jerry_delete_object_native_pointer (object1_value, &native_info_4));
jerry_native_pointer_release_references ((void *) &test_references4, &native_info_4);
jerry_release_value (object1_value);
TEST_ASSERT (jerry_object_delete_native_ptr (object1_value, &native_info_4));
jerry_native_ptr_free ((void *) &test_references4, &native_info_4);
jerry_value_free (object1_value);
}
jerry_release_value (string1_value);
jerry_release_value (string2_value);
jerry_value_free (string1_value);
jerry_value_free (string2_value);
jerry_release_value (object_value);
jerry_value_free (object_value);
jerry_cleanup ();