Document.h 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914
  1. /*
  2. * Copyright (c) 2018-2023, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2021-2023, Linus Groh <linusg@serenityos.org>
  4. * Copyright (c) 2023-2024, Shannon Booth <shannon@serenityos.org>
  5. *
  6. * SPDX-License-Identifier: BSD-2-Clause
  7. */
  8. #pragma once
  9. #include <AK/Function.h>
  10. #include <AK/HashMap.h>
  11. #include <AK/OwnPtr.h>
  12. #include <AK/String.h>
  13. #include <AK/Vector.h>
  14. #include <AK/WeakPtr.h>
  15. #include <LibCore/DateTime.h>
  16. #include <LibCore/Forward.h>
  17. #include <LibJS/Forward.h>
  18. #include <LibURL/URL.h>
  19. #include <LibWeb/CSS/CSSStyleSheet.h>
  20. #include <LibWeb/CSS/StyleSheetList.h>
  21. #include <LibWeb/Cookie/Cookie.h>
  22. #include <LibWeb/DOM/NonElementParentNode.h>
  23. #include <LibWeb/DOM/ParentNode.h>
  24. #include <LibWeb/HTML/BrowsingContext.h>
  25. #include <LibWeb/HTML/CrossOrigin/CrossOriginOpenerPolicy.h>
  26. #include <LibWeb/HTML/DocumentReadyState.h>
  27. #include <LibWeb/HTML/HTMLScriptElement.h>
  28. #include <LibWeb/HTML/History.h>
  29. #include <LibWeb/HTML/LazyLoadingElement.h>
  30. #include <LibWeb/HTML/Origin.h>
  31. #include <LibWeb/HTML/SandboxingFlagSet.h>
  32. #include <LibWeb/HTML/Scripting/Environments.h>
  33. #include <LibWeb/HTML/SharedImageRequest.h>
  34. #include <LibWeb/HTML/VisibilityState.h>
  35. #include <LibWeb/WebIDL/ExceptionOr.h>
  36. #include <LibWeb/WebIDL/ObservableArray.h>
  37. namespace Web::DOM {
  38. enum class QuirksMode {
  39. No,
  40. Limited,
  41. Yes
  42. };
  43. // https://html.spec.whatwg.org/multipage/dom.html#document-load-timing-info
  44. struct DocumentLoadTimingInfo {
  45. // https://html.spec.whatwg.org/multipage/dom.html#navigation-start-time
  46. double navigation_start_time { 0 };
  47. // https://html.spec.whatwg.org/multipage/dom.html#dom-interactive-time
  48. double dom_interactive_time { 0 };
  49. // https://html.spec.whatwg.org/multipage/dom.html#dom-content-loaded-event-start-time
  50. double dom_content_loaded_event_start_time { 0 };
  51. // https://html.spec.whatwg.org/multipage/dom.html#dom-content-loaded-event-end-time
  52. double dom_content_loaded_event_end_time { 0 };
  53. // https://html.spec.whatwg.org/multipage/dom.html#dom-complete-time
  54. double dom_complete_time { 0 };
  55. // https://html.spec.whatwg.org/multipage/dom.html#load-event-start-time
  56. double load_event_start_time { 0 };
  57. // https://html.spec.whatwg.org/multipage/dom.html#load-event-end-time
  58. double load_event_end_time { 0 };
  59. };
  60. // https://html.spec.whatwg.org/multipage/dom.html#document-unload-timing-info
  61. struct DocumentUnloadTimingInfo {
  62. // https://html.spec.whatwg.org/multipage/dom.html#unload-event-start-time
  63. double unload_event_start_time { 0 };
  64. // https://html.spec.whatwg.org/multipage/dom.html#unload-event-end-time
  65. double unload_event_end_time { 0 };
  66. };
  67. struct ElementCreationOptions {
  68. Optional<String> is;
  69. };
  70. enum class PolicyControlledFeature {
  71. Autoplay,
  72. };
  73. class Document
  74. : public ParentNode
  75. , public NonElementParentNode<Document>
  76. , public HTML::GlobalEventHandlers {
  77. WEB_PLATFORM_OBJECT(Document, ParentNode);
  78. JS_DECLARE_ALLOCATOR(Document);
  79. public:
  80. enum class Type {
  81. XML,
  82. HTML
  83. };
  84. static WebIDL::ExceptionOr<JS::NonnullGCPtr<Document>> create_and_initialize(Type, String content_type, HTML::NavigationParams const&);
  85. [[nodiscard]] static JS::NonnullGCPtr<Document> create(JS::Realm&, URL::URL const& url = "about:blank"sv);
  86. static WebIDL::ExceptionOr<JS::NonnullGCPtr<Document>> construct_impl(JS::Realm&);
  87. virtual ~Document() override;
  88. // AD-HOC: This number increments whenever a node is added or removed from the document, or an element attribute changes.
  89. // It can be used as a crude invalidation mechanism for caches that depend on the DOM structure.
  90. u64 dom_tree_version() const { return m_dom_tree_version; }
  91. void bump_dom_tree_version() { ++m_dom_tree_version; }
  92. WebIDL::ExceptionOr<void> populate_with_html_head_and_body();
  93. JS::GCPtr<Selection::Selection> get_selection() const;
  94. String cookie(Cookie::Source = Cookie::Source::NonHttp);
  95. void set_cookie(StringView, Cookie::Source = Cookie::Source::NonHttp);
  96. String fg_color() const;
  97. void set_fg_color(String const&);
  98. String link_color() const;
  99. void set_link_color(String const&);
  100. String vlink_color() const;
  101. void set_vlink_color(String const&);
  102. String alink_color() const;
  103. void set_alink_color(String const&);
  104. String bg_color() const;
  105. void set_bg_color(String const&);
  106. String referrer() const;
  107. void set_referrer(String);
  108. void set_url(const URL::URL& url) { m_url = url; }
  109. URL::URL url() const { return m_url; }
  110. URL::URL fallback_base_url() const;
  111. URL::URL base_url() const;
  112. void update_base_element(Badge<HTML::HTMLBaseElement>);
  113. JS::GCPtr<HTML::HTMLBaseElement const> first_base_element_with_href_in_tree_order() const;
  114. String url_string() const { return MUST(m_url.to_string()); }
  115. String document_uri() const { return url_string(); }
  116. HTML::Origin origin() const;
  117. void set_origin(HTML::Origin const& origin);
  118. HTML::CrossOriginOpenerPolicy const& cross_origin_opener_policy() const { return m_cross_origin_opener_policy; }
  119. void set_cross_origin_opener_policy(HTML::CrossOriginOpenerPolicy policy) { m_cross_origin_opener_policy = move(policy); }
  120. URL::URL parse_url(StringView) const;
  121. CSS::StyleComputer& style_computer() { return *m_style_computer; }
  122. const CSS::StyleComputer& style_computer() const { return *m_style_computer; }
  123. CSS::StyleSheetList& style_sheets();
  124. CSS::StyleSheetList const& style_sheets() const;
  125. void for_each_css_style_sheet(Function<void(CSS::CSSStyleSheet&)>&& callback) const;
  126. CSS::StyleSheetList* style_sheets_for_bindings() { return &style_sheets(); }
  127. virtual FlyString node_name() const override { return "#document"_fly_string; }
  128. void set_hovered_node(Node*);
  129. Node* hovered_node() { return m_hovered_node.ptr(); }
  130. Node const* hovered_node() const { return m_hovered_node.ptr(); }
  131. void set_inspected_node(Node*, Optional<CSS::Selector::PseudoElement::Type>);
  132. Node* inspected_node() { return m_inspected_node.ptr(); }
  133. Node const* inspected_node() const { return m_inspected_node.ptr(); }
  134. Layout::Node* inspected_layout_node();
  135. Layout::Node const* inspected_layout_node() const { return const_cast<Document*>(this)->inspected_layout_node(); }
  136. Element* document_element();
  137. Element const* document_element() const;
  138. HTML::HTMLHtmlElement* html_element();
  139. HTML::HTMLHeadElement* head();
  140. JS::GCPtr<HTML::HTMLTitleElement> title_element();
  141. HTML::HTMLElement* body();
  142. HTML::HTMLHtmlElement const* html_element() const
  143. {
  144. return const_cast<Document*>(this)->html_element();
  145. }
  146. HTML::HTMLHeadElement const* head() const
  147. {
  148. return const_cast<Document*>(this)->head();
  149. }
  150. JS::GCPtr<HTML::HTMLTitleElement const> title_element() const
  151. {
  152. return const_cast<Document*>(this)->title_element();
  153. }
  154. HTML::HTMLElement const* body() const
  155. {
  156. return const_cast<Document*>(this)->body();
  157. }
  158. WebIDL::ExceptionOr<void> set_body(HTML::HTMLElement* new_body);
  159. String title() const;
  160. WebIDL::ExceptionOr<void> set_title(String const&);
  161. HTML::BrowsingContext* browsing_context() { return m_browsing_context.ptr(); }
  162. HTML::BrowsingContext const* browsing_context() const { return m_browsing_context.ptr(); }
  163. void set_browsing_context(HTML::BrowsingContext*);
  164. Page& page();
  165. Page const& page() const;
  166. Color background_color() const;
  167. Vector<CSS::BackgroundLayerData> const* background_layers() const;
  168. Color normal_link_color() const;
  169. void set_normal_link_color(Color);
  170. Color active_link_color() const;
  171. void set_active_link_color(Color);
  172. Color visited_link_color() const;
  173. void set_visited_link_color(Color);
  174. void update_style();
  175. void update_layout();
  176. void update_paint_and_hit_testing_properties_if_needed();
  177. void update_animated_style_if_needed();
  178. void set_needs_layout();
  179. void invalidate_layout();
  180. void invalidate_stacking_context_tree();
  181. virtual bool is_child_allowed(Node const&) const override;
  182. Layout::Viewport const* layout_node() const;
  183. Layout::Viewport* layout_node();
  184. Painting::ViewportPaintable const* paintable() const;
  185. Painting::ViewportPaintable* paintable();
  186. void schedule_style_update();
  187. void schedule_layout_update();
  188. JS::NonnullGCPtr<HTMLCollection> get_elements_by_name(FlyString const&);
  189. JS::NonnullGCPtr<HTMLCollection> get_elements_by_class_name(StringView);
  190. JS::NonnullGCPtr<HTMLCollection> applets();
  191. JS::NonnullGCPtr<HTMLCollection> anchors();
  192. JS::NonnullGCPtr<HTMLCollection> images();
  193. JS::NonnullGCPtr<HTMLCollection> embeds();
  194. JS::NonnullGCPtr<HTMLCollection> plugins();
  195. JS::NonnullGCPtr<HTMLCollection> links();
  196. JS::NonnullGCPtr<HTMLCollection> forms();
  197. JS::NonnullGCPtr<HTMLCollection> scripts();
  198. JS::NonnullGCPtr<HTML::HTMLAllCollection> all();
  199. void clear();
  200. void capture_events();
  201. void release_events();
  202. String const& source() const { return m_source; }
  203. void set_source(String source) { m_source = move(source); }
  204. HTML::EnvironmentSettingsObject& relevant_settings_object() const;
  205. WebIDL::ExceptionOr<JS::NonnullGCPtr<Element>> create_element(String const& local_name, Variant<String, ElementCreationOptions> const& options);
  206. WebIDL::ExceptionOr<JS::NonnullGCPtr<Element>> create_element_ns(Optional<FlyString> const& namespace_, String const& qualified_name, Variant<String, ElementCreationOptions> const& options);
  207. JS::NonnullGCPtr<DocumentFragment> create_document_fragment();
  208. JS::NonnullGCPtr<Text> create_text_node(String const& data);
  209. WebIDL::ExceptionOr<JS::NonnullGCPtr<CDATASection>> create_cdata_section(String const& data);
  210. JS::NonnullGCPtr<Comment> create_comment(String const& data);
  211. WebIDL::ExceptionOr<JS::NonnullGCPtr<ProcessingInstruction>> create_processing_instruction(String const& target, String const& data);
  212. WebIDL::ExceptionOr<JS::NonnullGCPtr<Attr>> create_attribute(String const& local_name);
  213. WebIDL::ExceptionOr<JS::NonnullGCPtr<Attr>> create_attribute_ns(Optional<FlyString> const& namespace_, String const& qualified_name);
  214. WebIDL::ExceptionOr<JS::NonnullGCPtr<Event>> create_event(StringView interface);
  215. JS::NonnullGCPtr<Range> create_range();
  216. void set_pending_parsing_blocking_script(Badge<HTML::HTMLScriptElement>, HTML::HTMLScriptElement*);
  217. HTML::HTMLScriptElement* pending_parsing_blocking_script() { return m_pending_parsing_blocking_script.ptr(); }
  218. JS::NonnullGCPtr<HTML::HTMLScriptElement> take_pending_parsing_blocking_script(Badge<HTML::HTMLParser>);
  219. void add_script_to_execute_when_parsing_has_finished(Badge<HTML::HTMLScriptElement>, HTML::HTMLScriptElement&);
  220. Vector<JS::Handle<HTML::HTMLScriptElement>> take_scripts_to_execute_when_parsing_has_finished(Badge<HTML::HTMLParser>);
  221. Vector<JS::NonnullGCPtr<HTML::HTMLScriptElement>>& scripts_to_execute_when_parsing_has_finished() { return m_scripts_to_execute_when_parsing_has_finished; }
  222. void add_script_to_execute_as_soon_as_possible(Badge<HTML::HTMLScriptElement>, HTML::HTMLScriptElement&);
  223. Vector<JS::Handle<HTML::HTMLScriptElement>> take_scripts_to_execute_as_soon_as_possible(Badge<HTML::HTMLParser>);
  224. Vector<JS::NonnullGCPtr<HTML::HTMLScriptElement>>& scripts_to_execute_as_soon_as_possible() { return m_scripts_to_execute_as_soon_as_possible; }
  225. void add_script_to_execute_in_order_as_soon_as_possible(Badge<HTML::HTMLScriptElement>, HTML::HTMLScriptElement&);
  226. Vector<JS::Handle<HTML::HTMLScriptElement>> take_scripts_to_execute_in_order_as_soon_as_possible(Badge<HTML::HTMLParser>);
  227. Vector<JS::NonnullGCPtr<HTML::HTMLScriptElement>>& scripts_to_execute_in_order_as_soon_as_possible() { return m_scripts_to_execute_in_order_as_soon_as_possible; }
  228. QuirksMode mode() const { return m_quirks_mode; }
  229. bool in_quirks_mode() const { return m_quirks_mode == QuirksMode::Yes; }
  230. void set_quirks_mode(QuirksMode mode) { m_quirks_mode = mode; }
  231. Type document_type() const { return m_type; }
  232. void set_document_type(Type type) { m_type = type; }
  233. // https://dom.spec.whatwg.org/#html-document
  234. bool is_html_document() const { return m_type == Type::HTML; }
  235. // https://dom.spec.whatwg.org/#xml-document
  236. bool is_xml_document() const { return m_type == Type::XML; }
  237. WebIDL::ExceptionOr<JS::NonnullGCPtr<Node>> import_node(JS::NonnullGCPtr<Node> node, bool deep);
  238. void adopt_node(Node&);
  239. WebIDL::ExceptionOr<JS::NonnullGCPtr<Node>> adopt_node_binding(JS::NonnullGCPtr<Node>);
  240. DocumentType const* doctype() const;
  241. String const& compat_mode() const;
  242. void set_editable(bool editable) { m_editable = editable; }
  243. virtual bool is_editable() const final;
  244. Element* focused_element() { return m_focused_element.ptr(); }
  245. Element const* focused_element() const { return m_focused_element.ptr(); }
  246. void set_focused_element(Element*);
  247. Element const* active_element() const { return m_active_element.ptr(); }
  248. void set_active_element(Element*);
  249. Element const* target_element() const { return m_target_element.ptr(); }
  250. void set_target_element(Element*);
  251. void scroll_to_the_fragment();
  252. void scroll_to_the_beginning_of_the_document();
  253. bool created_for_appropriate_template_contents() const { return m_created_for_appropriate_template_contents; }
  254. JS::NonnullGCPtr<Document> appropriate_template_contents_owner_document();
  255. StringView ready_state() const;
  256. HTML::DocumentReadyState readiness() const { return m_readiness; }
  257. void update_readiness(HTML::DocumentReadyState);
  258. String last_modified() const;
  259. [[nodiscard]] JS::GCPtr<HTML::Window> window() const { return m_window; }
  260. void set_window(HTML::Window&);
  261. WebIDL::ExceptionOr<void> write(Vector<String> const& strings);
  262. WebIDL::ExceptionOr<void> writeln(Vector<String> const& strings);
  263. WebIDL::ExceptionOr<Document*> open(Optional<String> const& = {}, Optional<String> const& = {});
  264. WebIDL::ExceptionOr<JS::GCPtr<HTML::WindowProxy>> open(StringView url, StringView name, StringView features);
  265. WebIDL::ExceptionOr<void> close();
  266. HTML::Window* default_view() { return m_window.ptr(); }
  267. HTML::Window const* default_view() const { return m_window.ptr(); }
  268. String const& content_type() const { return m_content_type; }
  269. void set_content_type(String content_type) { m_content_type = move(content_type); }
  270. bool has_encoding() const { return m_encoding.has_value(); }
  271. Optional<String> const& encoding() const { return m_encoding; }
  272. String encoding_or_default() const { return m_encoding.value_or("UTF-8"_string); }
  273. void set_encoding(Optional<String> encoding) { m_encoding = move(encoding); }
  274. // NOTE: These are intended for the JS bindings
  275. String character_set() const { return encoding_or_default(); }
  276. String charset() const { return encoding_or_default(); }
  277. String input_encoding() const { return encoding_or_default(); }
  278. bool ready_for_post_load_tasks() const { return m_ready_for_post_load_tasks; }
  279. void set_ready_for_post_load_tasks(bool ready) { m_ready_for_post_load_tasks = ready; }
  280. void completely_finish_loading();
  281. DOMImplementation* implementation();
  282. JS::GCPtr<HTML::HTMLScriptElement> current_script() const { return m_current_script.ptr(); }
  283. void set_current_script(Badge<HTML::HTMLScriptElement>, JS::GCPtr<HTML::HTMLScriptElement> script) { m_current_script = move(script); }
  284. u32 ignore_destructive_writes_counter() const { return m_ignore_destructive_writes_counter; }
  285. void increment_ignore_destructive_writes_counter() { m_ignore_destructive_writes_counter++; }
  286. void decrement_ignore_destructive_writes_counter() { m_ignore_destructive_writes_counter--; }
  287. virtual EventTarget* get_parent(Event const&) override;
  288. String dump_dom_tree_as_json() const;
  289. bool has_a_style_sheet_that_is_blocking_scripts() const;
  290. bool is_fully_active() const;
  291. bool is_active() const;
  292. JS::NonnullGCPtr<HTML::History> history();
  293. JS::NonnullGCPtr<HTML::History> history() const;
  294. [[nodiscard]] JS::GCPtr<HTML::Location> location();
  295. bool anything_is_delaying_the_load_event() const;
  296. void increment_number_of_things_delaying_the_load_event(Badge<DocumentLoadEventDelayer>);
  297. void decrement_number_of_things_delaying_the_load_event(Badge<DocumentLoadEventDelayer>);
  298. bool page_showing() const { return m_page_showing; }
  299. void set_page_showing(bool value) { m_page_showing = value; }
  300. bool hidden() const;
  301. StringView visibility_state() const;
  302. // https://html.spec.whatwg.org/multipage/interaction.html#update-the-visibility-state
  303. void update_the_visibility_state(HTML::VisibilityState);
  304. // NOTE: This does not fire any events, unlike update_the_visibility_state().
  305. void set_visibility_state(Badge<HTML::BrowsingContext>, HTML::VisibilityState);
  306. void run_the_resize_steps();
  307. void run_the_scroll_steps();
  308. void evaluate_media_queries_and_report_changes();
  309. void add_media_query_list(JS::NonnullGCPtr<CSS::MediaQueryList>);
  310. JS::NonnullGCPtr<CSS::VisualViewport> visual_viewport();
  311. [[nodiscard]] CSSPixelRect viewport_rect() const;
  312. class ViewportClient {
  313. public:
  314. virtual ~ViewportClient() = default;
  315. virtual void did_set_viewport_rect(CSSPixelRect const&) = 0;
  316. };
  317. void register_viewport_client(ViewportClient&);
  318. void unregister_viewport_client(ViewportClient&);
  319. void inform_all_viewport_clients_about_the_current_viewport_rect();
  320. bool has_focus() const;
  321. void set_parser(Badge<HTML::HTMLParser>, HTML::HTMLParser&);
  322. void detach_parser(Badge<HTML::HTMLParser>);
  323. void set_is_temporary_document_for_fragment_parsing(Badge<HTML::HTMLParser>) { m_temporary_document_for_fragment_parsing = true; }
  324. [[nodiscard]] bool is_temporary_document_for_fragment_parsing() const { return m_temporary_document_for_fragment_parsing; }
  325. static bool is_valid_name(String const&);
  326. struct PrefixAndTagName {
  327. FlyString prefix;
  328. FlyString tag_name;
  329. };
  330. static WebIDL::ExceptionOr<PrefixAndTagName> validate_qualified_name(JS::Realm&, FlyString const& qualified_name);
  331. JS::NonnullGCPtr<NodeIterator> create_node_iterator(Node& root, unsigned what_to_show, JS::GCPtr<NodeFilter>);
  332. JS::NonnullGCPtr<TreeWalker> create_tree_walker(Node& root, unsigned what_to_show, JS::GCPtr<NodeFilter>);
  333. void register_node_iterator(Badge<NodeIterator>, NodeIterator&);
  334. void unregister_node_iterator(Badge<NodeIterator>, NodeIterator&);
  335. void register_document_observer(Badge<DocumentObserver>, DocumentObserver&);
  336. void unregister_document_observer(Badge<DocumentObserver>, DocumentObserver&);
  337. template<typename Callback>
  338. void for_each_node_iterator(Callback callback)
  339. {
  340. for (auto& node_iterator : m_node_iterators)
  341. callback(*node_iterator);
  342. }
  343. bool needs_full_style_update() const { return m_needs_full_style_update; }
  344. void set_needs_full_style_update(bool b) { m_needs_full_style_update = b; }
  345. bool has_active_favicon() const { return m_active_favicon; }
  346. void check_favicon_after_loading_link_resource();
  347. JS::GCPtr<HTML::CustomElementDefinition> lookup_custom_element_definition(Optional<FlyString> const& namespace_, FlyString const& local_name, Optional<String> const& is) const;
  348. void increment_throw_on_dynamic_markup_insertion_counter(Badge<HTML::HTMLParser>);
  349. void decrement_throw_on_dynamic_markup_insertion_counter(Badge<HTML::HTMLParser>);
  350. // https://html.spec.whatwg.org/multipage/dom.html#is-initial-about:blank
  351. bool is_initial_about_blank() const { return m_is_initial_about_blank; }
  352. void set_is_initial_about_blank(bool b) { m_is_initial_about_blank = b; }
  353. // https://html.spec.whatwg.org/multipage/dom.html#concept-document-about-base-url
  354. Optional<URL::URL> about_base_url() const { return m_about_base_url; }
  355. void set_about_base_url(Optional<URL::URL> url) { m_about_base_url = url; }
  356. String domain() const;
  357. void set_domain(String const&);
  358. auto& pending_scroll_event_targets() { return m_pending_scroll_event_targets; }
  359. auto& pending_scrollend_event_targets() { return m_pending_scrollend_event_targets; }
  360. // https://html.spec.whatwg.org/#completely-loaded
  361. bool is_completely_loaded() const;
  362. // https://html.spec.whatwg.org/multipage/dom.html#concept-document-navigation-id
  363. Optional<String> navigation_id() const;
  364. void set_navigation_id(Optional<String>);
  365. // https://html.spec.whatwg.org/multipage/origin.html#active-sandboxing-flag-set
  366. HTML::SandboxingFlagSet active_sandboxing_flag_set() const;
  367. // https://html.spec.whatwg.org/multipage/dom.html#concept-document-policy-container
  368. HTML::PolicyContainer policy_container() const;
  369. Vector<JS::Handle<HTML::Navigable>> descendant_navigables();
  370. Vector<JS::Handle<HTML::Navigable>> const descendant_navigables() const;
  371. Vector<JS::Handle<HTML::Navigable>> inclusive_descendant_navigables();
  372. Vector<JS::Handle<HTML::Navigable>> ancestor_navigables();
  373. Vector<JS::Handle<HTML::Navigable>> inclusive_ancestor_navigables();
  374. Vector<JS::Handle<HTML::Navigable>> document_tree_child_navigables();
  375. // https://html.spec.whatwg.org/multipage/document-lifecycle.html#destroy-a-document
  376. void destroy();
  377. // https://html.spec.whatwg.org/multipage/document-lifecycle.html#destroy-a-document-and-its-descendants
  378. void destroy_a_document_and_its_descendants(JS::GCPtr<JS::HeapFunction<void()>> after_all_destruction = {});
  379. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#abort-a-document
  380. void abort();
  381. // https://html.spec.whatwg.org/multipage/document-lifecycle.html#abort-a-document-and-its-descendants
  382. void abort_a_document_and_its_descendants();
  383. // https://html.spec.whatwg.org/multipage/document-lifecycle.html#unload-a-document
  384. void unload(JS::GCPtr<Document> new_document = nullptr);
  385. // https://html.spec.whatwg.org/multipage/document-lifecycle.html#unload-a-document-and-its-descendants
  386. void unload_a_document_and_its_descendants(JS::GCPtr<Document> new_document, JS::GCPtr<JS::HeapFunction<void()>> after_all_unloads = {});
  387. // https://html.spec.whatwg.org/multipage/dom.html#active-parser
  388. JS::GCPtr<HTML::HTMLParser> active_parser();
  389. // https://html.spec.whatwg.org/multipage/dom.html#load-timing-info
  390. DocumentLoadTimingInfo& load_timing_info() { return m_load_timing_info; }
  391. DocumentLoadTimingInfo const& load_timing_info() const { return m_load_timing_info; }
  392. void set_load_timing_info(DocumentLoadTimingInfo const& load_timing_info) { m_load_timing_info = load_timing_info; }
  393. // https://html.spec.whatwg.org/multipage/dom.html#previous-document-unload-timing
  394. DocumentUnloadTimingInfo& previous_document_unload_timing() { return m_previous_document_unload_timing; }
  395. DocumentUnloadTimingInfo const& previous_document_unload_timing() const { return m_previous_document_unload_timing; }
  396. void set_previous_document_unload_timing(DocumentUnloadTimingInfo const& previous_document_unload_timing) { m_previous_document_unload_timing = previous_document_unload_timing; }
  397. // https://w3c.github.io/editing/docs/execCommand/
  398. bool exec_command(String command_id, bool show_ui, String value);
  399. bool query_command_enabled(String command_id);
  400. bool query_command_indeterm(String command_id);
  401. bool query_command_state(String command_id);
  402. bool query_command_supported(String command_id);
  403. String query_command_value(String command_id);
  404. bool is_allowed_to_use_feature(PolicyControlledFeature) const;
  405. void did_stop_being_active_document_in_navigable();
  406. String dump_accessibility_tree_as_json();
  407. void make_active();
  408. void set_salvageable(bool value) { m_salvageable = value; }
  409. HTML::ListOfAvailableImages& list_of_available_images();
  410. HTML::ListOfAvailableImages const& list_of_available_images() const;
  411. void register_intersection_observer(Badge<IntersectionObserver::IntersectionObserver>, IntersectionObserver::IntersectionObserver&);
  412. void unregister_intersection_observer(Badge<IntersectionObserver::IntersectionObserver>, IntersectionObserver::IntersectionObserver&);
  413. void register_resize_observer(Badge<ResizeObserver::ResizeObserver>, ResizeObserver::ResizeObserver&);
  414. void unregister_resize_observer(Badge<ResizeObserver::ResizeObserver>, ResizeObserver::ResizeObserver&);
  415. void run_the_update_intersection_observations_steps(HighResolutionTime::DOMHighResTimeStamp time);
  416. void start_intersection_observing_a_lazy_loading_element(Element&);
  417. void shared_declarative_refresh_steps(StringView input, JS::GCPtr<HTML::HTMLMetaElement const> meta_element = nullptr);
  418. struct TopOfTheDocument { };
  419. using IndicatedPart = Variant<Element*, TopOfTheDocument>;
  420. IndicatedPart determine_the_indicated_part() const;
  421. u32 unload_counter() const { return m_unload_counter; }
  422. HTML::SourceSnapshotParams snapshot_source_snapshot_params() const;
  423. void update_for_history_step_application(JS::NonnullGCPtr<HTML::SessionHistoryEntry>, bool do_not_reactivate, size_t script_history_length, size_t script_history_index, Optional<Vector<JS::NonnullGCPtr<HTML::SessionHistoryEntry>>> entries_for_navigation_api = {}, bool update_navigation_api = true);
  424. HashMap<URL::URL, JS::GCPtr<HTML::SharedImageRequest>>& shared_image_requests();
  425. void restore_the_history_object_state(JS::NonnullGCPtr<HTML::SessionHistoryEntry> entry);
  426. JS::NonnullGCPtr<Animations::DocumentTimeline> timeline();
  427. void associate_with_timeline(JS::NonnullGCPtr<Animations::AnimationTimeline>);
  428. void disassociate_with_timeline(JS::NonnullGCPtr<Animations::AnimationTimeline>);
  429. struct PendingAnimationEvent {
  430. JS::NonnullGCPtr<DOM::Event> event;
  431. JS::NonnullGCPtr<Animations::Animation> target;
  432. Optional<double> scheduled_event_time;
  433. };
  434. void append_pending_animation_event(PendingAnimationEvent const&);
  435. void update_animations_and_send_events(Optional<double> const& timestamp);
  436. void remove_replaced_animations();
  437. void ensure_animation_timer();
  438. bool ready_to_run_scripts() const { return m_ready_to_run_scripts; }
  439. void set_ready_to_run_scripts() { m_ready_to_run_scripts = true; }
  440. JS::GCPtr<HTML::SessionHistoryEntry> latest_entry() const { return m_latest_entry; }
  441. void set_latest_entry(JS::GCPtr<HTML::SessionHistoryEntry> e) { m_latest_entry = e; }
  442. void element_id_changed(Badge<DOM::Element>, JS::NonnullGCPtr<DOM::Element> element);
  443. void element_with_id_was_added(Badge<DOM::Element>, JS::NonnullGCPtr<DOM::Element> element);
  444. void element_with_id_was_removed(Badge<DOM::Element>, JS::NonnullGCPtr<DOM::Element> element);
  445. void element_name_changed(Badge<DOM::Element>, JS::NonnullGCPtr<DOM::Element> element);
  446. void element_with_name_was_added(Badge<DOM::Element>, JS::NonnullGCPtr<DOM::Element> element);
  447. void element_with_name_was_removed(Badge<DOM::Element>, JS::NonnullGCPtr<DOM::Element> element);
  448. void add_form_associated_element_with_form_attribute(HTML::FormAssociatedElement&);
  449. void remove_form_associated_element_with_form_attribute(HTML::FormAssociatedElement&);
  450. bool design_mode_enabled_state() const { return m_design_mode_enabled; }
  451. void set_design_mode_enabled_state(bool);
  452. String design_mode() const;
  453. WebIDL::ExceptionOr<void> set_design_mode(String const&);
  454. Element const* element_from_point(double x, double y);
  455. Vector<JS::NonnullGCPtr<Element>> elements_from_point(double x, double y);
  456. JS::GCPtr<Element const> scrolling_element() const;
  457. void set_needs_to_resolve_paint_only_properties() { m_needs_to_resolve_paint_only_properties = true; }
  458. void set_needs_animated_style_update() { m_needs_animated_style_update = true; }
  459. virtual WebIDL::ExceptionOr<JS::Value> named_item_value(FlyString const& name) const override;
  460. virtual Vector<FlyString> supported_property_names() const override;
  461. Vector<JS::NonnullGCPtr<DOM::Element>> const& potentially_named_elements() const { return m_potentially_named_elements; }
  462. void gather_active_observations_at_depth(size_t depth);
  463. [[nodiscard]] size_t broadcast_active_resize_observations();
  464. [[nodiscard]] bool has_active_resize_observations();
  465. [[nodiscard]] bool has_skipped_resize_observations();
  466. JS::NonnullGCPtr<WebIDL::ObservableArray> adopted_style_sheets() const;
  467. WebIDL::ExceptionOr<void> set_adopted_style_sheets(JS::Value);
  468. void register_shadow_root(Badge<DOM::ShadowRoot>, DOM::ShadowRoot&);
  469. void unregister_shadow_root(Badge<DOM::ShadowRoot>, DOM::ShadowRoot&);
  470. void for_each_shadow_root(Function<void(DOM::ShadowRoot&)>&& callback);
  471. void add_an_element_to_the_top_layer(JS::NonnullGCPtr<Element>);
  472. void request_an_element_to_be_remove_from_the_top_layer(JS::NonnullGCPtr<Element>);
  473. void remove_an_element_from_the_top_layer_immediately(JS::NonnullGCPtr<Element>);
  474. void process_top_layer_removals();
  475. OrderedHashTable<JS::NonnullGCPtr<Element>> const& top_layer_elements() const { return m_top_layer_elements; }
  476. size_t transition_generation() const { return m_transition_generation; }
  477. // Does document represent an embedded svg img
  478. [[nodiscard]] bool is_decoded_svg() const;
  479. protected:
  480. virtual void initialize(JS::Realm&) override;
  481. virtual void visit_edges(Cell::Visitor&) override;
  482. Document(JS::Realm&, URL::URL const&);
  483. private:
  484. // ^HTML::GlobalEventHandlers
  485. virtual JS::GCPtr<EventTarget> global_event_handlers_to_event_target(FlyString const&) final { return *this; }
  486. void tear_down_layout_tree();
  487. void run_unloading_cleanup_steps();
  488. void evaluate_media_rules();
  489. WebIDL::ExceptionOr<void> run_the_document_write_steps(StringView);
  490. void queue_intersection_observer_task();
  491. void queue_an_intersection_observer_entry(IntersectionObserver::IntersectionObserver&, HighResolutionTime::DOMHighResTimeStamp time, JS::NonnullGCPtr<Geometry::DOMRectReadOnly> root_bounds, JS::NonnullGCPtr<Geometry::DOMRectReadOnly> bounding_client_rect, JS::NonnullGCPtr<Geometry::DOMRectReadOnly> intersection_rect, bool is_intersecting, double intersection_ratio, JS::NonnullGCPtr<Element> target);
  492. Element* find_a_potential_indicated_element(FlyString const& fragment) const;
  493. void dispatch_events_for_animation_if_necessary(JS::NonnullGCPtr<Animations::Animation>);
  494. JS::NonnullGCPtr<Page> m_page;
  495. OwnPtr<CSS::StyleComputer> m_style_computer;
  496. JS::GCPtr<CSS::StyleSheetList> m_style_sheets;
  497. JS::GCPtr<Node> m_hovered_node;
  498. JS::GCPtr<Node> m_inspected_node;
  499. Optional<CSS::Selector::PseudoElement::Type> m_inspected_pseudo_element;
  500. JS::GCPtr<Node> m_active_favicon;
  501. WeakPtr<HTML::BrowsingContext> m_browsing_context;
  502. URL::URL m_url;
  503. JS::GCPtr<HTML::Window> m_window;
  504. JS::GCPtr<Layout::Viewport> m_layout_root;
  505. Optional<Color> m_normal_link_color;
  506. Optional<Color> m_active_link_color;
  507. Optional<Color> m_visited_link_color;
  508. JS::GCPtr<HTML::HTMLParser> m_parser;
  509. bool m_active_parser_was_aborted { false };
  510. String m_source;
  511. JS::GCPtr<HTML::HTMLScriptElement> m_pending_parsing_blocking_script;
  512. Vector<JS::NonnullGCPtr<HTML::HTMLScriptElement>> m_scripts_to_execute_when_parsing_has_finished;
  513. // https://html.spec.whatwg.org/multipage/scripting.html#list-of-scripts-that-will-execute-in-order-as-soon-as-possible
  514. Vector<JS::NonnullGCPtr<HTML::HTMLScriptElement>> m_scripts_to_execute_in_order_as_soon_as_possible;
  515. // https://html.spec.whatwg.org/multipage/scripting.html#set-of-scripts-that-will-execute-as-soon-as-possible
  516. Vector<JS::NonnullGCPtr<HTML::HTMLScriptElement>> m_scripts_to_execute_as_soon_as_possible;
  517. QuirksMode m_quirks_mode { QuirksMode::No };
  518. // https://dom.spec.whatwg.org/#concept-document-type
  519. Type m_type { Type::XML };
  520. bool m_editable { false };
  521. JS::GCPtr<Element> m_focused_element;
  522. JS::GCPtr<Element> m_active_element;
  523. JS::GCPtr<Element> m_target_element;
  524. bool m_created_for_appropriate_template_contents { false };
  525. JS::GCPtr<Document> m_associated_inert_template_document;
  526. JS::GCPtr<Document> m_appropriate_template_contents_owner_document;
  527. HTML::DocumentReadyState m_readiness { HTML::DocumentReadyState::Loading };
  528. String m_content_type { "application/xml"_string };
  529. Optional<String> m_encoding;
  530. bool m_ready_for_post_load_tasks { false };
  531. JS::GCPtr<DOMImplementation> m_implementation;
  532. JS::GCPtr<HTML::HTMLScriptElement> m_current_script;
  533. bool m_should_invalidate_styles_on_attribute_changes { true };
  534. u32 m_ignore_destructive_writes_counter { 0 };
  535. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#unload-counter
  536. u32 m_unload_counter { 0 };
  537. // https://html.spec.whatwg.org/multipage/dynamic-markup-insertion.html#throw-on-dynamic-markup-insertion-counter
  538. u32 m_throw_on_dynamic_markup_insertion_counter { 0 };
  539. // https://html.spec.whatwg.org/multipage/semantics.html#script-blocking-style-sheet-counter
  540. u32 m_script_blocking_style_sheet_counter { 0 };
  541. JS::GCPtr<HTML::History> m_history;
  542. size_t m_number_of_things_delaying_the_load_event { 0 };
  543. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#concept-document-salvageable
  544. bool m_salvageable { true };
  545. // https://html.spec.whatwg.org/#page-showing
  546. bool m_page_showing { false };
  547. // Used by run_the_resize_steps().
  548. Gfx::IntSize m_last_viewport_size;
  549. HashTable<ViewportClient*> m_viewport_clients;
  550. // https://w3c.github.io/csswg-drafts/cssom-view-1/#document-pending-scroll-event-targets
  551. Vector<JS::NonnullGCPtr<EventTarget>> m_pending_scroll_event_targets;
  552. // https://w3c.github.io/csswg-drafts/cssom-view-1/#document-pending-scrollend-event-targets
  553. Vector<JS::NonnullGCPtr<EventTarget>> m_pending_scrollend_event_targets;
  554. // Used by evaluate_media_queries_and_report_changes().
  555. Vector<WeakPtr<CSS::MediaQueryList>> m_media_query_lists;
  556. bool m_needs_layout { false };
  557. bool m_needs_full_style_update { false };
  558. bool m_needs_animated_style_update { false };
  559. HashTable<JS::GCPtr<NodeIterator>> m_node_iterators;
  560. HashTable<JS::NonnullGCPtr<DocumentObserver>> m_document_observers;
  561. // https://html.spec.whatwg.org/multipage/dom.html#is-initial-about:blank
  562. bool m_is_initial_about_blank { false };
  563. // https://html.spec.whatwg.org/multipage/dom.html#concept-document-about-base-url
  564. Optional<URL::URL> m_about_base_url;
  565. // https://html.spec.whatwg.org/multipage/dom.html#concept-document-coop
  566. HTML::CrossOriginOpenerPolicy m_cross_origin_opener_policy;
  567. // https://html.spec.whatwg.org/multipage/dom.html#the-document's-referrer
  568. String m_referrer;
  569. // https://dom.spec.whatwg.org/#concept-document-origin
  570. HTML::Origin m_origin;
  571. JS::GCPtr<HTMLCollection> m_applets;
  572. JS::GCPtr<HTMLCollection> m_anchors;
  573. JS::GCPtr<HTMLCollection> m_images;
  574. JS::GCPtr<HTMLCollection> m_embeds;
  575. JS::GCPtr<HTMLCollection> m_links;
  576. JS::GCPtr<HTMLCollection> m_forms;
  577. JS::GCPtr<HTMLCollection> m_scripts;
  578. JS::GCPtr<HTML::HTMLAllCollection> m_all;
  579. // https://html.spec.whatwg.org/#completely-loaded-time
  580. Optional<AK::UnixDateTime> m_completely_loaded_time;
  581. // https://html.spec.whatwg.org/multipage/dom.html#concept-document-navigation-id
  582. Optional<String> m_navigation_id;
  583. // https://html.spec.whatwg.org/multipage/origin.html#active-sandboxing-flag-set
  584. HTML::SandboxingFlagSet m_active_sandboxing_flag_set;
  585. // https://html.spec.whatwg.org/multipage/dom.html#concept-document-policy-container
  586. HTML::PolicyContainer m_policy_container;
  587. // https://html.spec.whatwg.org/multipage/interaction.html#visibility-state
  588. HTML::VisibilityState m_visibility_state { HTML::VisibilityState::Hidden };
  589. // https://html.spec.whatwg.org/multipage/dom.html#load-timing-info
  590. DocumentLoadTimingInfo m_load_timing_info;
  591. // https://html.spec.whatwg.org/multipage/dom.html#previous-document-unload-timing
  592. DocumentUnloadTimingInfo m_previous_document_unload_timing;
  593. // https://w3c.github.io/selection-api/#dfn-selection
  594. JS::GCPtr<Selection::Selection> m_selection;
  595. // NOTE: This is a cache to make finding the first <base href> element O(1).
  596. JS::GCPtr<HTML::HTMLBaseElement const> m_first_base_element_with_href_in_tree_order;
  597. // https://html.spec.whatwg.org/multipage/images.html#list-of-available-images
  598. JS::GCPtr<HTML::ListOfAvailableImages> m_list_of_available_images;
  599. JS::GCPtr<CSS::VisualViewport> m_visual_viewport;
  600. // NOTE: Not in the spec per say, but Document must be able to access all IntersectionObservers whose root is in the document.
  601. OrderedHashTable<JS::NonnullGCPtr<IntersectionObserver::IntersectionObserver>> m_intersection_observers;
  602. // https://www.w3.org/TR/intersection-observer/#document-intersectionobservertaskqueued
  603. // Each document has an IntersectionObserverTaskQueued flag which is initialized to false.
  604. bool m_intersection_observer_task_queued { false };
  605. // https://html.spec.whatwg.org/multipage/urls-and-fetching.html#lazy-load-intersection-observer
  606. // Each Document has a lazy load intersection observer, initially set to null but can be set to an IntersectionObserver instance.
  607. JS::GCPtr<IntersectionObserver::IntersectionObserver> m_lazy_load_intersection_observer;
  608. Vector<JS::NonnullGCPtr<ResizeObserver::ResizeObserver>> m_resize_observers;
  609. // https://html.spec.whatwg.org/multipage/semantics.html#will-declaratively-refresh
  610. // A Document object has an associated will declaratively refresh (a boolean). It is initially false.
  611. bool m_will_declaratively_refresh { false };
  612. RefPtr<Core::Timer> m_active_refresh_timer;
  613. bool m_temporary_document_for_fragment_parsing { false };
  614. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#latest-entry
  615. JS::GCPtr<HTML::SessionHistoryEntry> m_latest_entry;
  616. HashMap<URL::URL, JS::GCPtr<HTML::SharedImageRequest>> m_shared_image_requests;
  617. // https://www.w3.org/TR/web-animations-1/#timeline-associated-with-a-document
  618. HashTable<JS::NonnullGCPtr<Animations::AnimationTimeline>> m_associated_animation_timelines;
  619. // https://www.w3.org/TR/web-animations-1/#document-default-document-timeline
  620. JS::GCPtr<Animations::DocumentTimeline> m_default_timeline;
  621. // https://www.w3.org/TR/web-animations-1/#pending-animation-event-queue
  622. Vector<PendingAnimationEvent> m_pending_animation_event_queue;
  623. RefPtr<Core::Timer> m_animation_driver_timer;
  624. // https://drafts.csswg.org/css-transitions-2/#current-transition-generation
  625. size_t m_transition_generation { 0 };
  626. bool m_needs_to_call_page_did_load { false };
  627. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#scripts-may-run-for-the-newly-created-document
  628. bool m_ready_to_run_scripts { false };
  629. Vector<HTML::FormAssociatedElement*> m_form_associated_elements_with_form_attribute;
  630. Vector<JS::NonnullGCPtr<DOM::Element>> m_potentially_named_elements;
  631. bool m_design_mode_enabled { false };
  632. bool m_needs_to_resolve_paint_only_properties { true };
  633. mutable JS::GCPtr<WebIDL::ObservableArray> m_adopted_style_sheets;
  634. Vector<JS::NonnullGCPtr<DOM::ShadowRoot>> m_shadow_roots;
  635. Optional<Core::DateTime> m_last_modified;
  636. u64 m_dom_tree_version { 0 };
  637. // https://drafts.csswg.org/css-position-4/#document-top-layer
  638. // Documents have a top layer, an ordered set containing elements from the document.
  639. // Elements in the top layer do not lay out normally based on their position in the document;
  640. // instead they generate boxes as if they were siblings of the root element.
  641. OrderedHashTable<JS::NonnullGCPtr<Element>> m_top_layer_elements;
  642. OrderedHashTable<JS::NonnullGCPtr<Element>> m_top_layer_pending_removals;
  643. };
  644. template<>
  645. inline bool Node::fast_is<Document>() const { return is_document(); }
  646. }