Add API documentation for create_string_from_utf8 and jerry_create_string_sz_from_utf8 functions.

JerryScript-DCO-1.0-Signed-off-by: Robert Sipka [email protected]

Author: robertsipka

docs/02.API-REFERENCE.md

@@ -1981,6 +1981,78 @@ jerry_create_string_sz (const jerry_char_t *str_p,
 
 - [jerry_create_string](#jerry_create_string)
 
+## jerry_create_string_from_utf8
+
+**Summary**
+
+Create string from a valid UTF8 string.
+
+*Note*: It differs from [jerry_create_string](#jerry_create_string) function in this converts all 4-bytes long unicode sequences into two 3-bytes long sequences.
+
+**Prototype**
+
+```c
+jerry_value_t
+jerry_create_string_from_utf8 (const jerry_char_t *str_p);
+```
+
+- `str_p` - pointer to string
+- return value - value of the created string
+
+**Example**
+
+```c
+{
+  const jerry_char_t char_array[] = "a string";
+  jerry_value_t string_value  = jerry_create_string_from_utf8 (char_array);
+
+  ... // usage of string_value
+
+  jerry_release_value (string_value);
+}
+```
+
+**See also**
+
+- [jerry_create_string_sz_from_utf8](#jerry_create_string_sz_from_utf8)
+
+
+## jerry_create_string_sz_from_utf8
+
+**Summary**
+
+Create string from a valid UTF8 string.
+
+**Prototype**
+
+```c
+jerry_value_t
+jerry_create_string_sz (const jerry_char_t *str_p,
+                        jerry_size_t str_size)
+```
+
+- `str_p` - pointer to string
+- `str_size` - size of the string
+- return value - value of the created string
+
+**Example**
+
+```c
+{
+  const jerry_char_t char_array[] = "a string";
+  jerry_value_t string_value  = jerry_create_string_sz_from_utf8 (char_array,
+                                                                  strlen ((const char *) char_array));
+
+  ... // usage of string_value
+
+  jerry_release_value (string_value);
+}
+
+```
+
+**See also**
+
+- [jerry_create_string_from_utf8](#jerry_create_string_from_utf8)
 
 ## jerry_create_undefined
 

tests/unit/test-api.c

@@ -339,6 +339,13 @@ main (void)
   TEST_ASSERT (sz == 0);
   jerry_release_value (args[0]);
 
+  // Test create_jerry_string_from_utf8 with 4-byte long unicode sequences
+  args[0] = jerry_create_string_from_utf8 ((jerry_char_t *) "𝔡𝔢𝔣𝔤");
+  sz = jerry_get_string_size (res);
+  sz = jerry_string_to_char_buffer (res, (jerry_char_t *) buffer, sz);
+  TEST_ASSERT (!strncmp (buffer, "𝔡𝔢𝔣𝔤", (size_t) sz));
+  jerry_release_value (args[0]);
+
   // Get global.boo (non-existing field)
   val_t = get_property (global_obj_val, "boo");
   TEST_ASSERT (!jerry_value_has_error_flag (val_t));