Implement Iterator interface and Array iterators

JerryScript-DCO-1.0-Signed-off-by: Robert Fancsik frobert@inf.u-szeged.hu

Author: rerobika

jerry-core/config.h

@@ -40,6 +40,7 @@
 # define CONFIG_DISABLE_ES2015_BUILTIN
 # define CONFIG_DISABLE_ES2015_CLASS
 # define CONFIG_DISABLE_ES2015_FUNCTION_PARAMETER_INITIALIZER
+# define CONFIG_DISABLE_ES2015_ITERATOR_BUILTIN
 # define CONFIG_DISABLE_ES2015_MAP_BUILTIN
 # define CONFIG_DISABLE_ES2015_OBJECT_INITIALIZER
 # define CONFIG_DISABLE_ES2015_PROMISE_BUILTIN

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

@@ -39,6 +39,9 @@
 #ifndef CONFIG_DISABLE_ES2015_MAP_BUILTIN
 #include "ecma-map-object.h"
 #endif /* !CONFIG_DISABLE_ES2015_MAP_BUILTIN */
+#ifndef CONFIG_DISABLE_ES2015_ITERATOR_BUILTIN
+#include "ecma-iterator-object.h"
+#endif /* !CONFIG_DISABLE_ES2015_ITERATOR_BUILTIN */
 
 /* TODO: Extract GC to a separate component */
 
@@ -369,6 +372,12 @@ ecma_gc_mark (ecma_object_t *object_p) /**< object to mark from */
             break;
           }
 #endif /* !CONFIG_DISABLE_ES2015_TYPEDARRAY_BUILTIN */
+#ifndef CONFIG_DISABLE_ES2015_BUILTIN
+          case ECMA_PSEUDO_ARRAY_ITERATOR:
+          {
+            break;
+          }
+#endif /* !CONFIG_DISABLE_ES2015_BUILTIN */
           default:
           {
             JERRY_ASSERT (ext_object_p->u.pseudo_array.type == ECMA_PSEUDO_ARRAY_ARGUMENTS);
@@ -759,6 +768,14 @@ ecma_gc_free_object (ecma_object_t *object_p) /**< object to free */
           return;
         }
 #endif /* !CONFIG_DISABLE_ES2015_TYPEDARRAY_BUILTIN */
+#ifndef CONFIG_DISABLE_ES2015_ITERATOR_BUILTIN
+        case ECMA_PSEUDO_ARRAY_ITERATOR:
+        {
+          ecma_op_free_iterator_object (ext_object_p);
+          ecma_dealloc_extended_object (object_p, sizeof (ecma_extended_object_t));
+          return;
+        }
+#endif /* !CONFIG_DISABLE_ES2015_ITERATOR_BUILTIN */
         default:
         {
           JERRY_ASSERT (ext_object_p->u.pseudo_array.type == ECMA_PSEUDO_ARRAY_ARGUMENTS);

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

@@ -659,8 +659,9 @@ typedef enum
   ECMA_PSEUDO_ARRAY_ARGUMENTS = 0, /**< Arguments object (10.6) */
   ECMA_PSEUDO_ARRAY_TYPEDARRAY = 1, /**< TypedArray which does NOT need extra space to store length and offset */
   ECMA_PSEUDO_ARRAY_TYPEDARRAY_WITH_INFO = 2, /**< TypedArray which NEEDS extra space to store length and offset */
+  ECMA_PSEUDO_ARRAY_ITERATOR = 3, /**< Array iterator object (ECMAScript v6, 22.1.5.1) */
 
-  ECMA_PSEUDO_ARRAY__MAX = ECMA_PSEUDO_ARRAY_TYPEDARRAY_WITH_INFO /**< maximum value */
+  ECMA_PSEUDO_ARRAY__MAX = ECMA_PSEUDO_ARRAY_ITERATOR /**< maximum value */
 } ecma_pseudo_array_type_t;
 
 /**
@@ -681,6 +682,20 @@ typedef enum
   ECMA_LEXICAL_ENVIRONMENT_TYPE__MAX = ECMA_LEXICAL_ENVIRONMENT_SUPER_OBJECT_BOUND /**< maximum value */
 } ecma_lexical_environment_type_t;
 
+/**
+ * Types of array iterators.
+ */
+typedef enum
+{
+  ECMA_ARRAY_ITERATOR_KEYS = (1 << 5), /**< List only key indices */
+  ECMA_ARRAY_ITERATOR_VALUES = (1 << 6), /**< List only key values */
+} ecma_array_iterator_type_t;
+
+/**
+ * List key indices and values simultaneously.
+ */
+#define ECMA_ARRAY_ITERATOR_KEYS_VALUES (ECMA_ARRAY_ITERATOR_KEYS | ECMA_ARRAY_ITERATOR_VALUES)
+
 /**
  * Offset for JERRY_CONTEXT (status_flags) top 8 bits.
  */
