/* * Copyright (c) 2018-2025, Andreas Kling * Copyright (c) 2021-2023, Linus Groh * Copyright (c) 2023-2024, Shannon Booth * Copyright (c) 2025, Jelle Raaijmakers * * 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 #include #include #include #include #include #include #include #include #include #include #include #include #include namespace Web::DOM { enum class QuirksMode { No, Limited, Yes }; #define ENUMERATE_INVALIDATE_LAYOUT_TREE_REASONS(X) \ X(DocumentAddAnElementToTheTopLayer) \ X(DocumentRequestAnElementToBeRemovedFromTheTopLayer) \ X(ShadowRootSetInnerHTML) enum class InvalidateLayoutTreeReason { #define ENUMERATE_INVALIDATE_LAYOUT_TREE_REASON(e) e, ENUMERATE_INVALIDATE_LAYOUT_TREE_REASONS(ENUMERATE_INVALIDATE_LAYOUT_TREE_REASON) #undef ENUMERATE_INVALIDATE_LAYOUT_TREE_REASON }; [[nodiscard]] StringView to_string(InvalidateLayoutTreeReason); #define ENUMERATE_UPDATE_LAYOUT_REASONS(X) \ X(CanvasRenderingContext2DSetFilter) \ X(CursorBlinkTimer) \ X(Debugging) \ X(DocumentElementFromPoint) \ X(DocumentElementsFromPoint) \ X(DocumentFindMatchingText) \ X(DocumentSetDesignMode) \ X(ElementCheckVisibility) \ X(ElementClientHeight) \ X(ElementClientLeft) \ X(ElementClientTop) \ X(ElementClientWidth) \ X(ElementGetClientRects) \ X(ElementIsPotentiallyScrollable) \ X(ElementScroll) \ X(ElementScrollHeight) \ X(ElementScrollIntoView) \ X(ElementScrollLeft) \ X(ElementScrollTop) \ X(ElementScrollWidth) \ X(ElementSetScrollLeft) \ X(ElementSetScrollTop) \ X(EventHandlerHandleDoubleClick) \ X(EventHandlerHandleDragAndDrop) \ X(EventHandlerHandleMouseDown) \ X(EventHandlerHandleMouseMove) \ X(EventHandlerHandleMouseUp) \ X(EventHandlerHandleMouseWheel) \ X(HTMLElementGetTheTextSteps) \ X(HTMLElementOffsetHeight) \ X(HTMLElementOffsetLeft) \ X(HTMLElementOffsetParent) \ X(HTMLElementOffsetTop) \ X(HTMLElementOffsetWidth) \ X(HTMLEventLoopRenderingUpdate) \ X(HTMLImageElementHeight) \ X(HTMLImageElementWidth) \ X(HTMLInputElementHeight) \ X(HTMLInputElementWidth) \ X(InternalsHitTest) \ X(MediaQueryListMatches) \ X(NodeNameOrDescription) \ X(RangeGetClientRects) \ X(ResolvedCSSStyleDeclarationProperty) \ X(SVGDecodedImageDataRender) \ X(SVGGraphicsElementGetBBox) \ X(SourceSetNormalizeSourceDensities) \ X(WindowScroll) enum class UpdateLayoutReason { #define ENUMERATE_UPDATE_LAYOUT_REASON(e) e, ENUMERATE_UPDATE_LAYOUT_REASONS(ENUMERATE_UPDATE_LAYOUT_REASON) #undef ENUMERATE_UPDATE_LAYOUT_REASON }; [[nodiscard]] StringView to_string(UpdateLayoutReason); // https://html.spec.whatwg.org/multipage/dom.html#document-load-timing-info struct DocumentLoadTimingInfo { // https://html.spec.whatwg.org/multipage/dom.html#navigation-start-time double navigation_start_time { 0 }; // https://html.spec.whatwg.org/multipage/dom.html#dom-interactive-time HighResolutionTime::DOMHighResTimeStamp dom_interactive_time { 0 }; // https://html.spec.whatwg.org/multipage/dom.html#dom-content-loaded-event-start-time HighResolutionTime::DOMHighResTimeStamp dom_content_loaded_event_start_time { 0 }; // https://html.spec.whatwg.org/multipage/dom.html#dom-content-loaded-event-end-time HighResolutionTime::DOMHighResTimeStamp dom_content_loaded_event_end_time { 0 }; // https://html.spec.whatwg.org/multipage/dom.html#dom-complete-time HighResolutionTime::DOMHighResTimeStamp dom_complete_time { 0 }; // https://html.spec.whatwg.org/multipage/dom.html#load-event-start-time HighResolutionTime::DOMHighResTimeStamp load_event_start_time { 0 }; // https://html.spec.whatwg.org/multipage/dom.html#load-event-end-time HighResolutionTime::DOMHighResTimeStamp load_event_end_time { 0 }; }; // https://html.spec.whatwg.org/multipage/dom.html#document-unload-timing-info struct DocumentUnloadTimingInfo { // https://html.spec.whatwg.org/multipage/dom.html#unload-event-start-time double unload_event_start_time { 0 }; // https://html.spec.whatwg.org/multipage/dom.html#unload-event-end-time double unload_event_end_time { 0 }; }; struct ElementCreationOptions { Optional is; }; enum class PolicyControlledFeature : u8 { Autoplay, FocusWithoutUserActivation, }; class Document : public ParentNode , public HTML::GlobalEventHandlers { WEB_PLATFORM_OBJECT(Document, ParentNode); GC_DECLARE_ALLOCATOR(Document); public: enum class Type { XML, HTML }; enum class TemporaryDocumentForFragmentParsing { No, Yes, }; static WebIDL::ExceptionOr> create_and_initialize(Type, String content_type, HTML::NavigationParams const&); [[nodiscard]] static GC::Ref create(JS::Realm&, URL::URL const& url = URL::about_blank()); [[nodiscard]] static GC::Ref create_for_fragment_parsing(JS::Realm&); static WebIDL::ExceptionOr> construct_impl(JS::Realm&); virtual ~Document() override; // AD-HOC: This number increments whenever a node is added or removed from the document, or an element attribute changes. // It can be used as a crude invalidation mechanism for caches that depend on the DOM structure. u64 dom_tree_version() const { return m_dom_tree_version; } void bump_dom_tree_version() { ++m_dom_tree_version; } // AD-HOC: This number increments whenever CharacterData is modified in the document. It is used together with // dom_tree_version() to understand whether either the DOM tree structure or contents were changed. u64 character_data_version() const { return m_character_data_version; } void bump_character_data_version() { ++m_character_data_version; } WebIDL::ExceptionOr populate_with_html_head_and_body(); GC::Ptr get_selection() const; WebIDL::ExceptionOr cookie(Cookie::Source = Cookie::Source::NonHttp); WebIDL::ExceptionOr set_cookie(StringView, Cookie::Source = Cookie::Source::NonHttp); bool is_cookie_averse() const; void enable_cookies_on_file_domains(Badge) { m_enable_cookies_on_file_domains = true; } String fg_color() const; void set_fg_color(String const&); String link_color() const; void set_link_color(String const&); String vlink_color() const; void set_vlink_color(String const&); String alink_color() const; void set_alink_color(String const&); String bg_color() const; void set_bg_color(String const&); String referrer() const; void set_referrer(String); void set_url(const URL::URL& url) { m_url = url; } URL::URL url() const { return m_url; } URL::URL fallback_base_url() const; URL::URL base_url() const; void update_base_element(Badge); GC::Ptr first_base_element_with_href_in_tree_order() const; GC::Ptr first_base_element_with_target_in_tree_order() const; String url_string() const { return m_url.to_string(); } String document_uri() const { return url_string(); } URL::Origin const& origin() const; void set_origin(URL::Origin const& origin); HTML::OpenerPolicy const& opener_policy() const { return m_opener_policy; } void set_opener_policy(HTML::OpenerPolicy policy) { m_opener_policy = move(policy); } Optional parse_url(StringView) const; Optional encoding_parse_url(StringView) const; Optional encoding_parse_and_serialize_url(StringView) const; CSS::StyleComputer& style_computer() { return *m_style_computer; } const CSS::StyleComputer& style_computer() const { return *m_style_computer; } CSS::StyleSheetList& style_sheets(); CSS::StyleSheetList const& style_sheets() const; void for_each_active_css_style_sheet(Function)>&& callback) const; CSS::StyleSheetList* style_sheets_for_bindings() { return &style_sheets(); } Optional get_style_sheet_source(CSS::StyleSheetIdentifier const&) const; virtual FlyString node_name() const override { return "#document"_fly_string; } void invalidate_style_for_elements_affected_by_pseudo_class_change(CSS::PseudoClass, auto& element_slot, Node& old_new_common_ancestor, auto node); void set_hovered_node(GC::Ptr); Node* hovered_node() { return m_hovered_node.ptr(); } Node const* hovered_node() const { return m_hovered_node.ptr(); } void set_inspected_node(GC::Ptr); GC::Ptr inspected_node() const { return m_inspected_node; } void set_highlighted_node(GC::Ptr, Optional); GC::Ptr highlighted_node() const { return m_highlighted_node; } GC::Ptr highlighted_layout_node(); GC::Ptr highlighted_layout_node() const { return const_cast(this)->highlighted_layout_node(); } Element* document_element(); Element const* document_element() const; HTML::HTMLHtmlElement* html_element(); HTML::HTMLHeadElement* head(); GC::Ptr title_element(); StringView dir() const; void set_dir(String const&); HTML::HTMLElement* body(); HTML::HTMLHtmlElement const* html_element() const { return const_cast(this)->html_element(); } HTML::HTMLHeadElement const* head() const { return const_cast(this)->head(); } GC::Ptr title_element() const { return const_cast(this)->title_element(); } HTML::HTMLElement const* body() const { return const_cast(this)->body(); } WebIDL::ExceptionOr set_body(HTML::HTMLElement* new_body); String title() const; WebIDL::ExceptionOr set_title(String const&); HTML::BrowsingContext* browsing_context() { return m_browsing_context.ptr(); } HTML::BrowsingContext const* browsing_context() const { return m_browsing_context.ptr(); } void set_browsing_context(HTML::BrowsingContext*); Page& page(); Page const& page() const; Color background_color() const; Vector const* background_layers() const; Optional normal_link_color() const; void set_normal_link_color(Color); Optional active_link_color() const; void set_active_link_color(Color); Optional visited_link_color() const; void set_visited_link_color(Color); Optional const&> supported_color_schemes() const; void obtain_supported_color_schemes(); void obtain_theme_color(); void update_style(); void update_layout(UpdateLayoutReason); void update_paint_and_hit_testing_properties_if_needed(); void update_animated_style_if_needed(); void invalidate_layout_tree(InvalidateLayoutTreeReason); void invalidate_stacking_context_tree(); virtual bool is_child_allowed(Node const&) const override; Layout::Viewport const* layout_node() const; Layout::Viewport* layout_node(); Painting::ViewportPaintable const* paintable() const; Painting::ViewportPaintable* paintable(); void schedule_style_update(); void schedule_layout_update(); GC::Ref get_elements_by_name(FlyString const&); GC::Ref applets(); GC::Ref anchors(); GC::Ref images(); GC::Ref embeds(); GC::Ref plugins(); GC::Ref links(); GC::Ref forms(); GC::Ref scripts(); GC::Ref all(); // https://drafts.csswg.org/css-font-loading/#font-source GC::Ref fonts(); void clear(); void capture_events(); void release_events(); String const& source() const { return m_source; } void set_source(String source) { m_source = move(source); } HTML::EnvironmentSettingsObject& relevant_settings_object() const; WebIDL::ExceptionOr> create_element(String const& local_name, Variant const& options); WebIDL::ExceptionOr> create_element_ns(Optional const& namespace_, String const& qualified_name, Variant const& options); GC::Ref create_document_fragment(); GC::Ref create_text_node(String const& data); WebIDL::ExceptionOr> create_cdata_section(String const& data); GC::Ref create_comment(String const& data); WebIDL::ExceptionOr> create_processing_instruction(String const& target, String const& data); WebIDL::ExceptionOr> create_attribute(String const& local_name); WebIDL::ExceptionOr> create_attribute_ns(Optional const& namespace_, String const& qualified_name); WebIDL::ExceptionOr> create_event(StringView interface); GC::Ref create_range(); void set_pending_parsing_blocking_script(HTML::HTMLScriptElement*); HTML::HTMLScriptElement* pending_parsing_blocking_script() { return m_pending_parsing_blocking_script.ptr(); } GC::Ref take_pending_parsing_blocking_script(Badge); void add_script_to_execute_when_parsing_has_finished(Badge, HTML::HTMLScriptElement&); Vector> take_scripts_to_execute_when_parsing_has_finished(Badge); Vector>& scripts_to_execute_when_parsing_has_finished() { return m_scripts_to_execute_when_parsing_has_finished; } void add_script_to_execute_as_soon_as_possible(Badge, HTML::HTMLScriptElement&); Vector> take_scripts_to_execute_as_soon_as_possible(Badge); Vector>& scripts_to_execute_as_soon_as_possible() { return m_scripts_to_execute_as_soon_as_possible; } void add_script_to_execute_in_order_as_soon_as_possible(Badge, HTML::HTMLScriptElement&); Vector> take_scripts_to_execute_in_order_as_soon_as_possible(Badge); Vector>& scripts_to_execute_in_order_as_soon_as_possible() { return m_scripts_to_execute_in_order_as_soon_as_possible; } QuirksMode mode() const { return m_quirks_mode; } bool in_quirks_mode() const { return m_quirks_mode == QuirksMode::Yes; } bool in_limited_quirks_mode() const { return m_quirks_mode == QuirksMode::Limited; } void set_quirks_mode(QuirksMode mode) { m_quirks_mode = mode; } Type document_type() const { return m_type; } void set_document_type(Type type) { m_type = type; } // https://dom.spec.whatwg.org/#html-document bool is_html_document() const { return m_type == Type::HTML; } // https://dom.spec.whatwg.org/#xml-document bool is_xml_document() const { return m_type == Type::XML; } WebIDL::ExceptionOr> import_node(GC::Ref node, bool deep); void adopt_node(Node&); WebIDL::ExceptionOr> adopt_node_binding(GC::Ref); DocumentType const* doctype() const; String const& compat_mode() const; void set_editable(bool editable) { m_editable = editable; } Element* focused_element() { return m_focused_element.ptr(); } Element const* focused_element() const { return m_focused_element.ptr(); } void set_focused_element(GC::Ptr); Element const* active_element() const { return m_active_element.ptr(); } void set_active_element(GC::Ptr); Element const* target_element() const { return m_target_element.ptr(); } void set_target_element(GC::Ptr); void try_to_scroll_to_the_fragment(); void scroll_to_the_fragment(); void scroll_to_the_beginning_of_the_document(); bool created_for_appropriate_template_contents() const { return m_created_for_appropriate_template_contents; } GC::Ref appropriate_template_contents_owner_document(); StringView ready_state() const; HTML::DocumentReadyState readiness() const { return m_readiness; } void update_readiness(HTML::DocumentReadyState); String last_modified() const; [[nodiscard]] GC::Ptr window() const { return m_window; } void set_window(HTML::Window&); WebIDL::ExceptionOr write(Vector const& strings); WebIDL::ExceptionOr writeln(Vector const& strings); WebIDL::ExceptionOr open(Optional const& = {}, Optional const& = {}); WebIDL::ExceptionOr> open(StringView url, StringView name, StringView features); WebIDL::ExceptionOr close(); GC::Ptr default_view() const; GC::Ptr default_view(); String const& content_type() const { return m_content_type; } void set_content_type(String content_type) { m_content_type = move(content_type); } Optional const& pragma_set_default_language() const { return m_pragma_set_default_language; } void set_pragma_set_default_language(String language) { m_pragma_set_default_language = move(language); } Optional const& http_content_language() const { return m_http_content_language; } bool has_encoding() const { return m_encoding.has_value(); } Optional const& encoding() const { return m_encoding; } String encoding_or_default() const { return m_encoding.value_or("UTF-8"_string); } void set_encoding(Optional encoding) { m_encoding = move(encoding); } // NOTE: These are intended for the JS bindings String character_set() const { return encoding_or_default(); } String charset() const { return encoding_or_default(); } String input_encoding() const { return encoding_or_default(); } bool ready_for_post_load_tasks() const { return m_ready_for_post_load_tasks; } void set_ready_for_post_load_tasks(bool ready) { m_ready_for_post_load_tasks = ready; } void completely_finish_loading(); DOMImplementation* implementation(); GC::Ptr current_script() const { return m_current_script.ptr(); } void set_current_script(Badge, GC::Ptr script) { m_current_script = move(script); } u32 ignore_destructive_writes_counter() const { return m_ignore_destructive_writes_counter; } void increment_ignore_destructive_writes_counter() { m_ignore_destructive_writes_counter++; } void decrement_ignore_destructive_writes_counter() { m_ignore_destructive_writes_counter--; } virtual EventTarget* get_parent(Event const&) override; String dump_dom_tree_as_json() const; [[nodiscard]] bool has_a_style_sheet_that_is_blocking_scripts() const; [[nodiscard]] bool has_no_style_sheet_that_is_blocking_scripts() const; bool is_fully_active() const; bool is_active() const; [[nodiscard]] bool allow_declarative_shadow_roots() const; void set_allow_declarative_shadow_roots(bool); GC::Ref history(); GC::Ref history() const; [[nodiscard]] GC::Ptr location(); bool anything_is_delaying_the_load_event() const; void increment_number_of_things_delaying_the_load_event(Badge); void decrement_number_of_things_delaying_the_load_event(Badge); bool page_showing() const { return m_page_showing; } void set_page_showing(bool); bool hidden() const; StringView visibility_state() const; HTML::VisibilityState visibility_state_value() const { return m_visibility_state; } // https://html.spec.whatwg.org/multipage/interaction.html#update-the-visibility-state void update_the_visibility_state(HTML::VisibilityState); // NOTE: This does not fire any events, unlike update_the_visibility_state(). void set_visibility_state(Badge, HTML::VisibilityState); void run_the_resize_steps(); void run_the_scroll_steps(); void evaluate_media_queries_and_report_changes(); void add_media_query_list(GC::Ref); GC::Ref visual_viewport(); [[nodiscard]] CSSPixelRect viewport_rect() const; class ViewportClient { public: virtual ~ViewportClient() = default; virtual void did_set_viewport_rect(CSSPixelRect const&) = 0; }; void register_viewport_client(ViewportClient&); void unregister_viewport_client(ViewportClient&); void inform_all_viewport_clients_about_the_current_viewport_rect(); bool has_focus_for_bindings() const; bool has_focus() const; bool allow_focus() const; void set_parser(Badge, HTML::HTMLParser&); void detach_parser(Badge); [[nodiscard]] bool is_temporary_document_for_fragment_parsing() const { return m_temporary_document_for_fragment_parsing == TemporaryDocumentForFragmentParsing::Yes; } static bool is_valid_name(String const&); struct PrefixAndTagName { FlyString prefix; FlyString tag_name; }; static WebIDL::ExceptionOr validate_qualified_name(JS::Realm&, FlyString const& qualified_name); GC::Ref create_node_iterator(Node& root, unsigned what_to_show, GC::Ptr); GC::Ref create_tree_walker(Node& root, unsigned what_to_show, GC::Ptr); void register_node_iterator(Badge, NodeIterator&); void unregister_node_iterator(Badge, NodeIterator&); void register_document_observer(Badge, DocumentObserver&); void unregister_document_observer(Badge, DocumentObserver&); template void for_each_node_iterator(Callback callback) { for (auto& node_iterator : m_node_iterators) callback(*node_iterator); } bool needs_full_style_update() const { return m_needs_full_style_update; } void set_needs_full_style_update(bool b) { m_needs_full_style_update = b; } [[nodiscard]] bool needs_full_layout_tree_update() const { return m_needs_full_layout_tree_update; } void set_needs_full_layout_tree_update(bool b) { m_needs_full_layout_tree_update = b; } void set_needs_to_refresh_scroll_state(bool b); bool has_active_favicon() const { return m_active_favicon; } void check_favicon_after_loading_link_resource(); GC::Ptr lookup_custom_element_definition(Optional const& namespace_, FlyString const& local_name, Optional const& is) const; void increment_throw_on_dynamic_markup_insertion_counter(Badge); void decrement_throw_on_dynamic_markup_insertion_counter(Badge); // https://html.spec.whatwg.org/multipage/dom.html#is-initial-about:blank bool is_initial_about_blank() const { return m_is_initial_about_blank; } void set_is_initial_about_blank(bool b) { m_is_initial_about_blank = b; } // https://html.spec.whatwg.org/multipage/dom.html#concept-document-about-base-url Optional about_base_url() const { return m_about_base_url; } void set_about_base_url(Optional url) { m_about_base_url = url; } String domain() const; void set_domain(String const&); auto& pending_scroll_event_targets() { return m_pending_scroll_event_targets; } auto& pending_scrollend_event_targets() { return m_pending_scrollend_event_targets; } // https://html.spec.whatwg.org/multipage/document-lifecycle.html#completely-loaded bool is_completely_loaded() const; // https://html.spec.whatwg.org/multipage/dom.html#concept-document-navigation-id Optional navigation_id() const; void set_navigation_id(Optional); // https://html.spec.whatwg.org/multipage/origin.html#active-sandboxing-flag-set HTML::SandboxingFlagSet active_sandboxing_flag_set() const; void set_active_sandboxing_flag_set(HTML::SandboxingFlagSet); // https://html.spec.whatwg.org/multipage/dom.html#concept-document-policy-container GC::Ref policy_container() const; void set_policy_container(GC::Ref); Vector> descendant_navigables(); Vector> const descendant_navigables() const; Vector> inclusive_descendant_navigables(); Vector> ancestor_navigables(); Vector> const ancestor_navigables() const; Vector> inclusive_ancestor_navigables(); Vector> document_tree_child_navigables(); [[nodiscard]] bool has_been_destroyed() const { return m_has_been_destroyed; } // https://html.spec.whatwg.org/multipage/document-lifecycle.html#destroy-a-document void destroy(); // https://html.spec.whatwg.org/multipage/document-lifecycle.html#destroy-a-document-and-its-descendants void destroy_a_document_and_its_descendants(GC::Ptr> after_all_destruction = {}); // https://html.spec.whatwg.org/multipage/browsing-the-web.html#abort-a-document void abort(); // https://html.spec.whatwg.org/multipage/document-lifecycle.html#abort-a-document-and-its-descendants void abort_a_document_and_its_descendants(); // https://html.spec.whatwg.org/multipage/document-lifecycle.html#unload-a-document void unload(GC::Ptr new_document = nullptr); // https://html.spec.whatwg.org/multipage/document-lifecycle.html#unload-a-document-and-its-descendants void unload_a_document_and_its_descendants(GC::Ptr new_document, GC::Ptr> after_all_unloads = {}); // https://html.spec.whatwg.org/multipage/dom.html#active-parser GC::Ptr active_parser(); // https://html.spec.whatwg.org/multipage/dom.html#load-timing-info DocumentLoadTimingInfo& load_timing_info() { return m_load_timing_info; } DocumentLoadTimingInfo const& load_timing_info() const { return m_load_timing_info; } void set_load_timing_info(DocumentLoadTimingInfo const& load_timing_info) { m_load_timing_info = load_timing_info; } // https://html.spec.whatwg.org/multipage/dom.html#previous-document-unload-timing DocumentUnloadTimingInfo& previous_document_unload_timing() { return m_previous_document_unload_timing; } DocumentUnloadTimingInfo const& previous_document_unload_timing() const { return m_previous_document_unload_timing; } void set_previous_document_unload_timing(DocumentUnloadTimingInfo const& previous_document_unload_timing) { m_previous_document_unload_timing = previous_document_unload_timing; } // https://w3c.github.io/editing/docs/execCommand/ WebIDL::ExceptionOr exec_command(FlyString const& command, bool show_ui, String const& value); WebIDL::ExceptionOr query_command_enabled(FlyString const& command); WebIDL::ExceptionOr query_command_indeterm(FlyString const& command); WebIDL::ExceptionOr query_command_state(FlyString const& command); WebIDL::ExceptionOr query_command_supported(FlyString const& command); WebIDL::ExceptionOr query_command_value(FlyString const& command); // https://w3c.github.io/selection-api/#dfn-has-scheduled-selectionchange-event bool has_scheduled_selectionchange_event() const { return m_has_scheduled_selectionchange_event; } void set_scheduled_selectionchange_event(bool value) { m_has_scheduled_selectionchange_event = value; } bool is_allowed_to_use_feature(PolicyControlledFeature) const; void did_stop_being_active_document_in_navigable(); String dump_accessibility_tree_as_json(); void make_active(); void set_salvageable(bool value) { m_salvageable = value; } void make_unsalvageable(String reason); HTML::ListOfAvailableImages& list_of_available_images(); HTML::ListOfAvailableImages const& list_of_available_images() const; void register_intersection_observer(Badge, IntersectionObserver::IntersectionObserver&); void unregister_intersection_observer(Badge, IntersectionObserver::IntersectionObserver&); void register_resize_observer(Badge, ResizeObserver::ResizeObserver&); void unregister_resize_observer(Badge, ResizeObserver::ResizeObserver&); void run_the_update_intersection_observations_steps(HighResolutionTime::DOMHighResTimeStamp time); void start_intersection_observing_a_lazy_loading_element(Element&); void stop_intersection_observing_a_lazy_loading_element(Element&); void shared_declarative_refresh_steps(StringView input, GC::Ptr meta_element = nullptr); struct TopOfTheDocument { }; using IndicatedPart = Variant; IndicatedPart determine_the_indicated_part() const; u32 unload_counter() const { return m_unload_counter; } GC::Ref snapshot_source_snapshot_params() const; void update_for_history_step_application(GC::Ref, bool do_not_reactivate, size_t script_history_length, size_t script_history_index, Optional navigation_type, Optional>> entries_for_navigation_api = {}, GC::Ptr previous_entry_for_activation = {}, bool update_navigation_api = true); HashMap>& shared_resource_requests(); void restore_the_history_object_state(GC::Ref entry); GC::Ref timeline(); auto const& last_animation_frame_timestamp() const { return m_last_animation_frame_timestamp; } void associate_with_timeline(GC::Ref); void disassociate_with_timeline(GC::Ref); struct PendingAnimationEvent { GC::Ref event; GC::Ref animation; GC::Ref target; Optional scheduled_event_time; }; void append_pending_animation_event(PendingAnimationEvent const&); void update_animations_and_send_events(Optional const& timestamp); void remove_replaced_animations(); WebIDL::ExceptionOr>> get_animations(); bool ready_to_run_scripts() const { return m_ready_to_run_scripts; } void set_ready_to_run_scripts() { m_ready_to_run_scripts = true; } GC::Ptr latest_entry() const { return m_latest_entry; } void set_latest_entry(GC::Ptr e) { m_latest_entry = e; } void element_id_changed(Badge, GC::Ref element, Optional old_id); void element_with_id_was_added(Badge, GC::Ref element); void element_with_id_was_removed(Badge, GC::Ref element); void element_name_changed(Badge, GC::Ref element); void element_with_name_was_added(Badge, GC::Ref element); void element_with_name_was_removed(Badge, GC::Ref element); void add_form_associated_element_with_form_attribute(HTML::FormAssociatedElement&); void remove_form_associated_element_with_form_attribute(HTML::FormAssociatedElement&); bool design_mode_enabled_state() const { return m_design_mode_enabled; } void set_design_mode_enabled_state(bool); String design_mode() const; WebIDL::ExceptionOr set_design_mode(String const&); Element const* element_from_point(double x, double y); GC::RootVector> elements_from_point(double x, double y); GC::Ptr scrolling_element() const; void set_needs_to_resolve_paint_only_properties() { m_needs_to_resolve_paint_only_properties = true; } void set_needs_animated_style_update() { m_needs_animated_style_update = true; } virtual JS::Value named_item_value(FlyString const& name) const override; virtual Vector supported_property_names() const override; Vector> const& potentially_named_elements() const { return m_potentially_named_elements; } void gather_active_observations_at_depth(size_t depth); [[nodiscard]] size_t broadcast_active_resize_observations(); [[nodiscard]] bool has_active_resize_observations(); [[nodiscard]] bool has_skipped_resize_observations(); GC::Ref adopted_style_sheets() const; WebIDL::ExceptionOr set_adopted_style_sheets(JS::Value); void register_shadow_root(Badge, DOM::ShadowRoot&); void unregister_shadow_root(Badge, DOM::ShadowRoot&); void for_each_shadow_root(Function&& callback); void for_each_shadow_root(Function&& callback) const; void add_an_element_to_the_top_layer(GC::Ref); void request_an_element_to_be_remove_from_the_top_layer(GC::Ref); void remove_an_element_from_the_top_layer_immediately(GC::Ref); void process_top_layer_removals(); OrderedHashTable> const& top_layer_elements() const { return m_top_layer_elements; } // AD-HOC: These lists are managed dynamically instead of being generated as needed. // Spec issue: https://github.com/whatwg/html/issues/11007 Vector>& showing_auto_popover_list() { return m_showing_auto_popover_list; } Vector>& showing_hint_popover_list() { return m_showing_hint_popover_list; } Vector> const& showing_auto_popover_list() const { return m_showing_auto_popover_list; } Vector> const& showing_hint_popover_list() const { return m_showing_hint_popover_list; } size_t transition_generation() const { return m_transition_generation; } // Does document represent an embedded svg img [[nodiscard]] bool is_decoded_svg() const; Vector> find_matching_text(String const&, CaseSensitivity); void parse_html_from_a_string(StringView); static GC::Ref parse_html_unsafe(JS::VM&, StringView); void set_console_client(GC::Ptr console_client) { m_console_client = console_client; } GC::Ptr console_client() const { return m_console_client; } InputEventsTarget* active_input_events_target(); GC::Ptr cursor_position() const; bool cursor_blink_state() const { return m_cursor_blink_state; } // Cached pointer to the last known node navigable. // If this document is currently the "active document" of the cached navigable, the cache is still valid. GC::Ptr cached_navigable(); void set_cached_navigable(GC::Ptr); void set_needs_display(InvalidateDisplayList = InvalidateDisplayList::Yes); void set_needs_display(CSSPixelRect const&, InvalidateDisplayList = InvalidateDisplayList::Yes); struct PaintConfig { bool paint_overlay { false }; bool should_show_line_box_borders { false }; bool has_focus { false }; Optional canvas_fill_rect {}; bool operator==(PaintConfig const& other) const = default; }; RefPtr record_display_list(PaintConfig); void invalidate_display_list(); Unicode::Segmenter& grapheme_segmenter() const; Unicode::Segmenter& word_segmenter() const; struct StepsToFireBeforeunloadResult { bool unload_prompt_shown { false }; bool unload_prompt_canceled { false }; }; StepsToFireBeforeunloadResult steps_to_fire_beforeunload(bool unload_prompt_shown); [[nodiscard]] WebIDL::CallbackType* onreadystatechange(); void set_onreadystatechange(WebIDL::CallbackType*); [[nodiscard]] WebIDL::CallbackType* onvisibilitychange(); void set_onvisibilitychange(WebIDL::CallbackType*); void reset_cursor_blink_cycle(); GC::Ref editing_host_manager() const { return *m_editing_host_manager; } // // https://w3c.github.io/editing/docs/execCommand/#default-single-line-container-name FlyString const& default_single_line_container_name() const { return m_default_single_line_container_name; } void set_default_single_line_container_name(FlyString const& name) { m_default_single_line_container_name = name; } // https://w3c.github.io/editing/docs/execCommand/#css-styling-flag bool css_styling_flag() const { return m_css_styling_flag; } void set_css_styling_flag(bool flag) { m_css_styling_flag = flag; } // https://w3c.github.io/editing/docs/execCommand/#state-override Optional command_state_override(FlyString const& command) const { return m_command_state_override.get(command); } void set_command_state_override(FlyString const& command, bool state) { m_command_state_override.set(command, state); } void clear_command_state_override(FlyString const& command) { m_command_state_override.remove(command); } void reset_command_state_overrides() { m_command_state_override.clear(); } // https://w3c.github.io/editing/docs/execCommand/#value-override Optional command_value_override(FlyString const& command) const { return m_command_value_override.get(command); } void set_command_value_override(FlyString const& command, String const& value); void clear_command_value_override(FlyString const& command); void reset_command_value_overrides() { m_command_value_override.clear(); } GC::Ptr container_document() const; GC::Ptr session_storage_holder() { return m_session_storage_holder; } void set_session_storage_holder(GC::Ptr storage) { m_session_storage_holder = storage; } GC::Ptr local_storage_holder() { return m_local_storage_holder; } void set_local_storage_holder(GC::Ptr storage) { m_local_storage_holder = storage; } // https:// html.spec.whatwg.org/multipage/dom.html#render-blocked [[nodiscard]] bool is_render_blocked() const; // https://html.spec.whatwg.org/multipage/dom.html#allows-adding-render-blocking-elements [[nodiscard]] bool allows_adding_render_blocking_elements() const; [[nodiscard]] bool is_render_blocking_element(GC::Ref) const; void add_render_blocking_element(GC::Ref); void remove_render_blocking_element(GC::Ref); void schedule_ancestors_style_invalidation_due_to_presence_of_has(Node& node) { m_pending_nodes_for_style_invalidation_due_to_presence_of_has.set(node.make_weak_ptr()); } ElementByIdMap& element_by_id() const; auto& script_blocking_style_sheet_set() { return m_script_blocking_style_sheet_set; } auto const& script_blocking_style_sheet_set() const { return m_script_blocking_style_sheet_set; } protected: virtual void initialize(JS::Realm&) override; virtual void visit_edges(Cell::Visitor&) override; Document(JS::Realm&, URL::URL const&, TemporaryDocumentForFragmentParsing = TemporaryDocumentForFragmentParsing::No); private: // ^HTML::GlobalEventHandlers virtual GC::Ptr global_event_handlers_to_event_target(FlyString const&) final { return *this; } void invalidate_style_of_elements_affected_by_has(); void tear_down_layout_tree(); void update_active_element(); void run_unloading_cleanup_steps(); void evaluate_media_rules(); enum class AddLineFeed { Yes, No, }; WebIDL::ExceptionOr run_the_document_write_steps(Vector const& text, AddLineFeed line_feed, TrustedTypes::InjectionSink sink); void queue_intersection_observer_task(); void queue_an_intersection_observer_entry(IntersectionObserver::IntersectionObserver&, HighResolutionTime::DOMHighResTimeStamp time, GC::Ref root_bounds, GC::Ref bounding_client_rect, GC::Ref intersection_rect, bool is_intersecting, double intersection_ratio, GC::Ref target); Element* find_a_potential_indicated_element(FlyString const& fragment) const; void dispatch_events_for_transition(GC::Ref); void dispatch_events_for_animation_if_necessary(GC::Ref); template void notify_each_document_observer(GetNotifier&& get_notifier, Args&&... args) { ScopeGuard guard { [&]() { m_document_observers_being_notified.clear_with_capacity(); } }; m_document_observers_being_notified.ensure_capacity(m_document_observers.size()); for (auto observer : m_document_observers) m_document_observers_being_notified.unchecked_append(observer); for (auto document_observer : m_document_observers_being_notified) { if (auto notifier = get_notifier(*document_observer)) notifier->function()(forward(args)...); } } void run_csp_initialization() const; GC::Ref m_page; OwnPtr m_style_computer; GC::Ptr m_style_sheets; GC::Ptr m_active_favicon; WeakPtr m_browsing_context; URL::URL m_url; mutable OwnPtr m_element_by_id; GC::Ptr m_window; GC::Ptr m_layout_root; GC::Ptr m_hovered_node; GC::Ptr m_inspected_node; GC::Ptr m_highlighted_node; Optional m_highlighted_pseudo_element; Optional m_normal_link_color; Optional m_active_link_color; Optional m_visited_link_color; Optional> m_supported_color_schemes; GC::Ptr m_parser; bool m_active_parser_was_aborted { false }; bool m_has_been_destroyed { false }; String m_source; GC::Ptr m_pending_parsing_blocking_script; Vector> m_scripts_to_execute_when_parsing_has_finished; // https://html.spec.whatwg.org/multipage/scripting.html#list-of-scripts-that-will-execute-in-order-as-soon-as-possible Vector> m_scripts_to_execute_in_order_as_soon_as_possible; // https://html.spec.whatwg.org/multipage/scripting.html#set-of-scripts-that-will-execute-as-soon-as-possible Vector> m_scripts_to_execute_as_soon_as_possible; QuirksMode m_quirks_mode { QuirksMode::No }; // https://dom.spec.whatwg.org/#concept-document-type Type m_type { Type::XML }; bool m_editable { false }; GC::Ptr m_focused_element; GC::Ptr m_active_element; GC::Ptr m_target_element; bool m_created_for_appropriate_template_contents { false }; GC::Ptr m_associated_inert_template_document; GC::Ptr m_appropriate_template_contents_owner_document; // https://html.spec.whatwg.org/multipage/dom.html#current-document-readiness // Each Document has a current document readiness, a string, initially "complete". // Spec Note: For Document objects created via the create and initialize a Document object algorithm, this will be // immediately reset to "loading" before any script can observe the value of document.readyState. // This default applies to other cases such as initial about:blank Documents or Documents without a // browsing context. HTML::DocumentReadyState m_readiness { HTML::DocumentReadyState::Complete }; String m_content_type { "application/xml"_string }; Optional m_pragma_set_default_language; Optional m_http_content_language; Optional m_encoding; bool m_ready_for_post_load_tasks { false }; GC::Ptr m_implementation; GC::Ptr m_current_script; bool m_should_invalidate_styles_on_attribute_changes { true }; u32 m_ignore_destructive_writes_counter { 0 }; // https://html.spec.whatwg.org/multipage/browsing-the-web.html#unload-counter u32 m_unload_counter { 0 }; // https://html.spec.whatwg.org/multipage/dynamic-markup-insertion.html#throw-on-dynamic-markup-insertion-counter u32 m_throw_on_dynamic_markup_insertion_counter { 0 }; // https://html.spec.whatwg.org/multipage/semantics.html#script-blocking-style-sheet-set HashTable> m_script_blocking_style_sheet_set; GC::Ptr m_history; size_t m_number_of_things_delaying_the_load_event { 0 }; // https://html.spec.whatwg.org/multipage/browsing-the-web.html#concept-document-salvageable bool m_salvageable { true }; // https://html.spec.whatwg.org/multipage/document-lifecycle.html#page-showing bool m_page_showing { false }; // Used by run_the_resize_steps(). Optional m_last_viewport_size; HashTable m_viewport_clients; // https://w3c.github.io/csswg-drafts/cssom-view-1/#document-pending-scroll-event-targets Vector> m_pending_scroll_event_targets; // https://w3c.github.io/csswg-drafts/cssom-view-1/#document-pending-scrollend-event-targets Vector> m_pending_scrollend_event_targets; // Used by evaluate_media_queries_and_report_changes(). Vector> m_media_query_lists; bool m_needs_full_style_update { false }; bool m_needs_full_layout_tree_update { false }; bool m_needs_animated_style_update { false }; HashTable> m_node_iterators; HashTable> m_document_observers; Vector> m_document_observers_being_notified; // https://html.spec.whatwg.org/multipage/dom.html#is-initial-about:blank bool m_is_initial_about_blank { false }; // https://html.spec.whatwg.org/multipage/dom.html#concept-document-about-base-url Optional m_about_base_url; // https://html.spec.whatwg.org/multipage/dom.html#concept-document-coop HTML::OpenerPolicy m_opener_policy; // https://html.spec.whatwg.org/multipage/dom.html#the-document's-referrer String m_referrer; // https://dom.spec.whatwg.org/#concept-document-origin URL::Origin m_origin; GC::Ptr m_applets; GC::Ptr m_anchors; GC::Ptr m_images; GC::Ptr m_embeds; GC::Ptr m_links; GC::Ptr m_forms; GC::Ptr m_scripts; GC::Ptr m_all; // https://drafts.csswg.org/css-font-loading/#font-source GC::Ptr m_fonts; // https://html.spec.whatwg.org/multipage/document-lifecycle.html#completely-loaded-time Optional m_completely_loaded_time; // https://html.spec.whatwg.org/multipage/dom.html#concept-document-navigation-id Optional m_navigation_id; // https://html.spec.whatwg.org/multipage/origin.html#active-sandboxing-flag-set HTML::SandboxingFlagSet m_active_sandboxing_flag_set; // https://html.spec.whatwg.org/multipage/dom.html#concept-document-policy-container mutable GC::Ptr m_policy_container; // https://html.spec.whatwg.org/multipage/interaction.html#visibility-state HTML::VisibilityState m_visibility_state { HTML::VisibilityState::Hidden }; // https://html.spec.whatwg.org/multipage/dom.html#load-timing-info DocumentLoadTimingInfo m_load_timing_info; // https://html.spec.whatwg.org/multipage/dom.html#previous-document-unload-timing DocumentUnloadTimingInfo m_previous_document_unload_timing; // https://w3c.github.io/selection-api/#dfn-selection GC::Ptr m_selection; // NOTE: This is a cache to make finding the first or element O(1). GC::Ptr m_first_base_element_with_href_in_tree_order; GC::Ptr m_first_base_element_with_target_in_tree_order; // https://html.spec.whatwg.org/multipage/images.html#list-of-available-images GC::Ptr m_list_of_available_images; GC::Ptr m_visual_viewport; // NOTE: Not in the spec per se, but Document must be able to access all IntersectionObservers whose root is in the document. IGNORE_GC OrderedHashTable> m_intersection_observers; // https://www.w3.org/TR/intersection-observer/#document-intersectionobservertaskqueued // Each document has an IntersectionObserverTaskQueued flag which is initialized to false. bool m_intersection_observer_task_queued { false }; // https://html.spec.whatwg.org/multipage/urls-and-fetching.html#lazy-load-intersection-observer // Each Document has a lazy load intersection observer, initially set to null but can be set to an IntersectionObserver instance. GC::Ptr m_lazy_load_intersection_observer; Vector> m_resize_observers; // https://html.spec.whatwg.org/multipage/semantics.html#will-declaratively-refresh // A Document object has an associated will declaratively refresh (a boolean). It is initially false. bool m_will_declaratively_refresh { false }; RefPtr m_active_refresh_timer; TemporaryDocumentForFragmentParsing m_temporary_document_for_fragment_parsing { TemporaryDocumentForFragmentParsing::No }; // https://html.spec.whatwg.org/multipage/browsing-the-web.html#latest-entry GC::Ptr m_latest_entry; HashMap> m_shared_resource_requests; // https://www.w3.org/TR/web-animations-1/#timeline-associated-with-a-document HashTable> m_associated_animation_timelines; // https://www.w3.org/TR/web-animations-1/#document-default-document-timeline GC::Ptr m_default_timeline; Optional m_last_animation_frame_timestamp; // https://www.w3.org/TR/web-animations-1/#pending-animation-event-queue Vector m_pending_animation_event_queue; RefPtr m_animation_driver_timer; // https://drafts.csswg.org/css-transitions-2/#current-transition-generation size_t m_transition_generation { 0 }; bool m_needs_to_call_page_did_load { false }; // https://html.spec.whatwg.org/multipage/browsing-the-web.html#scripts-may-run-for-the-newly-created-document bool m_ready_to_run_scripts { false }; Vector m_form_associated_elements_with_form_attribute; Vector> m_potentially_named_elements; bool m_design_mode_enabled { false }; bool m_needs_to_resolve_paint_only_properties { true }; mutable GC::Ptr m_adopted_style_sheets; ShadowRoot::DocumentShadowRootList m_shadow_roots; Optional m_last_modified; u64 m_dom_tree_version { 0 }; u64 m_character_data_version { 0 }; // https://drafts.csswg.org/css-position-4/#document-top-layer // Documents have a top layer, an ordered set containing elements from the document. // Elements in the top layer do not lay out normally based on their position in the document; // instead they generate boxes as if they were siblings of the root element. OrderedHashTable> m_top_layer_elements; OrderedHashTable> m_top_layer_pending_removals; Vector> m_showing_auto_popover_list; Vector> m_showing_hint_popover_list; // https://dom.spec.whatwg.org/#document-allow-declarative-shadow-roots bool m_allow_declarative_shadow_roots { false }; // https://w3c.github.io/selection-api/#dfn-has-scheduled-selectionchange-event bool m_has_scheduled_selectionchange_event { false }; GC::Ptr m_console_client; RefPtr m_cursor_blink_timer; bool m_cursor_blink_state { false }; // NOTE: This is WeakPtr, not GCPtr, on purpose. We don't want the document to keep some old detached navigable alive. WeakPtr m_cached_navigable; bool m_enable_cookies_on_file_domains { false }; Optional m_cached_display_list_paint_config; RefPtr m_cached_display_list; mutable OwnPtr m_grapheme_segmenter; mutable OwnPtr m_word_segmenter; GC::Ref m_editing_host_manager; bool m_inside_exec_command { false }; // https://w3c.github.io/editing/docs/execCommand/#default-single-line-container-name FlyString m_default_single_line_container_name { HTML::TagNames::div }; // https://w3c.github.io/editing/docs/execCommand/#css-styling-flag bool m_css_styling_flag { false }; // https://w3c.github.io/editing/docs/execCommand/#state-override HashMap m_command_state_override; // https://w3c.github.io/editing/docs/execCommand/#value-override HashMap m_command_value_override; // https://html.spec.whatwg.org/multipage/webstorage.html#session-storage-holder // A Document object has an associated session storage holder, which is null or a Storage object. It is initially null. GC::Ptr m_session_storage_holder; // https://html.spec.whatwg.org/multipage/webstorage.html#local-storage-holder // A Document object has an associated local storage holder, which is null or a Storage object. It is initially null. GC::Ptr m_local_storage_holder; // https://html.spec.whatwg.org/multipage/dom.html#render-blocking-element-set HashTable> m_render_blocking_elements; HashTable> m_pending_nodes_for_style_invalidation_due_to_presence_of_has; }; template<> inline bool Node::fast_is() const { return is_document(); } }