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-api-object-property-names.c
+69 -70
View File
@@ -26,33 +26,33 @@ static jerry_char_t buffer[256] = { 0 };
static void
create_and_set_property (const jerry_value_t object, const char *prop_name)
{
jerry_value_t jprop_name = jerry_create_string ((const jerry_char_t *) prop_name);
jerry_value_t ret_val = jerry_set_property (object, jprop_name, jerry_create_undefined ());
jerry_value_t jprop_name = jerry_string_sz (prop_name);
jerry_value_t ret_val = jerry_object_set (object, jprop_name, jerry_undefined ());
jerry_release_value (jprop_name);
jerry_release_value (ret_val);
jerry_value_free (jprop_name);
jerry_value_free (ret_val);
} /* create_and_set_property */
static void
compare_prop_name (const jerry_value_t object, const char *prop_name, uint32_t idx)
{
jerry_value_t name = jerry_get_property_by_index (object, idx);
jerry_value_t name = jerry_object_get_index (object, idx);
TEST_ASSERT (jerry_value_is_string (name) || jerry_value_is_number (name));
if (jerry_value_is_string (name))
{
jerry_size_t name_size = jerry_get_string_size (name);
jerry_size_t name_size = jerry_string_size (name, JERRY_ENCODING_CESU8);
TEST_ASSERT (name_size < sizeof (buffer));
jerry_size_t ret_size = jerry_string_to_char_buffer (name, buffer, sizeof (buffer));
jerry_size_t ret_size = jerry_string_to_buffer (name, JERRY_ENCODING_CESU8, buffer, sizeof (buffer));
TEST_ASSERT (name_size == ret_size);
buffer[name_size] = '\0';
TEST_ASSERT (strcmp ((const char *) buffer, prop_name) == 0);
}
else
{
TEST_ASSERT ((int) jerry_get_number_value (name) == atoi (prop_name));
TEST_ASSERT ((int) jerry_value_as_number (name) == atoi (prop_name));
}
jerry_release_value (name);
jerry_value_free (name);
} /* compare_prop_name */
static void
@@ -61,27 +61,27 @@ define_property (const jerry_value_t object,
jerry_property_descriptor_t *prop_desc_p,
bool is_symbol)
{
jerry_value_t jname = jerry_create_string ((const jerry_char_t *) prop_name);
jerry_value_t jname = jerry_string_sz (prop_name);
jerry_value_t ret_val;
if (is_symbol)
{
jerry_value_t symbol = jerry_create_symbol (jname);
ret_val = jerry_define_own_property (object, symbol, prop_desc_p);
jerry_release_value (symbol);
jerry_value_t symbol = jerry_symbol_with_description (jname);
ret_val = jerry_object_define_own_prop (object, symbol, prop_desc_p);
jerry_value_free (symbol);
}
else
{
ret_val = jerry_define_own_property (object, jname, prop_desc_p);
ret_val = jerry_object_define_own_prop (object, jname, prop_desc_p);
}
jerry_release_value (jname);
jerry_release_value (ret_val);
jerry_value_free (jname);
jerry_value_free (ret_val);
} /* define_property */
int
main (void)
{
if (!jerry_is_feature_enabled (JERRY_FEATURE_SYMBOL))
if (!jerry_feature_enabled (JERRY_FEATURE_SYMBOL))
{
return 0;
}
@@ -89,61 +89,61 @@ main (void)
TEST_INIT ();
jerry_init (JERRY_INIT_EMPTY);
jerry_value_t error_value = jerry_object_get_property_names (jerry_create_undefined (), JERRY_PROPERTY_FILTER_ALL);
TEST_ASSERT (jerry_value_is_error (error_value) && jerry_get_error_type (error_value) == JERRY_ERROR_TYPE);
jerry_release_value (error_value);
jerry_value_t error_value = jerry_object_property_names (jerry_undefined (), JERRY_PROPERTY_FILTER_ALL);
TEST_ASSERT (jerry_value_is_exception (error_value) && jerry_error_type (error_value) == JERRY_ERROR_TYPE);
jerry_value_free (error_value);
jerry_value_t test_object = jerry_create_object ();
jerry_value_t test_object = jerry_object ();
create_and_set_property (test_object, prop_names[0]);
create_and_set_property (test_object, prop_names[1]);
jerry_value_t names;
jerry_property_descriptor_t prop_desc = jerry_property_descriptor_create ();
jerry_property_descriptor_t prop_desc = jerry_property_descriptor ();
prop_desc.flags |= (JERRY_PROP_IS_CONFIGURABLE_DEFINED | JERRY_PROP_IS_CONFIGURABLE | JERRY_PROP_IS_WRITABLE_DEFINED
| JERRY_PROP_IS_WRITABLE | JERRY_PROP_IS_ENUMERABLE_DEFINED);
// Test enumerable - non-enumerable filter
define_property (test_object, prop_names[2], &prop_desc, false);
names = jerry_object_get_property_names (test_object,
JERRY_PROPERTY_FILTER_ALL | JERRY_PROPERTY_FILTER_EXCLUDE_NON_ENUMERABLE);
TEST_ASSERT (jerry_get_array_length (names) == (uint32_t) 2);
jerry_release_value (names);
names = jerry_object_get_property_names (test_object, JERRY_PROPERTY_FILTER_ALL);
TEST_ASSERT (jerry_get_array_length (names) == (uint32_t) 3);
names =
jerry_object_property_names (test_object, JERRY_PROPERTY_FILTER_ALL | JERRY_PROPERTY_FILTER_EXCLUDE_NON_ENUMERABLE);
TEST_ASSERT (jerry_array_length (names) == (uint32_t) 2);
jerry_value_free (names);
names = jerry_object_property_names (test_object, JERRY_PROPERTY_FILTER_ALL);
TEST_ASSERT (jerry_array_length (names) == (uint32_t) 3);
compare_prop_name (names, prop_names[2], 2);
jerry_release_value (names);
jerry_value_free (names);
prop_desc.flags |= JERRY_PROP_IS_ENUMERABLE;
// Test configurable - non-configurable filter
prop_desc.flags &= (uint16_t) ~JERRY_PROP_IS_CONFIGURABLE;
define_property (test_object, prop_names[3], &prop_desc, false);
names = jerry_object_get_property_names (test_object,
JERRY_PROPERTY_FILTER_ALL | JERRY_PROPERTY_FILTER_EXCLUDE_NON_CONFIGURABLE);
TEST_ASSERT (jerry_get_array_length (names) == (uint32_t) 3);
jerry_release_value (names);
names = jerry_object_get_property_names (test_object, JERRY_PROPERTY_FILTER_ALL);
TEST_ASSERT (jerry_get_array_length (names) == (uint32_t) 4);
names = jerry_object_property_names (test_object,
JERRY_PROPERTY_FILTER_ALL | JERRY_PROPERTY_FILTER_EXCLUDE_NON_CONFIGURABLE);
TEST_ASSERT (jerry_array_length (names) == (uint32_t) 3);
jerry_value_free (names);
names = jerry_object_property_names (test_object, JERRY_PROPERTY_FILTER_ALL);
TEST_ASSERT (jerry_array_length (names) == (uint32_t) 4);
compare_prop_name (names, prop_names[3], 3);
jerry_release_value (names);
jerry_value_free (names);
prop_desc.flags |= JERRY_PROP_IS_CONFIGURABLE;
// Test writable - non-writable filter
prop_desc.flags &= (uint16_t) ~JERRY_PROP_IS_WRITABLE;
define_property (test_object, prop_names[4], &prop_desc, false);
names = jerry_object_get_property_names (test_object,
JERRY_PROPERTY_FILTER_ALL | JERRY_PROPERTY_FILTER_EXCLUDE_NON_WRITABLE);
TEST_ASSERT (jerry_get_array_length (names) == (uint32_t) 4);
jerry_release_value (names);
names = jerry_object_get_property_names (test_object, JERRY_PROPERTY_FILTER_ALL);
TEST_ASSERT (jerry_get_array_length (names) == (uint32_t) 5);
names =
jerry_object_property_names (test_object, JERRY_PROPERTY_FILTER_ALL | JERRY_PROPERTY_FILTER_EXCLUDE_NON_WRITABLE);
TEST_ASSERT (jerry_array_length (names) == (uint32_t) 4);
jerry_value_free (names);
names = jerry_object_property_names (test_object, JERRY_PROPERTY_FILTER_ALL);
TEST_ASSERT (jerry_array_length (names) == (uint32_t) 5);
compare_prop_name (names, prop_names[4], 4);
jerry_release_value (names);
jerry_value_free (names);
prop_desc.flags |= JERRY_PROP_IS_WRITABLE;
// Test all property filter
names = jerry_object_get_property_names (test_object, JERRY_PROPERTY_FILTER_ALL);
jerry_length_t array_len = jerry_get_array_length (names);
names = jerry_object_property_names (test_object, JERRY_PROPERTY_FILTER_ALL);
jerry_length_t array_len = jerry_array_length (names);
TEST_ASSERT (array_len == (uint32_t) 5);
for (uint32_t i = 0; i < array_len; i++)
@@ -151,42 +151,41 @@ main (void)
compare_prop_name (names, prop_names[i], i);
}
jerry_release_value (names);
jerry_value_free (names);
// Test number and string index exclusion
define_property (test_object, prop_names[5], &prop_desc, false);
names = jerry_object_get_property_names (test_object,
JERRY_PROPERTY_FILTER_ALL | JERRY_PROPERTY_FILTER_EXCLUDE_STRINGS
| JERRY_PROPERTY_FILTER_INTEGER_INDICES_AS_NUMBER);
TEST_ASSERT (jerry_get_array_length (names) == (uint32_t) 1);
names = jerry_object_property_names (test_object,
JERRY_PROPERTY_FILTER_ALL | JERRY_PROPERTY_FILTER_EXCLUDE_STRINGS
| JERRY_PROPERTY_FILTER_INTEGER_INDICES_AS_NUMBER);
TEST_ASSERT (jerry_array_length (names) == (uint32_t) 1);
compare_prop_name (names, prop_names[5], 0);
jerry_release_value (names);
names = jerry_object_get_property_names (test_object,
JERRY_PROPERTY_FILTER_ALL | JERRY_PROPERTY_FILTER_EXCLUDE_INTEGER_INDICES);
TEST_ASSERT (jerry_get_array_length (names) == (uint32_t) 5);
jerry_release_value (names);
jerry_value_free (names);
names = jerry_object_property_names (test_object,
JERRY_PROPERTY_FILTER_ALL | JERRY_PROPERTY_FILTER_EXCLUDE_INTEGER_INDICES);
TEST_ASSERT (jerry_array_length (names) == (uint32_t) 5);
jerry_value_free (names);
// Test prototype chain traversion
names = jerry_object_get_property_names (test_object, JERRY_PROPERTY_FILTER_ALL);
TEST_ASSERT (jerry_get_array_length (names) == (uint32_t) 6);
jerry_release_value (names);
names = jerry_object_get_property_names (test_object,
JERRY_PROPERTY_FILTER_ALL | JERRY_PROPERTY_FILTER_TRAVERSE_PROTOTYPE_CHAIN);
TEST_ASSERT (jerry_get_array_length (names) == (uint32_t) 18);
jerry_release_value (names);
names = jerry_object_property_names (test_object, JERRY_PROPERTY_FILTER_ALL);
TEST_ASSERT (jerry_array_length (names) == (uint32_t) 6);
jerry_value_free (names);
names = jerry_object_property_names (test_object,
JERRY_PROPERTY_FILTER_ALL | JERRY_PROPERTY_FILTER_TRAVERSE_PROTOTYPE_CHAIN);
TEST_ASSERT (jerry_array_length (names) == (uint32_t) 18);
jerry_value_free (names);
// Test symbol exclusion
define_property (test_object, prop_names[6], &prop_desc, true);
names =
jerry_object_get_property_names (test_object, JERRY_PROPERTY_FILTER_ALL | JERRY_PROPERTY_FILTER_EXCLUDE_SYMBOLS);
TEST_ASSERT (jerry_get_array_length (names) == (uint32_t) 6);
jerry_release_value (names);
names = jerry_object_get_property_names (test_object, JERRY_PROPERTY_FILTER_ALL);
TEST_ASSERT (jerry_get_array_length (names) == (uint32_t) 7);
jerry_release_value (names);
names = jerry_object_property_names (test_object, JERRY_PROPERTY_FILTER_ALL | JERRY_PROPERTY_FILTER_EXCLUDE_SYMBOLS);
TEST_ASSERT (jerry_array_length (names) == (uint32_t) 6);
jerry_value_free (names);
names = jerry_object_property_names (test_object, JERRY_PROPERTY_FILTER_ALL);
TEST_ASSERT (jerry_array_length (names) == (uint32_t) 7);
jerry_value_free (names);
jerry_property_descriptor_free (&prop_desc);
jerry_release_value (test_object);
jerry_value_free (test_object);
jerry_cleanup ();
return 0;
} /* main */