/* * Copyright (c) 2018-2023, 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 #include #include #include #include #include #include #include #include #include namespace Web::DOM { enum class QuirksMode { No, Limited, Yes }; // 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 double dom_interactive_time { 0 }; // https://html.spec.whatwg.org/multipage/dom.html#dom-content-loaded-event-start-time double dom_content_loaded_event_start_time { 0 }; // https://html.spec.whatwg.org/multipage/dom.html#dom-content-loaded-event-end-time double dom_content_loaded_event_end_time { 0 }; // https://html.spec.whatwg.org/multipage/dom.html#dom-complete-time double dom_complete_time { 0 }; // https://html.spec.whatwg.org/multipage/dom.html#load-event-start-time double load_event_start_time { 0 }; // https://html.spec.whatwg.org/multipage/dom.html#load-event-end-time double 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 { DeprecatedString is; }; class Document : public ParentNode , public NonElementParentNode , public HTML::GlobalEventHandlers { WEB_PLATFORM_OBJECT(Document, ParentNode); public: enum class Type { XML, HTML }; static WebIDL::ExceptionOr> create_and_initialize(Type, DeprecatedString content_type, HTML::NavigationParams); static WebIDL::ExceptionOr> create(JS::Realm&, AK::URL const& url = "about:blank"sv); static WebIDL::ExceptionOr> construct_impl(JS::Realm&); virtual ~Document() override; JS::GCPtr get_selection() const; size_t next_layout_node_serial_id(Badge) { return m_next_layout_node_serial_id++; } size_t layout_node_count() const { return m_next_layout_node_serial_id; } DeprecatedString cookie(Cookie::Source = Cookie::Source::NonHttp); void set_cookie(DeprecatedString const&, Cookie::Source = Cookie::Source::NonHttp); DeprecatedString referrer() const; void set_referrer(DeprecatedString); void set_url(const AK::URL& url) { m_url = url; } AK::URL url() const { return m_url; } AK::URL fallback_base_url() const; AK::URL base_url() const; void update_base_element(Badge); JS::GCPtr first_base_element_with_href_in_tree_order() const; DeprecatedString url_string() const { return m_url.to_deprecated_string(); } DeprecatedString document_uri() const { return m_url.to_deprecated_string(); } HTML::Origin origin() const; void set_origin(HTML::Origin const& origin); HTML::CrossOriginOpenerPolicy const& cross_origin_opener_policy() const { return m_cross_origin_opener_policy; } void set_cross_origin_opener_policy(HTML::CrossOriginOpenerPolicy policy) { m_cross_origin_opener_policy = move(policy); } AK::URL parse_url(DeprecatedString const&) 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; CSS::StyleSheetList* style_sheets_for_bindings() { return &style_sheets(); } virtual DeprecatedFlyString node_name() const override { return "#document"; } void set_hovered_node(Node*); Node* hovered_node() { return m_hovered_node.ptr(); } Node const* hovered_node() const { return m_hovered_node.ptr(); } void set_inspected_node(Node*); Node* inspected_node() { return m_inspected_node.ptr(); } Node const* inspected_node() const { return m_inspected_node.ptr(); } Element* document_element(); Element const* document_element() const; HTML::HTMLHtmlElement* html_element(); HTML::HTMLHeadElement* head(); HTML::HTMLElement* body(); const HTML::HTMLHtmlElement* html_element() const { return const_cast(this)->html_element(); } const HTML::HTMLHeadElement* head() const { return const_cast(this)->head(); } const HTML::HTMLElement* body() const { return const_cast(this)->body(); } WebIDL::ExceptionOr set_body(HTML::HTMLElement* new_body); DeprecatedString title() const; void set_title(DeprecatedString 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(Gfx::Palette const&) const; Vector const* background_layers() const; Color link_color() const; void set_link_color(Color); Color active_link_color() const; void set_active_link_color(Color); Color visited_link_color() const; void set_visited_link_color(Color); void force_layout(); void update_style(); void update_layout(); void set_needs_layout(); void invalidate_layout(); void invalidate_stacking_context_tree(); virtual bool is_child_allowed(Node const&) const override; Layout::Viewport const* layout_node() const; Layout::Viewport* layout_node(); void schedule_style_update(); void schedule_layout_update(); JS::NonnullGCPtr get_elements_by_name(DeprecatedString const&); JS::NonnullGCPtr get_elements_by_class_name(DeprecatedFlyString const&); JS::NonnullGCPtr applets(); JS::NonnullGCPtr anchors(); JS::NonnullGCPtr images(); JS::NonnullGCPtr embeds(); JS::NonnullGCPtr plugins(); JS::NonnullGCPtr links(); JS::NonnullGCPtr forms(); JS::NonnullGCPtr scripts(); JS::NonnullGCPtr all(); DeprecatedString const& source() const { return m_source; } void set_source(DeprecatedString source) { m_source = move(source); } HTML::EnvironmentSettingsObject& relevant_settings_object(); JS::Value run_javascript(StringView source, StringView filename = "(unknown)"sv); WebIDL::ExceptionOr> create_element(DeprecatedString const& local_name, Variant const& options); WebIDL::ExceptionOr> create_element_ns(DeprecatedString const& namespace_, DeprecatedString const& qualified_name, Variant const& options); JS::NonnullGCPtr create_document_fragment(); JS::NonnullGCPtr create_text_node(DeprecatedString const& data); JS::NonnullGCPtr create_comment(DeprecatedString const& data); WebIDL::ExceptionOr> create_processing_instruction(DeprecatedString const& target, DeprecatedString const& data); WebIDL::ExceptionOr> create_attribute(DeprecatedString const& local_name); WebIDL::ExceptionOr> create_attribute_ns(DeprecatedString const& namespace_, DeprecatedString const& qualified_name); WebIDL::ExceptionOr> create_event(DeprecatedString const& interface); JS::NonnullGCPtr create_range(); void set_pending_parsing_blocking_script(Badge, HTML::HTMLScriptElement*); HTML::HTMLScriptElement* pending_parsing_blocking_script() { return m_pending_parsing_blocking_script.ptr(); } JS::NonnullGCPtr 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; } 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(JS::NonnullGCPtr node, bool deep); void adopt_node(Node&); WebIDL::ExceptionOr> adopt_node_binding(JS::NonnullGCPtr); DocumentType const* doctype() const; DeprecatedString const& compat_mode() const; void set_editable(bool editable) { m_editable = editable; } virtual bool is_editable() const final; Element* focused_element() { return m_focused_element.ptr(); } Element const* focused_element() const { return m_focused_element.ptr(); } void set_focused_element(Element*); Element const* active_element() const { return m_active_element.ptr(); } void set_active_element(Element*); bool created_for_appropriate_template_contents() const { return m_created_for_appropriate_template_contents; } JS::NonnullGCPtr appropriate_template_contents_owner_document(); DeprecatedString ready_state() const; HTML::DocumentReadyState readiness() const { return m_readiness; }; void update_readiness(HTML::DocumentReadyState); HTML::Window& window() const { return const_cast(*m_window); } void set_window(Badge, HTML::Window&); WebIDL::ExceptionOr write(Vector const& strings); WebIDL::ExceptionOr writeln(Vector const& strings); WebIDL::ExceptionOr open(DeprecatedString const& = "", DeprecatedString const& = ""); WebIDL::ExceptionOr> open(DeprecatedString const& url, DeprecatedString const& name, DeprecatedString const& features); WebIDL::ExceptionOr close(); HTML::Window* default_view() { return m_window.ptr(); } HTML::Window const* default_view() const { return m_window.ptr(); } DeprecatedString const& content_type() const { return m_content_type; } void set_content_type(DeprecatedString const& content_type) { m_content_type = content_type; } bool has_encoding() const { return m_encoding.has_value(); } Optional const& encoding() const { return m_encoding; } DeprecatedString encoding_or_default() const { return m_encoding.value_or("UTF-8"); } void set_encoding(Optional const& encoding) { m_encoding = encoding; } // NOTE: These are intended for the JS bindings DeprecatedString character_set() const { return encoding_or_default(); } DeprecatedString charset() const { return encoding_or_default(); } DeprecatedString 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(); JS::GCPtr current_script() const { return m_current_script.ptr(); } void set_current_script(Badge, JS::GCPtr 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; DeprecatedString dump_dom_tree_as_json() const; bool has_a_style_sheet_that_is_blocking_scripts() const; bool is_fully_active() const; bool is_active() const; JS::NonnullGCPtr history(); JS::NonnullGCPtr history() const; WebIDL::ExceptionOr> location(); size_t number_of_things_delaying_the_load_event() { return m_number_of_things_delaying_the_load_event; } 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 value) { m_page_showing = value; } bool hidden() const; DeprecatedString visibility_state() const; // 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(JS::NonnullGCPtr); bool has_focus() const; void set_parser(Badge, HTML::HTMLParser&); void detach_parser(Badge); static bool is_valid_name(DeprecatedString const&); struct PrefixAndTagName { DeprecatedFlyString prefix; DeprecatedFlyString tag_name; }; static WebIDL::ExceptionOr validate_qualified_name(JS::Realm&, DeprecatedString const& qualified_name); JS::NonnullGCPtr create_node_iterator(Node& root, unsigned what_to_show, JS::GCPtr); JS::NonnullGCPtr create_tree_walker(Node& root, unsigned what_to_show, JS::GCPtr); void register_node_iterator(Badge, NodeIterator&); void unregister_node_iterator(Badge, NodeIterator&); 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; } bool has_active_favicon() const { return m_active_favicon; } void check_favicon_after_loading_link_resource(); JS::GCPtr lookup_custom_element_definition(DeprecatedFlyString const& namespace_, DeprecatedFlyString 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; } DeprecatedString domain() const; void set_domain(DeprecatedString const& domain); 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/#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; // https://html.spec.whatwg.org/multipage/dom.html#concept-document-policy-container HTML::PolicyContainer policy_container() const; // https://html.spec.whatwg.org/multipage/browsers.html#list-of-the-descendant-browsing-contexts Vector> list_of_descendant_browsing_contexts() const; // https://html.spec.whatwg.org/multipage/window-object.html#discard-a-document void discard(); // https://html.spec.whatwg.org/multipage/browsing-the-web.html#abort-a-document void abort(); // https://html.spec.whatwg.org/multipage/browsing-the-web.html#unload-a-document void unload(bool recursive_flag = false, Optional = {}); // https://html.spec.whatwg.org/multipage/dom.html#active-parser JS::GCPtr 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; } void did_stop_being_active_document_in_browsing_context(Badge); bool query_command_supported(DeprecatedString const&) const; DeprecatedString dump_accessibility_tree_as_json(); protected: virtual JS::ThrowCompletionOr initialize(JS::Realm&) override; virtual void visit_edges(Cell::Visitor&) override; private: Document(JS::Realm&, AK::URL const&); // ^HTML::GlobalEventHandlers virtual EventTarget& global_event_handlers_to_event_target(FlyString const&) final { return *this; } void tear_down_layout_tree(); void evaluate_media_rules(); WebIDL::ExceptionOr run_the_document_write_steps(DeprecatedString); size_t m_next_layout_node_serial_id { 0 }; OwnPtr m_style_computer; JS::GCPtr m_style_sheets; JS::GCPtr m_hovered_node; JS::GCPtr m_inspected_node; JS::GCPtr m_active_favicon; WeakPtr m_browsing_context; AK::URL m_url; JS::GCPtr m_window; JS::GCPtr m_layout_root; Optional m_link_color; Optional m_active_link_color; Optional m_visited_link_color; RefPtr m_style_update_timer; RefPtr m_layout_update_timer; JS::GCPtr m_parser; bool m_active_parser_was_aborted { false }; DeprecatedString m_source; JS::GCPtr 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::HTML }; bool m_editable { false }; JS::GCPtr m_focused_element; JS::GCPtr m_active_element; bool m_created_for_appropriate_template_contents { false }; JS::GCPtr m_associated_inert_template_document; JS::GCPtr m_appropriate_template_contents_owner_document; HTML::DocumentReadyState m_readiness { HTML::DocumentReadyState::Loading }; DeprecatedString m_content_type { "application/xml" }; Optional m_encoding; bool m_ready_for_post_load_tasks { false }; JS::GCPtr m_implementation; JS::GCPtr 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-counter u32 m_script_blocking_style_sheet_counter { 0 }; JS::GCPtr 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/#page-showing bool m_page_showing { false }; // Used by run_the_resize_steps(). Gfx::IntSize m_last_viewport_size; // 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_layout { false }; bool m_needs_full_style_update { false }; HashTable> m_node_iterators; // 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-coop HTML::CrossOriginOpenerPolicy m_cross_origin_opener_policy; // https://html.spec.whatwg.org/multipage/dom.html#the-document's-referrer DeprecatedString m_referrer { "" }; // https://dom.spec.whatwg.org/#concept-document-origin HTML::Origin m_origin; JS::GCPtr m_applets; JS::GCPtr m_anchors; JS::GCPtr m_images; JS::GCPtr m_embeds; JS::GCPtr m_links; JS::GCPtr m_forms; JS::GCPtr m_scripts; JS::GCPtr m_all; // https://html.spec.whatwg.org/#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 HTML::PolicyContainer 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 JS::GCPtr m_selection; // NOTE: This is a cache to make finding the first element O(1). JS::GCPtr m_first_base_element_with_href_in_tree_order; }; template<> inline bool Node::fast_is() const { return is_document(); } }