Rename resource_name to source_name (#4846)

JerryScript-DCO-1.0-Signed-off-by: Yonggang Luo [email protected]

Author: lygstate

docs/02.API-REFERENCE.md

@@ -324,7 +324,7 @@ Flags for [jerry_exec_snapshot](#jerry_exec_snapshot) functions:
  - JERRY_SNAPSHOT_EXEC_COPY_DATA - copy snapshot data into memory (see below)
  - JERRY_SNAPSHOT_EXEC_ALLOW_STATIC - allow executing static snapshots
  - JERRY_SNAPSHOT_EXEC_LOAD_AS_FUNCTION - load snapshot as function instead of executing it
- - JERRY_SNAPSHOT_EXEC_HAS_RESOURCE - `source_name` field is valid
+ - JERRY_SNAPSHOT_EXEC_HAS_SOURCE_NAME - `source_name` field is valid
                                       in [jerry_exec_snapshot_option_values_t](#jerry_exec_snapshot_option_values_t)
  - JERRY_SNAPSHOT_EXEC_HAS_USER_VALUE - `user_value` field is valid
                                         in [jerry_exec_snapshot_option_values_t](#jerry_exec_snapshot_option_values_t)
@@ -560,7 +560,7 @@ typedef struct
   uint32_t options; /**< combination of jerry_parse_option_enable_feature_t values */
   jerry_value_t argument_list; /**< function argument list if JERRY_PARSE_HAS_ARGUMENT_LIST is set in options
                                 *   Note: must be string value */
-  jerry_value_t source_name; /**< resource name string (usually a file name)
+  jerry_value_t source_name; /**< source name string (usually a file name)
                               *   if JERRY_PARSE_HAS_SOURCE_NAME is set in options
                               *   Note: must be string value */
   uint32_t start_line; /**< start line of the source code if JERRY_PARSE_HAS_START is set in options */
@@ -626,7 +626,7 @@ Source code location data retrieved by
 ```c
 typedef struct
 {
-  jerry_value_t source_name; /**< resource name */
+  jerry_value_t source_name; /**< source name */
   jerry_size_t line; /**< line index */
   jerry_size_t column; /**< column index */
 } jerry_frame_location_t;
@@ -1398,8 +1398,8 @@ Various configuration options for [jerry_exec_snapshot](#jerry_exec_snapshot)
 ```c
 typedef struct
 {
-  jerry_value_t source_name; /**< resource name string (usually a file name)
-                              *   if JERRY_SNAPSHOT_EXEC_HAS_RESOURCE is set in exec_snapshot_opts
+  jerry_value_t source_name; /**< source name string (usually a file name)
+                              *   if JERRY_SNAPSHOT_EXEC_HAS_SOURCE_NAME is set in exec_snapshot_opts
                               *   Note: non-string values are ignored */
   jerry_value_t user_value; /**< user value assigned to all functions created by this script including
                              *   eval calls executed by the script if JERRY_SNAPSHOT_EXEC_HAS_USER_VALUE
@@ -11575,7 +11575,7 @@ main (void)
 
 **Summary**
 
-Get the resource name (usually a file name) of the currently executed script or the given function object.
+Get the source name (usually a file name) of the currently executed script or the given function object.
 
 This function is typically called from native callbacks.
 
@@ -11592,17 +11592,17 @@ is no longer needed.
 jerry_value_t
 jerry_source_name (jerry_value_t value);
 ```
-- `value` - api value to obtain the resource name from
+- `value` - api value to obtain the source name from
 - return string value constructed from
-  - the currently executed function object's resource name, if the given value is undefined
-  - resource name of the function object, if the given value is a function object
+  - the currently executed function object's source name, if the given value is undefined
+  - source name of the function object, if the given value is a function object
   - "<anonymous>", otherwise
 
 *New in version 2.2*.
 
 **Example**
 
-[doctest]: # (name="02.API-REFERENCE-jsresourcename.c")
+[doctest]: # (name="02.API-REFERENCE-jssourcename.c")
 
 ```c
 #include <stdio.h>
@@ -11628,10 +11628,10 @@ main (void)
 
   jerry_value_t global = jerry_current_realm ();
 
-  /* Register the "resourceName" method. */
+  /* Register the sourceName" method. */
   {
     jerry_value_t func = jerry_function_external (source_name_handler);
-    jerry_value_t name = jerry_string_sz ("resourceName");
+    jerry_value_t name = jerry_string_sz ("sourceName");
     jerry_value_t result = jerry_object_set (global, name, func);
     jerry_value_free (result);
     jerry_value_free (name);
@@ -11640,7 +11640,7 @@ main (void)
 
   jerry_value_free (global);
 
-  const jerry_char_t source[] = "function myFunction() { return resourceName() }; myFunction()";
+  const jerry_char_t source[] = "function myFunction() { return sourceName() }; myFunction()";
 
   jerry_parse_options_t parse_options;
   parse_options.options = JERRY_PARSE_HAS_SOURCE_NAME;

docs/07.DEBUGGER.md

@@ -74,8 +74,8 @@ Currently, `jerryx_debugger_rp_create ()` for raw packet transport layer and
 `jerryx_debugger_serial_create (const char* config)` for serial protocol
 are also available.)
 
-The resource name provided to `jerry_parse ()` is used by the client
-to identify the resource name of the source code. This resource name
+The source name provided to `jerry_parse ()` is used by the client
+to identify the source name of the source code. This source name
 is usually a file name.
 
 ## JerryScript debugger C-API interface
@@ -103,8 +103,8 @@ typedef jerry_value_t
                                               size_t source_size, void *user_p);
 ```
 
-- `source_name_p` - resource (usually a file) name of the source code
-- `source_name_size` - size of resource name
+- `source_name_p` - source (usually a file) name of the source code
+- `source_name_size` - size of source name
 - `source_p` - source code character data
 - `source_size` - size of source code
 - `user_p` - custom pointer passed to [jerry_debugger_wait_for_client_source](#jerry_debugger_wait_for_client_source)
@@ -306,8 +306,8 @@ jerry_debugger_wait_for_client_source (jerry_debugger_wait_for_source_callback_t
  * Runs the source code received by jerry_debugger_wait_for_client_source.
  */
 static jerry_value_t
-wait_for_source_callback (const jerry_char_t *source_name_p, /**< resource name */
-                          size_t source_name_size, /**< size of resource name */
+wait_for_source_callback (const jerry_char_t *source_name_p, /**< source name */
+                          size_t source_name_size, /**< size of source name */
                           const jerry_char_t *source_p, /**< source code */
                           size_t source_size, /**< source code size */
                           void *user_p /**< user pointer */)

jerry-core/api/jerry-snapshot.c

@@ -643,10 +643,10 @@ snapshot_load_compiled_code (const uint8_t *base_addr_p, /**< base address of th
     }
 #endif /* JERRY_ESNEXT */
 
-#if JERRY_RESOURCE_NAME
-    /* resource name */
+#if JERRY_SOURCE_NAME
+    /* source name */
     extra_bytes += (uint32_t) sizeof (ecma_value_t);
-#endif /* JERRY_RESOURCE_NAME */
+#endif /* JERRY_SOURCE_NAME */
 
     new_code_size = JERRY_ALIGNUP (new_code_size + extra_bytes, JMEM_ALIGNMENT);
 
@@ -880,7 +880,7 @@ jerry_exec_snapshot (const uint32_t *snapshot_p, /**< snapshot */
 
   uint32_t allowed_opts =
     (JERRY_SNAPSHOT_EXEC_COPY_DATA | JERRY_SNAPSHOT_EXEC_ALLOW_STATIC | JERRY_SNAPSHOT_EXEC_LOAD_AS_FUNCTION
-     | JERRY_SNAPSHOT_EXEC_HAS_RESOURCE | JERRY_SNAPSHOT_EXEC_HAS_USER_VALUE);
+     | JERRY_SNAPSHOT_EXEC_HAS_SOURCE_NAME | JERRY_SNAPSHOT_EXEC_HAS_USER_VALUE);
 
   if ((exec_snapshot_opts & ~(allowed_opts)) != 0)
   {
@@ -955,18 +955,18 @@ jerry_exec_snapshot (const uint32_t *snapshot_p, /**< snapshot */
     script_p->realm_p = (ecma_object_t *) JERRY_CONTEXT (global_object_p);
 #endif /* JERRY_BUILTIN_REALMS */
 
-#if JERRY_RESOURCE_NAME
-    ecma_value_t source_name = ecma_make_magic_string_value (LIT_MAGIC_STRING_RESOURCE_ANON);
+#if JERRY_SOURCE_NAME
+    ecma_value_t source_name = ecma_make_magic_string_value (LIT_MAGIC_STRING_SOURCE_NAME_ANON);
 
-    if ((exec_snapshot_opts & JERRY_SNAPSHOT_EXEC_HAS_RESOURCE) && option_values_p != NULL
+    if ((exec_snapshot_opts & JERRY_SNAPSHOT_EXEC_HAS_SOURCE_NAME) && option_values_p != NULL
         && ecma_is_value_string (option_values_p->source_name) > 0)
     {
       ecma_ref_ecma_string (ecma_get_string_from_value (option_values_p->source_name));
       source_name = option_values_p->source_name;
     }
 
     script_p->source_name = source_name;
-#endif /* JERRY_RESOURCE_NAME */
+#endif /* JERRY_SOURCE_NAME */
 
 #if JERRY_FUNCTION_TO_STRING
     script_p->source_code = ecma_make_magic_string_value (LIT_MAGIC_STRING__EMPTY);

jerry-core/api/jerryscript.c

@@ -5364,19 +5364,19 @@ jerry_frame_is_strict (jerry_frame_t *frame_p) /**< frame pointer */
 } /* jerry_frame_is_strict */
 
 /**
- * Get the resource name (usually a file name) of the currently executed script or the given function object
+ * Get the source name (usually a file name) of the currently executed script or the given function object
  *
  * Note: returned value must be freed with jerry_value_free, when it is no longer needed
  *
  * @return JS string constructed from
- *         - the currently executed function object's resource name, if the given value is undefined
- *         - resource name of the function object, if the given value is a function object
+ *         - the currently executed function object's source name, if the given value is undefined
+ *         - source name of the function object, if the given value is a function object
  *         - "<anonymous>", otherwise
  */
 jerry_value_t
 jerry_source_name (const jerry_value_t value) /**< jerry api value */
 {
-#if JERRY_RESOURCE_NAME
+#if JERRY_SOURCE_NAME
   if (ecma_is_value_undefined (value) && JERRY_CONTEXT (vm_top_context_p) != NULL)
   {
     return ecma_copy_value (ecma_get_source_name (JERRY_CONTEXT (vm_top_context_p)->shared_p->bytecode_header_p));
@@ -5386,16 +5386,16 @@ jerry_source_name (const jerry_value_t value) /**< jerry api value */
 
   if (script_value == JMEM_CP_NULL)
   {
-    return ecma_make_magic_string_value (LIT_MAGIC_STRING_RESOURCE_ANON);
+    return ecma_make_magic_string_value (LIT_MAGIC_STRING_SOURCE_NAME_ANON);
   }
 
   const cbc_script_t *script_p = ECMA_GET_INTERNAL_VALUE_POINTER (cbc_script_t, script_value);
 
   return ecma_copy_value (script_p->source_name);
-#else /* !JERRY_RESOURCE_NAME */
+#else /* !JERRY_SOURCE_NAME */
   JERRY_UNUSED (value);
-  return ecma_make_magic_string_value (LIT_MAGIC_STRING_RESOURCE_ANON);
-#endif /* JERRY_RESOURCE_NAME */
+  return ecma_make_magic_string_value (LIT_MAGIC_STRING_SOURCE_NAME_ANON);
+#endif /* JERRY_SOURCE_NAME */
 } /* jerry_source_name */
 
 /**

jerry-core/config.h

@@ -716,12 +716,12 @@
 #endif /* JERRY_PROMISE_CALLBACK && !JERRY_ESNEXT */
 
 /**
- * Resource name related types into a single guard
+ * Source name related types into a single guard
  */
 #if JERRY_LINE_INFO || JERRY_ERROR_MESSAGES || JERRY_MODULE_SYSTEM
-#define JERRY_RESOURCE_NAME 1
+#define JERRY_SOURCE_NAME 1
 #else /* !(JERRY_LINE_INFO || JERRY_ERROR_MESSAGES || JERRY_MODULE_SYSTEM) */
-#define JERRY_RESOURCE_NAME 0
+#define JERRY_SOURCE_NAME 0
 #endif /* JERRY_LINE_INFO || JERRY_ERROR_MESSAGES || JERRY_MODULE_SYSTEM */
 
 #endif /* !JERRYSCRIPT_CONFIG_H */

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

@@ -1433,9 +1433,9 @@ ecma_script_deref (ecma_value_t script_value) /**< script value */
     }
   }
 
-#if JERRY_RESOURCE_NAME
+#if JERRY_SOURCE_NAME
   ecma_deref_ecma_string (ecma_get_string_from_value (script_p->source_name));
-#endif /* JERRY_RESOURCE_NAME */
+#endif /* JERRY_SOURCE_NAME */
 
 #if JERRY_MODULE_SYSTEM
   if (type & CBC_SCRIPT_HAS_IMPORT_META)
@@ -1773,27 +1773,27 @@ ecma_compiled_code_get_line_info (const ecma_compiled_code_t *bytecode_header_p)
 #endif /* JERRY_LINE_INFO */
 
 /**
- * Get the resource name of a compiled code.
+ * Get the source name of a compiled code.
  *
- * @return resource name value
+ * @return source name value
  */
 ecma_value_t
 ecma_get_source_name (const ecma_compiled_code_t *bytecode_p) /**< compiled code */
 {
-#if JERRY_RESOURCE_NAME
+#if JERRY_SOURCE_NAME
 #if JERRY_SNAPSHOT_EXEC
   if (JERRY_UNLIKELY (bytecode_p->status_flags & CBC_CODE_FLAGS_STATIC_FUNCTION))
   {
-    return ecma_make_magic_string_value (LIT_MAGIC_STRING_RESOURCE_ANON);
+    return ecma_make_magic_string_value (LIT_MAGIC_STRING_SOURCE_NAME_ANON);
   }
 #endif /* JERRY_SNAPSHOT_EXEC */
 
   ecma_value_t script_value = ((cbc_uint8_arguments_t *) bytecode_p)->script_value;
   return ECMA_GET_INTERNAL_VALUE_POINTER (cbc_script_t, script_value)->source_name;
-#else /* !JERRY_RESOURCE_NAME */
+#else /* !JERRY_SOURCE_NAME */
   JERRY_UNUSED (bytecode_p);
-  return ecma_make_magic_string_value (LIT_MAGIC_STRING_RESOURCE_ANON);
-#endif /* !JERRY_RESOURCE_NAME */
+  return ecma_make_magic_string_value (LIT_MAGIC_STRING_SOURCE_NAME_ANON);
+#endif /* !JERRY_SOURCE_NAME */
 } /* ecma_get_source_name */
 
 #if (JERRY_STACK_LIMIT != 0)

jerry-core/ecma/operations/ecma-function-object.c

@@ -47,7 +47,7 @@
  *
  * See also: ECMAScript v6, 9.2.1.1
  *
- * @return resource name as ecma-string
+ * @return source name as ecma-string
  */
 ecma_value_t
 ecma_op_function_form_name (ecma_string_t *prop_name_p, /**< property name */

jerry-core/include/jerryscript-debugger.h

@@ -43,7 +43,7 @@ typedef enum
 /**
  * Callback for jerry_debugger_wait_and_run_client_source
  *
- * The callback receives the resource name, source code and a user pointer.
+ * The callback receives the source name, source code and a user pointer.
  *
  * @return this value is passed back by jerry_debugger_wait_and_run_client_source
  */

jerry-core/include/jerryscript-snapshot.h

@@ -45,8 +45,8 @@ typedef enum
   JERRY_SNAPSHOT_EXEC_COPY_DATA = (1u << 0), /**< copy snashot data */
   JERRY_SNAPSHOT_EXEC_ALLOW_STATIC = (1u << 1), /**< static snapshots allowed */
   JERRY_SNAPSHOT_EXEC_LOAD_AS_FUNCTION = (1u << 2), /**< load snapshot as function instead of executing it */
-  JERRY_SNAPSHOT_EXEC_HAS_RESOURCE = (1u << 3), /**< source_name field is valid
-                                                 *   in jerry_exec_snapshot_option_values_t */
+  JERRY_SNAPSHOT_EXEC_HAS_SOURCE_NAME = (1u << 3), /**< source_name field is valid
+                                                    *   in jerry_exec_snapshot_option_values_t */
   JERRY_SNAPSHOT_EXEC_HAS_USER_VALUE = (1u << 4), /**< user_value field is valid
                                                    *   in jerry_exec_snapshot_option_values_t */
 } jerry_exec_snapshot_opts_t;
@@ -56,8 +56,8 @@ typedef enum
  */
 typedef struct
 {
-  jerry_value_t source_name; /**< resource name string (usually a file name)
-                              *   if JERRY_SNAPSHOT_EXEC_HAS_RESOURCE is set in exec_snapshot_opts
+  jerry_value_t source_name; /**< source name string (usually a file name)
+                              *   if JERRY_SNAPSHOT_EXEC_HAS_SOURCE_NAME is set in exec_snapshot_opts
                               *   Note: non-string values are ignored */
   jerry_value_t user_value; /**< user value assigned to all functions created by this script including
                              *   eval calls executed by the script if JERRY_SNAPSHOT_EXEC_HAS_USER_VALUE

jerry-core/include/jerryscript-types.h

@@ -441,7 +441,7 @@ typedef enum
  */
 typedef struct
 {
-  jerry_value_t source_name; /**< resource name */
+  jerry_value_t source_name; /**< source name */
   jerry_size_t line; /**< line index */
   jerry_size_t column; /**< column index */
 } jerry_frame_location_t;