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:
+74
-54
@@ -27,7 +27,7 @@ custom_to_json (const jerry_call_info_t *call_info_p, /**< call information */
|
||||
JERRY_UNUSED (args_p);
|
||||
JERRY_UNUSED (args_cnt);
|
||||
|
||||
return jerry_create_error (JERRY_ERROR_URI, (const jerry_char_t *) "Error");
|
||||
return jerry_throw_sz (JERRY_ERROR_URI, "Error");
|
||||
} /* custom_to_json */
|
||||
|
||||
int
|
||||
@@ -43,125 +43,145 @@ main (void)
|
||||
jerry_value_t parsed_json = jerry_json_parse (data, sizeof (data) - 1);
|
||||
|
||||
/* Check "name" property values */
|
||||
jerry_value_t name_key = jerry_create_string ((const jerry_char_t *) "name");
|
||||
jerry_value_t name_key = jerry_string_sz ("name");
|
||||
|
||||
jerry_value_t has_name = jerry_has_property (parsed_json, name_key);
|
||||
jerry_value_t has_name = jerry_object_has (parsed_json, name_key);
|
||||
TEST_ASSERT (jerry_value_is_true (has_name));
|
||||
jerry_release_value (has_name);
|
||||
jerry_value_free (has_name);
|
||||
|
||||
jerry_value_t name_value = jerry_get_property (parsed_json, name_key);
|
||||
jerry_value_t name_value = jerry_object_get (parsed_json, name_key);
|
||||
TEST_ASSERT (jerry_value_is_string (name_value) == true);
|
||||
|
||||
jerry_size_t name_size = jerry_get_string_size (name_value);
|
||||
jerry_size_t name_size = jerry_string_size (name_value, JERRY_ENCODING_CESU8);
|
||||
TEST_ASSERT (name_size == 4);
|
||||
JERRY_VLA (jerry_char_t, name_data, name_size + 1);
|
||||
jerry_size_t copied = jerry_string_to_char_buffer (name_value, name_data, name_size);
|
||||
jerry_size_t copied = jerry_string_to_buffer (name_value, JERRY_ENCODING_CESU8, name_data, name_size);
|
||||
name_data[name_size] = '\0';
|
||||
|
||||
jerry_release_value (name_value);
|
||||
jerry_value_free (name_value);
|
||||
|
||||
TEST_ASSERT (copied == name_size);
|
||||
TEST_ASSERT_STR ("John", name_data);
|
||||
jerry_release_value (name_key);
|
||||
jerry_value_free (name_key);
|
||||
|
||||
/* Check "age" property values */
|
||||
jerry_value_t age_key = jerry_create_string ((const jerry_char_t *) "age");
|
||||
jerry_value_t age_key = jerry_string_sz ("age");
|
||||
|
||||
jerry_value_t has_age = jerry_has_property (parsed_json, age_key);
|
||||
jerry_value_t has_age = jerry_object_has (parsed_json, age_key);
|
||||
TEST_ASSERT (jerry_value_is_true (has_age));
|
||||
jerry_release_value (has_age);
|
||||
jerry_value_free (has_age);
|
||||
|
||||
jerry_value_t age_value = jerry_get_property (parsed_json, age_key);
|
||||
jerry_value_t age_value = jerry_object_get (parsed_json, age_key);
|
||||
TEST_ASSERT (jerry_value_is_number (age_value) == true);
|
||||
TEST_ASSERT (jerry_get_number_value (age_value) == 5.0);
|
||||
TEST_ASSERT (jerry_value_as_number (age_value) == 5.0);
|
||||
|
||||
jerry_release_value (age_value);
|
||||
jerry_release_value (age_key);
|
||||
jerry_value_free (age_value);
|
||||
jerry_value_free (age_key);
|
||||
|
||||
jerry_release_value (parsed_json);
|
||||
jerry_value_free (parsed_json);
|
||||
}
|
||||
|
||||
/* JSON.parse cesu-8 / utf-8 encoded string */
|
||||
{
|
||||
jerry_char_t cesu8[] = "{\"ch\": \"\xED\xA0\x83\xED\xB2\x9F\"}";
|
||||
jerry_char_t utf8[] = "{\"ch\": \"\xF0\x90\xB2\x9F\"}";
|
||||
|
||||
jerry_value_t parsed_cesu8 = jerry_json_parse (cesu8, sizeof (cesu8) - 1);
|
||||
jerry_value_t parsed_utf8 = jerry_json_parse (utf8, sizeof (utf8) - 1);
|
||||
|
||||
jerry_value_t key = jerry_string_sz ("ch");
|
||||
jerry_value_t char_cesu8 = jerry_object_get (parsed_cesu8, key);
|
||||
jerry_value_t char_utf8 = jerry_object_get (parsed_utf8, key);
|
||||
jerry_value_free (key);
|
||||
|
||||
TEST_ASSERT (jerry_value_to_boolean (jerry_binary_op (JERRY_BIN_OP_STRICT_EQUAL, char_cesu8, char_utf8)));
|
||||
jerry_value_free (char_cesu8);
|
||||
jerry_value_free (char_utf8);
|
||||
jerry_value_free (parsed_cesu8);
|
||||
jerry_value_free (parsed_utf8);
|
||||
}
|
||||
|
||||
/* JSON.parse error checks */
|
||||
{
|
||||
jerry_value_t parsed_json = jerry_json_parse ((const jerry_char_t *) "", 0);
|
||||
TEST_ASSERT (jerry_value_is_error (parsed_json));
|
||||
TEST_ASSERT (jerry_get_error_type (parsed_json) == JERRY_ERROR_SYNTAX);
|
||||
jerry_release_value (parsed_json);
|
||||
TEST_ASSERT (jerry_value_is_exception (parsed_json));
|
||||
TEST_ASSERT (jerry_error_type (parsed_json) == JERRY_ERROR_SYNTAX);
|
||||
jerry_value_free (parsed_json);
|
||||
}
|
||||
|
||||
{
|
||||
jerry_value_t parsed_json = jerry_json_parse ((const jerry_char_t *) "-", 1);
|
||||
TEST_ASSERT (jerry_value_is_error (parsed_json));
|
||||
TEST_ASSERT (jerry_get_error_type (parsed_json) == JERRY_ERROR_SYNTAX);
|
||||
jerry_release_value (parsed_json);
|
||||
TEST_ASSERT (jerry_value_is_exception (parsed_json));
|
||||
TEST_ASSERT (jerry_error_type (parsed_json) == JERRY_ERROR_SYNTAX);
|
||||
jerry_value_free (parsed_json);
|
||||
}
|
||||
|
||||
/* JSON.stringify check */
|
||||
{
|
||||
jerry_value_t obj = jerry_create_object ();
|
||||
jerry_value_t obj = jerry_object ();
|
||||
/* Fill "obj" with data */
|
||||
{
|
||||
jerry_value_t name_key = jerry_create_string ((const jerry_char_t *) "name");
|
||||
jerry_value_t name_value = jerry_create_string ((const jerry_char_t *) "John");
|
||||
jerry_value_t name_set = jerry_set_property (obj, name_key, name_value);
|
||||
TEST_ASSERT (!jerry_value_is_error (name_set));
|
||||
jerry_value_t name_key = jerry_string_sz ("name");
|
||||
jerry_value_t name_value = jerry_string_sz ("John");
|
||||
jerry_value_t name_set = jerry_object_set (obj, name_key, name_value);
|
||||
TEST_ASSERT (!jerry_value_is_exception (name_set));
|
||||
TEST_ASSERT (jerry_value_is_boolean (name_set));
|
||||
TEST_ASSERT (jerry_value_is_true (name_set));
|
||||
jerry_release_value (name_key);
|
||||
jerry_release_value (name_value);
|
||||
jerry_release_value (name_set);
|
||||
jerry_value_free (name_key);
|
||||
jerry_value_free (name_value);
|
||||
jerry_value_free (name_set);
|
||||
}
|
||||
{
|
||||
jerry_value_t age_key = jerry_create_string ((const jerry_char_t *) "age");
|
||||
jerry_value_t age_value = jerry_create_number (32);
|
||||
jerry_value_t age_set = jerry_set_property (obj, age_key, age_value);
|
||||
TEST_ASSERT (!jerry_value_is_error (age_set));
|
||||
jerry_value_t age_key = jerry_string_sz ("age");
|
||||
jerry_value_t age_value = jerry_number (32);
|
||||
jerry_value_t age_set = jerry_object_set (obj, age_key, age_value);
|
||||
TEST_ASSERT (!jerry_value_is_exception (age_set));
|
||||
TEST_ASSERT (jerry_value_is_boolean (age_set));
|
||||
TEST_ASSERT (jerry_value_is_true (age_set));
|
||||
jerry_release_value (age_key);
|
||||
jerry_release_value (age_value);
|
||||
jerry_release_value (age_set);
|
||||
jerry_value_free (age_key);
|
||||
jerry_value_free (age_value);
|
||||
jerry_value_free (age_set);
|
||||
}
|
||||
|
||||
jerry_value_t json_string = jerry_json_stringify (obj);
|
||||
TEST_ASSERT (jerry_value_is_string (json_string));
|
||||
|
||||
jerry_release_value (obj);
|
||||
jerry_value_free (obj);
|
||||
|
||||
const char check_value[] = "{\"name\":\"John\",\"age\":32}";
|
||||
jerry_size_t json_size = jerry_get_string_size (json_string);
|
||||
jerry_size_t json_size = jerry_string_size (json_string, JERRY_ENCODING_CESU8);
|
||||
TEST_ASSERT (json_size == strlen (check_value));
|
||||
JERRY_VLA (jerry_char_t, json_data, json_size + 1);
|
||||
jerry_string_to_char_buffer (json_string, json_data, json_size);
|
||||
jerry_string_to_buffer (json_string, JERRY_ENCODING_CESU8, json_data, json_size);
|
||||
json_data[json_size] = '\0';
|
||||
|
||||
TEST_ASSERT_STR (check_value, json_data);
|
||||
|
||||
jerry_release_value (json_string);
|
||||
jerry_value_free (json_string);
|
||||
}
|
||||
|
||||
/* Custom "toJSON" invocation test */
|
||||
{
|
||||
jerry_value_t obj = jerry_create_object ();
|
||||
jerry_value_t obj = jerry_object ();
|
||||
/* Fill "obj" with data */
|
||||
{
|
||||
jerry_value_t name_key = jerry_create_string ((const jerry_char_t *) "toJSON");
|
||||
jerry_value_t name_value = jerry_create_external_function (custom_to_json);
|
||||
jerry_value_t name_set = jerry_set_property (obj, name_key, name_value);
|
||||
TEST_ASSERT (!jerry_value_is_error (name_set));
|
||||
jerry_value_t name_key = jerry_string_sz ("toJSON");
|
||||
jerry_value_t name_value = jerry_function_external (custom_to_json);
|
||||
jerry_value_t name_set = jerry_object_set (obj, name_key, name_value);
|
||||
TEST_ASSERT (!jerry_value_is_exception (name_set));
|
||||
TEST_ASSERT (jerry_value_is_boolean (name_set));
|
||||
TEST_ASSERT (jerry_value_is_true (name_set));
|
||||
jerry_release_value (name_key);
|
||||
jerry_release_value (name_value);
|
||||
jerry_release_value (name_set);
|
||||
jerry_value_free (name_key);
|
||||
jerry_value_free (name_value);
|
||||
jerry_value_free (name_set);
|
||||
}
|
||||
|
||||
jerry_value_t json_string = jerry_json_stringify (obj);
|
||||
TEST_ASSERT (jerry_value_is_error (json_string));
|
||||
TEST_ASSERT (jerry_get_error_type (json_string) == JERRY_ERROR_URI);
|
||||
TEST_ASSERT (jerry_value_is_exception (json_string));
|
||||
TEST_ASSERT (jerry_error_type (json_string) == JERRY_ERROR_URI);
|
||||
|
||||
jerry_release_value (json_string);
|
||||
jerry_release_value (obj);
|
||||
jerry_value_free (json_string);
|
||||
jerry_value_free (obj);
|
||||
}
|
||||
|
||||
jerry_cleanup ();
|
||||
|
||||
Reference in New Issue
Block a user