IteratorOperations.h 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. /*
  2. * Copyright (c) 2020, Matthew Olsson <mattco@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #pragma once
  7. #include <AK/Function.h>
  8. #include <LibJS/Runtime/Completion.h>
  9. #include <LibJS/Runtime/Object.h>
  10. namespace JS {
  11. // 7.4 Operations on Iterator Objects, https://tc39.es/ecma262/#sec-operations-on-iterator-objects
  12. enum class IteratorHint {
  13. Sync,
  14. Async,
  15. };
  16. ThrowCompletionOr<Object*> get_iterator(GlobalObject&, Value value, IteratorHint hint = IteratorHint::Sync, Value method = {});
  17. ThrowCompletionOr<Object*> iterator_next(Object& iterator, Value value = {});
  18. ThrowCompletionOr<Object*> iterator_step(GlobalObject&, Object& iterator);
  19. ThrowCompletionOr<bool> iterator_complete(GlobalObject&, Object& iterator_result);
  20. Value iterator_value(GlobalObject&, Object& iterator_result);
  21. void iterator_close(Object& iterator);
  22. Object* create_iterator_result_object(GlobalObject&, Value value, bool done);
  23. MarkedValueList iterable_to_list(GlobalObject&, Value iterable, Value method = {});
  24. enum class CloseOnAbrupt {
  25. No,
  26. Yes
  27. };
  28. void get_iterator_values(GlobalObject&, Value value, Function<IterationDecision(Value)> callback, Value method = {}, CloseOnAbrupt close_on_abrupt = CloseOnAbrupt::Yes);
  29. }