Implement import.meta object (#4766)

JerryScript-DCO-1.0-Signed-off-by: Zoltan Herczeg [email protected]

Author: zherczeg

docs/02.API-REFERENCE.md

@@ -952,6 +952,31 @@ typedef void (*jerry_module_state_changed_callback_t) (jerry_module_state_t new_
 **See also**
 - [jerry_module_set_state_changed_callback](#jerry_module_set_state_changed_callback)
 
+## jerry_module_import_meta_callback_t
+
+**Summary**
+
+Callback which is called when an import.meta expression of a module is evaluated the first time.
+The object returned by import.meta is passed as the `meta_object` argument to the callback, and
+the callback can set the initial status of the object (e.g. add properties or set prototype).
+
+**Prototype**
+
+```c
+typedef void (*jerry_module_import_meta_callback_t) (const jerry_value_t module,
+                                                     const jerry_value_t meta_object,
+                                                     void *user_p);
+```
+
+- `module` - module whose import.meta object is requested.
+- `meta_object` - import.meta object created for the module.
+- `user_p` - pointer passed to [jerry_module_set_import_meta_callback](#jerry_module_set_import_meta_callback).
+
+*New in version [[NEXT_RELEASE]]*.
+
+**See also**
+- [jerry_module_set_import_meta_callback](#jerry_module_set_import_meta_callback)
+
 ## jerry_native_module_evaluate_callback_t
 
 **Summary**
@@ -4996,13 +5021,12 @@ Sets a callback which is called after a module state is changed to linked, evalu
 **Prototype**
 
 ```c
-void
-jerry_module_set_state_changed_callback (jerry_module_state_changed_callback_t callback,
-                                         void *user_p)
+void jerry_module_set_state_changed_callback (jerry_module_state_changed_callback_t callback,
+                                              void *user_p);
 ```
 
 - `callback` - callback, which is called after the state change.
-- `module_val` - pointer passed to the callback function.
+- `user_p` - pointer passed to the callback function.
 
 *New in version [[NEXT_RELEASE]]*.
 
@@ -5060,6 +5084,82 @@ main (void)
 - [jerry_module_state_t](#jerry_module_state_t)
 - [jerry_module_state_changed_callback_t](#jerry_module_state_changed_callback_t)
 
+## jerry_module_set_import_meta_callback
+
+**Summary**
+
+Sets a callback which is called when an import.meta expression of a module is evaluated the first time.
+
+*Notes*:
+- This API depends on a build option (`JERRY_MODULE_SYSTEM`) and can be checked
+  in runtime with the `JERRY_FEATURE_MODULE` feature enum value,
+  see: [jerry_is_feature_enabled](#jerry_is_feature_enabled).
+
+**Prototype**
+
+```c
+void jerry_module_set_import_meta_callback (jerry_module_import_meta_callback_t callback,
+                                            void *user_p);
+```
+
+- `callback` - callback, which is called when an import.meta
+               expression of a module is evaluated the first time
+- `user_p` - pointer passed to the callback function.
+
+*New in version [[NEXT_RELEASE]]*.
+
+**Example**
+
+[doctest]: # (test="compile")
+
+```c
+#include <jerryscript.h>
+#include <stdio.h>
+
+static void
+module_import_meta_callback (const jerry_value_t module, /**< module */
+                             const jerry_value_t meta_object, /**< import.meta object */
+                             void *user_p) /**< user pointer */
+{
+  (void) user_p;
+
+  /* Create a property for the meta object */
+  jerry_value_t property_name_value = jerry_create_string ((const jerry_char_t *) "prop");
+  jerry_value_t property_value = jerry_create_string ((const jerry_char_t *) "prop");
+  jerry_value_t result_value = jerry_set_property (meta_object, property_name_value, property_value);
+  jerry_release_value (result_value);
+  jerry_release_value (property_value);
+  jerry_release_value (property_name_value);
+} /* module_import_meta_callback */
+
+int
+main (void)
+{
+  jerry_init (JERRY_INIT_EMPTY);
+
+  const jerry_char_t script[] = "import.meta";
+
+  jerry_module_set_import_meta_callback (module_import_meta_callback, NULL);
+
+  jerry_parse_options_t parse_options;
+  parse_options.options = JERRY_PARSE_MODULE;
+
+  jerry_value_t module_value = jerry_parse (script, sizeof (script) - 1, &parse_options);
+
+  jerry_release_value (jerry_module_link (module_value, NULL, NULL));
+  jerry_release_value (jerry_module_evaluate (module_value));
+
+  jerry_release_value (module_value);
+
+  jerry_cleanup ();
+  return 0;
+}
+```
+
+**See also**
+
+- [jerry_module_import_meta_callback_t](#jerry_module_import_meta_callback_t)
+
 ## jerry_module_get_number_of_requests
 
 **Summary**

jerry-core/api/jerry.c

@@ -740,6 +740,24 @@ jerry_module_set_state_changed_callback (jerry_module_state_changed_callback_t c
 #endif /* JERRY_MODULE_SYSTEM */
 } /* jerry_module_set_state_changed_callback */
 
+/**
+ * Sets a callback which is called when an import.meta expression of a module is evaluated the first time.
+ */
+void
+jerry_module_set_import_meta_callback (jerry_module_import_meta_callback_t callback, /**< callback */
+                                       void *user_p) /**< pointer passed to the callback */
+{
+  jerry_assert_api_available ();
+
+#if JERRY_MODULE_SYSTEM
+  JERRY_CONTEXT (module_import_meta_callback_p) = callback;
+  JERRY_CONTEXT (module_import_meta_callback_user_p) = user_p;
+#else /* !JERRY_MODULE_SYSTEM */
+  JERRY_UNUSED (callback);
+  JERRY_UNUSED (user_p);
+#endif /* JERRY_MODULE_SYSTEM */
+} /* jerry_module_set_import_meta_callback */
+
 /**
  * Returns the number of import/export requests of a module
  *
@@ -5489,7 +5507,7 @@ jerry_get_user_value (const jerry_value_t value) /**< jerry api value */
   ecma_value_t script_value = ((cbc_uint8_arguments_t *) bytecode_p)->script_value;
   cbc_script_t *script_p = ECMA_GET_INTERNAL_VALUE_POINTER (cbc_script_t, script_value);
 
-  if (CBC_SCRIPT_GET_TYPE (script_p) == CBC_SCRIPT_GENERIC)
+  if (!(script_p->refs_and_type & CBC_SCRIPT_HAS_USER_VALUE))
   {
     return ECMA_VALUE_UNDEFINED;
   }

jerry-core/ecma/base/ecma-gc.c

@@ -428,14 +428,24 @@ ecma_gc_mark_compiled_code (const ecma_compiled_code_t *compiled_code_p) /**< co
   ecma_value_t script_value = ((cbc_uint8_arguments_t *) compiled_code_p)->script_value;
   cbc_script_t *script_p = ECMA_GET_INTERNAL_VALUE_POINTER (cbc_script_t, script_value);
 
-  if (CBC_SCRIPT_GET_TYPE (script_p) == CBC_SCRIPT_USER_OBJECT)
+  if (script_p->refs_and_type & CBC_SCRIPT_USER_VALUE_IS_OBJECT)
   {
     ecma_value_t user_value = CBC_SCRIPT_GET_USER_VALUE (script_p);
 
     JERRY_ASSERT (ecma_is_value_object (user_value));
     ecma_gc_set_object_visited (ecma_get_object_from_value (user_value));
   }
 
+#if JERRY_MODULE_SYSTEM
+  if (script_p->refs_and_type & CBC_SCRIPT_HAS_IMPORT_META)
+  {
+    ecma_value_t import_meta = CBC_SCRIPT_GET_IMPORT_META (script_p, script_p->refs_and_type);
+
+    JERRY_ASSERT (ecma_is_value_object (import_meta));
+    ecma_gc_set_object_visited (ecma_get_object_from_value (import_meta));
+  }
+#endif /* JERRY_MODULE_SYSTEM */
+
 #if JERRY_BUILTIN_REALMS
   ecma_gc_set_object_visited (script_p->realm_p);
 #endif /* JERRY_BUILTIN_REALMS */

jerry-core/ecma/base/ecma-globals.h

@@ -130,8 +130,11 @@ typedef enum
 #if JERRY_ESNEXT
   ECMA_PARSE_INTERNAL_PRE_SCANNING = (1u << 16), /**< the parser is in pre-scanning mode */
 #endif /* JERRY_ESNEXT */
+#if JERRY_MODULE_SYSTEM
+  ECMA_PARSE_INTERNAL_HAS_IMPORT_META = (1u << 17), /**< module has import.meta expression */
+#endif /* JERRY_MODULE_SYSTEM */
 #if JERRY_FUNCTION_TO_STRING
-  ECMA_PARSE_INTERNAL_HAS_4_BYTE_MARKER = (1u << 17), /**< source has 4 byte marker */
+  ECMA_PARSE_INTERNAL_HAS_4_BYTE_MARKER = (1u << 18), /**< source has 4 byte marker */
 #endif /* JERRY_FUNCTION_TO_STRING */
 #ifndef JERRY_NDEBUG
   /**

jerry-core/ecma/base/ecma-helpers.c

@@ -1485,14 +1485,13 @@ ecma_bytecode_deref (ecma_compiled_code_t *bytecode_p) /**< byte code pointer */
     if (script_p->refs_and_type < CBC_SCRIPT_REF_ONE)
     {
       size_t script_size = sizeof (cbc_script_t);
+      uint32_t type = script_p->refs_and_type;
 
-      uint32_t type = CBC_SCRIPT_GET_TYPE (script_p);
-
-      if (type != CBC_SCRIPT_GENERIC)
+      if (type & CBC_SCRIPT_HAS_USER_VALUE)
       {
         script_size += sizeof (ecma_value_t);
 
-        if (type == CBC_SCRIPT_USER_VALUE)
+        if (!(type & CBC_SCRIPT_USER_VALUE_IS_OBJECT))
         {
           ecma_value_t user_value = CBC_SCRIPT_GET_USER_VALUE (script_p);
 
@@ -1505,10 +1504,19 @@ ecma_bytecode_deref (ecma_compiled_code_t *bytecode_p) /**< byte code pointer */
       ecma_deref_ecma_string (ecma_get_string_from_value (script_p->resource_name));
 #endif /* JERRY_RESOURCE_NAME */
 
+#if JERRY_MODULE_SYSTEM
+      if (type & CBC_SCRIPT_HAS_IMPORT_META)
+      {
+        JERRY_ASSERT (ecma_is_value_object (CBC_SCRIPT_GET_IMPORT_META (script_p, type)));
+
+        script_size += sizeof (ecma_value_t);
+      }
+#endif /* JERRY_MODULE_SYSTEM */
+
 #if JERRY_FUNCTION_TO_STRING
       ecma_deref_ecma_string (ecma_get_string_from_value (script_p->source_code));
 
-      if (script_p->refs_and_type & CBC_SCRIPT_HAS_FUNCTION_ARGUMENTS)
+      if (type & CBC_SCRIPT_HAS_FUNCTION_ARGUMENTS)
       {
         ecma_deref_ecma_string (ecma_get_string_from_value (CBC_SCRIPT_GET_FUNCTION_ARGUMENTS (script_p, type)));
         script_size += sizeof (ecma_value_t);

jerry-core/ecma/builtin-objects/ecma-builtin-function-prototype.c

@@ -133,7 +133,7 @@ ecma_builtin_function_prototype_object_to_string (ecma_object_t *func_obj_p) /**
         JERRY_ASSERT (script_p->refs_and_type & CBC_SCRIPT_HAS_FUNCTION_ARGUMENTS);
 #endif /* JERRY_SNAPSHOT_EXEC */
 
-        source_code = CBC_SCRIPT_GET_FUNCTION_ARGUMENTS (script_p, CBC_SCRIPT_GET_TYPE (script_p));
+        source_code = CBC_SCRIPT_GET_FUNCTION_ARGUMENTS (script_p, script_p->refs_and_type);
       }
 
       ecma_string_t *result_string_p;
@@ -179,7 +179,7 @@ ecma_builtin_function_prototype_object_to_string (ecma_object_t *func_obj_p) /**
 #endif /* JERRY_ESNEXT */
 
   ecma_stringbuilder_t builder = ecma_stringbuilder_create_from (ecma_get_magic_string (header_id));
-  ecma_value_t function_arguments = CBC_SCRIPT_GET_FUNCTION_ARGUMENTS (script_p, CBC_SCRIPT_GET_TYPE (script_p));
+  ecma_value_t function_arguments = CBC_SCRIPT_GET_FUNCTION_ARGUMENTS (script_p, script_p->refs_and_type);
 
   ecma_stringbuilder_append (&builder, ecma_get_string_from_value (function_arguments));
   ecma_stringbuilder_append_raw (&builder, (const lit_utf8_byte_t *) "\n) {\n", 5);

jerry-core/include/jerryscript-core.h

@@ -274,6 +274,7 @@ jerry_value_t jerry_module_link (const jerry_value_t module_val,
 jerry_value_t jerry_module_evaluate (const jerry_value_t module_val);
 jerry_module_state_t jerry_module_get_state (const jerry_value_t module_val);
 void jerry_module_set_state_changed_callback (jerry_module_state_changed_callback_t callback, void *user_p);
+void jerry_module_set_import_meta_callback (jerry_module_import_meta_callback_t callback, void *user_p);
 size_t jerry_module_get_number_of_requests (const jerry_value_t module_val);
 jerry_value_t jerry_module_get_request (const jerry_value_t module_val, size_t request_index);
 jerry_value_t jerry_module_get_namespace (const jerry_value_t module_val);

jerry-core/include/jerryscript-snapshot.h

@@ -30,7 +30,7 @@ extern "C"
 /**
  * Jerry snapshot format version.
  */
-#define JERRY_SNAPSHOT_VERSION (68u)
+#define JERRY_SNAPSHOT_VERSION (69u)
 
 /**
  * Flags for jerry_generate_snapshot and jerry_generate_function_snapshot.

jerry-core/include/jerryscript-types.h

@@ -588,6 +588,12 @@ typedef jerry_value_t (*jerry_module_import_callback_t) (const jerry_value_t spe
 typedef void (*jerry_module_state_changed_callback_t) (jerry_module_state_t new_state, const jerry_value_t module,
                                                        const jerry_value_t value, void *user_p);
 
+/**
+ * Callback which is called when an import.meta expression of a module is evaluated the first time.
+ */
+typedef void (*jerry_module_import_meta_callback_t) (const jerry_value_t module,
+                                                     const jerry_value_t meta_object, void *user_p);
+
 /**
  * Callback which is called by jerry_module_evaluate to evaluate the native module.
  */

jerry-core/jcontext/jcontext.h

@@ -152,6 +152,10 @@ struct jerry_context_t
   jerry_module_state_changed_callback_t module_state_changed_callback_p; /**< callback which is called after the
                                                                           *   state of a module is changed */
   void *module_state_changed_callback_user_p; /**< user pointer for module_state_changed_callback_p */
+  jerry_module_import_meta_callback_t module_import_meta_callback_p; /**< callback which is called when an
+                                                                      *   import.meta expression of a module
+                                                                      *   is evaluated the first time */
+  void *module_import_meta_callback_user_p; /**< user pointer for module_import_meta_callback_p */
   jerry_module_import_callback_t module_import_callback_p; /**< callback for dynamic module import */
   void *module_import_callback_user_p; /**< user pointer for module_import_callback_p */
 #endif /* JERRY_MODULE_SYSTEM */

jerry-core/parser/js/byte-code.c

@@ -31,7 +31,7 @@ JERRY_STATIC_ASSERT (offsetof (cbc_uint8_arguments_t, script_value) == offsetof
  */
 JERRY_STATIC_ASSERT (CBC_END == 238,
                      number_of_cbc_opcodes_changed);
-JERRY_STATIC_ASSERT (CBC_EXT_END == 147,
+JERRY_STATIC_ASSERT (CBC_EXT_END == 148,
                      number_of_cbc_ext_opcodes_changed);
 
 #if JERRY_PARSER || JERRY_PARSER_DUMP_BYTE_CODE

jerry-core/parser/js/byte-code.h

@@ -600,6 +600,8 @@
               VM_OC_PUSH_REST_OBJECT) \
   CBC_OPCODE (CBC_EXT_MODULE_IMPORT, CBC_NO_FLAG, 0, \
               VM_OC_MODULE_IMPORT) \
+  CBC_OPCODE (CBC_EXT_MODULE_IMPORT_META, CBC_NO_FLAG, 1, \
+              VM_OC_MODULE_IMPORT_META) \
   CBC_OPCODE (CBC_EXT_STRING_CONCAT, CBC_NO_FLAG, -1, \
               VM_OC_STRING_CONCAT | VM_OC_GET_STACK_STACK | VM_OC_PUT_STACK) \
   CBC_OPCODE (CBC_EXT_STRING_CONCAT_RIGHT_LITERAL, CBC_HAS_LITERAL_ARG, 0, \
@@ -998,42 +1000,36 @@ typedef enum
  */
 typedef enum
 {
-  CBC_SCRIPT_GENERIC, /**< script without user specific data */
-  CBC_SCRIPT_USER_OBJECT, /**< script with a user object */
-  CBC_SCRIPT_USER_VALUE, /**< script with a non-object user value */
+  CBC_SCRIPT_HAS_USER_VALUE = (1 << 0), /**< script has user value */
+  CBC_SCRIPT_USER_VALUE_IS_OBJECT = (1 << 1), /**< user value is object */
+  CBC_SCRIPT_HAS_FUNCTION_ARGUMENTS = (1 << 2), /**< script is a function with arguments source code */
+  CBC_SCRIPT_HAS_IMPORT_META = (1 << 3), /**< script is a module with import.meta object */
 } cbc_script_type;
 
-/**
- * Script is a function with arguments source code.
- */
-#define CBC_SCRIPT_HAS_FUNCTION_ARGUMENTS 0x4
-
 /**
  * Value for increasing or decreasing the script reference counter.
  */
-#define CBC_SCRIPT_REF_ONE 0x8
+#define CBC_SCRIPT_REF_ONE 0x10
 
 /**
  * Maximum value of script reference counter.
  */
 #define CBC_SCRIPT_REF_MAX (UINT32_MAX - CBC_SCRIPT_REF_ONE + 1)
 
-/**
- * Get the type of a script.
- */
-#define CBC_SCRIPT_GET_TYPE(script_p) ((script_p)->refs_and_type & 0x3)
-
 /**
  * Sets the type of a script using the user_value.
  */
 #define CBC_SCRIPT_SET_TYPE(script_p, user_value, ref_count) \
   do \
   { \
-    (script_p)->refs_and_type = ((ref_count) | CBC_SCRIPT_GENERIC); \
+    (script_p)->refs_and_type = (ref_count); \
     if ((user_value) != ECMA_VALUE_EMPTY) \
     { \
-      (script_p)->refs_and_type = (ecma_is_value_object (user_value) ? ((ref_count) | CBC_SCRIPT_USER_OBJECT) \
-                                                                     : ((ref_count) | CBC_SCRIPT_USER_VALUE)); \
+      (script_p)->refs_and_type |= CBC_SCRIPT_HAS_USER_VALUE; \
+      if (ecma_is_value_object (user_value)) \
+      { \
+        (script_p)->refs_and_type |= CBC_SCRIPT_USER_VALUE_IS_OBJECT; \
+      } \
     } \
   } \
   while (false)
@@ -1073,7 +1069,13 @@ typedef struct
  * Get function arguments.
  */
 #define CBC_SCRIPT_GET_FUNCTION_ARGUMENTS(script_p, type) \
-  (CBC_SCRIPT_GET_OPTIONAL_VALUES (script_p)[(type) != CBC_SCRIPT_GENERIC ? 1 : 0])
+  (CBC_SCRIPT_GET_OPTIONAL_VALUES (script_p)[((type) & CBC_SCRIPT_HAS_USER_VALUE) ? 1 : 0])
+
+/**
+ * Get import.meta object.
+ */
+#define CBC_SCRIPT_GET_IMPORT_META(script_p, type) \
+  (CBC_SCRIPT_GET_OPTIONAL_VALUES (script_p)[((type) & CBC_SCRIPT_HAS_USER_VALUE) ? 1 : 0])
 
 #define CBC_OPCODE(arg1, arg2, arg3, arg4) arg1,
 

jerry-core/parser/js/js-lexer.c

@@ -491,6 +491,9 @@ static const keyword_string_t keywords_with_length_4[] =
   LEXER_KEYWORD ("else", LEXER_KEYW_ELSE),
   LEXER_KEYWORD ("enum", LEXER_KEYW_ENUM),
   LEXER_KEYWORD ("eval", LEXER_KEYW_EVAL),
+#if JERRY_MODULE_SYSTEM
+  LEXER_KEYWORD ("meta", LEXER_KEYW_META),
+#endif /* JERRY_MODULE_SYSTEM */
   LEXER_KEYWORD ("null", LEXER_LIT_NULL),
   LEXER_KEYWORD ("this", LEXER_KEYW_THIS),
   LEXER_KEYWORD ("true", LEXER_LIT_TRUE),