ladybird/Userland/Libraries/LibWeb/HTML/EventLoop/EventLoop.h
Andreas Kling ae71e5f99b LibWeb: Let HTML::EventLoop keep track of live DOM::Document objects
This will be used by the event loop processing model.
2021-10-03 16:42:34 +02:00

82 lines
2.2 KiB
C++

/*
* Copyright (c) 2021, Andreas Kling <kling@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/Function.h>
#include <AK/WeakPtr.h>
#include <LibCore/Forward.h>
#include <LibJS/Forward.h>
#include <LibWeb/HTML/EventLoop/TaskQueue.h>
namespace Web::HTML {
class EventLoop {
public:
enum class Type {
// https://html.spec.whatwg.org/multipage/webappapis.html#window-event-loop
Window,
// https://html.spec.whatwg.org/multipage/webappapis.html#worker-event-loop
Worker,
// https://html.spec.whatwg.org/multipage/webappapis.html#worklet-event-loop
Worklet,
};
EventLoop();
~EventLoop();
Type type() const { return m_type; }
TaskQueue& task_queue() { return m_task_queue; }
TaskQueue const& task_queue() const { return m_task_queue; }
TaskQueue& microtask_queue() { return m_microtask_queue; }
TaskQueue const& microtask_queue() const { return m_microtask_queue; }
void spin_until(Function<bool()> goal_condition);
void process();
Task const* currently_running_task() const { return m_currently_running_task; }
JS::VM& vm() { return *m_vm; }
JS::VM const& vm() const { return *m_vm; }
void set_vm(JS::VM&);
void schedule();
void perform_a_microtask_checkpoint();
void register_document(Badge<DOM::Document>, DOM::Document&);
void unregister_document(Badge<DOM::Document>, DOM::Document&);
NonnullRefPtrVector<DOM::Document> documents_in_this_event_loop() const;
private:
Type m_type { Type::Window };
TaskQueue m_task_queue;
TaskQueue m_microtask_queue;
// https://html.spec.whatwg.org/multipage/webappapis.html#currently-running-task
Task* m_currently_running_task { nullptr };
JS::VM* m_vm { nullptr };
RefPtr<Core::Timer> m_system_event_loop_timer;
// https://html.spec.whatwg.org/#performing-a-microtask-checkpoint
bool m_performing_a_microtask_checkpoint { false };
Vector<WeakPtr<DOM::Document>> m_documents;
};
EventLoop& main_thread_event_loop();
void queue_global_task(HTML::Task::Source, DOM::Document&, Function<void()> steps);
void queue_a_microtask(DOM::Document&, Function<void()> steps);
void perform_a_microtask_checkpoint();
}