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-core/test-arraybuffer.c
+80 -94
View File
@@ -26,16 +26,16 @@ static void
register_js_value (const char *name_p, /**< name of the function */
jerry_value_t value) /**< JS value */
{
jerry_value_t global_obj_val = jerry_get_global_object ();
jerry_value_t global_obj_val = jerry_current_realm ();
jerry_value_t name_val = jerry_create_string ((const jerry_char_t *) name_p);
jerry_value_t result_val = jerry_set_property (global_obj_val, name_val, value);
jerry_value_t name_val = jerry_string_sz (name_p);
jerry_value_t result_val = jerry_object_set (global_obj_val, name_val, value);
TEST_ASSERT (jerry_value_is_boolean (result_val));
jerry_release_value (name_val);
jerry_release_value (global_obj_val);
jerry_value_free (name_val);
jerry_value_free (global_obj_val);
jerry_release_value (result_val);
jerry_value_free (result_val);
} /* register_js_value */
static jerry_value_t
@@ -47,17 +47,17 @@ assert_handler (const jerry_call_info_t *call_info_p, /**< call information */
if (args_cnt > 0 && jerry_value_is_true (args_p[0]))
{
return jerry_create_boolean (true);
return jerry_boolean (true);
}
if (args_cnt > 1 && jerry_value_is_string (args_p[1]))
{
jerry_length_t utf8_sz = jerry_get_string_size (args_p[1]);
jerry_length_t utf8_sz = jerry_string_size (args_p[1], JERRY_ENCODING_CESU8);
TEST_ASSERT (utf8_sz <= 127); /* 127 is the expected max assert fail message size. */
JERRY_VLA (char, string_from_utf8, utf8_sz + 1);
string_from_utf8[utf8_sz] = 0;
jerry_string_to_char_buffer (args_p[1], (jerry_char_t *) string_from_utf8, utf8_sz);
jerry_string_to_buffer (args_p[1], JERRY_ENCODING_CESU8, (jerry_char_t *) string_from_utf8, utf8_sz);
printf ("JS assert: %s\n", string_from_utf8);
}
@@ -78,9 +78,9 @@ test_read_with_offset (uint8_t offset) /**< offset for buffer read. */
jerry_value_t arraybuffer =
jerry_eval (eval_arraybuffer_src, sizeof (eval_arraybuffer_src) - 1, JERRY_PARSE_STRICT_MODE);
TEST_ASSERT (!jerry_value_is_error (arraybuffer));
TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
TEST_ASSERT (jerry_get_arraybuffer_byte_length (arraybuffer) == 15);
TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == 15);
uint8_t buffer[20];
memset (buffer, 120, 20);
@@ -95,7 +95,7 @@ test_read_with_offset (uint8_t offset) /**< offset for buffer read. */
}
TEST_ASSERT (buffer[15 - offset] == 120);
jerry_release_value (arraybuffer);
jerry_value_free (arraybuffer);
} /* test_read_with_offset */
/**
@@ -105,18 +105,18 @@ static void
test_write_with_offset (uint8_t offset) /**< offset for buffer write. */
{
{
jerry_value_t offset_val = jerry_create_number (offset);
jerry_value_t offset_val = jerry_number (offset);
register_js_value ("offset", offset_val);
jerry_release_value (offset_val);
jerry_value_free (offset_val);
}
const jerry_char_t eval_arraybuffer_src[] = "var array = new Uint8Array (15); array.buffer";
jerry_value_t arraybuffer =
jerry_eval (eval_arraybuffer_src, sizeof (eval_arraybuffer_src) - 1, JERRY_PARSE_STRICT_MODE);
TEST_ASSERT (!jerry_value_is_error (arraybuffer));
TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
TEST_ASSERT (jerry_get_arraybuffer_byte_length (arraybuffer) == 15);
TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == 15);
uint8_t buffer[20];
@@ -141,8 +141,8 @@ test_write_with_offset (uint8_t offset) /**< offset for buffer write. */
"};"
"assert (array[15] === undefined, 'ArrayBuffer out of bounds index should return undefined value');");
jerry_value_t res = jerry_eval (eval_test_arraybuffer, sizeof (eval_test_arraybuffer) - 1, JERRY_PARSE_STRICT_MODE);
jerry_release_value (res);
jerry_release_value (arraybuffer);
jerry_value_free (res);
jerry_value_free (arraybuffer);
} /* test_write_with_offset */
static int allocate_mode = 0;
@@ -205,39 +205,39 @@ main (void)
{
jerry_init (JERRY_INIT_EMPTY);
if (!jerry_is_feature_enabled (JERRY_FEATURE_TYPEDARRAY))
if (!jerry_feature_enabled (JERRY_FEATURE_TYPEDARRAY))
{
jerry_port_log (JERRY_LOG_LEVEL_ERROR, "ArrayBuffer is disabled!\n");
jerry_cleanup ();
return 0;
}
jerry_arraybuffer_set_compact_allocation_limit (4);
jerry_arraybuffer_set_allocator_callbacks (test_allocate_cb, test_free_cb, (void *) &allocate_mode);
jerry_arraybuffer_heap_allocation_limit (4);
jerry_arraybuffer_allocator (test_allocate_cb, test_free_cb, (void *) &allocate_mode);
jerry_value_t function_val = jerry_create_external_function (assert_handler);
jerry_value_t function_val = jerry_function_external (assert_handler);
register_js_value ("assert", function_val);
jerry_release_value (function_val);
jerry_value_free (function_val);
/* Test array buffer queries */
{
const jerry_char_t eval_arraybuffer_src[] = "new ArrayBuffer (10)";
jerry_value_t eval_arraybuffer =
jerry_eval (eval_arraybuffer_src, sizeof (eval_arraybuffer_src) - 1, JERRY_PARSE_STRICT_MODE);
TEST_ASSERT (!jerry_value_is_error (eval_arraybuffer));
TEST_ASSERT (!jerry_value_is_exception (eval_arraybuffer));
TEST_ASSERT (jerry_value_is_arraybuffer (eval_arraybuffer));
TEST_ASSERT (jerry_get_arraybuffer_byte_length (eval_arraybuffer) == 10);
jerry_release_value (eval_arraybuffer);
TEST_ASSERT (jerry_arraybuffer_size (eval_arraybuffer) == 10);
jerry_value_free (eval_arraybuffer);
}
/* Test array buffer creation */
{
const uint32_t length = 15;
jerry_value_t arraybuffer = jerry_create_arraybuffer (length);
TEST_ASSERT (!jerry_value_is_error (arraybuffer));
jerry_value_t arraybuffer = jerry_arraybuffer (length);
TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
TEST_ASSERT (jerry_get_arraybuffer_byte_length (arraybuffer) == length);
jerry_release_value (arraybuffer);
TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == length);
jerry_value_free (arraybuffer);
}
/* Test array buffer read operations */
@@ -249,10 +249,10 @@ main (void)
/* Test zero length ArrayBuffer read */
{
const uint32_t length = 0;
jerry_value_t arraybuffer = jerry_create_arraybuffer (length);
TEST_ASSERT (!jerry_value_is_error (arraybuffer));
jerry_value_t arraybuffer = jerry_arraybuffer (length);
TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
TEST_ASSERT (jerry_get_arraybuffer_byte_length (arraybuffer) == length);
TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == length);
uint8_t data[20];
memset (data, 11, 20);
@@ -265,7 +265,7 @@ main (void)
TEST_ASSERT (data[i] == 11);
}
jerry_release_value (arraybuffer);
jerry_value_free (arraybuffer);
}
/* Test array buffer write operations */
@@ -277,10 +277,10 @@ main (void)
/* Test zero length ArrayBuffer write */
{
const uint32_t length = 0;
jerry_value_t arraybuffer = jerry_create_arraybuffer (length);
TEST_ASSERT (!jerry_value_is_error (arraybuffer));
jerry_value_t arraybuffer = jerry_arraybuffer (length);
TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
TEST_ASSERT (jerry_get_arraybuffer_byte_length (arraybuffer) == length);
TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == length);
uint8_t data[20];
memset (data, 11, 20);
@@ -288,17 +288,17 @@ main (void)
jerry_length_t bytes_written = jerry_arraybuffer_write (arraybuffer, 0, data, 20);
TEST_ASSERT (bytes_written == 0);
jerry_release_value (arraybuffer);
jerry_value_free (arraybuffer);
}
/* Test zero length external ArrayBuffer */
{
const uint32_t length = 0;
jerry_value_t arraybuffer = jerry_create_arraybuffer_external (length, NULL, NULL);
TEST_ASSERT (!jerry_value_is_error (arraybuffer));
jerry_value_t arraybuffer = jerry_arraybuffer_external (NULL, length, NULL);
TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
TEST_ASSERT (jerry_is_arraybuffer_detachable (arraybuffer));
TEST_ASSERT (jerry_get_arraybuffer_byte_length (arraybuffer) == length);
TEST_ASSERT (jerry_arraybuffer_is_detachable (arraybuffer));
TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == length);
uint8_t data[20];
memset (data, 11, 20);
@@ -306,7 +306,7 @@ main (void)
jerry_length_t bytes_written = jerry_arraybuffer_write (arraybuffer, 0, data, 20);
TEST_ASSERT (bytes_written == 0);
jerry_release_value (arraybuffer);
jerry_value_free (arraybuffer);
}
/* Test ArrayBuffer with buffer allocated externally */
@@ -317,12 +317,12 @@ main (void)
uint8_t *buffer_p = (uint8_t *) malloc (buffer_size);
memset (buffer_p, base_value, buffer_size);
jerry_value_t arrayb = jerry_create_arraybuffer_external (buffer_size, buffer_p, NULL);
jerry_value_t arrayb = jerry_arraybuffer_external (buffer_p, buffer_size, NULL);
uint8_t new_value = 123;
jerry_length_t copied = jerry_arraybuffer_write (arrayb, 0, &new_value, 1);
TEST_ASSERT (copied == 1);
TEST_ASSERT (buffer_p[0] == new_value);
TEST_ASSERT (jerry_get_arraybuffer_byte_length (arrayb) == buffer_size);
TEST_ASSERT (jerry_arraybuffer_size (arrayb) == buffer_size);
for (uint32_t i = 1; i < buffer_size; i++)
{
@@ -340,16 +340,16 @@ main (void)
}
TEST_ASSERT (jerry_value_is_arraybuffer (arrayb));
jerry_release_value (arrayb);
jerry_value_free (arrayb);
}
/* Test ArrayBuffer external memory map/unmap */
{
const uint32_t buffer_size = 20;
jerry_value_t input_buffer = jerry_create_arraybuffer_external (buffer_size, NULL, (void *) &allocate_count);
jerry_value_t input_buffer = jerry_arraybuffer_external (NULL, buffer_size, (void *) &allocate_count);
register_js_value ("input_buffer", input_buffer);
jerry_release_value (input_buffer);
jerry_value_free (input_buffer);
const jerry_char_t eval_arraybuffer_src[] = TEST_STRING_LITERAL ("var array = new Uint8Array(input_buffer);"
"for (var i = 0; i < array.length; i++)"
@@ -360,11 +360,11 @@ main (void)
jerry_value_t buffer =
jerry_eval (eval_arraybuffer_src, sizeof (eval_arraybuffer_src) - 1, JERRY_PARSE_STRICT_MODE);
TEST_ASSERT (!jerry_value_is_error (buffer));
TEST_ASSERT (!jerry_value_is_exception (buffer));
TEST_ASSERT (jerry_value_is_arraybuffer (buffer));
TEST_ASSERT (jerry_get_arraybuffer_byte_length (buffer) == 20);
TEST_ASSERT (jerry_arraybuffer_size (buffer) == 20);
uint8_t *const data = jerry_get_arraybuffer_pointer (buffer);
uint8_t *const data = jerry_arraybuffer_data (buffer);
TEST_ASSERT (data != NULL);
@@ -393,71 +393,57 @@ main (void)
"sum");
jerry_value_t res = jerry_eval (eval_test_arraybuffer, sizeof (eval_test_arraybuffer) - 1, JERRY_PARSE_STRICT_MODE);
TEST_ASSERT (jerry_value_is_number (res));
TEST_ASSERT (jerry_get_number_value (res) == sum);
jerry_release_value (res);
TEST_ASSERT (jerry_value_as_number (res) == sum);
jerry_value_free (res);
jerry_release_value (buffer);
jerry_value_free (buffer);
}
/* Test internal ArrayBuffer detach */
{
const uint32_t length = 4;
jerry_value_t arraybuffer = jerry_create_arraybuffer (length);
jerry_value_t arraybuffer = jerry_arraybuffer (length);
TEST_ASSERT (jerry_arraybuffer_has_buffer (arraybuffer));
TEST_ASSERT (!jerry_value_is_error (arraybuffer));
TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
TEST_ASSERT (jerry_get_arraybuffer_byte_length (arraybuffer) == length);
TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == length);
TEST_ASSERT (jerry_arraybuffer_is_detachable (arraybuffer));
jerry_value_t is_detachable = jerry_is_arraybuffer_detachable (arraybuffer);
TEST_ASSERT (jerry_value_is_true (is_detachable));
jerry_release_value (is_detachable);
jerry_value_t res = jerry_detach_arraybuffer (arraybuffer);
jerry_value_t res = jerry_arraybuffer_detach (arraybuffer);
TEST_ASSERT (!jerry_arraybuffer_has_buffer (arraybuffer));
TEST_ASSERT (!jerry_value_is_error (res));
TEST_ASSERT (jerry_get_arraybuffer_pointer (arraybuffer) == NULL);
TEST_ASSERT (jerry_get_arraybuffer_byte_length (arraybuffer) == 0);
TEST_ASSERT (!jerry_value_is_exception (res));
TEST_ASSERT (jerry_arraybuffer_data (arraybuffer) == NULL);
TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == 0);
TEST_ASSERT (!jerry_arraybuffer_is_detachable (arraybuffer));
is_detachable = jerry_is_arraybuffer_detachable (arraybuffer);
TEST_ASSERT (jerry_value_is_false (is_detachable));
jerry_release_value (is_detachable);
jerry_release_value (res);
jerry_release_value (arraybuffer);
jerry_value_free (res);
jerry_value_free (arraybuffer);
}
/* Test external ArrayBuffer detach */
{
const uint32_t length = 64;
jerry_value_t arraybuffer = jerry_create_arraybuffer_external (length, NULL, NULL);
TEST_ASSERT (!jerry_value_is_error (arraybuffer));
jerry_value_t arraybuffer = jerry_arraybuffer_external (NULL, length, NULL);
TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
TEST_ASSERT (jerry_get_arraybuffer_byte_length (arraybuffer) == length);
TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == length);
TEST_ASSERT (!jerry_arraybuffer_has_buffer (arraybuffer));
uint8_t buf[1] = { 1 };
TEST_ASSERT (jerry_arraybuffer_write (arraybuffer, 0, buf, 1) == 1);
TEST_ASSERT (jerry_arraybuffer_has_buffer (arraybuffer));
TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == length);
TEST_ASSERT (jerry_arraybuffer_is_detachable (arraybuffer));
jerry_value_t is_detachable = jerry_is_arraybuffer_detachable (arraybuffer);
TEST_ASSERT (!jerry_value_is_error (is_detachable));
TEST_ASSERT (jerry_value_is_true (is_detachable));
TEST_ASSERT (jerry_get_arraybuffer_byte_length (arraybuffer) == length);
jerry_release_value (is_detachable);
jerry_value_t res = jerry_detach_arraybuffer (arraybuffer);
TEST_ASSERT (!jerry_value_is_error (res));
TEST_ASSERT (jerry_get_arraybuffer_pointer (arraybuffer) == NULL);
TEST_ASSERT (jerry_get_arraybuffer_byte_length (arraybuffer) == 0);
is_detachable = jerry_is_arraybuffer_detachable (arraybuffer);
TEST_ASSERT (!jerry_value_is_error (is_detachable));
TEST_ASSERT (!jerry_value_is_true (is_detachable));
jerry_value_t res = jerry_arraybuffer_detach (arraybuffer);
TEST_ASSERT (!jerry_value_is_exception (res));
TEST_ASSERT (jerry_arraybuffer_data (arraybuffer) == NULL);
TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == 0);
TEST_ASSERT (!jerry_arraybuffer_has_buffer (arraybuffer));
jerry_release_value (is_detachable);
TEST_ASSERT (!jerry_arraybuffer_is_detachable (arraybuffer));
jerry_release_value (res);
jerry_release_value (arraybuffer);
jerry_value_free (res);
jerry_value_free (arraybuffer);
}
/* Test ArrayBuffer created in ECMAScript */
@@ -465,7 +451,7 @@ main (void)
{
const jerry_char_t source[] = TEST_STRING_LITERAL ("new ArrayBuffer(64)");
jerry_value_t arraybuffer = jerry_eval (source, sizeof (source) - 1, JERRY_PARSE_NO_OPTS);
TEST_ASSERT (!jerry_value_is_error (arraybuffer));
TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
TEST_ASSERT (!jerry_arraybuffer_has_buffer (arraybuffer));
@@ -482,13 +468,13 @@ main (void)
}
else
{
uint8_t *buffer_p = jerry_get_arraybuffer_pointer (arraybuffer);
uint8_t *buffer_p = jerry_arraybuffer_data (arraybuffer);
TEST_ASSERT (buffer_p != NULL);
}
TEST_ASSERT (jerry_arraybuffer_has_buffer (arraybuffer));
jerry_release_value (arraybuffer);
jerry_value_free (arraybuffer);
}
jerry_cleanup ();