Stowage/ladybird
2
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-12-08 06:09:58 +00:00
Code Issues Projects Releases Packages Wiki Activity
ladybird/Libraries/LibWeb/HTML/Timer.h

49 lines
1 KiB
C
Raw Normal View History

LibWeb: Make DOM timers cancellable and stop leaking them This patch adds a Web::Timer object that represents a single timer registration made with window.setTimeout() or window.setInterval(). All live timers are owned by the DOM Window object. The timers can be stopped via clearTimeout() or clearInterval(). Note that those API's are actually interchangeable, but we have to support both.
2020-06-27 18:30:29 +02:00
/*
Meta: Update my e-mail address everywhere
2024-10-04 13:19:50 +02:00
* Copyright (c) 2020, Andreas Kling <andreas@ladybird.org>
LibWeb: Make DOM timers cancellable and stop leaking them This patch adds a Web::Timer object that represents a single timer registration made with window.setTimeout() or window.setInterval(). All live timers are owned by the DOM Window object. The timers can be stopped via clearTimeout() or clearInterval(). Note that those API's are actually interchangeable, but we have to support both.
2020-06-27 18:30:29 +02:00
*
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt *
2021-04-22 01:24:48 -07:00
* SPDX-License-Identifier: BSD-2-Clause
LibWeb: Make DOM timers cancellable and stop leaking them This patch adds a Web::Timer object that represents a single timer registration made with window.setTimeout() or window.setInterval(). All live timers are owned by the DOM Window object. The timers can be stopped via clearTimeout() or clearInterval(). Note that those API's are actually interchangeable, but we have to support both.
2020-06-27 18:30:29 +02:00
*/
#pragma once
#include <AK/Forward.h>
LibWeb: Implement setTimeout/setInterval with ESO according to the spec Our setInterval implementation currently crashes on DuckDuckGo when it's invoked with a string argument. In this path, we were creating a native function to evaluate and execute that string. That evaluation was always returning a Completion, but NativeFunction expects ThrowCompletionOr. The conversion from Completion to ThrowCompletionOr would fail a VERIFY because that conversion is only valid if the Completion is an error; but we would trigger this conversion even on success. This change re-implements setTimeout & setInterval in direct accordance with the spec. So we avoid making that NativeFunction altogether, and DDG can progress past its invocation to the timer. With this change, we also have other features we did not previously support, such as passing any number of arguments to the timers. This does not implement handling of nesting levels yet.
2022-03-04 10:41:12 -05:00
#include <AK/Function.h>
LibWeb: Make HTML::Timer GC-allocated These are the timers used internally by setTimeout() and setInterval().
2022-09-01 12:21:47 +02:00
#include <AK/WeakPtr.h>
LibWeb: Make DOM timers cancellable and stop leaking them This patch adds a Web::Timer object that represents a single timer registration made with window.setTimeout() or window.setInterval(). All live timers are owned by the DOM Window object. The timers can be stopped via clearTimeout() or clearInterval(). Note that those API's are actually interchangeable, but we have to support both.
2020-06-27 18:30:29 +02:00
#include <LibCore/Forward.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>
#include <LibGC/Ptr.h>
LibWeb: Make HTML::Timer GC-allocated These are the timers used internally by setTimeout() and setInterval().
2022-09-01 12:21:47 +02:00
#include <LibJS/Heap/Cell.h>
LibWeb: Make DOM timers cancellable and stop leaking them This patch adds a Web::Timer object that represents a single timer registration made with window.setTimeout() or window.setInterval(). All live timers are owned by the DOM Window object. The timers can be stopped via clearTimeout() or clearInterval(). Note that those API's are actually interchangeable, but we have to support both.
2020-06-27 18:30:29 +02:00
#include <LibWeb/Forward.h>
LibWeb: Move Timer from DOM directory & namespace to HTML Timers are part of the HTML spec. :^) https://html.spec.whatwg.org/multipage/timers-and-user-prompts.html#timers
2022-03-07 23:54:56 +01:00
namespace Web::HTML {
LibWeb: Make DOM timers cancellable and stop leaking them This patch adds a Web::Timer object that represents a single timer registration made with window.setTimeout() or window.setInterval(). All live timers are owned by the DOM Window object. The timers can be stopped via clearTimeout() or clearInterval(). Note that those API's are actually interchangeable, but we have to support both.
2020-06-27 18:30:29 +02:00
LibWeb: Make HTML::Timer GC-allocated These are the timers used internally by setTimeout() and setInterval().
2022-09-01 12:21:47 +02:00
class Timer final : public JS::Cell {
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_CELL(Timer, JS::Cell);
GC_DECLARE_ALLOCATOR(Timer);
LibWeb: Make HTML::Timer GC-allocated These are the timers used internally by setTimeout() and setInterval().
2022-09-01 12:21:47 +02:00
LibWeb: Make DOM timers cancellable and stop leaking them This patch adds a Web::Timer object that represents a single timer registration made with window.setTimeout() or window.setInterval(). All live timers are owned by the DOM Window object. The timers can be stopped via clearTimeout() or clearInterval(). Note that those API's are actually interchangeable, but we have to support both.
2020-06-27 18:30:29 +02:00
public:
LibWeb: Make setInterval() reuse the timer to reduce drift Instead of creating a new single-shot timer every time a setInterval timer reschedules itself, we now use a repeating Core::Timer internally. This dramatically reduces timer drift, since the next timeout is now based on when the timer fired, rather than when the timer callback completed (which could take arbitrarily long since we run JS). It's not perfect, but it's a huge improvement and allows us to play DiabloWeb at full framerate (20 fps).
2025-12-01 15:23:27 +01:00
enum class Repeating {
No,
Yes,
};
static GC::Ref<Timer> create(JS::Object&, i32 milliseconds, Function<void()> callback, i32 id, Repeating);
LibWeb: Make HTML::Timer GC-allocated These are the timers used internally by setTimeout() and setInterval().
2022-09-01 12:21:47 +02:00
virtual ~Timer() override;
LibWeb: Make DOM timers cancellable and stop leaking them This patch adds a Web::Timer object that represents a single timer registration made with window.setTimeout() or window.setInterval(). All live timers are owned by the DOM Window object. The timers can be stopped via clearTimeout() or clearInterval(). Note that those API's are actually interchangeable, but we have to support both.
2020-06-27 18:30:29 +02:00
LibWeb: Implement setTimeout/setInterval with ESO according to the spec Our setInterval implementation currently crashes on DuckDuckGo when it's invoked with a string argument. In this path, we were creating a native function to evaluate and execute that string. That evaluation was always returning a Completion, but NativeFunction expects ThrowCompletionOr. The conversion from Completion to ThrowCompletionOr would fail a VERIFY because that conversion is only valid if the Completion is an error; but we would trigger this conversion even on success. This change re-implements setTimeout & setInterval in direct accordance with the spec. So we avoid making that NativeFunction altogether, and DDG can progress past its invocation to the timer. With this change, we also have other features we did not previously support, such as passing any number of arguments to the timers. This does not implement handling of nesting levels yet.
2022-03-04 10:41:12 -05:00
void start();
LibWeb: Clear all active timers when document is destroyed This change implements a step from the document's destroy procedure in the specification, saying that all active timers should be cleared. By doing this, we also fix the leaking of a document in case where we have navigated away from a page that has scheduled timers that haven't yet been triggered.
2023-09-26 11:44:56 +02:00
void stop();
LibWeb: Make DOM timers cancellable and stop leaking them This patch adds a Web::Timer object that represents a single timer registration made with window.setTimeout() or window.setInterval(). All live timers are owned by the DOM Window object. The timers can be stopped via clearTimeout() or clearInterval(). Note that those API's are actually interchangeable, but we have to support both.
2020-06-27 18:30:29 +02:00
LibWeb: Make setInterval() reuse the timer to reduce drift Instead of creating a new single-shot timer every time a setInterval timer reschedules itself, we now use a repeating Core::Timer internally. This dramatically reduces timer drift, since the next timeout is now based on when the timer fired, rather than when the timer callback completed (which could take arbitrarily long since we run JS). It's not perfect, but it's a huge improvement and allows us to play DiabloWeb at full framerate (20 fps).
2025-12-01 15:23:27 +01:00
void set_callback(Function<void()>);
LibWeb: Make DOM timers cancellable and stop leaking them This patch adds a Web::Timer object that represents a single timer registration made with window.setTimeout() or window.setInterval(). All live timers are owned by the DOM Window object. The timers can be stopped via clearTimeout() or clearInterval(). Note that those API's are actually interchangeable, but we have to support both.
2020-06-27 18:30:29 +02:00
private:
LibWeb: Make setInterval() reuse the timer to reduce drift Instead of creating a new single-shot timer every time a setInterval timer reschedules itself, we now use a repeating Core::Timer internally. This dramatically reduces timer drift, since the next timeout is now based on when the timer fired, rather than when the timer callback completed (which could take arbitrarily long since we run JS). It's not perfect, but it's a huge improvement and allows us to play DiabloWeb at full framerate (20 fps).
2025-12-01 15:23:27 +01:00
Timer(JS::Object& window, i32 milliseconds, Function<void()> callback, i32 id, Repeating);
LibWeb: Make DOM timers cancellable and stop leaking them This patch adds a Web::Timer object that represents a single timer registration made with window.setTimeout() or window.setInterval(). All live timers are owned by the DOM Window object. The timers can be stopped via clearTimeout() or clearInterval(). Note that those API's are actually interchangeable, but we have to support both.
2020-06-27 18:30:29 +02:00
LibWeb: Make HTML::Timer GC-allocated These are the timers used internally by setTimeout() and setInterval().
2022-09-01 12:21:47 +02:00
virtual void visit_edges(Cell::Visitor&) override;
LibWeb: Use Core::Timer instead of Platform::Timer in HTML::Timer By using Core::Timer that accepts Function instead of JS::SafeFunction in Platform::Timer does we fix memory leak caused by circular dependency of timer's callback and timer itself.
2023-09-26 11:53:37 +02:00
RefPtr<Core::Timer> m_timer;
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::Ref<JS::Object> m_window_or_worker_global_scope;
LibWeb: Implement setTimeout/setInterval with ESO according to the spec Our setInterval implementation currently crashes on DuckDuckGo when it's invoked with a string argument. In this path, we were creating a native function to evaluate and execute that string. That evaluation was always returning a Completion, but NativeFunction expects ThrowCompletionOr. The conversion from Completion to ThrowCompletionOr would fail a VERIFY because that conversion is only valid if the Completion is an error; but we would trigger this conversion even on success. This change re-implements setTimeout & setInterval in direct accordance with the spec. So we avoid making that NativeFunction altogether, and DDG can progress past its invocation to the timer. With this change, we also have other features we did not previously support, such as passing any number of arguments to the timers. This does not implement handling of nesting levels yet.
2022-03-04 10:41:12 -05:00
i32 m_id { 0 };
LibWeb: Make DOM timers cancellable and stop leaking them This patch adds a Web::Timer object that represents a single timer registration made with window.setTimeout() or window.setInterval(). All live timers are owned by the DOM Window object. The timers can be stopped via clearTimeout() or clearInterval(). Note that those API's are actually interchangeable, but we have to support both.
2020-06-27 18:30:29 +02:00
};
}
Reference in a new issue Copy permalink