Implement BigInt primitve type and some of its operations (#4062)

Supported operations: - parse BigInt (decimal, hexadecimal, binary) - toString with any radix between 2 and 36 - arithmetic operations: negate, add, subtract, multiply, divide, modulo - left and right shift JerryScript-DCO-1.0-Signed-off-by: Zoltan Herczeg zherczeg.u-szeged@partner.samsung.com
2020-07-30 12:08:34 +02:00
parent 3eb69075f7
commit df2f7782f7
29 changed files with 3237 additions and 192 deletions
@@ -0,0 +1,134 @@
+/* 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-bigint.h"
+#include "ecma-exceptions.h"
+
+#if ENABLED (JERRY_BUILTIN_BIGINT)
+
+#define ECMA_BUILTINS_INTERNAL
+#include "ecma-builtins-internal.h"
+
+/**
+ * This object has a custom dispatch function.
+ */
+#define BUILTIN_INC_HEADER_NAME "ecma-builtin-bigint-prototype.inc.h"
+#define BUILTIN_UNDERSCORED_ID bigint_prototype
+#include "ecma-builtin-internal-routines-template.inc.h"
+
+/** \addtogroup ecma ECMA
+ * @{
+ *
+ * \addtogroup ecmabuiltins
+ * @{
+ *
+ * \addtogroup bigint ECMA BigInt object built-in
+ * @{
+ */
+
+/**
+ * The BigInt.prototype object's 'valueOf' routine
+ *
+ * See also:
+ *          ECMA-262 v11, 20.2.3.4
+ *
+ * @return ecma value
+ *         Returned value must be freed with ecma_free_value.
+ */
+static ecma_value_t
+ecma_builtin_bigint_prototype_object_value_of (ecma_value_t this_arg) /**< this argument */
+{
+  if (ecma_is_value_bigint (this_arg))
+  {
+    return ecma_copy_value (this_arg);
+  }
+
+  if (ecma_is_value_object (this_arg))
+  {
+    ecma_object_t *object_p = ecma_get_object_from_value (this_arg);
+
+    if (ecma_object_class_is (object_p, LIT_MAGIC_STRING_BIGINT_UL))
+    {
+      ecma_extended_object_t *ext_object_p = (ecma_extended_object_t *) object_p;
+
+      JERRY_ASSERT (ecma_is_value_bigint (ext_object_p->u.class_prop.u.value));
+
+      return ecma_copy_value (ext_object_p->u.class_prop.u.value);
+    }
+  }
+
+  return ecma_raise_type_error (ECMA_ERR_MSG ("BigInt value expected."));
+} /* ecma_builtin_bigint_prototype_object_value_of */
+
+/**
+ * The BigInt.prototype object's 'toString' routine
+ *
+ * See also:
+ *          ECMA-262 v11, 20.2.3.3
+ *
+ * @return ecma value
+ *         Returned value must be freed with ecma_free_value.
+ */
+static ecma_value_t
+ecma_builtin_bigint_prototype_object_to_string (ecma_value_t this_arg, /**< this argument */
+                                                const ecma_value_t *arguments_list_p, /**< arguments list */
+                                                uint32_t arguments_list_len) /**< number of arguments */
+{
+  ecma_value_t bigint = ecma_builtin_bigint_prototype_object_value_of (this_arg);
+
+  if (ECMA_IS_VALUE_ERROR (bigint))
+  {
+    return bigint;
+  }
+
+  uint32_t radix = 10;
+
+  if (arguments_list_len > 0 && !ecma_is_value_undefined (arguments_list_p[0]))
+  {
+    ecma_number_t arg_num;
+
+    if (ECMA_IS_VALUE_ERROR (ecma_op_to_integer (arguments_list_p[0], &arg_num)))
+    {
+      ecma_free_value (bigint);
+      return ECMA_VALUE_ERROR;
+    }
+
+    if (arg_num < 2 || arg_num > 36)
+    {
+      ecma_free_value (bigint);
+      return ecma_raise_range_error (ECMA_ERR_MSG ("Radix must be between 2 and 36."));
+    }
+
+    radix = (uint32_t) arg_num;
+  }
+
+  ecma_string_t *string_p = ecma_bigint_to_string (bigint, radix);
+  ecma_free_value (bigint);
+
+  if (string_p == NULL)
+  {
+    return ECMA_VALUE_ERROR;
+  }
+
+  return ecma_make_string_value (string_p);
+} /* ecma_builtin_bigint_prototype_object_to_string */
+
+/**
+ * @}
+ * @}
+ * @}
+ */
+
+#endif /* ENABLED (JERRY_BUILTIN_BIGINT) */
@@ -0,0 +1,44 @@
+/* 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.
+ */
+
+/*
+ * BigInt.prototype built-in description
+ */
+
+#include "ecma-builtin-helpers-macro-defines.inc.h"
+
+#if ENABLED (JERRY_BUILTIN_BIGINT)
+
+/* Object properties:
+ *  (property name, object pointer getter) */
+
+/* ECMA-262 v11, 20.2.3.1 */
+OBJECT_VALUE (LIT_MAGIC_STRING_CONSTRUCTOR,
+              ECMA_BUILTIN_ID_BIGINT,
+              ECMA_PROPERTY_CONFIGURABLE_WRITABLE)
+
+/* ECMA-262 v11, 20.2.3.5 */
+STRING_VALUE (LIT_GLOBAL_SYMBOL_TO_STRING_TAG,
+              LIT_MAGIC_STRING_BIGINT_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_VALUE_OF_UL, ecma_builtin_bigint_prototype_object_value_of, 0, 0)
+ROUTINE (LIT_MAGIC_STRING_TO_STRING_UL, ecma_builtin_bigint_prototype_object_to_string, NON_FIXED, 1)
+
+#endif /* ENABLED (JERRY_BUILTIN_BIGINT) */
+
+#include "ecma-builtin-helpers-macro-undefs.inc.h"
@@ -0,0 +1,93 @@
+/* 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-bigint.h"
+#include "ecma-builtins.h"
+#include "ecma-exceptions.h"
+
+#if ENABLED (JERRY_BUILTIN_BIGINT)
+
+#define ECMA_BUILTINS_INTERNAL
+#include "ecma-builtins-internal.h"
+
+#define BUILTIN_INC_HEADER_NAME "ecma-builtin-bigint.inc.h"
+#define BUILTIN_UNDERSCORED_ID bigint
+#include "ecma-builtin-internal-routines-template.inc.h"
+
+/** \addtogroup ecma ECMA
+ * @{
+ *
+ * \addtogroup ecmabuiltins
+ * @{
+ *
+ * \addtogroup bigint ECMA BigInt object built-in
+ * @{
+ */
+
+/**
+ * Handle calling [[Call]] of built-in BigInt object
+ *
+ * See also:
+ *          ECMA-262 v11, 20.2.1.1
+ *
+ * @return ecma value
+ */
+ecma_value_t
+ecma_builtin_bigint_dispatch_call (const ecma_value_t *arguments_list_p, /**< arguments list */
+                                   uint32_t arguments_list_len) /**< number of arguments */
+{
+  JERRY_ASSERT (arguments_list_len == 0 || arguments_list_p != NULL);
+
+  ecma_value_t value = (arguments_list_len == 0) ? ECMA_VALUE_UNDEFINED : arguments_list_p[0];
+
+  if (!ecma_is_value_string (value))
+  {
+    return ecma_raise_type_error (ECMA_ERR_MSG ("TODO: Only strings are supported now"));
+  }
+
+  ecma_string_t *string_p = ecma_get_string_from_value (value);
+
+  ECMA_STRING_TO_UTF8_STRING (string_p, string_buffer_p, string_buffer_size);
+
+  ecma_value_t result = ecma_bigint_parse_string (string_buffer_p, string_buffer_size);
+
+  ECMA_FINALIZE_UTF8_STRING (string_buffer_p, string_buffer_size);
+  return result;
+} /* ecma_builtin_bigint_dispatch_call */
+
+/**
+ * Handle calling [[Construct]] of built-in BigInt object
+ *
+ * See also:
+ *          ECMA-262 v11, 20.2.1
+ *
+ * @return ecma value
+ */
+ecma_value_t
+ecma_builtin_bigint_dispatch_construct (const ecma_value_t *arguments_list_p, /**< arguments list */
+                                        uint32_t arguments_list_len) /**< number of arguments */
+{
+  JERRY_ASSERT (arguments_list_len == 0 || arguments_list_p != NULL);
+
+  return ecma_raise_type_error (ECMA_ERR_MSG ("BigInt function is not a constructor."));
+} /* ecma_builtin_bigint_dispatch_construct */
+
+/**
+ * @}
+ * @}
+ * @}
+ */
+
+#endif /* ENABLED (JERRY_BUILTIN_BIGINT) */
@@ -0,0 +1,47 @@
+/* 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.
+ */
+
+/*
+ * BigInt built-in description
+ */
+
+#include "ecma-builtin-helpers-macro-defines.inc.h"
+
+#if ENABLED (JERRY_BUILTIN_BIGINT)
+
+/* Number properties:
+ *  (property name, number value, writable, enumerable, configurable) */
+
+/* ECMA-262 v11, 20.2.1 */
+NUMBER_VALUE (LIT_MAGIC_STRING_LENGTH,
+              1,
+              ECMA_PROPERTY_FLAG_CONFIGURABLE)
+
+/* ECMA-262 v11, 20.2.1 */
+STRING_VALUE (LIT_MAGIC_STRING_NAME,
+              LIT_MAGIC_STRING_BIGINT_UL,
+              ECMA_PROPERTY_FLAG_CONFIGURABLE)
+
+/* Object properties:
+ *  (property name, object pointer getter) */
+
+/* ECMA-262 v11, 20.2.2.3 */
+OBJECT_VALUE (LIT_MAGIC_STRING_PROTOTYPE,
+              ECMA_BUILTIN_ID_BIGINT_PROTOTYPE,
+              ECMA_PROPERTY_FIXED)
+
+#endif /* ENABLED (JERRY_BUILTIN_BIGINT) */
+
+#include "ecma-builtin-helpers-macro-undefs.inc.h"
@@ -253,6 +253,13 @@ OBJECT_VALUE (LIT_MAGIC_STRING_PROXY_UL,
              ECMA_PROPERTY_CONFIGURABLE_WRITABLE)
 #endif /* ENABLED (JERRY_BUILTIN_PROXY) */

+#if ENABLED (JERRY_BUILTIN_BIGINT)
+/* ECMA-262 v11, 20.2.1 */
+OBJECT_VALUE (LIT_MAGIC_STRING_BIGINT_UL,
+              ECMA_BUILTIN_ID_BIGINT,
+              ECMA_PROPERTY_CONFIGURABLE_WRITABLE)
+#endif /* ENABLED (JERRY_BUILTIN_BIGINT) */
+
 /* Routine properties:
 *  (property name, C routine name, arguments number or NON_FIXED, value of the routine's length property) */

@@ -677,6 +677,23 @@ BUILTIN (ECMA_BUILTIN_ID_MAP_ITERATOR_PROTOTYPE,
         true,
         map_iterator_prototype)
 #endif /* ENABLED (JERRY_BUILTIN_SET) */
+
+#if ENABLED (JERRY_BUILTIN_BIGINT)
+/* The %BigInt.prototype% object */
+BUILTIN (ECMA_BUILTIN_ID_BIGINT_PROTOTYPE,
+         ECMA_OBJECT_TYPE_GENERAL,
+         ECMA_BUILTIN_ID_OBJECT_PROTOTYPE,
+         true,
+         bigint_prototype)
+
+/* The %BigInt% object */
+BUILTIN_ROUTINE (ECMA_BUILTIN_ID_BIGINT,
+                 ECMA_OBJECT_TYPE_FUNCTION,
+                 ECMA_BUILTIN_ID_FUNCTION_PROTOTYPE,
+                 true,
+                 bigint)
+#endif /* ENABLED (JERRY_BUILTIN_BIGINT) */
+
 #endif /* ENABLED (JERRY_ESNEXT) */

 #if ENABLED (JERRY_BUILTIN_DATAVIEW)