Implement the string iterators (#2873)

JerryScript-DCO-1.0-Signed-off-by: Robert Fancsik frobert@inf.u-szeged.hu
2019-05-30 12:34:19 -04:00
parent 442e482afa
commit 076f515d61
15 changed files with 372 additions and 17 deletions
@@ -66,21 +66,22 @@ ecma_builtin_array_iterator_prototype_object_next (ecma_value_t this_val) /**< t
  ecma_extended_object_t *ext_obj_p = (ecma_extended_object_t *) obj_p;

  /* 3. */
-  if (ext_obj_p->u.pseudo_array.type != ECMA_PSEUDO_ARRAY_ITERATOR)
+  if (ecma_get_object_type (obj_p) != ECMA_OBJECT_TYPE_PSEUDO_ARRAY
+      || ext_obj_p->u.pseudo_array.type != ECMA_PSEUDO_ARRAY_ITERATOR)
  {
    return ecma_raise_type_error (ECMA_ERR_MSG ("Argument 'this' is not an iterator."));
  }

-  ecma_object_t *array_object_p = ECMA_GET_POINTER (ecma_object_t,
-                                                    ext_obj_p->u.pseudo_array.u2.iterated_value_cp);
-
+  ecma_value_t iterated_value = ext_obj_p->u.pseudo_array.u2.iterated_value;

  /* 4 - 5 */
-  if (array_object_p == NULL)
+  if (ecma_is_value_empty (iterated_value))
  {
    return ecma_create_iter_result_object (ECMA_VALUE_UNDEFINED, ECMA_VALUE_TRUE);
  }

+  ecma_object_t *array_object_p = ecma_get_object_from_value (iterated_value);
+
  uint32_t length;

  /* 8 - 9. */
@@ -147,7 +148,7 @@ ecma_builtin_array_iterator_prototype_object_next (ecma_value_t this_val) /**< t

  if (index >= length)
  {
-    ECMA_SET_POINTER (ext_obj_p->u.pseudo_array.u2.iterated_value_cp, NULL);
+    ext_obj_p->u.pseudo_array.u2.iterated_value = ECMA_VALUE_EMPTY;
    return ecma_create_iter_result_object (ECMA_VALUE_UNDEFINED, ECMA_VALUE_TRUE);
  }

@@ -0,0 +1,152 @@
+/* Copyright JS Foundation and other contributors, http://js.foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "ecma-builtin-helpers.h"
+#include "ecma-builtins.h"
+#include "ecma-iterator-object.h"
+
+#if ENABLED (JERRY_ES2015_BUILTIN_ITERATOR)
+
+#if !ENABLED (JERRY_ES2015_BUILTIN_SYMBOL)
+#error "Iterator builtin requires ES2015 symbol builtin"
+#endif /* !ENABLED (JERRY_ES2015_BUILTIN_SYMBOL) */
+
+#define ECMA_BUILTINS_INTERNAL
+#include "ecma-builtins-internal.h"
+
+#define BUILTIN_INC_HEADER_NAME "ecma-builtin-string-iterator-prototype.inc.h"
+#define BUILTIN_UNDERSCORED_ID string_iterator_prototype
+#include "ecma-builtin-internal-routines-template.inc.h"
+
+/** \addtogroup ecma ECMA
+ * @{
+ *
+ * \addtogroup ecmabuiltins
+ * @{
+ *
+ * \addtogroup %stringiteratorprototype% ECMA %ArrayIteratorPrototype% object built-in
+ * @{
+ */
+
+/**
+ * The %StringIteratorPrototype% object's 'next' routine
+ *
+ * See also:
+ *          ECMA-262 v6, 22.1.5.2.1
+ *
+ * Note:
+ *     Returned value must be freed with ecma_free_value.
+ *
+ * @return iterator result object, if success
+ *         error - otherwise
+ */
+static ecma_value_t
+ecma_builtin_string_iterator_prototype_object_next (ecma_value_t this_val) /**< this argument */
+{
+    /* 1 - 2. */
+  if (!ecma_is_value_object (this_val))
+  {
+    return ecma_raise_type_error (ECMA_ERR_MSG ("Argument 'this' is not an object."));
+  }
+
+  ecma_object_t *obj_p = ecma_get_object_from_value (this_val);
+  ecma_extended_object_t *ext_obj_p = (ecma_extended_object_t *) obj_p;
+
+  /* 3. */
+  if (ecma_get_object_type (obj_p) != ECMA_OBJECT_TYPE_PSEUDO_ARRAY
+      || ext_obj_p->u.pseudo_array.type != ECMA_PSEUDO_STRING_ITERATOR)
+  {
+    return ecma_raise_type_error (ECMA_ERR_MSG ("Argument 'this' is not an iterator."));
+  }
+
+  ecma_value_t iterated_value = ext_obj_p->u.pseudo_array.u2.iterated_value;
+
+  /* 4 - 5 */
+  if (ecma_is_value_empty (iterated_value))
+  {
+    return ecma_create_iter_result_object (ECMA_VALUE_UNDEFINED, ECMA_VALUE_TRUE);
+  }
+
+  JERRY_ASSERT (ecma_is_value_string (iterated_value));
+
+
+  ecma_string_t *string_p = ecma_get_string_from_value (iterated_value);
+
+  /* 6. */
+  ecma_length_t position = ext_obj_p->u.pseudo_array.u1.iterator_index;
+
+  if (JERRY_UNLIKELY (position == ECMA_ITERATOR_INDEX_LIMIT))
+  {
+    return ecma_raise_range_error (ECMA_ERR_MSG ("String iteration cannot be continued."));
+  }
+
+  /* 7. */
+  ecma_length_t len = ecma_string_get_length (string_p);
+
+  /* 8. */
+  if (position >= len)
+  {
+    ecma_deref_ecma_string (string_p);
+    ext_obj_p->u.pseudo_array.u2.iterated_value = ECMA_VALUE_EMPTY;
+    return ecma_create_iter_result_object (ECMA_VALUE_UNDEFINED, ECMA_VALUE_TRUE);
+  }
+
+  /* 9. */
+  ecma_char_t first = ecma_string_get_char_at_pos (string_p, position);
+
+  ecma_string_t *result_str_p;
+  ecma_length_t result_size = 1;
+
+  /* 10. */
+  if (first < LIT_UTF16_HIGH_SURROGATE_MIN || first > LIT_UTF16_HIGH_SURROGATE_MAX || (position + 1 == len))
+  {
+    result_str_p = ecma_new_ecma_string_from_code_unit (first);
+  }
+  /* 11. */
+  else
+  {
+    /* 11.a */
+    ecma_char_t second = ecma_string_get_char_at_pos (string_p, (ecma_length_t) (position + 1));
+
+    /* 11.b */
+    if (second < LIT_UTF16_LOW_SURROGATE_MIN || second > LIT_UTF16_LOW_SURROGATE_MAX)
+    {
+      result_str_p = ecma_new_ecma_string_from_code_unit (first);
+    }
+    /* 11.c */
+    else
+    {
+      result_str_p = ecma_new_ecma_string_from_code_units (first, second);
+      result_size = 2;
+    }
+  }
+
+  /* 13. */
+  ext_obj_p->u.pseudo_array.u1.iterator_index = (uint16_t) (position + result_size);
+
+  /* 14. */
+  ecma_value_t result = ecma_create_iter_result_object (ecma_make_string_value (result_str_p), ECMA_VALUE_FALSE);
+  ecma_deref_ecma_string (result_str_p);
+
+  return result;
+} /* ecma_builtin_string_iterator_prototype_object_next */
+
+/**
+ * @}
+ * @}
+ * @}
+ */
+
+#endif /* ENABLED (JERRY_ES2015_BUILTIN_ITERATOR) */
@@ -0,0 +1,34 @@
+/* Copyright JS Foundation and other contributors, http://js.foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/*
+ * %StringIteratorPrototype% built-in description
+ */
+
+#include "ecma-builtin-helpers-macro-defines.inc.h"
+
+#if ENABLED (JERRY_ES2015_BUILTIN_ITERATOR)
+
+STRING_VALUE (LIT_GLOBAL_SYMBOL_TO_STRING_TAG,
+              LIT_MAGIC_STRING_STRING_ITERATOR_UL,
+              ECMA_PROPERTY_FLAG_CONFIGURABLE)
+
+/* Routine properties:
+ *  (property name, C routine name, arguments number or NON_FIXED, value of the routine's length property) */
+ROUTINE (LIT_MAGIC_STRING_NEXT, ecma_builtin_string_iterator_prototype_object_next, 0, 0)
+
+#endif /* ENABLED (JERRY_ES2015_BUILTIN_ITERATOR) */
+
+#include "ecma-builtin-helpers-macro-undefs.inc.h"
@@ -23,6 +23,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"
@@ -2164,6 +2165,40 @@ ecma_builtin_string_prototype_object_substr (ecma_value_t this_arg, /**< this ar

 #endif /* ENABLED (JERRY_BUILTIN_ANNEXB) */

+#if ENABLED (JERRY_ES2015_BUILTIN_ITERATOR)
+/**
+ * The String.prototype object's @@iterator routine
+ *
+ * See also:
+ *          ECMA-262 v6, 21.1.3.27
+ *
+ * @return ecma value
+ *         Returned value must be freed with ecma_free_value.
+ */
+static ecma_value_t
+ecma_builtin_string_prototype_object_iterator (ecma_value_t this_arg) /**< this argument */
+{
+  ecma_value_t coercible = ecma_op_check_object_coercible (this_arg);
+
+  if (ECMA_IS_VALUE_ERROR (coercible))
+  {
+    return coercible;
+  }
+
+  ecma_value_t to_string = ecma_op_to_string (this_arg);
+
+  if (ECMA_IS_VALUE_ERROR (to_string))
+  {
+    return to_string;
+  }
+
+  return ecma_op_create_iterator_object (to_string,
+                                         ecma_builtin_get (ECMA_BUILTIN_ID_STRING_ITERATOR_PROTOTYPE),
+                                         ECMA_PSEUDO_STRING_ITERATOR,
+                                         0);
+} /* ecma_builtin_string_prototype_object_iterator */
+#endif /* ENABLED (JERRY_ES2015_BUILTIN_ITERATOR) */
+
 /**
 * @}
 * @}
@@ -67,6 +67,10 @@ ROUTINE (LIT_MAGIC_STRING_TRIM, ecma_builtin_string_prototype_object_trim, 0, 0)
 ROUTINE (LIT_MAGIC_STRING_SUBSTR, ecma_builtin_string_prototype_object_substr, 2, 2)
 #endif /* ENABLED (JERRY_BUILTIN_ANNEXB) */

+#if ENABLED (JERRY_ES2015_BUILTIN_ITERATOR)
+ROUTINE (LIT_GLOBAL_SYMBOL_ITERATOR, ecma_builtin_string_prototype_object_iterator, 0, 0)
+#endif /* ENABLED (JERRY_ES2015_BUILTIN_ITERATOR) */
+
 #endif /* ENABLED (JERRY_BUILTIN_STRING) */

 #include "ecma-builtin-helpers-macro-undefs.inc.h"
@@ -490,6 +490,13 @@ BUILTIN (ECMA_BUILTIN_ID_ARRAY_ITERATOR_PROTOTYPE,
         ECMA_BUILTIN_ID_ITERATOR_PROTOTYPE,
         true,
         array_iterator_prototype)
+
+/* The %StringIteratorPrototype% object (ECMA-262 v6, 22.1.5.2) */
+BUILTIN (ECMA_BUILTIN_ID_STRING_ITERATOR_PROTOTYPE,
+         ECMA_OBJECT_TYPE_GENERAL,
+         ECMA_BUILTIN_ID_ITERATOR_PROTOTYPE,
+         true,
+         string_iterator_prototype)
 #endif /* ENABLED (JERRY_ES2015_BUILTIN_ITERATOR) */

 #if ENABLED (JERRY_ES2015_BUILTIN_DATAVIEW)