RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-25 06:37:43 +00:00
Code Issues Activity Actions

LibJS: Add spec comments to ArrayConstructor

Browse source
This commit is contained in:
Linus Groh 2023-01-27 21:29:55 +00:00
parent eefb73add2
commit 7b139c6982
1 changed files with 205 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

258
Userland/Libraries/LibJS/Runtime/ArrayConstructor.cpp
View file

@ -43,6 +43,7 @@ void ArrayConstructor::initialize(Realm& realm)
// 23.1.1.1 Array ( ...values ), https://tc39.es/ecma262/#sec-array
ThrowCompletionOr<Value> ArrayConstructor::call()
{
// 1. If NewTarget is undefined, let newTarget be the active function object; else let newTarget be NewTarget.
return TRY(construct(*this));
}
@ -52,32 +53,77 @@ ThrowCompletionOr<NonnullGCPtr<Object>> ArrayConstructor::construct(FunctionObje
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));
if (vm.argument_count() == 0)
// 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;
} else {
}
// 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<RangeError>(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));
for (size_t k = 0; k < vm.argument_count(); ++k)
MUST(array->create_data_property_or_throw(k, vm.argument(k)));
// 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;
}
@ -85,113 +131,219 @@ ThrowCompletionOr<NonnullGCPtr<Object>> ArrayConstructor::construct(FunctionObje
JS_DEFINE_NATIVE_FUNCTION(ArrayConstructor::from)
{
auto& realm = *vm.current_realm();
auto constructor = vm.this_value();
FunctionObject* map_fn = nullptr;
if (!vm.argument(1).is_undefined()) {
auto callback = vm.argument(1);
if (!callback.is_function())
return vm.throw_completion<TypeError>(ErrorType::NotAFunction, callback.to_string_without_side_effects());
map_fn = &callback.as_function();
}
auto this_arg = vm.argument(2);
auto items = vm.argument(0);
auto using_iterator = TRY(items.get_method(vm, *vm.well_known_symbol_iterator()));
if (using_iterator) {
Object* array;
if (constructor.is_constructor())
array = TRY(JS::construct(vm, constructor.as_function(), {}));
else
array = MUST(Array::create(realm, 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.
GCPtr<FunctionObject> 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<TypeError>(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) {
GCPtr<Object> 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 ? GetIterator(items, sync, usingIterator).
auto iterator = TRY(get_iterator(vm, items, IteratorHint::Sync, using_iterator));
size_t k = 0;
while (true) {
// 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<TypeError>(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 ? IteratorStep(iteratorRecord).
auto* next = TRY(iterator_step(vm, iterator));
// iv. If next is false, then
if (!next) {
// 1. Perform ? Set(A, "length", 𝔽(k), true).
TRY(array->set(vm.names.length, Value(k), Object::ShouldThrowExceptions::Yes));
// 2. Return A.
return array;
}
// v. Let nextValue be ? IteratorValue(next).
auto next_value = TRY(iterator_value(vm, *next));
Value mapped_value;
if (map_fn) {
auto mapped_value_or_error = JS::call(vm, *map_fn, this_arg, next_value, Value(k));
// vi. 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_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();
} else {
}
// vii. Else, let mappedValue be nextValue.
else {
mapped_value = next_value;
}
auto result_or_error = array->create_data_property_or_throw(k, mapped_value);
// viii. Let defineStatus be Completion(CreateDataPropertyOrThrow(A, Pk, mappedValue)).
auto result_or_error = array->create_data_property_or_throw(property_key, mapped_value);
// IfAbruptCloseIterator(defineStatus, iteratorRecord).
if (result_or_error.is_error())
return TRY(iterator_close(vm, iterator, result_or_error.release_error()));
++k;
// x. 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));
Object* array;
if (constructor.is_constructor())
array = TRY(JS::construct(vm, constructor.as_function(), Value(length)));
else
array = TRY(Array::create(realm, length));
GCPtr<Object> array;
for (size_t k = 0; k < length; ++k) {
auto k_value = TRY(array_like->get(k));
Value mapped_value;
if (map_fn)
mapped_value = TRY(JS::call(vm, *map_fn, this_arg, k_value, Value(k)));
else
mapped_value = k_value;
TRY(array->create_data_property_or_throw(k, mapped_value));
// 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;
}
// 23.1.2.2 Array.isArray ( arg ), https://tc39.es/ecma262/#sec-array.isarray
JS_DEFINE_NATIVE_FUNCTION(ArrayConstructor::is_array)
{
auto value = vm.argument(0);
return Value(TRY(value.is_array(vm)));
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();
auto this_value = vm.this_value();
Object* array;
if (this_value.is_constructor())
array = TRY(JS::construct(vm, this_value.as_function(), Value(vm.argument_count())));
else
array = TRY(Array::create(realm, vm.argument_count()));
for (size_t k = 0; k < vm.argument_count(); ++k)
TRY(array->create_data_property_or_throw(k, vm.argument(k)));
TRY(array->set(vm.names.length, Value(vm.argument_count()), Object::ShouldThrowExceptions::Yes));
// 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();
GCPtr<Object> 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();
}