mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2025-04-25 14:05:15 +00:00
88 lines
3 KiB
C++
88 lines
3 KiB
C++
/*
|
|
* Copyright (c) 2020, Matthew Olsson <mattco@serenityos.org>
|
|
* Copyright (c) 2022-2023, Linus Groh <linusg@serenityos.org>
|
|
* Copyright (c) 2023-2024, Tim Flynn <trflynn89@ladybird.org>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/Function.h>
|
|
#include <AK/Optional.h>
|
|
#include <LibJS/Runtime/Completion.h>
|
|
#include <LibJS/Runtime/Object.h>
|
|
#include <LibJS/Runtime/Value.h>
|
|
|
|
namespace JS {
|
|
|
|
// 7.4.1 Iterator Records, https://tc39.es/ecma262/#sec-iterator-records
|
|
class IteratorRecord final : public Cell {
|
|
GC_CELL(IteratorRecord, Cell);
|
|
GC_DECLARE_ALLOCATOR(IteratorRecord);
|
|
|
|
public:
|
|
IteratorRecord(GC::Ptr<Object> iterator, Value next_method, bool done)
|
|
: done(done)
|
|
, iterator(iterator)
|
|
, next_method(next_method)
|
|
{
|
|
}
|
|
|
|
bool done { false }; // [[Done]]
|
|
GC::Ptr<Object> iterator; // [[Iterator]]
|
|
Value next_method; // [[NextMethod]]
|
|
|
|
private:
|
|
virtual void visit_edges(Cell::Visitor&) override;
|
|
};
|
|
|
|
static_assert(sizeof(IteratorRecord) == 32);
|
|
|
|
class Iterator : public Object {
|
|
JS_OBJECT(Iterator, Object);
|
|
GC_DECLARE_ALLOCATOR(Iterator);
|
|
|
|
public:
|
|
static GC::Ref<Iterator> create(Realm&, Object& prototype, GC::Ref<IteratorRecord> iterated);
|
|
|
|
IteratorRecord const& iterated() const { return m_iterated; }
|
|
|
|
private:
|
|
Iterator(Object& prototype, GC::Ref<IteratorRecord> iterated);
|
|
explicit Iterator(Object& prototype);
|
|
|
|
virtual void visit_edges(Cell::Visitor&) override;
|
|
|
|
GC::Ref<IteratorRecord> m_iterated; // [[Iterated]]
|
|
};
|
|
|
|
enum class IteratorHint {
|
|
Sync,
|
|
Async,
|
|
};
|
|
|
|
enum class PrimitiveHandling {
|
|
IterateStringPrimitives,
|
|
RejectPrimitives,
|
|
};
|
|
|
|
ThrowCompletionOr<GC::Ref<IteratorRecord>> get_iterator_direct(VM&, Object&);
|
|
ThrowCompletionOr<GC::Ref<IteratorRecord>> get_iterator_from_method(VM&, Value, GC::Ref<FunctionObject>);
|
|
ThrowCompletionOr<GC::Ref<IteratorRecord>> get_iterator(VM&, Value, IteratorHint);
|
|
ThrowCompletionOr<GC::Ref<IteratorRecord>> get_iterator_flattenable(VM&, Value, PrimitiveHandling);
|
|
ThrowCompletionOr<GC::Ref<Object>> iterator_next(VM&, IteratorRecord&, Optional<Value> = {});
|
|
ThrowCompletionOr<bool> iterator_complete(VM&, Object& iterator_result);
|
|
ThrowCompletionOr<Value> iterator_value(VM&, Object& iterator_result);
|
|
ThrowCompletionOr<GC::Ptr<Object>> iterator_step(VM&, IteratorRecord&);
|
|
ThrowCompletionOr<Optional<Value>> iterator_step_value(VM&, IteratorRecord&);
|
|
Completion iterator_close(VM&, IteratorRecord const&, Completion);
|
|
Completion async_iterator_close(VM&, IteratorRecord const&, Completion);
|
|
GC::Ref<Object> create_iterator_result_object(VM&, Value, bool done);
|
|
ThrowCompletionOr<GC::RootVector<Value>> iterator_to_list(VM&, IteratorRecord&);
|
|
ThrowCompletionOr<void> setter_that_ignores_prototype_properties(VM&, Value this_, Object const& home, PropertyKey const& property, Value value);
|
|
|
|
using IteratorValueCallback = Function<Optional<Completion>(Value)>;
|
|
Completion get_iterator_values(VM&, Value iterable, IteratorValueCallback callback);
|
|
|
|
}
|