Stowage/ladybird
2
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-10-20 08:03:21 +00:00
Code Issues Projects Releases Packages Wiki Activity
ladybird/Libraries/LibWeb/DOM/AbortSignal.h

91 lines
3.6 KiB
C
Raw Normal View History

LibWeb: Add initial support for AbortController and AbortSignal The DOM specification says that the primary use case for these is to give Promises abort semantics. It is also a prerequisite for Fetch, as it is used to make Fetch abortable. a
2021-09-02 02:12:49 +01:00
/*
* Copyright (c) 2021, Luke Wilde <lukew@serenityos.org>
LibWeb: Implement `AbortSignal.any()` This method takes a list of AbortSignals and returns an AbortSignal that is aborted when any of the input signals is aborted.
2024-03-10 18:50:30 +00:00
* Copyright (c) 2024, Tim Ledbetter <timledbetter@gmail.com>
LibWeb: Add initial support for AbortController and AbortSignal The DOM specification says that the primary use case for these is to give Promises abort semantics. It is also a prerequisite for Fetch, as it is used to make Fetch abortable. a
2021-09-02 02:12:49 +01:00
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
LibWeb: Support removing callbacks from AbortSignal This will be needed by Streams. To support this, we now store callbacks in a hash table, keyed by an ID. Callers may use that ID to remove the callback at a later point.
2025-04-10 09:04:01 -04:00
#include <AK/HashMap.h>
LibWeb: Add initial support for AbortController and AbortSignal The DOM specification says that the primary use case for these is to give Promises abort semantics. It is also a prerequisite for Fetch, as it is used to make Fetch abortable. a
2021-09-02 02:12:49 +01:00
#include <AK/RefCounted.h>
#include <AK/Weakable.h>
LibGC+Everywhere: Factor out a LibGC from LibJS Resulting in a massive rename across almost everywhere! Alongside the namespace change, we now have the following names: * JS::NonnullGCPtr -> GC::Ref * JS::GCPtr -> GC::Ptr * JS::HeapFunction -> GC::Function * JS::CellImpl -> GC::Cell * JS::Handle -> GC::Root
2024-11-15 04:01:23 +13:00
#include <LibGC/Function.h>
LibWeb: Add initial support for AbortController and AbortSignal The DOM specification says that the primary use case for these is to give Promises abort semantics. It is also a prerequisite for Fetch, as it is used to make Fetch abortable. a
2021-09-02 02:12:49 +01:00
#include <LibWeb/DOM/EventTarget.h>
#include <LibWeb/Forward.h>
LibWeb: Implement `AbortSignal.timeout()` This method returns a signal that will automatically abort after a given number of milliseconds.
2024-02-26 17:52:32 +00:00
#include <LibWeb/WebIDL/Types.h>
LibWeb: Add initial support for AbortController and AbortSignal The DOM specification says that the primary use case for these is to give Promises abort semantics. It is also a prerequisite for Fetch, as it is used to make Fetch abortable. a
2021-09-02 02:12:49 +01:00
namespace Web::DOM {
// https://dom.spec.whatwg.org/#abortsignal
LibWeb+LibJS: Make the EventTarget hierarchy (incl. DOM) GC-allocated This is a monster patch that turns all EventTargets into GC-allocated PlatformObjects. Their C++ wrapper classes are removed, and the LibJS garbage collector is now responsible for their lifetimes. There's a fair amount of hacks and band-aids in this patch, and we'll have a lot of cleanup to do after this.
2022-08-28 13:42:07 +02:00
class AbortSignal final : public EventTarget {
WEB_PLATFORM_OBJECT(AbortSignal, EventTarget);
LibGC+Everywhere: Factor out a LibGC from LibJS Resulting in a massive rename across almost everywhere! Alongside the namespace change, we now have the following names: * JS::NonnullGCPtr -> GC::Ref * JS::GCPtr -> GC::Ptr * JS::HeapFunction -> GC::Function * JS::CellImpl -> GC::Cell * JS::Handle -> GC::Root
2024-11-15 04:01:23 +13:00
GC_DECLARE_ALLOCATOR(AbortSignal);
LibWeb: Add initial support for AbortController and AbortSignal The DOM specification says that the primary use case for these is to give Promises abort semantics. It is also a prerequisite for Fetch, as it is used to make Fetch abortable. a
2021-09-02 02:12:49 +01:00
LibWeb+LibJS: Make the EventTarget hierarchy (incl. DOM) GC-allocated This is a monster patch that turns all EventTargets into GC-allocated PlatformObjects. Their C++ wrapper classes are removed, and the LibJS garbage collector is now responsible for their lifetimes. There's a fair amount of hacks and band-aids in this patch, and we'll have a lot of cleanup to do after this.
2022-08-28 13:42:07 +02:00
public:
LibGC+Everywhere: Factor out a LibGC from LibJS Resulting in a massive rename across almost everywhere! Alongside the namespace change, we now have the following names: * JS::NonnullGCPtr -> GC::Ref * JS::GCPtr -> GC::Ptr * JS::HeapFunction -> GC::Function * JS::CellImpl -> GC::Cell * JS::Handle -> GC::Root
2024-11-15 04:01:23 +13:00
static WebIDL::ExceptionOr<GC::Ref<AbortSignal>> construct_impl(JS::Realm&);
LibWeb: Add initial support for AbortController and AbortSignal The DOM specification says that the primary use case for these is to give Promises abort semantics. It is also a prerequisite for Fetch, as it is used to make Fetch abortable. a
2021-09-02 02:12:49 +01:00
Libraries: Use default constructors/destructors in LibWeb https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#cother-other-default-operation-rules "The compiler is more likely to get the default semantics right and you cannot implement these functions better than the compiler."
2022-03-14 13:21:51 -06:00
virtual ~AbortSignal() override = default;
LibWeb: Add initial support for AbortController and AbortSignal The DOM specification says that the primary use case for these is to give Promises abort semantics. It is also a prerequisite for Fetch, as it is used to make Fetch abortable. a
2021-09-02 02:12:49 +01:00
LibWeb: Support removing callbacks from AbortSignal This will be needed by Streams. To support this, we now store callbacks in a hash table, keyed by an ID. Callers may use that ID to remove the callback at a later point.
2025-04-10 09:04:01 -04:00
using AbortAlgorithmID = u64;
Optional<AbortAlgorithmID> add_abort_algorithm(Function<void()>);
void remove_abort_algorithm(AbortAlgorithmID);
LibWeb: Add initial support for AbortController and AbortSignal The DOM specification says that the primary use case for these is to give Promises abort semantics. It is also a prerequisite for Fetch, as it is used to make Fetch abortable. a
2021-09-02 02:12:49 +01:00
// https://dom.spec.whatwg.org/#dom-abortsignal-aborted
LibWeb: Add support for AbortSignal.reason
2021-12-10 20:05:12 +00:00
// An AbortSignal object is aborted when its abort reason is not undefined.
bool aborted() const { return !m_abort_reason.is_undefined(); }
LibWeb: Add initial support for AbortController and AbortSignal The DOM specification says that the primary use case for these is to give Promises abort semantics. It is also a prerequisite for Fetch, as it is used to make Fetch abortable. a
2021-09-02 02:12:49 +01:00
LibWeb: Add support for AbortSignal.reason
2021-12-10 20:05:12 +00:00
void signal_abort(JS::Value reason);
LibWeb: Add initial support for AbortController and AbortSignal The DOM specification says that the primary use case for these is to give Promises abort semantics. It is also a prerequisite for Fetch, as it is used to make Fetch abortable. a
2021-09-02 02:12:49 +01:00
LibWeb: Move CallbackType from Bindings/ to WebIDL/ Let's stop putting generic types and AOs from the Web IDL spec into the Bindings namespace and directory in LibWeb, and instead follow our usual naming rules of 'directory = namespace = spec name'. The IDL namespace is already used by LibIDL, so Web::WebIDL seems like a good choice.
2022-09-24 16:02:41 +01:00
void set_onabort(WebIDL::CallbackType*);
WebIDL::CallbackType* onabort();
LibWeb: Implement AbortSignal.onabort
2021-10-01 01:09:11 +01:00
LibWeb: Add support for AbortSignal.reason
2021-12-10 20:05:12 +00:00
// https://dom.spec.whatwg.org/#dom-abortsignal-reason
JS::Value reason() const { return m_abort_reason; }
LibWeb: Implement `AbortSignal.abort()` This returns an AbortSignal that is already set as aborted.
2024-02-20 20:51:29 +00:00
void set_reason(JS::Value reason) { m_abort_reason = reason; }
LibWeb: Add support for AbortSignal.reason
2021-12-10 20:05:12 +00:00
LibWeb: Implement AbortSignal.throwIfAborted See: https://github.com/whatwg/dom/commit/cfe2f1e
2021-12-10 19:48:51 +00:00
JS::ThrowCompletionOr<void> throw_if_aborted() const;
LibGC+Everywhere: Factor out a LibGC from LibJS Resulting in a massive rename across almost everywhere! Alongside the namespace change, we now have the following names: * JS::NonnullGCPtr -> GC::Ref * JS::GCPtr -> GC::Ptr * JS::HeapFunction -> GC::Function * JS::CellImpl -> GC::Cell * JS::Handle -> GC::Root
2024-11-15 04:01:23 +13:00
static WebIDL::ExceptionOr<GC::Ref<AbortSignal>> abort(JS::VM&, JS::Value reason);
static WebIDL::ExceptionOr<GC::Ref<AbortSignal>> timeout(JS::VM&, Web::WebIDL::UnsignedLongLong milliseconds);
static WebIDL::ExceptionOr<GC::Ref<AbortSignal>> any(JS::VM&, Vector<GC::Root<AbortSignal>> const&);
LibWeb: Implement `AbortSignal.abort()` This returns an AbortSignal that is already set as aborted.
2024-02-20 20:51:29 +00:00
LibGC+Everywhere: Factor out a LibGC from LibJS Resulting in a massive rename across almost everywhere! Alongside the namespace change, we now have the following names: * JS::NonnullGCPtr -> GC::Ref * JS::GCPtr -> GC::Ptr * JS::HeapFunction -> GC::Function * JS::CellImpl -> GC::Cell * JS::Handle -> GC::Root
2024-11-15 04:01:23 +13:00
static WebIDL::ExceptionOr<GC::Ref<AbortSignal>> create_dependent_abort_signal(JS::Realm&, Vector<GC::Root<AbortSignal>> const&);
LibWeb/Fetch: Replace usages of AbortSignal::follow() in Fetch::Request Since the introduction of `AbortSignal::any()`, the specification says `AbortSignal::create_dependent_abort_signal()` should be used where `AbortSignal::follow` was previously.
2024-03-26 07:45:11 +00:00
LibWeb: Add initial support for AbortController and AbortSignal The DOM specification says that the primary use case for these is to give Promises abort semantics. It is also a prerequisite for Fetch, as it is used to make Fetch abortable. a
2021-09-02 02:12:49 +01:00
private:
LibWeb: Remove unecessary dependence on Window from DOM and WebIDL These classes only needed Window to get at its realm. Pass a realm directly to construct DOM and WebIDL classes. This change importantly removes the guarantee that a Document will always have a non-null Window object. Only Documents created by a BrowsingContext will have a non-null Window object. Documents created by for example, DocumentFragment, will not have a Window (soon). This incremental commit leaves some workarounds in place to keep other parts of the code building.
2022-09-25 16:15:49 -06:00
explicit AbortSignal(JS::Realm&);
LibWeb+LibJS: Make the EventTarget hierarchy (incl. DOM) GC-allocated This is a monster patch that turns all EventTargets into GC-allocated PlatformObjects. Their C++ wrapper classes are removed, and the LibJS garbage collector is now responsible for their lifetimes. There's a fair amount of hacks and band-aids in this patch, and we'll have a lot of cleanup to do after this.
2022-08-28 13:42:07 +02:00
LibJS: Make Cell::initialize() return void Stop worrying about tiny OOMs. Work towards #20405
2023-08-07 08:41:28 +02:00
virtual void initialize(JS::Realm&) override;
LibWeb+LibJS: Make the EventTarget hierarchy (incl. DOM) GC-allocated This is a monster patch that turns all EventTargets into GC-allocated PlatformObjects. Their C++ wrapper classes are removed, and the LibJS garbage collector is now responsible for their lifetimes. There's a fair amount of hacks and band-aids in this patch, and we'll have a lot of cleanup to do after this.
2022-08-28 13:42:07 +02:00
virtual void visit_edges(JS::Cell::Visitor&) override;
LibWeb: Add initial support for AbortController and AbortSignal The DOM specification says that the primary use case for these is to give Promises abort semantics. It is also a prerequisite for Fetch, as it is used to make Fetch abortable. a
2021-09-02 02:12:49 +01:00
LibWeb: Implement `AbortSignal.any()` This method takes a list of AbortSignals and returns an AbortSignal that is aborted when any of the input signals is aborted.
2024-03-10 18:50:30 +00:00
bool dependent() const { return m_dependent; }
void set_dependent(bool dependent) { m_dependent = dependent; }
LibGC+Everywhere: Factor out a LibGC from LibJS Resulting in a massive rename across almost everywhere! Alongside the namespace change, we now have the following names: * JS::NonnullGCPtr -> GC::Ref * JS::GCPtr -> GC::Ptr * JS::HeapFunction -> GC::Function * JS::CellImpl -> GC::Cell * JS::Handle -> GC::Root
2024-11-15 04:01:23 +13:00
Vector<GC::Ptr<AbortSignal>> source_signals() const { return m_source_signals; }
LibWeb: Implement `AbortSignal.any()` This method takes a list of AbortSignals and returns an AbortSignal that is aborted when any of the input signals is aborted.
2024-03-10 18:50:30 +00:00
LibGC+Everywhere: Factor out a LibGC from LibJS Resulting in a massive rename across almost everywhere! Alongside the namespace change, we now have the following names: * JS::NonnullGCPtr -> GC::Ref * JS::GCPtr -> GC::Ptr * JS::HeapFunction -> GC::Function * JS::CellImpl -> GC::Cell * JS::Handle -> GC::Root
2024-11-15 04:01:23 +13:00
void append_source_signal(GC::Ptr<AbortSignal> source_signal) { m_source_signals.append(source_signal); }
void append_dependent_signal(GC::Ptr<AbortSignal> dependent_signal) { m_dependent_signals.append(dependent_signal); }
LibWeb: Implement `AbortSignal.any()` This method takes a list of AbortSignals and returns an AbortSignal that is aborted when any of the input signals is aborted.
2024-03-10 18:50:30 +00:00
LibWeb: Add support for AbortSignal.reason
2021-12-10 20:05:12 +00:00
// https://dom.spec.whatwg.org/#abortsignal-abort-reason
// An AbortSignal object has an associated abort reason, which is a JavaScript value. It is undefined unless specified otherwise.
JS::Value m_abort_reason { JS::js_undefined() };
LibWeb: Add initial support for AbortController and AbortSignal The DOM specification says that the primary use case for these is to give Promises abort semantics. It is also a prerequisite for Fetch, as it is used to make Fetch abortable. a
2021-09-02 02:12:49 +01:00
// https://dom.spec.whatwg.org/#abortsignal-abort-algorithms
LibWeb: Support removing callbacks from AbortSignal This will be needed by Streams. To support this, we now store callbacks in a hash table, keyed by an ID. Callers may use that ID to remove the callback at a later point.
2025-04-10 09:04:01 -04:00
OrderedHashMap<AbortAlgorithmID, GC::Ref<GC::Function<void()>>> m_abort_algorithms;
AbortAlgorithmID m_next_abort_algorithm_id { 0 };
LibWeb: Implement `AbortSignal.any()` This method takes a list of AbortSignals and returns an AbortSignal that is aborted when any of the input signals is aborted.
2024-03-10 18:50:30 +00:00
// https://dom.spec.whatwg.org/#abortsignal-source-signals
// An AbortSignal object has associated source signals (a weak set of AbortSignal objects that the object is dependent on for its aborted state), which is initially empty.
LibGC+Everywhere: Factor out a LibGC from LibJS Resulting in a massive rename across almost everywhere! Alongside the namespace change, we now have the following names: * JS::NonnullGCPtr -> GC::Ref * JS::GCPtr -> GC::Ptr * JS::HeapFunction -> GC::Function * JS::CellImpl -> GC::Cell * JS::Handle -> GC::Root
2024-11-15 04:01:23 +13:00
Vector<GC::Ptr<AbortSignal>> m_source_signals;
LibWeb: Implement `AbortSignal.any()` This method takes a list of AbortSignals and returns an AbortSignal that is aborted when any of the input signals is aborted.
2024-03-10 18:50:30 +00:00
// https://dom.spec.whatwg.org/#abortsignal-dependent-signals
// An AbortSignal object has associated dependent signals (a weak set of AbortSignal objects that are dependent on the object for their aborted state), which is initially empty.
LibGC+Everywhere: Factor out a LibGC from LibJS Resulting in a massive rename across almost everywhere! Alongside the namespace change, we now have the following names: * JS::NonnullGCPtr -> GC::Ref * JS::GCPtr -> GC::Ptr * JS::HeapFunction -> GC::Function * JS::CellImpl -> GC::Cell * JS::Handle -> GC::Root
2024-11-15 04:01:23 +13:00
Vector<GC::Ptr<AbortSignal>> m_dependent_signals;
LibWeb: Implement `AbortSignal.any()` This method takes a list of AbortSignals and returns an AbortSignal that is aborted when any of the input signals is aborted.
2024-03-10 18:50:30 +00:00
// https://dom.spec.whatwg.org/#abortsignal-dependent
// An AbortSignal object has a dependent (a boolean), which is initially false.
bool m_dependent { false };
LibWeb: Add initial support for AbortController and AbortSignal The DOM specification says that the primary use case for these is to give Promises abort semantics. It is also a prerequisite for Fetch, as it is used to make Fetch abortable. a
2021-09-02 02:12:49 +01:00
};
}
Reference in a new issue Copy permalink