/* * 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 namespace Web::HTML { class IdleCallback; // https://html.spec.whatwg.org/#timerhandler using TimerHandler = Variant, DeprecatedString>; class Window final : public DOM::EventTarget , public HTML::GlobalEventHandlers , public HTML::WindowEventHandlers { WEB_PLATFORM_OBJECT(Window, DOM::EventTarget); public: static JS::NonnullGCPtr create(JS::Realm&); ~Window(); virtual bool dispatch_event(DOM::Event&) 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(); JS::ThrowCompletionOr 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); void alert_impl(DeprecatedString const&); bool confirm_impl(DeprecatedString const&); DeprecatedString prompt_impl(DeprecatedString const&, DeprecatedString const&); i32 request_animation_frame_impl(WebIDL::CallbackType& js_callback); void cancel_animation_frame_impl(i32); 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 queue_microtask_impl(WebIDL::CallbackType& callback); int inner_width() const; int inner_height() const; 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); HighResolutionTime::Performance& performance(); Crypto::Crypto& crypto() { return *m_crypto; } CSS::Screen& screen(); 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); CSS::CSSStyleDeclaration* get_computed_style_impl(DOM::Element&) const; JS::NonnullGCPtr match_media_impl(DeprecatedString); Optional query_media_feature(CSS::MediaFeatureID) const; float scroll_x() const; float scroll_y() const; void fire_a_page_transition_event(DeprecatedFlyString const& event_name, bool persisted); float device_pixel_ratio() const; int screen_x() const; int screen_y() const; int outer_width() const; int outer_height() const; JS::NonnullGCPtr local_storage(); JS::NonnullGCPtr session_storage(); // https://html.spec.whatwg.org/multipage/browsers.html#dom-parent WindowProxy* parent(); WebIDL::ExceptionOr post_message_impl(JS::Value, DeprecatedString const& target_origin); WebIDL::ExceptionOr structured_clone_impl(JS::VM& vm, JS::Value); DeprecatedString name() const; void set_name(DeprecatedString const&); void start_an_idle_period(); u32 request_idle_callback_impl(WebIDL::CallbackType& callback); void cancel_idle_callback_impl(u32); 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; void initialize_web_interfaces(Badge); 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; AnimationFrameCallbackDriver m_animation_frame_callback_driver; // https://w3c.github.io/requestidlecallback/#dfn-list-of-idle-request-callbacks NonnullRefPtrVector m_idle_request_callbacks; // https://w3c.github.io/requestidlecallback/#dfn-list-of-runnable-idle-callbacks NonnullRefPtrVector m_runnable_idle_callbacks; // https://w3c.github.io/requestidlecallback/#dfn-idle-callback-identifier u32 m_idle_callback_identifier = 0; public: HTML::Origin origin() const; HTML::Location* location() { return m_location; } HTML::Location const* location() const { return m_location; } virtual JS::ThrowCompletionOr internal_set_prototype_of(JS::Object* prototype) override; 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; } private: JS_DECLARE_NATIVE_FUNCTION(length_getter); JS_DECLARE_NATIVE_FUNCTION(top_getter); JS_DECLARE_NATIVE_FUNCTION(document_getter); JS_DECLARE_NATIVE_FUNCTION(frame_element_getter); JS_DECLARE_NATIVE_FUNCTION(location_getter); JS_DECLARE_NATIVE_FUNCTION(location_setter); JS_DECLARE_NATIVE_FUNCTION(name_getter); JS_DECLARE_NATIVE_FUNCTION(name_setter); JS_DECLARE_NATIVE_FUNCTION(performance_getter); JS_DECLARE_NATIVE_FUNCTION(performance_setter); JS_DECLARE_NATIVE_FUNCTION(history_getter); JS_DECLARE_NATIVE_FUNCTION(screen_getter); JS_DECLARE_NATIVE_FUNCTION(event_getter); JS_DECLARE_NATIVE_FUNCTION(event_setter); JS_DECLARE_NATIVE_FUNCTION(inner_width_getter); JS_DECLARE_NATIVE_FUNCTION(inner_height_getter); JS_DECLARE_NATIVE_FUNCTION(window_getter); JS_DECLARE_NATIVE_FUNCTION(frames_getter); JS_DECLARE_NATIVE_FUNCTION(self_getter); JS_DECLARE_NATIVE_FUNCTION(parent_getter); JS_DECLARE_NATIVE_FUNCTION(device_pixel_ratio_getter); JS_DECLARE_NATIVE_FUNCTION(scroll_x_getter); JS_DECLARE_NATIVE_FUNCTION(scroll_y_getter); JS_DECLARE_NATIVE_FUNCTION(scroll); JS_DECLARE_NATIVE_FUNCTION(scroll_by); JS_DECLARE_NATIVE_FUNCTION(screen_x_getter); JS_DECLARE_NATIVE_FUNCTION(screen_y_getter); JS_DECLARE_NATIVE_FUNCTION(screen_left_getter); JS_DECLARE_NATIVE_FUNCTION(screen_top_getter); JS_DECLARE_NATIVE_FUNCTION(outer_width_getter); JS_DECLARE_NATIVE_FUNCTION(outer_height_getter); JS_DECLARE_NATIVE_FUNCTION(post_message); JS_DECLARE_NATIVE_FUNCTION(structured_clone); JS_DECLARE_NATIVE_FUNCTION(local_storage_getter); JS_DECLARE_NATIVE_FUNCTION(session_storage_getter); JS_DECLARE_NATIVE_FUNCTION(origin_getter); JS_DECLARE_NATIVE_FUNCTION(is_secure_context_getter); JS_DECLARE_NATIVE_FUNCTION(open); JS_DECLARE_NATIVE_FUNCTION(alert); JS_DECLARE_NATIVE_FUNCTION(confirm); JS_DECLARE_NATIVE_FUNCTION(prompt); JS_DECLARE_NATIVE_FUNCTION(set_interval); JS_DECLARE_NATIVE_FUNCTION(set_timeout); JS_DECLARE_NATIVE_FUNCTION(clear_interval); JS_DECLARE_NATIVE_FUNCTION(clear_timeout); JS_DECLARE_NATIVE_FUNCTION(request_animation_frame); JS_DECLARE_NATIVE_FUNCTION(cancel_animation_frame); JS_DECLARE_NATIVE_FUNCTION(atob); JS_DECLARE_NATIVE_FUNCTION(btoa); JS_DECLARE_NATIVE_FUNCTION(focus); JS_DECLARE_NATIVE_FUNCTION(get_computed_style); JS_DECLARE_NATIVE_FUNCTION(match_media); JS_DECLARE_NATIVE_FUNCTION(get_selection); JS_DECLARE_NATIVE_FUNCTION(queue_microtask); JS_DECLARE_NATIVE_FUNCTION(request_idle_callback); JS_DECLARE_NATIVE_FUNCTION(cancel_idle_callback); JS_DECLARE_NATIVE_FUNCTION(crypto_getter); #define __ENUMERATE(attribute, event_name) \ JS_DECLARE_NATIVE_FUNCTION(attribute##_getter); \ JS_DECLARE_NATIVE_FUNCTION(attribute##_setter); ENUMERATE_GLOBAL_EVENT_HANDLERS(__ENUMERATE); ENUMERATE_WINDOW_EVENT_HANDLERS(__ENUMERATE); #undef __ENUMERATE HTML::Location* m_location { nullptr }; // [[CrossOriginPropertyDescriptorMap]], https://html.spec.whatwg.org/multipage/browsers.html#crossoriginpropertydescriptormap CrossOriginPropertyDescriptorMap m_cross_origin_property_descriptor_map; }; void run_animation_frame_callbacks(DOM::Document&, double now); }