@@ -841,18 +856,21 @@ typedef struct
      */
     struct
     {
-      uint8_t type; /**< pseudo array type, e.g. Arguments, TypedArray*/
+      uint8_t type; /**< pseudo array type, e.g. Arguments, TypedArray, ArrayIterator */
       uint8_t extra_info; /**< extra information about the object.
-                           *   e.g. element_width_shift for typed arrays */
+                           *   e.g. element_width_shift for typed arrays,
+                           *        elementKind for ArrayIterator */
       union
       {
         uint16_t length; /**< for arguments: length of names */
         uint16_t class_id; /**< for typedarray: the specific class name */
+        uint16_t iterator_index; /**< for ArrayIterator: [[ArrayIteratorNextIndex]] property */
       } u1;
       union
       {
         ecma_value_t lex_env_cp; /**< for arguments: lexical environment */
         ecma_value_t arraybuffer; /**< for typedarray: internal arraybuffer */
+        ecma_value_t prop_chunk_cp; /**< for ArrayIterator: current collection chunk */
       } u2;
     } pseudo_array;
 

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

@@ -24,6 +24,7 @@
 #include "ecma-gc.h"
 #include "ecma-globals.h"
 #include "ecma-helpers.h"
+#include "ecma-iterator-object.h"
 #include "ecma-objects.h"
 #include "ecma-string-object.h"
 #include "ecma-try-catch-macro.h"
@@ -2504,6 +2505,81 @@ ecma_builtin_array_prototype_object_find (ecma_value_t this_arg, /**< this argum
 } /* ecma_builtin_array_prototype_object_find */
 #endif /* !CONFIG_DISABLE_ES2015_BUILTIN */
 
+#ifndef CONFIG_DISABLE_ES2015_ITERATOR_BUILTIN
+/**
+ * Helper function for Array.prototype object's {'keys', 'values', 'entries'}
+ * routines common parts.
+ *
+ * @return ecma value
+ *         Returned value must be freed with ecma_free_value.
+ */
+static ecma_value_t
+ecma_builtin_array_iterators_helper (ecma_value_t this_arg, /**< this argument */
+                                     uint8_t type) /**< any combination of
+                                                    *   ecma_array_iterator_type_t bits */
+{
+  /* 1. */
+  ecma_value_t obj_this = ecma_op_to_object (this_arg);
+
+  if (ECMA_IS_VALUE_ERROR (obj_this))
+  {
+    /* 2. */
+    return obj_this;
+  }
+
+  /* 3. */
+  ecma_value_t ret_value = ecma_op_create_iterator_object (obj_this, ECMA_PSEUDO_ARRAY_ITERATOR, type);
+  ecma_free_value (obj_this);
+
+  return ret_value;
+} /* ecma_builtin_array_iterators_helper */
+
+/**
+ * The Array.prototype object's 'entries' routine
+ *
+ * See also:
+ *          ECMA-262 v6, 22.1.3.4
+ *
+ * @return ecma value
+ *         Returned value must be freed with ecma_free_value.
+ */
+static ecma_value_t
+ecma_builtin_array_prototype_entries (ecma_value_t this_arg) /**< this argument */
+{
+  return ecma_builtin_array_iterators_helper (this_arg, ECMA_ARRAY_ITERATOR_KEYS_VALUES);
+} /* ecma_builtin_array_prototype_entries */
+
+/**
+ * The Array.prototype object's 'values' routine
+ *
+ * See also:
+ *          ECMA-262 v6, 22.1.3.29.
+ *
+ * @return ecma value
+ *         Returned value must be freed with ecma_free_value.
+ */
+static ecma_value_t
+ecma_builtin_array_prototype_values (ecma_value_t this_arg) /**< this argument */
+{
+  return ecma_builtin_array_iterators_helper (this_arg, ECMA_ARRAY_ITERATOR_VALUES);
+} /* ecma_builtin_array_prototype_values */
+
+/**
+ * The Array.prototype object's 'keys' routine
+ *
+ * See also:
+ *          ECMA-262 v6, 22.1.3.13
+ *
+ * @return ecma value
+ *         Returned value must be freed with ecma_free_value.
+ */
+static ecma_value_t
+ecma_builtin_array_prototype_keys (ecma_value_t this_arg) /**< this argument */
+{
+  return ecma_builtin_array_iterators_helper (this_arg, ECMA_ARRAY_ITERATOR_KEYS);
+} /* ecma_builtin_array_prototype_keys */
+#endif /* !CONFIG_DISABLE_ES2015_ITERATOR_BUILTIN */
+
 /**
  * @}
  * @}

jerry-core/ecma/builtin-objects/ecma-builtin-array-prototype.inc.h

@@ -61,6 +61,9 @@ ROUTINE (LIT_MAGIC_STRING_FILTER, ecma_builtin_array_prototype_object_filter, 2,
 ROUTINE (LIT_MAGIC_STRING_REDUCE, ecma_builtin_array_prototype_object_reduce, NON_FIXED, 1)
 ROUTINE (LIT_MAGIC_STRING_REDUCE_RIGHT_UL, ecma_builtin_array_prototype_object_reduce_right, NON_FIXED, 1)
 #ifndef CONFIG_DISABLE_ES2015_BUILTIN
+ROUTINE (LIT_MAGIC_STRING_ENTRIES, ecma_builtin_array_prototype_entries, 0, 0)
+ROUTINE (LIT_MAGIC_STRING_VALUES, ecma_builtin_array_prototype_values, 0, 0)
+ROUTINE (LIT_MAGIC_STRING_KEYS, ecma_builtin_array_prototype_keys, 0, 0)
 ROUTINE (LIT_MAGIC_STRING_FIND, ecma_builtin_array_prototype_object_find, 2, 1)
 #endif /* !CONFIG_DISABLE_ES2015_BUILTIN */