Skip to content

feat(ecmascript): Implement Iterator functions that don't need a helper #591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aapoalas merged 8 commits into from
Mar 16, 2025
Merged

feat(ecmascript): Implement Iterator functions that don't need a helper #591

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7a4e403
refactor(ecmascript): use macro for global bindings
r58Playz Mar 10, 2025
47fb7c8
feat(ecmascript): implement Iterator constructor
r58Playz Mar 10, 2025
9865a5b
feat(ecmascript): implement Iterator.prototype methods that do not ne…
r58Playz Mar 11, 2025
a4d64f9
chore(ecmascript): cargo fmt
r58Playz Mar 13, 2025
7c6d33a
fix based on review
r58Playz Mar 16, 2025
01eeadb
chore(test262): update expectations
r58Playz Mar 16, 2025
a0095c1
fix: Add NoGcScope parameter to scope_static and use Scoped::replace …
aapoalas Mar 16, 2025
76699f1
nit: error message
aapoalas Mar 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions ..._vm/src/ecmascript/builtins/control_abstraction_objects/iteration/iterator_constructor.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,19 @@ impl IteratorConstructor {
gc.nogc(),
));
};
if new_target
== agent
.running_execution_context()
.function
.unwrap()
.into_object()
{
return Err(agent.throw_exception_with_static_message(
ExceptionType::TypeError,
"Iterator is abstract",
Comment thread
aapoalas marked this conversation as resolved.
Outdated
gc.into_nogc(),
));
}

