Reduce the usage of strlen

* Improve jerry_string_sz only accept UTF-8 string(that's a rare case accept CESU-8 in c/cpp code) * The document about jerry_string_sz only support ASCII(the fact is CESU-8 before this MR), update it to support UTF-8 after this MR * Improve all _sz function to take jerry_value_t that can construct from `jerry_string_sz` * Improve JERRY_ZSTR_ARG can only accept string literal(that's UTF-8) * Add function jerry_value_list_free to free a list of jerry_value_t * All call to jerry_string/jerry_string_cesu8 in core indeed are removed, so when there is no linkage to it, code size is saved The prototype of new/improved function/macros is: ```c jerry_value_t jerry_string_cesu8 (const jerry_char_t *buffer_p, jerry_size_t buffer_size); jerry_value_t jerry_string_utf8 (const jerry_char_t *buffer_p, jerry_size_t buffer_size); #define jerry_string_sz(str) jerry_string_utf8 (JERRY_ZSTR_ARG (str)) jerry_value_t jerry_error_sz (jerry_error_t error_type, const jerry_value_t message_sz); jerry_value_t jerry_throw_sz (jerry_error_t error_type, const jerry_value_t message_sz); jerry_value_t jerry_regexp_sz (const jerry_value_t pattern_sz, uint16_t flags); jerry_value_t jerry_object_delete_sz (const jerry_value_t object, const jerry_value_t key_sz); jerry_value_t jerry_object_get_sz (const jerry_value_t object, const jerry_value_t key_sz); jerry_value_t jerry_object_has_sz (const jerry_value_t object, const jerry_value_t key_sz); jerry_value_t jerry_object_set_sz (jerry_value_t object, const jerry_value_t key_sz, const jerry_value_t value); ``` JerryScript-DCO-1.0-Signed-off-by: Yonggang Luo [email protected]
jerryscript-project · Dec 17, 2024 · 466caea · 466caea
1 parent d2d30df
commit 466caea
Show file tree

Hide file tree

Showing 78 changed files with 835 additions and 642 deletions.
diff --git a/docs/02.API-REFERENCE.md b/docs/02.API-REFERENCE.md
diff --git a/docs/03.API-EXAMPLE.md b/docs/03.API-EXAMPLE.md
@@ -393,9 +393,17 @@ In this example the following extension methods are used:
 
 In further examples this "print" handler will be used.
 
