/* * Copyright (c) 2022, Andrew Kaster * * SPDX-License-Identifier: BSD-2-Clause */ #pragma once #include #include #include #include #include #include #include #include #include #include #include #define ENUMERATE_WORKER_GLOBAL_SCOPE_EVENT_HANDLERS(E) \ E(onerror, HTML::EventNames::error) \ E(onlanguagechange, HTML::EventNames::languagechange) \ E(ononline, HTML::EventNames::online) \ E(onoffline, HTML::EventNames::offline) \ E(onrejectionhandled, HTML::EventNames::rejectionhandled) \ E(onunhandledrejection, HTML::EventNames::unhandledrejection) namespace Web::HTML { // https://html.spec.whatwg.org/multipage/workers.html#the-workerglobalscope-common-interface // WorkerGlobalScope is the base class of each real WorkerGlobalScope that will be created when the // user agent runs the run a worker algorithm. class WorkerGlobalScope : public DOM::EventTarget , public WindowOrWorkerGlobalScopeMixin { WEB_PLATFORM_OBJECT(WorkerGlobalScope, DOM::EventTarget); JS_DECLARE_ALLOCATOR(WorkerGlobalScope); public: virtual ~WorkerGlobalScope() override; // ^WindowOrWorkerGlobalScopeMixin virtual Bindings::PlatformObject& this_impl() override { return *this; } virtual Bindings::PlatformObject const& this_impl() const override { return *this; } using WindowOrWorkerGlobalScopeMixin::atob; using WindowOrWorkerGlobalScopeMixin::btoa; using WindowOrWorkerGlobalScopeMixin::clear_interval; using WindowOrWorkerGlobalScopeMixin::clear_timeout; using WindowOrWorkerGlobalScopeMixin::create_image_bitmap; using WindowOrWorkerGlobalScopeMixin::fetch; using WindowOrWorkerGlobalScopeMixin::performance; using WindowOrWorkerGlobalScopeMixin::queue_microtask; using WindowOrWorkerGlobalScopeMixin::set_interval; using WindowOrWorkerGlobalScopeMixin::set_timeout; using WindowOrWorkerGlobalScopeMixin::structured_clone; // Following methods are from the WorkerGlobalScope IDL definition // https://html.spec.whatwg.org/multipage/workers.html#the-workerglobalscope-common-interface // https://html.spec.whatwg.org/multipage/workers.html#dom-workerglobalscope-self JS::NonnullGCPtr self() const { return *this; } JS::NonnullGCPtr location() const; JS::NonnullGCPtr navigator() const; WebIDL::ExceptionOr import_scripts(Vector const& urls, PerformTheFetchHook = nullptr); #undef __ENUMERATE #define __ENUMERATE(attribute_name, event_name) \ void set_##attribute_name(WebIDL::CallbackType*); \ WebIDL::CallbackType* attribute_name(); ENUMERATE_WORKER_GLOBAL_SCOPE_EVENT_HANDLERS(__ENUMERATE) #undef __ENUMERATE JS::NonnullGCPtr fonts(); // Non-IDL public methods URL::URL const& url() const { return m_url.value(); } void set_url(URL::URL const& url) { m_url = url; } // Spec note: While the WorkerLocation object is created after the WorkerGlobalScope object, // this is not problematic as it cannot be observed from script. void set_location(JS::NonnullGCPtr loc) { m_location = move(loc); } void set_internal_port(JS::NonnullGCPtr port); void initialize_web_interfaces(Badge) { initialize_web_interfaces_impl(); } Web::Page* page() { return m_page.ptr(); } PolicyContainer policy_container() const { return m_policy_container; } bool is_closing() const { return m_closing; } protected: explicit WorkerGlobalScope(JS::Realm&, JS::NonnullGCPtr); virtual void initialize_web_interfaces_impl(); void close_a_worker(); virtual void finalize() override; JS::GCPtr m_internal_port; private: virtual void visit_edges(Cell::Visitor&) override; JS::GCPtr m_location; JS::GCPtr m_navigator; JS::NonnullGCPtr m_page; // FIXME: Add all these internal slots // https://html.spec.whatwg.org/multipage/workers.html#concept-WorkerGlobalScope-owner-set // A WorkerGlobalScope object has an associated owner set (a set of Document and WorkerGlobalScope objects). It is initially empty and populated when the worker is created or obtained. // Note: It is a set, instead of a single owner, to accommodate SharedWorkerGlobalScope objects. // https://html.spec.whatwg.org/multipage/workers.html#concept-workerglobalscope-type // A WorkerGlobalScope object has an associated type ("classic" or "module"). It is set during creation. // https://html.spec.whatwg.org/multipage/workers.html#concept-workerglobalscope-url // A WorkerGlobalScope object has an associated url (null or a URL). It is initially null. Optional m_url; // https://html.spec.whatwg.org/multipage/workers.html#concept-workerglobalscope-name // A WorkerGlobalScope object has an associated name (a string). It is set during creation. // Note: The name can have different semantics for each subclass of WorkerGlobalScope. // For DedicatedWorkerGlobalScope instances, it is simply a developer-supplied name, useful mostly for debugging purposes. // For SharedWorkerGlobalScope instances, it allows obtaining a reference to a common shared worker via the SharedWorker() constructor. // For ServiceWorkerGlobalScope objects, it doesn't make sense (and as such isn't exposed through the JavaScript API at all). // https://html.spec.whatwg.org/multipage/workers.html#concept-workerglobalscope-policy-container // A WorkerGlobalScope object has an associated policy container (a policy container). It is initially a new policy container. PolicyContainer m_policy_container; // https://html.spec.whatwg.org/multipage/workers.html#concept-workerglobalscope-embedder-policy // A WorkerGlobalScope object has an associated embedder policy (an embedder policy). EmbedderPolicy m_embedder_policy; // https://html.spec.whatwg.org/multipage/workers.html#concept-workerglobalscope-module-map // A WorkerGlobalScope object has an associated module map. It is a module map, initially empty. // https://html.spec.whatwg.org/multipage/workers.html#concept-workerglobalscope-cross-origin-isolated-capability bool m_cross_origin_isolated_capability { false }; // https://html.spec.whatwg.org/multipage/workers.html#dom-workerglobalscope-closing bool m_closing { false }; // https://drafts.csswg.org/css-font-loading/#font-source JS::GCPtr m_fonts; }; }