// 2. Return ? OrdinaryCreateFromConstructor(NewTarget, "%Iterator.prototype%").
ordinary_create_from_constructor(
Expand Down
127 changes: 64 additions & 63 deletions nova_vm/src/ecmascript/builtins/control_abstraction_objects/iteration/iterator_prototype.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@

use crate::ecmascript::abstract_operations::operations_on_iterator_objects::{
IteratorRecord, get_iterator_direct, if_abrupt_close_iterator, iterator_close,
iterator_step_value,
iterator_close_with_error, iterator_step_value,
};
use crate::ecmascript::abstract_operations::operations_on_objects::{call, throw_not_callable};
use crate::ecmascript::abstract_operations::testing_and_comparison::is_callable;
use crate::ecmascript::abstract_operations::type_conversion::to_boolean;
use crate::ecmascript::builtins::Array;
use crate::ecmascript::execution::agent::ExceptionType;
use crate::ecmascript::types::{IntoValue, Object};
use crate::engine::Scoped;
use crate::engine::context::{Bindable, GcScope};
use crate::engine::rootable::Scopable;
use crate::{
Expand Down Expand Up @@ -128,7 +129,6 @@ impl IteratorPrototype {
};
let scoped_predicate = Value::from(predicate).scope(agent, nogc);

let scoped_o = o.scope(agent, nogc);
// 5. Set iterated to ? GetIteratorDirect(O).
let iterated = get_iterator_direct(agent, o.unbind(), gc.reborrow())
.unbind()
Expand All @@ -150,11 +150,11 @@ impl IteratorPrototype {
// 7. Repeat,
loop {
// a. Let value be ? IteratorStepValue(iterated).
let record = IteratorRecord {
let iterated = IteratorRecord {
iterator: iterator.get(agent),
next_method: next_method.get(agent),
};
let value = iterator_step_value(agent, record, gc.reborrow())
let value = iterator_step_value(agent, iterated, gc.reborrow())
.unbind()
.bind(gc.nogc())?;

Expand All @@ -175,15 +175,15 @@ impl IteratorPrototype {
.bind(gc.nogc());

// d. IfAbruptCloseIterator(result, iterated).
let record = IteratorRecord {
let iterated = IteratorRecord {
iterator: iterator.get(agent),
next_method: next_method.get(agent),
};
let result = if_abrupt_close_iterator!(agent, result, record, gc);
let result = if_abrupt_close_iterator!(agent, result, iterated, gc);

// e. If ToBoolean(result) is false, return ? IteratorClose(iterated, NormalCompletion(false)).
if !to_boolean(agent, result) {
return iterator_close(agent, scoped_o.get(agent), Ok(Value::from(false)), gc);
return iterator_close(agent, iterator.get(agent), Ok(Value::from(false)), gc);
}

// f. Set counter to counter + 1.
Expand Down Expand Up @@ -222,11 +222,10 @@ impl IteratorPrototype {
nogc,
);
// b. Return ? IteratorClose(iterated, error).
return iterator_close(agent, o.unbind(), Err(error), gc);
return Err(iterator_close_with_error(agent, o.unbind(), error, gc));
};
let scoped_predicate = Value::from(predicate).scope(agent, nogc);

let scoped_o = o.scope(agent, nogc);
// 5. Set iterated to ? GetIteratorDirect(O).
let iterated = get_iterator_direct(agent, o.unbind(), gc.reborrow())
.unbind()
Expand All @@ -248,11 +247,11 @@ impl IteratorPrototype {
// 7. Repeat,
loop {
// a. Let value be ? IteratorStepValue(iterated).
let record = IteratorRecord {
let iterated = IteratorRecord {
iterator: iterator.get(agent),
next_method: next_method.get(agent),
};
let value = iterator_step_value(agent, record, gc.reborrow())
let value = iterator_step_value(agent, iterated, gc.reborrow())
.unbind()
.bind(gc.nogc())?;

Expand All @@ -274,15 +273,15 @@ impl IteratorPrototype {
.bind(gc.nogc());

// d. IfAbruptCloseIterator(result, iterated).
let record = IteratorRecord {
let iterated = IteratorRecord {
iterator: iterator.get(agent),
next_method: next_method.get(agent),
};
let result = if_abrupt_close_iterator!(agent, result, record, gc);
let result = if_abrupt_close_iterator!(agent, result, iterated, gc);

// e. If ToBoolean(result) is true, return ? IteratorClose(iterated, NormalCompletion(value)).
if to_boolean(agent, result) {
return iterator_close(agent, scoped_o.get(agent), Ok(scoped_value.get(agent)), gc);
return iterator_close(agent, iterator.get(agent), Ok(scoped_value.get(agent)), gc);
}

// f. Set counter to counter + 1.
Expand Down Expand Up @@ -346,11 +345,11 @@ impl IteratorPrototype {
// 7. Repeat,
loop {
// a. Let value be ? IteratorStepValue(iterated).
let record = IteratorRecord {
let iterated = IteratorRecord {
iterator: iterator.get(agent),
next_method: next_method.get(agent),
};
let value = iterator_step_value(agent, record, gc.reborrow())
let value = iterator_step_value(agent, iterated, gc.reborrow())
.unbind()
.bind(gc.nogc())?;
// b. If value is done, return undefined.
Expand All @@ -370,11 +369,11 @@ impl IteratorPrototype {
.bind(gc.nogc());

// d. IfAbruptCloseIterator(result, iterated).
let record = IteratorRecord {
let iterated = IteratorRecord {
iterator: iterator.get(agent),
next_method: next_method.get(agent),
};
if_abrupt_close_iterator!(agent, result, record, gc);
if_abrupt_close_iterator!(agent, result, iterated, gc);

// e. Set counter to counter + 1.
counter += 1;
Expand All @@ -391,6 +390,7 @@ impl IteratorPrototype {
let nogc = gc.nogc();
let this_value = this_value.bind(nogc);
let reducer = arguments.get(0).bind(nogc);
let has_initial_value = arguments.len() > 1;
let initial_value = arguments.get(1).bind(nogc);
let scoped_initial_value = initial_value.scope(agent, nogc);

Expand Down Expand Up @@ -433,47 +433,43 @@ impl IteratorPrototype {
let iterator = iterator.scope(agent, gc.nogc());
let next_method = next_method.scope(agent, gc.nogc());

let (accumulator, mut counter) = match scoped_initial_value.get(agent).bind(gc.nogc()) {
let (mut accumulator, mut counter) = if !has_initial_value {
// 6. If initialValue is not present, then
Value::Null | Value::Undefined => {
// a. Let accumulator be ? IteratorStepValue(iterated).
let record = IteratorRecord {
iterator: iterator.get(agent),
next_method: next_method.get(agent),
};
let accumulator = iterator_step_value(agent, record, gc.reborrow())
.unbind()
.bind(gc.nogc())?;

// b. If accumulator is done, throw a TypeError exception.
let Some(accumulator) = accumulator else {
return Err(agent.throw_exception_with_static_message(
ExceptionType::TypeError,
"'this' was done",
gc.into_nogc(),
));
};

// c. Let counter be 1.
(accumulator, 1)
}
initial_value => {
// 7. Else,
// a. Let accumulator be initialValue.
// b. Let counter be 0.
(initial_value, 0)
}
// a. Let accumulator be ? IteratorStepValue(iterated).
let iterated = IteratorRecord {
iterator: iterator.get(agent),
next_method: next_method.get(agent),
};
let accumulator = iterator_step_value(agent, iterated, gc.reborrow())
.unbind()
.bind(gc.nogc())?;

// b. If accumulator is done, throw a TypeError exception.
let Some(accumulator) = accumulator else {
return Err(agent.throw_exception_with_static_message(
ExceptionType::TypeError,
"'this' was done",
gc.into_nogc(),
));
};

// c. Let counter be 1.
(accumulator.scope(agent, gc.nogc()), 1)
} else {
// 7. Else,
// a. Let accumulator be initialValue.
// b. Let counter be 0.
(scoped_initial_value, 0)
};
let mut accumulator = accumulator.scope(agent, gc.nogc());

// 8. Repeat,
loop {
// a. Let value be ? IteratorStepValue(iterated).
let record = IteratorRecord {
let iterated = IteratorRecord {
iterator: iterator.get(agent),
next_method: next_method.get(agent),
};
let value = iterator_step_value(agent, record, gc.reborrow())
let value = iterator_step_value(agent, iterated, gc.reborrow())
.unbind()
.bind(gc.nogc())?;

Expand All @@ -498,11 +494,11 @@ impl IteratorPrototype {
.bind(gc.nogc());

// d. IfAbruptCloseIterator(result, iterated).
let record = IteratorRecord {
let iterated = IteratorRecord {
iterator: iterator.get(agent),
next_method: next_method.get(agent),
};
let result = if_abrupt_close_iterator!(agent, result, record, gc);
let result = if_abrupt_close_iterator!(agent, result, iterated, gc);

// e. Set accumulator to result.
accumulator = result.scope(agent, gc.nogc());
Comment thread
aapoalas marked this conversation as resolved.
Outdated
Expand Down Expand Up @@ -547,7 +543,6 @@ impl IteratorPrototype {
};
let scoped_predicate = Value::from(predicate).scope(agent, nogc);

let scoped_o = o.scope(agent, nogc);
// 5. Set iterated to ? GetIteratorDirect(O).
let iterated = get_iterator_direct(agent, o.unbind(), gc.reborrow())
.unbind()
Expand All @@ -569,11 +564,11 @@ impl IteratorPrototype {
// 7. Repeat,
loop {
// a. Let value be ? IteratorStepValue(iterated).
let record = IteratorRecord {
let iterated = IteratorRecord {
iterator: iterator.get(agent),
next_method: next_method.get(agent),
};
let value = iterator_step_value(agent, record, gc.reborrow())
let value = iterator_step_value(agent, iterated, gc.reborrow())
.unbind()
.bind(gc.nogc())?;

Expand All @@ -594,15 +589,15 @@ impl IteratorPrototype {
.bind(gc.nogc());

// d. IfAbruptCloseIterator(result, iterated).
let record = IteratorRecord {
let iterated = IteratorRecord {
iterator: iterator.get(agent),
next_method: next_method.get(agent),
};
let result = if_abrupt_close_iterator!(agent, result, record, gc);
let result = if_abrupt_close_iterator!(agent, result, iterated, gc);

// e. If ToBoolean(result) is true, return ? IteratorClose(iterated, NormalCompletion(true)).
if to_boolean(agent, result) {
return iterator_close(agent, scoped_o.get(agent), Ok(Value::from(true)), gc);
return iterator_close(agent, iterator.get(agent), Ok(Value::from(true)), gc);
}

// f. Set counter to counter + 1.
Expand Down Expand Up @@ -646,27 +641,33 @@ impl IteratorPrototype {
let next_method = next_method.scope(agent, gc.nogc());

// 4. Let items be a new empty List.
let mut items: Vec<Value> = Vec::new();
let mut items: Vec<Scoped<Value>> = Vec::new();

// 5. Repeat,
loop {
// a. Let value be ? IteratorStepValue(iterated).
let record = IteratorRecord {
let iterated = IteratorRecord {
iterator: iterator.get(agent),
next_method: next_method.get(agent),
};
let value = iterator_step_value(agent, record, gc.reborrow())
let value = iterator_step_value(agent, iterated, gc.reborrow())
.unbind()
.bind(gc.nogc())?
.map(|x| x.scope(agent, gc.nogc()));

// b. If value is done, return CreateArrayFromList(items).
let Some(value) = value else {
return Ok(Array::from_slice(agent, &items, gc.into_nogc()).into_value());
let gc = gc.into_nogc();

// should reuse the allocation
let unscoped: Vec<Value> =
items.into_iter().map(|x| x.get(agent).bind(gc)).collect();

return Ok(Array::from_slice(agent, &unscoped, gc).into_value());
};

// c. Append value to items.
items.push(value.get(agent));
items.push(value);
}
}

Expand Down