9d7215c636
Rather than splitting the Iterator type and its AOs into two files, let's combine them into one file to match every other JS runtime object that we have.
67 lines
2.3 KiB
C++
67 lines
2.3 KiB
C++
/*
|
|
* Copyright (c) 2020, Matthew Olsson <mattco@serenityos.org>
|
|
* Copyright (c) 2022-2023, Linus Groh <linusg@serenityos.org>
|
|
* Copyright (c) 2023, Tim Flynn <trflynn89@serenityos.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
|
|
struct IteratorRecord {
|
|
GCPtr<Object> iterator; // [[Iterator]]
|
|
Value next_method; // [[NextMethod]]
|
|
bool done { false }; // [[Done]]
|
|
};
|
|
|
|
class Iterator : public Object {
|
|
JS_OBJECT(Iterator, Object);
|
|
|
|
public:
|
|
static ThrowCompletionOr<NonnullGCPtr<Iterator>> create(Realm&, Object& prototype, IteratorRecord iterated);
|
|
|
|
IteratorRecord const& iterated() const { return m_iterated; }
|
|
|
|
private:
|
|
Iterator(Object& prototype, IteratorRecord iterated);
|
|
explicit Iterator(Object& prototype);
|
|
|
|
IteratorRecord m_iterated; // [[Iterated]]
|
|
};
|
|
|
|
enum class IteratorHint {
|
|
Sync,
|
|
Async,
|
|
};
|
|
|
|
enum class StringHandling {
|
|
IterateStrings,
|
|
RejectStrings,
|
|
};
|
|
|
|
ThrowCompletionOr<IteratorRecord> get_iterator_from_method(VM&, Value, NonnullGCPtr<FunctionObject>);
|
|
ThrowCompletionOr<IteratorRecord> get_iterator(VM&, Value, IteratorHint);
|
|
ThrowCompletionOr<IteratorRecord> get_iterator_direct(VM&, Object&);
|
|
ThrowCompletionOr<IteratorRecord> get_iterator_flattenable(VM&, Value, StringHandling);
|
|
ThrowCompletionOr<NonnullGCPtr<Object>> iterator_next(VM&, IteratorRecord const&, Optional<Value> = {});
|
|
ThrowCompletionOr<GCPtr<Object>> iterator_step(VM&, IteratorRecord const&);
|
|
ThrowCompletionOr<bool> iterator_complete(VM&, Object& iterator_result);
|
|
ThrowCompletionOr<Value> iterator_value(VM&, Object& iterator_result);
|
|
Completion iterator_close(VM&, IteratorRecord const&, Completion);
|
|
Completion async_iterator_close(VM&, IteratorRecord const&, Completion);
|
|
NonnullGCPtr<Object> create_iterator_result_object(VM&, Value, bool done);
|
|
ThrowCompletionOr<MarkedVector<Value>> iterator_to_list(VM&, IteratorRecord const&);
|
|
|
|
using IteratorValueCallback = Function<Optional<Completion>(Value)>;
|
|
Completion get_iterator_values(VM&, Value iterable, IteratorValueCallback callback);
|
|
|
|
}
|