Task.h 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. /*
  2. * Copyright (c) 2021-2024, Andreas Kling <kling@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #pragma once
  7. #include <LibJS/Heap/Cell.h>
  8. #include <LibJS/Heap/CellAllocator.h>
  9. #include <LibJS/SafeFunction.h>
  10. #include <LibWeb/Forward.h>
  11. namespace Web::HTML {
  12. struct UniqueTaskSource;
  13. class Task final : public JS::Cell {
  14. JS_CELL(Task, JS::Cell);
  15. JS_DECLARE_ALLOCATOR(Task);
  16. public:
  17. // https://html.spec.whatwg.org/multipage/webappapis.html#generic-task-sources
  18. enum class Source {
  19. Unspecified,
  20. DOMManipulation,
  21. UserInteraction,
  22. Networking,
  23. HistoryTraversal,
  24. IdleTask,
  25. PostedMessage,
  26. Microtask,
  27. TimerTask,
  28. JavaScriptEngine,
  29. // https://html.spec.whatwg.org/multipage/webappapis.html#navigation-and-traversal-task-source
  30. NavigationAndTraversal,
  31. // https://w3c.github.io/FileAPI/#fileReadingTaskSource
  32. FileReading,
  33. // https://www.w3.org/TR/intersection-observer/#intersectionobserver-task-source
  34. IntersectionObserver,
  35. // https://w3c.github.io/performance-timeline/#dfn-performance-timeline-task-source
  36. PerformanceTimeline,
  37. // https://html.spec.whatwg.org/multipage/canvas.html#canvas-blob-serialisation-task-source
  38. CanvasBlobSerializationTask,
  39. // https://w3c.github.io/clipboard-apis/#clipboard-task-source
  40. Clipboard,
  41. // https://w3c.github.io/permissions/#permissions-task-source
  42. Permissions,
  43. // https://drafts.csswg.org/css-font-loading/#task-source
  44. FontLoading,
  45. // https://html.spec.whatwg.org/multipage/server-sent-events.html#remote-event-task-source
  46. RemoteEvent,
  47. // !!! IMPORTANT: Keep this field last!
  48. // This serves as the base value of all unique task sources.
  49. // Some elements, such as the HTMLMediaElement, must have a unique task source per instance.
  50. UniqueTaskSourceStart
  51. };
  52. static JS::NonnullGCPtr<Task> create(JS::VM&, Source, JS::GCPtr<DOM::Document const>, JS::NonnullGCPtr<JS::HeapFunction<void()>> steps);
  53. virtual ~Task() override;
  54. virtual void finalize() override;
  55. int id() const { return m_id; }
  56. Source source() const { return m_source; }
  57. void execute();
  58. DOM::Document const* document() const;
  59. bool is_runnable() const;
  60. private:
  61. Task(Source, JS::GCPtr<DOM::Document const>, JS::NonnullGCPtr<JS::HeapFunction<void()>> steps);
  62. virtual void visit_edges(Visitor&) override;
  63. int m_id { 0 };
  64. Source m_source { Source::Unspecified };
  65. JS::NonnullGCPtr<JS::HeapFunction<void()>> m_steps;
  66. JS::GCPtr<DOM::Document const> m_document;
  67. };
  68. struct UniqueTaskSource {
  69. UniqueTaskSource();
  70. ~UniqueTaskSource();
  71. Task::Source const source;
  72. };
  73. }