/* * Copyright (c) 2020, Andreas Kling * Copyright (c) 2020-2023, Linus Groh * Copyright (c) 2023, Shannon Booth * * SPDX-License-Identifier: BSD-2-Clause */ #include #include #include #include #include #include #include #include #include #include #include #include #include namespace JS { GC_DEFINE_ALLOCATOR(ArrayConstructor); ArrayConstructor::ArrayConstructor(Realm& realm) : NativeFunction(realm.vm().names.Array.as_string(), realm.intrinsics().function_prototype()) { } void ArrayConstructor::initialize(Realm& realm) { auto& vm = this->vm(); Base::initialize(realm); // 23.1.2.4 Array.prototype, https://tc39.es/ecma262/#sec-array.prototype define_direct_property(vm.names.prototype, realm.intrinsics().array_prototype(), 0); u8 attr = Attribute::Writable | Attribute::Configurable; define_native_function(realm, vm.names.from, from, 1, attr); define_native_function(realm, vm.names.fromAsync, from_async, 1, attr); define_native_function(realm, vm.names.isArray, is_array, 1, attr); define_native_function(realm, vm.names.of, of, 0, attr); // 23.1.2.5 get Array [ @@species ], https://tc39.es/ecma262/#sec-get-array-@@species define_native_accessor(realm, vm.well_known_symbol_species(), symbol_species_getter, {}, Attribute::Configurable); define_direct_property(vm.names.length, Value(1), Attribute::Configurable); } // 23.1.1.1 Array ( ...values ), https://tc39.es/ecma262/#sec-array ThrowCompletionOr ArrayConstructor::call() { // 1. If NewTarget is undefined, let newTarget be the active function object; else let newTarget be NewTarget. return TRY(construct(*this)); } // 23.1.1.1 Array ( ...values ), https://tc39.es/ecma262/#sec-array ThrowCompletionOr> ArrayConstructor::construct(FunctionObject& new_target) { auto& vm = this->vm(); auto& realm = *vm.current_realm(); // 2. Let proto be ? GetPrototypeFromConstructor(newTarget, "%Array.prototype%"). auto* proto = TRY(get_prototype_from_constructor(vm, new_target, &Intrinsics::array_prototype)); // 3. Let numberOfArgs be the number of elements in values. // 4. If numberOfArgs = 0, then if (vm.argument_count() == 0) { // a. Return ! ArrayCreate(0, proto). return MUST(Array::create(realm, 0, proto)); } // 5. Else if numberOfArgs = 1, then if (vm.argument_count() == 1) { // a. Let len be values[0]. auto length = vm.argument(0); // b. Let array be ! ArrayCreate(0, proto). auto array = MUST(Array::create(realm, 0, proto)); size_t int_length; // c. If len is not a Number, then if (!length.is_number()) { // i. Perform ! CreateDataPropertyOrThrow(array, "0", len). MUST(array->create_data_property_or_throw(0, length)); // ii. Let intLen be 1𝔽. int_length = 1; } // d. Else, else { // i. Let intLen be ! ToUint32(len). int_length = MUST(length.to_u32(vm)); // ii. If SameValueZero(intLen, len) is false, throw a RangeError exception. if (int_length != length.as_double()) return vm.throw_completion(ErrorType::InvalidLength, "array"); } // e. Perform ! Set(array, "length", intLen, true). TRY(array->set(vm.names.length, Value(int_length), Object::ShouldThrowExceptions::Yes)); // f. Return array. return array; } // 6. Else, // a. Assert: numberOfArgs ≥ 2. VERIFY(vm.argument_count() >= 2); // b. Let array be ? ArrayCreate(numberOfArgs, proto). auto array = TRY(Array::create(realm, vm.argument_count(), proto)); // c. Let k be 0. // d. Repeat, while k < numberOfArgs, for (size_t k = 0; k < vm.argument_count(); ++k) { // i. Let Pk be ! ToString(𝔽(k)). auto property_key = PropertyKey { k }; // ii. Let itemK be values[k]. auto item_k = vm.argument(k); // iii. Perform ! CreateDataPropertyOrThrow(array, Pk, itemK). MUST(array->create_data_property_or_throw(property_key, item_k)); // iv. Set k to k + 1. } // e. Assert: The mathematical value of array's "length" property is numberOfArgs. // f. Return array. return array; } // 23.1.2.1 Array.from ( items [ , mapfn [ , thisArg ] ] ), https://tc39.es/ecma262/#sec-array.from JS_DEFINE_NATIVE_FUNCTION(ArrayConstructor::from) { auto& realm = *vm.current_realm(); auto items = vm.argument(0); auto mapfn_value = vm.argument(1); auto this_arg = vm.argument(2); // 1. Let C be the this value. auto constructor = vm.this_value(); // 2. If mapfn is undefined, let mapping be false. GC::Ptr mapfn; // 3. Else, if (!mapfn_value.is_undefined()) { // a. If IsCallable(mapfn) is false, throw a TypeError exception. if (!mapfn_value.is_function()) return vm.throw_completion(ErrorType::NotAFunction, mapfn_value.to_string_without_side_effects()); // b. Let mapping be true. mapfn = &mapfn_value.as_function(); } // 4. Let usingIterator be ? GetMethod(items, @@iterator). auto using_iterator = TRY(items.get_method(vm, vm.well_known_symbol_iterator())); // 5. If usingIterator is not undefined, then if (using_iterator) { GC::Ptr array; // a. If IsConstructor(C) is true, then if (constructor.is_constructor()) { // i. Let A be ? Construct(C). array = TRY(JS::construct(vm, constructor.as_function())); } // b. Else, else { // i. Let A be ! ArrayCreate(0). array = MUST(Array::create(realm, 0)); } // c. Let iteratorRecord be ? GetIteratorFromMethod(items, usingIterator). auto iterator = TRY(get_iterator_from_method(vm, items, *using_iterator)); // d. Let k be 0. // e. Repeat, for (size_t k = 0;; ++k) { // i. If k ≥ 2^53 - 1, then if (k >= MAX_ARRAY_LIKE_INDEX) { // 1. Let error be ThrowCompletion(a newly created TypeError object). auto error = vm.throw_completion(ErrorType::ArrayMaxSize); // 2. Return ? IteratorClose(iteratorRecord, error). return *TRY(iterator_close(vm, iterator, move(error))); } // ii. Let Pk be ! ToString(𝔽(k)). auto property_key = PropertyKey { k }; // iii. Let next be ? IteratorStepValue(iteratorRecord). auto next = TRY(iterator_step_value(vm, iterator)); // iv. If next is DONE, then if (!next.has_value()) { // 1. Perform ? Set(A, "length", 𝔽(k), true). TRY(array->set(vm.names.length, Value(k), Object::ShouldThrowExceptions::Yes)); // 2. Return A. return array; } Value mapped_value; // v. If mapping is true, then if (mapfn) { // 1. Let mappedValue be Completion(Call(mapfn, thisArg, « nextValue, 𝔽(k) »)). auto mapped_value_or_error = JS::call(vm, *mapfn, this_arg, next.release_value(), Value(k)); // 2. IfAbruptCloseIterator(mappedValue, iteratorRecord). if (mapped_value_or_error.is_error()) return *TRY(iterator_close(vm, iterator, mapped_value_or_error.release_error())); mapped_value = mapped_value_or_error.release_value(); } // vi. Else, let mappedValue be nextValue. else { mapped_value = next.release_value(); } // vii. Let defineStatus be Completion(CreateDataPropertyOrThrow(A, Pk, mappedValue)). auto result_or_error = array->create_data_property_or_throw(property_key, mapped_value); // viii. IfAbruptCloseIterator(defineStatus, iteratorRecord). if (result_or_error.is_error()) return *TRY(iterator_close(vm, iterator, result_or_error.release_error())); // ix. Set k to k + 1. } } // 6. NOTE: items is not an Iterable so assume it is an array-like object. // 7. Let arrayLike be ! ToObject(items). auto array_like = MUST(items.to_object(vm)); // 8. Let len be ? LengthOfArrayLike(arrayLike). auto length = TRY(length_of_array_like(vm, array_like)); GC::Ptr array; // 9. If IsConstructor(C) is true, then if (constructor.is_constructor()) { // a. Let A be ? Construct(C, « 𝔽(len) »). array = TRY(JS::construct(vm, constructor.as_function(), Value(length))); } else { // a. Let A be ? ArrayCreate(len). array = TRY(Array::create(realm, length)); } // 11. Let k be 0. // 12. Repeat, while k < len, for (size_t k = 0; k < length; ++k) { // a. Let Pk be ! ToString(𝔽(k)). auto property_key = PropertyKey { k }; // b. Let kValue be ? Get(arrayLike, Pk). auto k_value = TRY(array_like->get(property_key)); Value mapped_value; // c. If mapping is true, then if (mapfn) { // i. Let mappedValue be ? Call(mapfn, thisArg, « kValue, 𝔽(k) »). mapped_value = TRY(JS::call(vm, *mapfn, this_arg, k_value, Value(k))); } // d. Else, let mappedValue be kValue. else { mapped_value = k_value; } // e. Perform ? CreateDataPropertyOrThrow(A, Pk, mappedValue). TRY(array->create_data_property_or_throw(property_key, mapped_value)); // f. Set k to k + 1. } // 13. Perform ? Set(A, "length", 𝔽(len), true). TRY(array->set(vm.names.length, Value(length), Object::ShouldThrowExceptions::Yes)); // 14. Return A. return array; } // 2.1.1.1 Array.fromAsync ( asyncItems [ , mapfn [ , thisArg ] ] ), https://tc39.es/proposal-array-from-async/#sec-array.fromAsync JS_DEFINE_NATIVE_FUNCTION(ArrayConstructor::from_async) { auto& realm = *vm.current_realm(); auto async_items = vm.argument(0); auto mapfn = vm.argument(1); auto this_arg = vm.argument(2); // 1. Let C be the this value. auto constructor = vm.this_value(); // 2. Let promiseCapability be ! NewPromiseCapability(%Promise%). auto promise_capability = MUST(new_promise_capability(vm, realm.intrinsics().promise_constructor())); // 3. Let fromAsyncClosure be a new Abstract Closure with no parameters that captures C, mapfn, and thisArg and performs the following steps when called: auto from_async_closure = GC::create_function(realm.heap(), [constructor, mapfn, this_arg, &vm, &realm, async_items]() mutable -> Completion { bool mapping; // a. If mapfn is undefined, let mapping be false. if (mapfn.is_undefined()) { mapping = false; } // b. Else, else { // i. If IsCallable(mapfn) is false, throw a TypeError exception. if (!mapfn.is_function()) return vm.throw_completion(ErrorType::NotAFunction, mapfn.to_string_without_side_effects()); // ii. Let mapping be true. mapping = true; } // c. Let usingAsyncIterator be ? GetMethod(asyncItems, @@asyncIterator). auto using_async_iterator = TRY(async_items.get_method(vm, vm.well_known_symbol_async_iterator())); GC::Ptr using_sync_iterator; // d. If usingAsyncIterator is undefined, then if (!using_async_iterator) { // i. Let usingSyncIterator be ? GetMethod(asyncItems, @@iterator). using_sync_iterator = TRY(async_items.get_method(vm, vm.well_known_symbol_iterator())); } // e. Let iteratorRecord be undefined. GC::Ptr iterator_record; // f. If usingAsyncIterator is not undefined, then if (using_async_iterator) { // i. Set iteratorRecord to ? GetIterator(asyncItems, async, usingAsyncIterator). // FIXME: The Array.from proposal is out of date - it should be using GetIteratorFromMethod. iterator_record = TRY(get_iterator_from_method(vm, async_items, *using_async_iterator)); } // g. Else if usingSyncIterator is not undefined, then else if (using_sync_iterator) { // i. Set iteratorRecord to ? CreateAsyncFromSyncIterator(GetIterator(asyncItems, sync, usingSyncIterator)). // FIXME: The Array.from proposal is out of date - it should be using GetIteratorFromMethod. iterator_record = create_async_from_sync_iterator(vm, TRY(get_iterator_from_method(vm, async_items, *using_sync_iterator))); } // h. If iteratorRecord is not undefined, then if (iterator_record) { GC::Ptr array; // i. If IsConstructor(C) is true, then if (constructor.is_constructor()) { // 1. Let A be ? Construct(C). array = TRY(JS::construct(vm, constructor.as_function())); } // ii. Else, else { // i. Let A be ! ArrayCreate(0). array = MUST(Array::create(realm, 0)); } // iii. Let k be 0. // iv. Repeat, for (size_t k = 0;; ++k) { // 1. If k ≥ 2^53 - 1, then if (k >= MAX_ARRAY_LIKE_INDEX) { // a. Let error be ThrowCompletion(a newly created TypeError object). auto error = vm.throw_completion(ErrorType::ArrayMaxSize); // b. Return ? AsyncIteratorClose(iteratorRecord, error). return *TRY(async_iterator_close(vm, *iterator_record, move(error))); } // 2. Let Pk be ! ToString(𝔽(k)). auto property_key = PropertyKey { k }; // FIXME: There seems to be a bug here where we are not respecting array mutation. After resolving the first entry, the // iterator should also take into account any other changes which are made to async_items (which does not seem to // be happening). // 3. Let nextResult be ? Call(iteratorRecord.[[NextMethod]], iteratorRecord.[[Iterator]]). auto next_result = TRY(JS::call(vm, iterator_record->next_method, iterator_record->iterator)); // 4. Set nextResult to ? Await(nextResult). next_result = TRY(await(vm, next_result)); // 5. If nextResult is not an Object, throw a TypeError exception. if (!next_result.is_object()) return vm.throw_completion(ErrorType::IterableNextBadReturn); // 6. Let done be ? IteratorComplete(nextResult). auto done = TRY(JS::iterator_complete(vm, next_result.as_object())); // 7. If done is true, if (done) { // a. Perform ? Set(A, "length", 𝔽(k), true). TRY(array->set(vm.names.length, Value(k), Object::ShouldThrowExceptions::Yes)); // b. Return Completion Record { [[Type]]: return, [[Value]]: A, [[Target]]: empty }. return Completion { Completion::Type::Return, array }; } // 8. Let nextValue be ? IteratorValue(nextResult). auto next_value = TRY(iterator_value(vm, next_result.as_object())); Value mapped_value; // 9. If mapping is true, then if (mapping) { // a. Let mappedValue be Call(mapfn, thisArg, « nextValue, 𝔽(k) »). auto mapped_value_or_error = JS::call(vm, mapfn, this_arg, next_value, Value(k)); // b. IfAbruptCloseAsyncIterator(mappedValue, iteratorRecord). if (mapped_value_or_error.is_error()) { TRY(async_iterator_close(vm, *iterator_record, mapped_value_or_error)); return mapped_value_or_error; } // c. Set mappedValue to Await(mappedValue). mapped_value_or_error = await(vm, mapped_value_or_error.value()); // d. IfAbruptCloseAsyncIterator(mappedValue, iteratorRecord). if (mapped_value_or_error.is_error()) { TRY(async_iterator_close(vm, *iterator_record, mapped_value_or_error)); return mapped_value_or_error; } mapped_value = mapped_value_or_error.value(); } // 10. Else, let mappedValue be nextValue. else { mapped_value = next_value; } // 11. Let defineStatus be CreateDataPropertyOrThrow(A, Pk, mappedValue). auto define_status = array->create_data_property_or_throw(property_key, mapped_value); // 12. If defineStatus is an abrupt completion, return ? AsyncIteratorClose(iteratorRecord, defineStatus). if (define_status.is_error()) return *TRY(iterator_close(vm, *iterator_record, define_status.release_error())); // 13. Set k to k + 1. } } // k. Else, else { // i. NOTE: asyncItems is neither an AsyncIterable nor an Iterable so assume it is an array-like object. // ii. Let arrayLike be ! ToObject(asyncItems). auto array_like = MUST(async_items.to_object(vm)); // iii. Let len be ? LengthOfArrayLike(arrayLike). auto length = TRY(length_of_array_like(vm, array_like)); GC::Ptr array; // iv. If IsConstructor(C) is true, then if (constructor.is_constructor()) { // 1. Let A be ? Construct(C, « 𝔽(len) »). array = TRY(JS::construct(vm, constructor.as_function(), Value(length))); } // v. Else, else { // 1. Let A be ? ArrayCreate(len). array = TRY(Array::create(realm, length)); } // vi. Let k be 0. // vii. Repeat, while k < len, for (size_t k = 0; k < length; ++k) { // 1. Let Pk be ! ToString(𝔽(k)). auto property_key = PropertyKey { k }; // 2. Let kValue be ? Get(arrayLike, Pk). auto k_value = TRY(array_like->get(property_key)); // 3. Set kValue to ? Await(kValue). k_value = TRY(await(vm, k_value)); Value mapped_value; // 4. If mapping is true, then if (mapping) { // a. Let mappedValue be ? Call(mapfn, thisArg, « kValue, 𝔽(k) »). mapped_value = TRY(JS::call(vm, mapfn, this_arg, k_value, Value(k))); // b. Set mappedValue to ? Await(mappedValue). mapped_value = TRY(await(vm, mapped_value)); } // 5. Else, let mappedValue be kValue. else { mapped_value = k_value; } // 6. Perform ? CreateDataPropertyOrThrow(A, Pk, mappedValue). TRY(array->create_data_property_or_throw(property_key, mapped_value)); // 7. Set k to k + 1. } // viii. Perform ? Set(A, "length", 𝔽(len), true). TRY(array->set(vm.names.length, Value(length), Object::ShouldThrowExceptions::Yes)); // ix. Return Completion Record { [[Type]]: return, [[Value]]: A, [[Target]]: empty }. return Completion { Completion::Type::Return, array }; } }); // 4. Perform AsyncFunctionStart(promiseCapability, fromAsyncClosure). async_function_start(vm, promise_capability, *from_async_closure); // 5. Return promiseCapability.[[Promise]]. return promise_capability->promise(); } // 23.1.2.2 Array.isArray ( arg ), https://tc39.es/ecma262/#sec-array.isarray JS_DEFINE_NATIVE_FUNCTION(ArrayConstructor::is_array) { auto arg = vm.argument(0); // 1. Return ? IsArray(arg). return Value(TRY(arg.is_array(vm))); } // 23.1.2.3 Array.of ( ...items ), https://tc39.es/ecma262/#sec-array.of JS_DEFINE_NATIVE_FUNCTION(ArrayConstructor::of) { auto& realm = *vm.current_realm(); // 1. Let len be the number of elements in items. auto len = vm.argument_count(); // 2. Let lenNumber be 𝔽(len). auto len_number = Value(len); // 3. Let C be the this value. auto constructor = vm.this_value(); GC::Ptr array; // 4. If IsConstructor(C) is true, then if (constructor.is_constructor()) { // a. Let A be ? Construct(C, « lenNumber »). array = TRY(JS::construct(vm, constructor.as_function(), Value(vm.argument_count()))); } else { // a. Let A be ? ArrayCreate(len). array = TRY(Array::create(realm, len)); } // 6. Let k be 0. // 7. Repeat, while k < len, for (size_t k = 0; k < len; ++k) { // a. Let kValue be items[k]. auto k_value = vm.argument(k); // b. Let Pk be ! ToString(𝔽(k)). auto property_key = PropertyKey { k }; // c. Perform ? CreateDataPropertyOrThrow(A, Pk, kValue). TRY(array->create_data_property_or_throw(property_key, k_value)); // d. Set k to k + 1. } // 8. Perform ? Set(A, "length", lenNumber, true). TRY(array->set(vm.names.length, len_number, Object::ShouldThrowExceptions::Yes)); // 9. Return A. return array; } // 23.1.2.5 get Array [ @@species ], https://tc39.es/ecma262/#sec-get-array-@@species JS_DEFINE_NATIVE_FUNCTION(ArrayConstructor::symbol_species_getter) { // 1. Return the this value. return vm.this_value(); } }