jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2021, Luke Wilde <lukew@serenityos.org>
3 *
4 * SPDX-License-Identifier: BSD-2-Clause
5 */
6
7#include <LibWeb/Bindings/Intrinsics.h>
8#include <LibWeb/DOM/AbortSignal.h>
9#include <LibWeb/DOM/Document.h>
10#include <LibWeb/DOM/EventDispatcher.h>
11#include <LibWeb/HTML/EventHandler.h>
12
13namespace Web::DOM {
14
15WebIDL::ExceptionOr<JS::NonnullGCPtr<AbortSignal>> AbortSignal::construct_impl(JS::Realm& realm)
16{
17 return MUST_OR_THROW_OOM(realm.heap().allocate<AbortSignal>(realm, realm));
18}
19
20AbortSignal::AbortSignal(JS::Realm& realm)
21 : EventTarget(realm)
22{
23}
24
25JS::ThrowCompletionOr<void> AbortSignal::initialize(JS::Realm& realm)
26{
27 MUST_OR_THROW_OOM(Base::initialize(realm));
28 set_prototype(&Bindings::ensure_web_prototype<Bindings::AbortSignalPrototype>(realm, "AbortSignal"));
29
30 return {};
31}
32
33// https://dom.spec.whatwg.org/#abortsignal-add
34void AbortSignal::add_abort_algorithm(JS::SafeFunction<void()> abort_algorithm)
35{
36 // 1. If signal is aborted, then return.
37 if (aborted())
38 return;
39
40 // 2. Append algorithm to signal’s abort algorithms.
41 m_abort_algorithms.append(move(abort_algorithm));
42}
43
44// https://dom.spec.whatwg.org/#abortsignal-signal-abort
45void AbortSignal::signal_abort(JS::Value reason)
46{
47 // 1. If signal is aborted, then return.
48 if (aborted())
49 return;
50
51 // 2. Set signal’s abort reason to reason if it is given; otherwise to a new "AbortError" DOMException.
52 if (!reason.is_undefined())
53 m_abort_reason = reason;
54 else
55 m_abort_reason = WebIDL::AbortError::create(realm(), "Aborted without reason").ptr();
56
57 // 3. For each algorithm in signal’s abort algorithms: run algorithm.
58 for (auto& algorithm : m_abort_algorithms)
59 algorithm();
60
61 // 4. Empty signal’s abort algorithms.
62 m_abort_algorithms.clear();
63
64 // 5. Fire an event named abort at signal.
65 dispatch_event(Event::create(realm(), HTML::EventNames::abort).release_value_but_fixme_should_propagate_errors());
66}
67
68void AbortSignal::set_onabort(WebIDL::CallbackType* event_handler)
69{
70 set_event_handler_attribute(HTML::EventNames::abort, event_handler);
71}
72
73WebIDL::CallbackType* AbortSignal::onabort()
74{
75 return event_handler_attribute(HTML::EventNames::abort);
76}
77
78// https://dom.spec.whatwg.org/#dom-abortsignal-throwifaborted
79JS::ThrowCompletionOr<void> AbortSignal::throw_if_aborted() const
80{
81 // The throwIfAborted() method steps are to throw this’s abort reason, if this is aborted.
82 if (!aborted())
83 return {};
84
85 return JS::throw_completion(m_abort_reason);
86}
87
88void AbortSignal::visit_edges(JS::Cell::Visitor& visitor)
89{
90 Base::visit_edges(visitor);
91 visitor.visit(m_abort_reason);
92}
93
94// https://dom.spec.whatwg.org/#abortsignal-follow
95void AbortSignal::follow(JS::NonnullGCPtr<AbortSignal> parent_signal)
96{
97 // A followingSignal (an AbortSignal) is made to follow a parentSignal (an AbortSignal) by running these steps:
98
99 // 1. If followingSignal is aborted, then return.
100 if (aborted())
101 return;
102
103 // 2. If parentSignal is aborted, then signal abort on followingSignal with parentSignal’s abort reason.
104 if (parent_signal->aborted()) {
105 signal_abort(parent_signal->reason());
106 return;
107 }
108
109 // 3. Otherwise, add the following abort steps to parentSignal:
110 // NOTE: `this` and `parent_signal` are protected by AbortSignal using JS::SafeFunction.
111 parent_signal->add_abort_algorithm([this, parent_signal] {
112 // 1. Signal abort on followingSignal with parentSignal’s abort reason.
113 signal_abort(parent_signal->reason());
114 });
115}
116
117}