/* * Copyright (c) 2020-2022, Andreas Kling * Copyright (c) 2021-2023, Linus Groh * * SPDX-License-Identifier: BSD-2-Clause */ #pragma once #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace Web::HTML { class IdleCallback; // https://html.spec.whatwg.org/#timerhandler using TimerHandler = Variant, DeprecatedString>; // https://w3c.github.io/csswg-drafts/cssom-view/#dictdef-scrolloptions struct ScrollOptions { Bindings::ScrollBehavior behavior { Bindings::ScrollBehavior::Auto }; }; // https://w3c.github.io/csswg-drafts/cssom-view/#dictdef-scrolltooptions struct ScrollToOptions : public ScrollOptions { Optional left; Optional top; }; class Window final : public DOM::EventTarget , public HTML::GlobalEventHandlers , public HTML::WindowEventHandlers , public WindowOrWorkerGlobalScopeMixin , public Bindings::WindowGlobalMixin { WEB_PLATFORM_OBJECT(Window, DOM::EventTarget); public: static WebIDL::ExceptionOr> create(JS::Realm&); ~Window(); using WindowOrWorkerGlobalScopeMixin::atob; using WindowOrWorkerGlobalScopeMixin::btoa; using WindowOrWorkerGlobalScopeMixin::fetch; using WindowOrWorkerGlobalScopeMixin::queue_microtask; using WindowOrWorkerGlobalScopeMixin::structured_clone; // ^DOM::EventTarget virtual bool dispatch_event(DOM::Event&) override; // ^WindowOrWorkerGlobalScopeMixin virtual Bindings::PlatformObject& this_impl() override { return *this; } virtual Bindings::PlatformObject const& this_impl() const override { return *this; } // ^JS::Object virtual JS::ThrowCompletionOr internal_set_prototype_of(JS::Object* prototype) override; Page* page(); Page const* page() const; // https://html.spec.whatwg.org/multipage/window-object.html#concept-document-window DOM::Document const& associated_document() const { return *m_associated_document; } DOM::Document& associated_document() { return *m_associated_document; } void set_associated_document(DOM::Document&); // https://html.spec.whatwg.org/multipage/window-object.html#window-bc HTML::BrowsingContext const* browsing_context() const; HTML::BrowsingContext* browsing_context(); size_t document_tree_child_browsing_context_count() const; ImportMap const& import_map() const { return m_import_map; } bool import_maps_allowed() const { return m_import_maps_allowed; } void set_import_maps_allowed(bool import_maps_allowed) { m_import_maps_allowed = import_maps_allowed; } WebIDL::ExceptionOr> open_impl(StringView url, StringView target, StringView features); bool has_animation_frame_callbacks() const { return m_animation_frame_callback_driver.has_callbacks(); } i32 set_timeout_impl(TimerHandler, i32 timeout, JS::MarkedVector arguments); i32 set_interval_impl(TimerHandler, i32 timeout, JS::MarkedVector arguments); void clear_timeout_impl(i32); void clear_interval_impl(i32); void did_set_location_href(Badge, AK::URL const& new_href); void did_call_location_reload(Badge); void did_call_location_replace(Badge, DeprecatedString url); void deallocate_timer_id(Badge, i32); DOM::Event* current_event() { return m_current_event.ptr(); } DOM::Event const* current_event() const { return m_current_event.ptr(); } void set_current_event(DOM::Event* event); Optional query_media_feature(CSS::MediaFeatureID) const; void fire_a_page_transition_event(DeprecatedFlyString const& event_name, bool persisted); WebIDL::ExceptionOr> local_storage(); WebIDL::ExceptionOr> session_storage(); void start_an_idle_period(); AnimationFrameCallbackDriver& animation_frame_callback_driver() { return m_animation_frame_callback_driver; } // https://html.spec.whatwg.org/multipage/interaction.html#transient-activation bool has_transient_activation() const; WebIDL::ExceptionOr initialize_web_interfaces(Badge); Vector> pdf_viewer_plugin_objects(); Vector> pdf_viewer_mime_type_objects(); CrossOriginPropertyDescriptorMap const& cross_origin_property_descriptor_map() const { return m_cross_origin_property_descriptor_map; } CrossOriginPropertyDescriptorMap& cross_origin_property_descriptor_map() { return m_cross_origin_property_descriptor_map; } // JS API functions JS::NonnullGCPtr window() const; JS::NonnullGCPtr self() const; JS::NonnullGCPtr document() const; String name() const; void set_name(String const&); WebIDL::ExceptionOr> location(); JS::NonnullGCPtr history() const; void focus(); JS::NonnullGCPtr frames() const; u32 length() const; JS::GCPtr top() const; JS::GCPtr parent() const; JS::GCPtr frame_element() const; WebIDL::ExceptionOr> open(Optional const& url, Optional const& target, Optional const& features); WebIDL::ExceptionOr> navigator(); void alert(String const& message = {}); bool confirm(Optional const& message); Optional prompt(Optional const& message, Optional const& default_); void post_message(JS::Value message, String const&); Variant, JS::Value> event() const; WebIDL::ExceptionOr> get_computed_style(DOM::Element&, Optional const& pseudo_element) const; WebIDL::ExceptionOr> match_media(String const& query); WebIDL::ExceptionOr> screen(); i32 inner_width() const; i32 inner_height() const; double scroll_x() const; double scroll_y() const; void scroll(ScrollToOptions const&); void scroll(double x, double y); void scroll_by(ScrollToOptions); void scroll_by(double x, double y); i32 screen_x() const; i32 screen_y() const; i32 outer_width() const; i32 outer_height() const; double device_pixel_ratio() const; i32 request_animation_frame(WebIDL::CallbackType&); void cancel_animation_frame(i32 handle); u32 request_idle_callback(WebIDL::CallbackType&, RequestIdleCallback::IdleRequestOptions const&); void cancel_idle_callback(u32 handle); JS::GCPtr get_selection() const; WebIDL::ExceptionOr> performance(); WebIDL::ExceptionOr> crypto(); private: explicit Window(JS::Realm&); virtual void visit_edges(Cell::Visitor&) override; // ^HTML::GlobalEventHandlers virtual DOM::EventTarget& global_event_handlers_to_event_target(DeprecatedFlyString const&) override { return *this; } // ^HTML::WindowEventHandlers virtual DOM::EventTarget& window_event_handlers_to_event_target() override { return *this; } enum class Repeat { Yes, No, }; i32 run_timer_initialization_steps(TimerHandler handler, i32 timeout, JS::MarkedVector arguments, Repeat repeat, Optional previous_id = {}); void invoke_idle_callbacks(); // https://html.spec.whatwg.org/multipage/window-object.html#concept-document-window JS::GCPtr m_associated_document; JS::GCPtr m_current_event; IDAllocator m_timer_id_allocator; HashMap> m_timers; // https://html.spec.whatwg.org/multipage/webappapis.html#concept-window-import-map ImportMap m_import_map; // https://html.spec.whatwg.org/multipage/webappapis.html#import-maps-allowed bool m_import_maps_allowed { true }; JS::GCPtr m_performance; JS::GCPtr m_crypto; JS::GCPtr m_screen; JS::GCPtr m_navigator; JS::GCPtr m_location; AnimationFrameCallbackDriver m_animation_frame_callback_driver; // https://w3c.github.io/requestidlecallback/#dfn-list-of-idle-request-callbacks Vector> m_idle_request_callbacks; // https://w3c.github.io/requestidlecallback/#dfn-list-of-runnable-idle-callbacks Vector> m_runnable_idle_callbacks; // https://w3c.github.io/requestidlecallback/#dfn-idle-callback-identifier u32 m_idle_callback_identifier = 0; // https://html.spec.whatwg.org/multipage/system-state.html#pdf-viewer-plugin-objects Vector> m_pdf_viewer_plugin_objects; // https://html.spec.whatwg.org/multipage/system-state.html#pdf-viewer-mime-type-objects Vector> m_pdf_viewer_mime_type_objects; // [[CrossOriginPropertyDescriptorMap]], https://html.spec.whatwg.org/multipage/browsers.html#crossoriginpropertydescriptormap CrossOriginPropertyDescriptorMap m_cross_origin_property_descriptor_map; JS_DECLARE_NATIVE_FUNCTION(location_setter); JS_DECLARE_NATIVE_FUNCTION(set_interval); JS_DECLARE_NATIVE_FUNCTION(set_timeout); JS_DECLARE_NATIVE_FUNCTION(clear_interval); JS_DECLARE_NATIVE_FUNCTION(clear_timeout); }; void run_animation_frame_callbacks(DOM::Document&, double now); }