+The `api-example-6.c` file should contain the following code:
+
+[doctest]: # ()
+
 ```c
+#include <stdio.h>
+
 #include "jerryscript.h"
+
 #include "jerryscript-ext/handlers.h"
+#include "jerryscript-ext/properties.h"
 
 int
 main (void)
@@ -407,7 +415,7 @@ main (void)
   jerry_init (JERRY_INIT_EMPTY);
 
   /* Register 'print' function from the extensions to the global object */
-  jerryx_register_global ("print", jerryx_handler_print);
+  jerryx_register_global (jerry_string_sz ("print"), jerryx_handler_print);
 
   /* Setup Global scope code */
   jerry_value_t parsed_code = jerry_parse (script, script_size, NULL);
@@ -470,7 +478,7 @@ main (void)
   jerry_init (JERRY_INIT_EMPTY);
 
   /* Register 'print' function from the extensions */
-  jerryx_register_global ("print", jerryx_handler_print);
+  jerryx_register_global (jerry_string_sz ("print"), jerryx_handler_print);
 
   /* Getting pointer to the Global object */
   jerry_value_t global_object = jerry_current_realm ();
@@ -729,7 +737,7 @@ main (void)
   jerry_init (JERRY_INIT_EMPTY);
 
   /* Register 'print' function from the extensions */
-  jerryx_register_global ("print", jerryx_handler_print);
+  jerryx_register_global (jerry_string_sz ("print"), jerryx_handler_print);
 
   while (!is_done)
   {
@@ -808,10 +816,8 @@ In this example (`api-example-9.c`) an object with a native function is added to
 #include "jerryscript-ext/handlers.h"
 #include "jerryscript-ext/properties.h"
 
-struct my_struct
-{
-  const char *msg;
-} my_struct;
+
+jerry_string_t my_struct;
 
 /**
  * Get a string from a native object
@@ -821,7 +827,7 @@ get_msg_handler (const jerry_call_info_t *call_info_p, /**< call information */
                  const jerry_value_t *args_p, /**< function arguments */
                  const jerry_length_t args_cnt) /**< number of function arguments */
 {
-  return jerry_string_sz (my_struct.msg);
+  return jerry_string_utf8 (my_struct.ptr, my_struct.size);
 } /* get_msg_handler */
 
 int
@@ -831,10 +837,13 @@ main (void)
   jerry_init (JERRY_INIT_EMPTY);
 
   /* Register 'print' function from the extensions */
-  jerryx_register_global ("print", jerryx_handler_print);
+  jerryx_register_global (jerry_string_sz ("print"), jerryx_handler_print);
 
   /* Do something with the native object */
-  my_struct.msg = "Hello, World!";
+  {
+    static const jerry_string_t hello = { JERRY_ZSTR_ARG ("Hello, World!") };
+    my_struct = hello;
+  }
 
   /* Create an empty JS object */
   jerry_value_t object = jerry_object ();
@@ -958,7 +967,7 @@ main (void)
   jerry_init (JERRY_INIT_EMPTY);
 
   /* Register 'print' function from the extensions */
-  jerryx_register_global ("print", jerryx_handler_print);
+  jerryx_register_global (jerry_string_sz ("print"), jerryx_handler_print);
 
   /* Create a JS object */
   const jerry_char_t my_js_object[] = " \
@@ -1058,7 +1067,7 @@ main (void)
   jerry_init (JERRY_INIT_EMPTY);
 
   /* Register the print function */
-  jerryx_register_global ("print", jerryx_handler_print);
+  jerryx_register_global (jerry_string_sz ("print"), jerryx_handler_print);
 
   /* Evaluate the script */
   jerry_value_t eval_ret = jerry_eval (script, sizeof (script) - 1, JERRY_PARSE_NO_OPTS);

diff --git a/docs/06.REFERENCE-COUNTING.md b/docs/06.REFERENCE-COUNTING.md
@@ -135,7 +135,7 @@ jerry_value_t my_external_handler (const jerry_value_t function_obj,
 
   /* If the value to be returned is needed for other purposes the
    * jerry_value_copy () can be used to create new references. */
-  return jerry_string (...);
+  return jerry_string_utf8 (...);
 }
 ```
 

