EventLoop.h 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. /*
  2. * Copyright (c) 2021, Andreas Kling <kling@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #pragma once
  7. #include <AK/Function.h>
  8. #include <AK/WeakPtr.h>
  9. #include <LibCore/Forward.h>
  10. #include <LibJS/Forward.h>
  11. #include <LibWeb/HTML/EventLoop/TaskQueue.h>
  12. namespace Web::HTML {
  13. class EventLoop {
  14. public:
  15. enum class Type {
  16. // https://html.spec.whatwg.org/multipage/webappapis.html#window-event-loop
  17. Window,
  18. // https://html.spec.whatwg.org/multipage/webappapis.html#worker-event-loop
  19. Worker,
  20. // https://html.spec.whatwg.org/multipage/webappapis.html#worklet-event-loop
  21. Worklet,
  22. };
  23. EventLoop();
  24. ~EventLoop();
  25. Type type() const { return m_type; }
  26. TaskQueue& task_queue() { return m_task_queue; }
  27. TaskQueue const& task_queue() const { return m_task_queue; }
  28. TaskQueue& microtask_queue() { return m_microtask_queue; }
  29. TaskQueue const& microtask_queue() const { return m_microtask_queue; }
  30. void spin_until(Function<bool()> goal_condition);
  31. void process();
  32. Task const* currently_running_task() const { return m_currently_running_task; }
  33. JS::VM& vm() { return *m_vm; }
  34. JS::VM const& vm() const { return *m_vm; }
  35. void set_vm(JS::VM&);
  36. void schedule();
  37. void perform_a_microtask_checkpoint();
  38. void register_document(Badge<DOM::Document>, DOM::Document&);
  39. void unregister_document(Badge<DOM::Document>, DOM::Document&);
  40. Vector<JS::Handle<DOM::Document>> documents_in_this_event_loop() const;
  41. Vector<JS::Handle<HTML::Window>> same_loop_windows() const;
  42. void push_onto_backup_incumbent_settings_object_stack(Badge<EnvironmentSettingsObject>, EnvironmentSettingsObject& environment_settings_object);
  43. void pop_backup_incumbent_settings_object_stack(Badge<EnvironmentSettingsObject>);
  44. EnvironmentSettingsObject& top_of_backup_incumbent_settings_object_stack();
  45. bool is_backup_incumbent_settings_object_stack_empty() const { return m_backup_incumbent_settings_object_stack.is_empty(); }
  46. void register_environment_settings_object(Badge<EnvironmentSettingsObject>, EnvironmentSettingsObject&);
  47. void unregister_environment_settings_object(Badge<EnvironmentSettingsObject>, EnvironmentSettingsObject&);
  48. double unsafe_shared_current_time() const;
  49. double compute_deadline() const;
  50. private:
  51. Type m_type { Type::Window };
  52. TaskQueue m_task_queue;
  53. TaskQueue m_microtask_queue;
  54. // https://html.spec.whatwg.org/multipage/webappapis.html#currently-running-task
  55. Task* m_currently_running_task { nullptr };
  56. // https://html.spec.whatwg.org/multipage/webappapis.html#last-render-opportunity-time
  57. double m_last_render_opportunity_time { 0 };
  58. // https://html.spec.whatwg.org/multipage/webappapis.html#last-idle-period-start-time
  59. double m_last_idle_period_start_time { 0 };
  60. JS::VM* m_vm { nullptr };
  61. RefPtr<Core::Timer> m_system_event_loop_timer;
  62. // https://html.spec.whatwg.org/#performing-a-microtask-checkpoint
  63. bool m_performing_a_microtask_checkpoint { false };
  64. Vector<WeakPtr<DOM::Document>> m_documents;
  65. // Used to implement step 4 of "perform a microtask checkpoint".
  66. Vector<EnvironmentSettingsObject&> m_related_environment_settings_objects;
  67. // https://html.spec.whatwg.org/multipage/webappapis.html#backup-incumbent-settings-object-stack
  68. Vector<EnvironmentSettingsObject&> m_backup_incumbent_settings_object_stack;
  69. };
  70. EventLoop& main_thread_event_loop();
  71. void old_queue_global_task_with_document(HTML::Task::Source, DOM::Document&, Function<void()> steps);
  72. void queue_global_task(HTML::Task::Source, JS::Object&, Function<void()> steps);
  73. void queue_a_microtask(DOM::Document*, Function<void()> steps);
  74. void perform_a_microtask_checkpoint();
  75. }