diff --git a/docs/07.DEBUGGER.md b/docs/07.DEBUGGER.md
@@ -320,9 +320,8 @@ wait_for_source_callback (const jerry_char_t *source_name_p, /**< source name */
 
   jerry_parse_options_t parse_options;
   parse_options.options = JERRY_PARSE_HAS_SOURCE_NAME;
-  parse_options.source_name = jerry_string ((const jerry_char_t *) source_name_p,
-                                              (jerry_size_t) source_name_size,
-                                              JERRY_ENCODING_UTF8);
+  parse_options.source_name = jerry_string_utf8 ((const jerry_char_t *) source_name_p,
+                                                 (jerry_size_t) source_name_size);
 
   jerry_value_t ret_val = jerry_parse (source_p,
                                        source_size,

diff --git a/docs/09.EXT-REFERENCE-ARG.md b/docs/09.EXT-REFERENCE-ARG.md
@@ -612,6 +612,7 @@ jerryx_arg_object_properties (const jerryx_arg_object_props_t *obj_prop_p,
 
 ```c
 #include "jerryscript.h"
+
 #include "jerryscript-ext/arg.h"
 
 /**
@@ -628,39 +629,31 @@ my_external_handler (const jerry_value_t function_obj,
 {
   bool required_bool;
   double required_num;
-  double optional_num = 1234.567;  // default value
+  double optional_num = 1234.567; // default value
 
   /* "prop_name_p" defines the name list of the expected properties' names. */
-  const char *prop_name_p[] = { "enable", "data", "extra_data" };
+  const jerry_value_t prop_name_p[] = { jerry_string_sz ("enable"),
+                                        jerry_string_sz ("data"),
+                                        jerry_string_sz ("extra_data") };
 
   /* "prop_mapping" defines the steps to transform properties to C variables. */
-  const jerryx_arg_t prop_mapping[] =
-  {
-    jerryx_arg_boolean (&required_bool, JERRYX_ARG_COERCE, JERRYX_ARG_REQUIRED),
-    jerryx_arg_number (&required_num, JERRYX_ARG_COERCE, JERRYX_ARG_REQUIRED),
-    jerryx_arg_number (&optional_num, JERRYX_ARG_COERCE, JERRYX_ARG_OPTIONAL)
-  };
+  const jerryx_arg_t prop_mapping[] = { jerryx_arg_boolean (&required_bool, JERRYX_ARG_COERCE, JERRYX_ARG_REQUIRED),
+                                        jerryx_arg_number (&required_num, JERRYX_ARG_COERCE, JERRYX_ARG_REQUIRED),
+                                        jerryx_arg_number (&optional_num, JERRYX_ARG_COERCE, JERRYX_ARG_OPTIONAL) };
 
   /* Prepare the jerryx_arg_object_props_t instance. */
-  const jerryx_arg_object_props_t prop_info =
-  {
-    .name_p = (const jerry_char_t **) prop_name_p,
-    .name_cnt = 3,
-    .c_arg_p = prop_mapping,
-    .c_arg_cnt = 3
-  };
+  const jerryx_arg_object_props_t prop_info = { .name_p = prop_name_p,
+                                                .name_cnt = 3,
+                                                .c_arg_p = prop_mapping,
+                                                .c_arg_cnt = 3 };
 
   /* It is the mapping used in the jerryx_arg_transform_args. */
-  const jerryx_arg_t mapping[] =
-  {
-    jerryx_arg_object_properties (&prop_info, JERRYX_ARG_REQUIRED)
-  };
+  const jerryx_arg_t mapping[] = { jerryx_arg_object_properties (&prop_info, JERRYX_ARG_REQUIRED) };
+
+  jerry_value_list_free (prop_name_p, sizeof (prop_name_p) / sizeof (prop_name_p[0]));
 
   /* Validate and transform. */
-  const jerry_value_t rv = jerryx_arg_transform_args (args_p,
-                                                      args_count,
-                                                      mapping,
-                                                      1);
+  const jerry_value_t rv = jerryx_arg_transform_args (args_p, args_count, mapping, 1);
 
   if (jerry_value_is_exception (rv))
   {
@@ -673,9 +666,8 @@ my_external_handler (const jerry_value_t function_obj,
    * required_bool, required_num and optional_num can now be used.
    */
 
-   return jerry_undefined (); /* Or return something more meaningful. */
+  return jerry_undefined (); /* Or return something more meaningful. */
 }
-
 ```
 
  **See also**

diff --git a/docs/10.EXT-REFERENCE-HANDLER.md b/docs/10.EXT-REFERENCE-HANDLER.md
@@ -120,8 +120,8 @@ main (int argc, char **argv)
 
   jerryx_property_entry methods[] =
   {
-    { "demo", jerry_function_external (handler) },
-    { NULL, 0 },
+    JERRYX_PROPERTY_FUNCTION("demo", handler),
+    JERRYX_PROPERTY_LIST_END(),
   };
 
   jerry_value_t global = jerry_current_realm ();
@@ -362,7 +362,7 @@ longer needed.
 
 ```c
 jerry_value_t
-jerryx_register_global (const char *name_p,
+jerryx_register_global (jerry_value_t function_name_val,
                         jerry_external_handler_t handler_p);
 ```
 
@@ -381,14 +381,15 @@ jerryx_register_global (const char *name_p,
 #include "jerryscript-ext/properties.h"
 
 static const struct {
-  const char *name_p;
+  const jerry_char_t *name_p;
+  jerry_size_t name_size;
   jerry_external_handler_t handler_p;
 } common_functions[] =
 {
-  { "assert", jerryx_handler_assert },
-  { "gc", jerryx_handler_gc },
-  { "print", jerryx_handler_print },
-  { NULL, NULL }
+  { JERRY_ZSTR_ARG ("assert"), jerryx_handler_assert },
+  { JERRY_ZSTR_ARG ("gc"), jerryx_handler_gc },
+  { JERRY_ZSTR_ARG ("print"), jerryx_handler_print },
+  { NULL, 0, NULL }
 };
 
 static void
@@ -398,7 +399,7 @@ register_common_functions (void)
 
   for (int i = 0; common_functions[i].name_p != NULL && !jerry_value_is_exception (ret); i++)
   {
-    ret = jerryx_register_global (common_functions[i].name_p,
+    ret = jerryx_register_global (jerry_string_utf8 (common_functions[i].name_p, common_functions[i].name_size),
                                   common_functions[i].handler_p);
   }
 

diff --git a/docs/12.EXT-REFERENCE-MODULE.md b/docs/12.EXT-REFERENCE-MODULE.md
@@ -205,7 +205,7 @@ canonicalize_file_path (const jerry_value_t name)
   /**
    * Since a file on the file system can be referred to by multiple relative paths, but only by one absolute path, the
    * absolute path becomes the canonical name for the module. Thus, to establish this canonical name, we must search
-   * name for "./" and "../", follow symlinks, etc., then create absolute_path via jerry_string () and return
+   * name for "./" and "../", follow symlinks, etc., then create absolute_path via jerry_string_utf8 () and return
    * it, because it is the canonical name for this module. Thus, we avoid loading the same JavaScript file twice.
    */
 

diff --git a/jerry-core/api/jerry-module.c b/jerry-core/api/jerry-module.c
@@ -16,7 +16,7 @@
 #include "jerryscript-core.h"
 #include "jerryscript-port.h"
 
-#include "ecma-errors.h"
+#include "ecma-globals.h"
 
 #include "lit-magic-strings.h"
 #include "lit-strings.h"
@@ -162,7 +162,7 @@ jerry_module_resolve (const jerry_value_t specifier, /**< module specifier strin
 
   if (path_p == NULL)
   {
-    return jerry_throw_sz (JERRY_ERROR_SYNTAX, "Failed to resolve module");
+    return jerry_throw_sz (JERRY_ERROR_SYNTAX, jerry_string_sz ("Failed to resolve module"));
   }
 
   jerry_value_t realm = jerry_current_realm ();
@@ -192,7 +192,7 @@ jerry_module_resolve (const jerry_value_t specifier, /**< module specifier strin
     jerry_value_free (realm);
     jerry_port_path_free (path_p);
 
-    return jerry_throw_sz (JERRY_ERROR_SYNTAX, "Module file not found");
+    return jerry_throw_sz (JERRY_ERROR_SYNTAX, jerry_string_sz ("Module file not found"));
   }
 
   jerry_parse_options_t parse_options;

diff --git a/jerry-core/api/jerry-snapshot.c b/jerry-core/api/jerry-snapshot.c
@@ -140,7 +140,7 @@ snapshot_add_compiled_code (const ecma_compiled_code_t *compiled_code_p, /**< co
                             size_t snapshot_buffer_size, /**< snapshot buffer size */
                             snapshot_globals_t *globals_p) /**< snapshot globals */
 {
-  const char *error_buffer_too_small_p = "Snapshot buffer too small";
+#define error_buffer_too_small_p "Snapshot buffer too small"
 
   if (!ecma_is_value_empty (globals_p->snapshot_error))
   {
@@ -180,7 +180,7 @@ snapshot_add_compiled_code (const ecma_compiled_code_t *compiled_code_p, /**< co
     /* Regular expression. */
     if (globals_p->snapshot_buffer_write_offset + sizeof (ecma_compiled_code_t) > snapshot_buffer_size)
     {
-      globals_p->snapshot_error = jerry_throw_sz (JERRY_ERROR_RANGE, error_buffer_too_small_p);
+      globals_p->snapshot_error = jerry_throw_sz (JERRY_ERROR_RANGE, jerry_string_sz (error_buffer_too_small_p));
       return 0;
     }
 
@@ -201,7 +201,7 @@ snapshot_add_compiled_code (const ecma_compiled_code_t *compiled_code_p, /**< co
                                              buffer_p,
                                              buffer_size))
     {
-      globals_p->snapshot_error = jerry_throw_sz (JERRY_ERROR_RANGE, error_buffer_too_small_p);
+      globals_p->snapshot_error = jerry_throw_sz (JERRY_ERROR_RANGE, jerry_string_sz (error_buffer_too_small_p));
       /* cannot return inside ECMA_FINALIZE_UTF8_STRING */
     }
 
@@ -235,7 +235,7 @@ snapshot_add_compiled_code (const ecma_compiled_code_t *compiled_code_p, /**< co
                                            compiled_code_p,
                                            ((size_t) compiled_code_p->size) << JMEM_ALIGNMENT_LOG))
   {
-    globals_p->snapshot_error = jerry_throw_sz (JERRY_ERROR_RANGE, error_buffer_too_small_p);
+    globals_p->snapshot_error = jerry_throw_sz (JERRY_ERROR_RANGE, jerry_string_sz (error_buffer_too_small_p));
     return 0;
   }