Document.cpp 39 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139
  1. /*
  2. * Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2021, Linus Groh <linusg@serenityos.org>
  4. * Copyright (c) 2021, Luke Wilde <lukew@serenityos.org>
  5. * Copyright (c) 2021, Sam Atkins <atkinssj@serenityos.org>
  6. *
  7. * SPDX-License-Identifier: BSD-2-Clause
  8. */
  9. #include <AK/CharacterTypes.h>
  10. #include <AK/StringBuilder.h>
  11. #include <AK/Utf8View.h>
  12. #include <LibCore/Timer.h>
  13. #include <LibJS/Interpreter.h>
  14. #include <LibJS/Parser.h>
  15. #include <LibJS/Runtime/FunctionObject.h>
  16. #include <LibWeb/Bindings/MainThreadVM.h>
  17. #include <LibWeb/Bindings/WindowObject.h>
  18. #include <LibWeb/CSS/MediaQueryListEvent.h>
  19. #include <LibWeb/CSS/StyleComputer.h>
  20. #include <LibWeb/Cookie/ParsedCookie.h>
  21. #include <LibWeb/DOM/Comment.h>
  22. #include <LibWeb/DOM/CustomEvent.h>
  23. #include <LibWeb/DOM/DOMException.h>
  24. #include <LibWeb/DOM/Document.h>
  25. #include <LibWeb/DOM/DocumentFragment.h>
  26. #include <LibWeb/DOM/DocumentType.h>
  27. #include <LibWeb/DOM/Element.h>
  28. #include <LibWeb/DOM/ElementFactory.h>
  29. #include <LibWeb/DOM/Event.h>
  30. #include <LibWeb/DOM/ExceptionOr.h>
  31. #include <LibWeb/DOM/HTMLCollection.h>
  32. #include <LibWeb/DOM/Range.h>
  33. #include <LibWeb/DOM/ShadowRoot.h>
  34. #include <LibWeb/DOM/Text.h>
  35. #include <LibWeb/DOM/Window.h>
  36. #include <LibWeb/Dump.h>
  37. #include <LibWeb/HTML/AttributeNames.h>
  38. #include <LibWeb/HTML/BrowsingContext.h>
  39. #include <LibWeb/HTML/EventLoop/EventLoop.h>
  40. #include <LibWeb/HTML/EventNames.h>
  41. #include <LibWeb/HTML/HTMLAnchorElement.h>
  42. #include <LibWeb/HTML/HTMLAreaElement.h>
  43. #include <LibWeb/HTML/HTMLBodyElement.h>
  44. #include <LibWeb/HTML/HTMLEmbedElement.h>
  45. #include <LibWeb/HTML/HTMLFormElement.h>
  46. #include <LibWeb/HTML/HTMLFrameSetElement.h>
  47. #include <LibWeb/HTML/HTMLHeadElement.h>
  48. #include <LibWeb/HTML/HTMLHtmlElement.h>
  49. #include <LibWeb/HTML/HTMLIFrameElement.h>
  50. #include <LibWeb/HTML/HTMLImageElement.h>
  51. #include <LibWeb/HTML/HTMLScriptElement.h>
  52. #include <LibWeb/HTML/HTMLTitleElement.h>
  53. #include <LibWeb/HTML/MessageEvent.h>
  54. #include <LibWeb/Layout/BlockFormattingContext.h>
  55. #include <LibWeb/Layout/InitialContainingBlock.h>
  56. #include <LibWeb/Layout/TreeBuilder.h>
  57. #include <LibWeb/Namespace.h>
  58. #include <LibWeb/Origin.h>
  59. #include <LibWeb/Page/Page.h>
  60. #include <LibWeb/SVG/TagNames.h>
  61. #include <LibWeb/UIEvents/EventNames.h>
  62. #include <LibWeb/UIEvents/KeyboardEvent.h>
  63. #include <LibWeb/UIEvents/MouseEvent.h>
  64. namespace Web::DOM {
  65. Document::Document(const AK::URL& url)
  66. : ParentNode(*this, NodeType::DOCUMENT_NODE)
  67. , m_style_computer(make<CSS::StyleComputer>(*this))
  68. , m_style_sheets(CSS::StyleSheetList::create(*this))
  69. , m_url(url)
  70. , m_window(Window::create_with_document(*this))
  71. , m_implementation(DOMImplementation::create(*this))
  72. , m_history(HTML::History::create(*this))
  73. {
  74. HTML::main_thread_event_loop().register_document({}, *this);
  75. m_style_update_timer = Core::Timer::create_single_shot(0, [this] {
  76. update_style();
  77. });
  78. m_layout_update_timer = Core::Timer::create_single_shot(0, [this] {
  79. force_layout();
  80. });
  81. }
  82. Document::~Document()
  83. {
  84. }
  85. void Document::removed_last_ref()
  86. {
  87. VERIFY(!ref_count());
  88. VERIFY(!m_deletion_has_begun);
  89. if (m_referencing_node_count) {
  90. // The document has reached ref_count==0 but still has nodes keeping it alive.
  91. // At this point, sever all the node links we control.
  92. // If nodes remain elsewhere (e.g JS wrappers), they will keep the document alive.
  93. // NOTE: This makes sure we stay alive across for the duration of the cleanup below.
  94. increment_referencing_node_count();
  95. m_focused_element = nullptr;
  96. m_hovered_node = nullptr;
  97. m_pending_parsing_blocking_script = nullptr;
  98. m_inspected_node = nullptr;
  99. m_scripts_to_execute_when_parsing_has_finished.clear();
  100. m_scripts_to_execute_as_soon_as_possible.clear();
  101. m_associated_inert_template_document = nullptr;
  102. m_interpreter = nullptr;
  103. {
  104. // Gather up all the descendants of this document and prune them from the tree.
  105. // FIXME: This could definitely be more elegant.
  106. NonnullRefPtrVector<Node> descendants;
  107. for_each_in_inclusive_subtree([&](auto& node) {
  108. if (&node != this)
  109. descendants.append(node);
  110. return IterationDecision::Continue;
  111. });
  112. for (auto& node : descendants) {
  113. VERIFY(&node.document() == this);
  114. VERIFY(!node.is_document());
  115. if (node.parent())
  116. node.remove();
  117. }
  118. }
  119. m_in_removed_last_ref = false;
  120. decrement_referencing_node_count();
  121. return;
  122. }
  123. m_in_removed_last_ref = false;
  124. m_deletion_has_begun = true;
  125. HTML::main_thread_event_loop().unregister_document({}, *this);
  126. delete this;
  127. }
  128. Origin Document::origin() const
  129. {
  130. if (!m_url.is_valid())
  131. return {};
  132. return { m_url.protocol(), m_url.host(), m_url.port_or_default() };
  133. }
  134. void Document::set_origin(const Origin& origin)
  135. {
  136. m_url.set_protocol(origin.protocol());
  137. m_url.set_host(origin.host());
  138. m_url.set_port(origin.port());
  139. }
  140. void Document::schedule_style_update()
  141. {
  142. if (m_style_update_timer->is_active())
  143. return;
  144. m_style_update_timer->start();
  145. }
  146. void Document::schedule_layout_update()
  147. {
  148. if (m_layout_update_timer->is_active())
  149. return;
  150. m_layout_update_timer->start();
  151. }
  152. bool Document::is_child_allowed(const Node& node) const
  153. {
  154. switch (node.type()) {
  155. case NodeType::DOCUMENT_NODE:
  156. case NodeType::TEXT_NODE:
  157. return false;
  158. case NodeType::COMMENT_NODE:
  159. return true;
  160. case NodeType::DOCUMENT_TYPE_NODE:
  161. return !first_child_of_type<DocumentType>();
  162. case NodeType::ELEMENT_NODE:
  163. return !first_child_of_type<Element>();
  164. default:
  165. return false;
  166. }
  167. }
  168. Element* Document::document_element()
  169. {
  170. return first_child_of_type<Element>();
  171. }
  172. const Element* Document::document_element() const
  173. {
  174. return first_child_of_type<Element>();
  175. }
  176. HTML::HTMLHtmlElement* Document::html_element()
  177. {
  178. auto* html = document_element();
  179. if (is<HTML::HTMLHtmlElement>(html))
  180. return verify_cast<HTML::HTMLHtmlElement>(html);
  181. return nullptr;
  182. }
  183. HTML::HTMLHeadElement* Document::head()
  184. {
  185. auto* html = html_element();
  186. if (!html)
  187. return nullptr;
  188. return html->first_child_of_type<HTML::HTMLHeadElement>();
  189. }
  190. HTML::HTMLElement* Document::body()
  191. {
  192. auto* html = html_element();
  193. if (!html)
  194. return nullptr;
  195. auto* first_body = html->first_child_of_type<HTML::HTMLBodyElement>();
  196. if (first_body)
  197. return first_body;
  198. auto* first_frameset = html->first_child_of_type<HTML::HTMLFrameSetElement>();
  199. if (first_frameset)
  200. return first_frameset;
  201. return nullptr;
  202. }
  203. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-body
  204. ExceptionOr<void> Document::set_body(HTML::HTMLElement* new_body)
  205. {
  206. if (!is<HTML::HTMLBodyElement>(new_body) && !is<HTML::HTMLFrameSetElement>(new_body))
  207. return DOM::HierarchyRequestError::create("Invalid document body element, must be 'body' or 'frameset'");
  208. auto* existing_body = body();
  209. if (existing_body) {
  210. auto replace_result = existing_body->parent()->replace_child(*new_body, *existing_body);
  211. if (replace_result.is_exception())
  212. return replace_result.exception();
  213. return {};
  214. }
  215. auto* document_element = this->document_element();
  216. if (!document_element)
  217. return DOM::HierarchyRequestError::create("Missing document element");
  218. auto append_result = document_element->append_child(*new_body);
  219. if (append_result.is_exception())
  220. return append_result.exception();
  221. return {};
  222. }
  223. String Document::title() const
  224. {
  225. auto* head_element = head();
  226. if (!head_element)
  227. return {};
  228. auto* title_element = head_element->first_child_of_type<HTML::HTMLTitleElement>();
  229. if (!title_element)
  230. return {};
  231. auto raw_title = title_element->text_content();
  232. StringBuilder builder;
  233. bool last_was_space = false;
  234. for (auto code_point : Utf8View(raw_title)) {
  235. if (is_ascii_space(code_point)) {
  236. last_was_space = true;
  237. } else {
  238. if (last_was_space && !builder.is_empty())
  239. builder.append(' ');
  240. builder.append_code_point(code_point);
  241. last_was_space = false;
  242. }
  243. }
  244. return builder.to_string();
  245. }
  246. void Document::set_title(const String& title)
  247. {
  248. auto* head_element = const_cast<HTML::HTMLHeadElement*>(head());
  249. if (!head_element)
  250. return;
  251. RefPtr<HTML::HTMLTitleElement> title_element = head_element->first_child_of_type<HTML::HTMLTitleElement>();
  252. if (!title_element) {
  253. title_element = static_ptr_cast<HTML::HTMLTitleElement>(create_element(HTML::TagNames::title));
  254. head_element->append_child(*title_element);
  255. }
  256. title_element->remove_all_children(true);
  257. title_element->append_child(adopt_ref(*new Text(*this, title)));
  258. if (auto* page = this->page()) {
  259. if (browsing_context() == &page->top_level_browsing_context())
  260. page->client().page_did_change_title(title);
  261. }
  262. }
  263. void Document::attach_to_browsing_context(Badge<HTML::BrowsingContext>, HTML::BrowsingContext& browsing_context)
  264. {
  265. m_browsing_context = browsing_context;
  266. update_layout();
  267. }
  268. void Document::detach_from_browsing_context(Badge<HTML::BrowsingContext>, HTML::BrowsingContext& browsing_context)
  269. {
  270. VERIFY(&browsing_context == m_browsing_context);
  271. tear_down_layout_tree();
  272. m_browsing_context = nullptr;
  273. }
  274. void Document::tear_down_layout_tree()
  275. {
  276. if (!m_layout_root)
  277. return;
  278. // Gather up all the layout nodes in a vector and detach them from parents
  279. // while the vector keeps them alive.
  280. NonnullRefPtrVector<Layout::Node> layout_nodes;
  281. m_layout_root->for_each_in_inclusive_subtree([&](auto& layout_node) {
  282. layout_nodes.append(layout_node);
  283. return IterationDecision::Continue;
  284. });
  285. for (auto& layout_node : layout_nodes) {
  286. if (layout_node.parent())
  287. layout_node.parent()->remove_child(layout_node);
  288. }
  289. m_layout_root = nullptr;
  290. }
  291. Color Document::background_color(const Palette& palette) const
  292. {
  293. auto default_color = palette.base();
  294. auto* body_element = body();
  295. if (!body_element)
  296. return default_color;
  297. auto* body_layout_node = body_element->layout_node();
  298. if (!body_layout_node)
  299. return default_color;
  300. auto color = body_layout_node->computed_values().background_color();
  301. if (!color.alpha())
  302. return default_color;
  303. return color;
  304. }
  305. Vector<CSS::BackgroundLayerData> const* Document::background_layers() const
  306. {
  307. auto* body_element = body();
  308. if (!body_element)
  309. return {};
  310. auto* body_layout_node = body_element->layout_node();
  311. if (!body_layout_node)
  312. return {};
  313. return &body_layout_node->background_layers();
  314. }
  315. // https://html.spec.whatwg.org/multipage/urls-and-fetching.html#parse-a-url
  316. AK::URL Document::parse_url(String const& url) const
  317. {
  318. // FIXME: Make sure we do this according to spec.
  319. return m_url.complete_url(url);
  320. }
  321. void Document::set_needs_layout()
  322. {
  323. if (m_needs_layout)
  324. return;
  325. m_needs_layout = true;
  326. schedule_layout_update();
  327. }
  328. void Document::force_layout()
  329. {
  330. tear_down_layout_tree();
  331. update_layout();
  332. }
  333. void Document::ensure_layout()
  334. {
  335. if (m_needs_layout || !m_layout_root)
  336. update_layout();
  337. }
  338. void Document::update_layout()
  339. {
  340. if (!m_needs_layout && m_layout_root)
  341. return;
  342. if (!browsing_context())
  343. return;
  344. update_style();
  345. if (!m_layout_root) {
  346. Layout::TreeBuilder tree_builder;
  347. m_layout_root = static_ptr_cast<Layout::InitialContainingBlock>(tree_builder.build(*this));
  348. }
  349. Layout::BlockFormattingContext root_formatting_context(*m_layout_root, nullptr);
  350. root_formatting_context.run(*m_layout_root, Layout::LayoutMode::Default);
  351. m_layout_root->set_needs_display();
  352. if (browsing_context()->is_top_level()) {
  353. if (auto* page = this->page())
  354. page->client().page_did_layout();
  355. }
  356. m_needs_layout = false;
  357. m_layout_update_timer->stop();
  358. }
  359. static void update_style_recursively(DOM::Node& node)
  360. {
  361. if (is<Element>(node))
  362. static_cast<Element&>(node).recompute_style();
  363. node.set_needs_style_update(false);
  364. if (node.child_needs_style_update()) {
  365. node.for_each_child([&](auto& child) {
  366. if (child.needs_style_update() || child.child_needs_style_update())
  367. update_style_recursively(child);
  368. return IterationDecision::Continue;
  369. });
  370. }
  371. node.set_child_needs_style_update(false);
  372. }
  373. void Document::update_style()
  374. {
  375. if (!browsing_context())
  376. return;
  377. if (!needs_style_update() && !child_needs_style_update())
  378. return;
  379. update_style_recursively(*this);
  380. m_style_update_timer->stop();
  381. set_needs_layout();
  382. }
  383. RefPtr<Layout::Node> Document::create_layout_node()
  384. {
  385. return adopt_ref(*new Layout::InitialContainingBlock(*this, style_computer().create_document_style()));
  386. }
  387. void Document::set_link_color(Color color)
  388. {
  389. m_link_color = color;
  390. }
  391. void Document::set_active_link_color(Color color)
  392. {
  393. m_active_link_color = color;
  394. }
  395. void Document::set_visited_link_color(Color color)
  396. {
  397. m_visited_link_color = color;
  398. }
  399. const Layout::InitialContainingBlock* Document::layout_node() const
  400. {
  401. return static_cast<const Layout::InitialContainingBlock*>(Node::layout_node());
  402. }
  403. Layout::InitialContainingBlock* Document::layout_node()
  404. {
  405. return static_cast<Layout::InitialContainingBlock*>(Node::layout_node());
  406. }
  407. void Document::set_inspected_node(Node* node)
  408. {
  409. if (m_inspected_node == node)
  410. return;
  411. if (m_inspected_node && m_inspected_node->layout_node())
  412. m_inspected_node->layout_node()->set_needs_display();
  413. m_inspected_node = node;
  414. if (m_inspected_node && m_inspected_node->layout_node())
  415. m_inspected_node->layout_node()->set_needs_display();
  416. }
  417. void Document::set_hovered_node(Node* node)
  418. {
  419. if (m_hovered_node == node)
  420. return;
  421. RefPtr<Node> old_hovered_node = move(m_hovered_node);
  422. m_hovered_node = node;
  423. invalidate_style();
  424. }
  425. NonnullRefPtr<HTMLCollection> Document::get_elements_by_name(String const& name)
  426. {
  427. return HTMLCollection::create(*this, [name](Element const& element) {
  428. return element.name() == name;
  429. });
  430. }
  431. NonnullRefPtr<HTMLCollection> Document::get_elements_by_class_name(FlyString const& class_name)
  432. {
  433. return HTMLCollection::create(*this, [class_name, quirks_mode = document().in_quirks_mode()](Element const& element) {
  434. return element.has_class(class_name, quirks_mode ? CaseSensitivity::CaseInsensitive : CaseSensitivity::CaseSensitive);
  435. });
  436. }
  437. // https://html.spec.whatwg.org/multipage/obsolete.html#dom-document-applets
  438. NonnullRefPtr<HTMLCollection> Document::applets()
  439. {
  440. // FIXME: This should return the same HTMLCollection object every time,
  441. // but that would cause a reference cycle since HTMLCollection refs the root.
  442. return HTMLCollection::create(*this, [](auto&) { return false; });
  443. }
  444. // https://html.spec.whatwg.org/multipage/obsolete.html#dom-document-anchors
  445. NonnullRefPtr<HTMLCollection> Document::anchors()
  446. {
  447. // FIXME: This should return the same HTMLCollection object every time,
  448. // but that would cause a reference cycle since HTMLCollection refs the root.
  449. return HTMLCollection::create(*this, [](Element const& element) {
  450. return is<HTML::HTMLAnchorElement>(element) && element.has_attribute(HTML::AttributeNames::name);
  451. });
  452. }
  453. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-images
  454. NonnullRefPtr<HTMLCollection> Document::images()
  455. {
  456. // FIXME: This should return the same HTMLCollection object every time,
  457. // but that would cause a reference cycle since HTMLCollection refs the root.
  458. return HTMLCollection::create(*this, [](Element const& element) {
  459. return is<HTML::HTMLImageElement>(element);
  460. });
  461. }
  462. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-embeds
  463. NonnullRefPtr<HTMLCollection> Document::embeds()
  464. {
  465. // FIXME: This should return the same HTMLCollection object every time,
  466. // but that would cause a reference cycle since HTMLCollection refs the root.
  467. return HTMLCollection::create(*this, [](Element const& element) {
  468. return is<HTML::HTMLEmbedElement>(element);
  469. });
  470. }
  471. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-plugins
  472. NonnullRefPtr<HTMLCollection> Document::plugins()
  473. {
  474. return embeds();
  475. }
  476. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-links
  477. NonnullRefPtr<HTMLCollection> Document::links()
  478. {
  479. // FIXME: This should return the same HTMLCollection object every time,
  480. // but that would cause a reference cycle since HTMLCollection refs the root.
  481. return HTMLCollection::create(*this, [](Element const& element) {
  482. return (is<HTML::HTMLAnchorElement>(element) || is<HTML::HTMLAreaElement>(element)) && element.has_attribute(HTML::AttributeNames::href);
  483. });
  484. }
  485. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-forms
  486. NonnullRefPtr<HTMLCollection> Document::forms()
  487. {
  488. // FIXME: This should return the same HTMLCollection object every time,
  489. // but that would cause a reference cycle since HTMLCollection refs the root.
  490. return HTMLCollection::create(*this, [](Element const& element) {
  491. return is<HTML::HTMLFormElement>(element);
  492. });
  493. }
  494. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-scripts
  495. NonnullRefPtr<HTMLCollection> Document::scripts()
  496. {
  497. // FIXME: This should return the same HTMLCollection object every time,
  498. // but that would cause a reference cycle since HTMLCollection refs the root.
  499. return HTMLCollection::create(*this, [](Element const& element) {
  500. return is<HTML::HTMLScriptElement>(element);
  501. });
  502. }
  503. Color Document::link_color() const
  504. {
  505. if (m_link_color.has_value())
  506. return m_link_color.value();
  507. if (!page())
  508. return Color::Blue;
  509. return page()->palette().link();
  510. }
  511. Color Document::active_link_color() const
  512. {
  513. if (m_active_link_color.has_value())
  514. return m_active_link_color.value();
  515. if (!page())
  516. return Color::Red;
  517. return page()->palette().active_link();
  518. }
  519. Color Document::visited_link_color() const
  520. {
  521. if (m_visited_link_color.has_value())
  522. return m_visited_link_color.value();
  523. if (!page())
  524. return Color::Magenta;
  525. return page()->palette().visited_link();
  526. }
  527. JS::Realm& Document::realm()
  528. {
  529. return interpreter().realm();
  530. }
  531. JS::Interpreter& Document::interpreter()
  532. {
  533. if (!m_interpreter) {
  534. auto& vm = Bindings::main_thread_vm();
  535. m_interpreter = JS::Interpreter::create<Bindings::WindowObject>(vm, *m_window);
  536. // NOTE: We must hook `on_call_stack_emptied` after the interpreter was created, as the initialization of the
  537. // WindowsObject can invoke some internal calls, which will eventually lead to this hook being called without
  538. // `m_interpreter` being fully initialized yet.
  539. // TODO: Hook up vm.on_promise_unhandled_rejection and vm.on_promise_rejection_handled
  540. // See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#promise_rejection_events
  541. vm.on_call_stack_emptied = [this] {
  542. auto& vm = m_interpreter->vm();
  543. vm.run_queued_promise_jobs();
  544. vm.run_queued_finalization_registry_cleanup_jobs();
  545. // FIXME: This isn't exactly the right place for this.
  546. HTML::main_thread_event_loop().perform_a_microtask_checkpoint();
  547. // Note: This is not an exception check for the promise jobs, they will just leave any
  548. // exception that already exists intact and never throw a new one (without cleaning it
  549. // up, that is). Taking care of any previous unhandled exception just happens to be the
  550. // very last thing we want to do, even after running promise jobs.
  551. if (auto* exception = vm.exception()) {
  552. auto value = exception->value();
  553. if (value.is_object()) {
  554. auto& object = value.as_object();
  555. auto name = object.get_without_side_effects(vm.names.name).value_or(JS::js_undefined());
  556. auto message = object.get_without_side_effects(vm.names.message).value_or(JS::js_undefined());
  557. if (name.is_accessor() || message.is_accessor()) {
  558. // The result is not going to be useful, let's just print the value. This affects DOMExceptions, for example.
  559. dbgln("\033[31;1mUnhandled JavaScript exception:\033[0m {}", value);
  560. } else {
  561. dbgln("\033[31;1mUnhandled JavaScript exception:\033[0m [{}] {}", name, message);
  562. }
  563. } else {
  564. dbgln("\033[31;1mUnhandled JavaScript exception:\033[0m {}", value);
  565. }
  566. for (auto& traceback_frame : exception->traceback()) {
  567. auto& function_name = traceback_frame.function_name;
  568. auto& source_range = traceback_frame.source_range;
  569. dbgln(" {} at {}:{}:{}", function_name, source_range.filename, source_range.start.line, source_range.start.column);
  570. }
  571. }
  572. vm.finish_execution_generation();
  573. };
  574. }
  575. return *m_interpreter;
  576. }
  577. JS::Value Document::run_javascript(StringView source, StringView filename)
  578. {
  579. auto parser = JS::Parser(JS::Lexer(source, filename));
  580. auto program = parser.parse_program();
  581. if (parser.has_errors()) {
  582. parser.print_errors(false);
  583. return JS::js_undefined();
  584. }
  585. auto& interpreter = document().interpreter();
  586. auto& vm = interpreter.vm();
  587. interpreter.run(interpreter.global_object(), *program);
  588. if (vm.exception())
  589. vm.clear_exception();
  590. return vm.last_value();
  591. }
  592. // https://dom.spec.whatwg.org/#dom-document-createelement
  593. // FIXME: This only implements step 6 of the algorithm and does not take in options.
  594. NonnullRefPtr<Element> Document::create_element(const String& tag_name)
  595. {
  596. // FIXME: Let namespace be the HTML namespace, if this is an HTML document or this’s content type is "application/xhtml+xml", and null otherwise.
  597. return DOM::create_element(*this, tag_name, Namespace::HTML);
  598. }
  599. // https://dom.spec.whatwg.org/#internal-createelementns-steps
  600. // FIXME: This only implements step 4 of the algorithm and does not take in options.
  601. NonnullRefPtr<Element> Document::create_element_ns(const String& namespace_, const String& qualified_name)
  602. {
  603. return DOM::create_element(*this, qualified_name, namespace_);
  604. }
  605. NonnullRefPtr<DocumentFragment> Document::create_document_fragment()
  606. {
  607. return adopt_ref(*new DocumentFragment(*this));
  608. }
  609. NonnullRefPtr<Text> Document::create_text_node(const String& data)
  610. {
  611. return adopt_ref(*new Text(*this, data));
  612. }
  613. NonnullRefPtr<Comment> Document::create_comment(const String& data)
  614. {
  615. return adopt_ref(*new Comment(*this, data));
  616. }
  617. NonnullRefPtr<Range> Document::create_range()
  618. {
  619. return Range::create(*this);
  620. }
  621. // https://dom.spec.whatwg.org/#dom-document-createevent
  622. NonnullRefPtr<Event> Document::create_event(const String& interface)
  623. {
  624. auto interface_lowercase = interface.to_lowercase();
  625. RefPtr<Event> event;
  626. if (interface_lowercase == "beforeunloadevent") {
  627. event = Event::create(""); // FIXME: Create BeforeUnloadEvent
  628. } else if (interface_lowercase == "compositionevent") {
  629. event = Event::create(""); // FIXME: Create CompositionEvent
  630. } else if (interface_lowercase == "customevent") {
  631. event = CustomEvent::create("");
  632. } else if (interface_lowercase == "devicemotionevent") {
  633. event = Event::create(""); // FIXME: Create DeviceMotionEvent
  634. } else if (interface_lowercase == "deviceorientationevent") {
  635. event = Event::create(""); // FIXME: Create DeviceOrientationEvent
  636. } else if (interface_lowercase == "dragevent") {
  637. event = Event::create(""); // FIXME: Create DragEvent
  638. } else if (interface_lowercase.is_one_of("event", "events")) {
  639. event = Event::create("");
  640. } else if (interface_lowercase == "focusevent") {
  641. event = Event::create(""); // FIXME: Create FocusEvent
  642. } else if (interface_lowercase == "hashchangeevent") {
  643. event = Event::create(""); // FIXME: Create HashChangeEvent
  644. } else if (interface_lowercase == "htmlevents") {
  645. event = Event::create("");
  646. } else if (interface_lowercase == "keyboardevent") {
  647. event = UIEvents::KeyboardEvent::create("");
  648. } else if (interface_lowercase == "messageevent") {
  649. event = HTML::MessageEvent::create("");
  650. } else if (interface_lowercase.is_one_of("mouseevent", "mouseevents")) {
  651. event = UIEvents::MouseEvent::create("", 0, 0, 0, 0);
  652. } else if (interface_lowercase == "storageevent") {
  653. event = Event::create(""); // FIXME: Create StorageEvent
  654. } else if (interface_lowercase == "svgevents") {
  655. event = Event::create("");
  656. } else if (interface_lowercase == "textevent") {
  657. event = Event::create(""); // FIXME: Create CompositionEvent
  658. } else if (interface_lowercase == "touchevent") {
  659. event = Event::create(""); // FIXME: Create TouchEvent
  660. } else if (interface_lowercase.is_one_of("uievent", "uievents")) {
  661. event = UIEvents::UIEvent::create("");
  662. } else {
  663. // FIXME:
  664. // 3. If constructor is null, then throw a "NotSupportedError" DOMException.
  665. // 4. If the interface indicated by constructor is not exposed on the relevant global object of this, then throw a "NotSupportedError" DOMException.
  666. TODO();
  667. }
  668. // Setting type to empty string is handled by each constructor.
  669. // FIXME:
  670. // 7. Initialize event’s timeStamp attribute to a DOMHighResTimeStamp representing the high resolution time from the time origin to now.
  671. event->set_is_trusted(false);
  672. event->set_initialized(false);
  673. return event.release_nonnull();
  674. }
  675. void Document::set_pending_parsing_blocking_script(Badge<HTML::HTMLScriptElement>, HTML::HTMLScriptElement* script)
  676. {
  677. m_pending_parsing_blocking_script = script;
  678. }
  679. NonnullRefPtr<HTML::HTMLScriptElement> Document::take_pending_parsing_blocking_script(Badge<HTML::HTMLParser>)
  680. {
  681. return m_pending_parsing_blocking_script.release_nonnull();
  682. }
  683. void Document::add_script_to_execute_when_parsing_has_finished(Badge<HTML::HTMLScriptElement>, HTML::HTMLScriptElement& script)
  684. {
  685. m_scripts_to_execute_when_parsing_has_finished.append(script);
  686. }
  687. NonnullRefPtrVector<HTML::HTMLScriptElement> Document::take_scripts_to_execute_when_parsing_has_finished(Badge<HTML::HTMLParser>)
  688. {
  689. return move(m_scripts_to_execute_when_parsing_has_finished);
  690. }
  691. void Document::add_script_to_execute_as_soon_as_possible(Badge<HTML::HTMLScriptElement>, HTML::HTMLScriptElement& script)
  692. {
  693. m_scripts_to_execute_as_soon_as_possible.append(script);
  694. }
  695. NonnullRefPtrVector<HTML::HTMLScriptElement> Document::take_scripts_to_execute_as_soon_as_possible(Badge<HTML::HTMLParser>)
  696. {
  697. return move(m_scripts_to_execute_as_soon_as_possible);
  698. }
  699. // https://dom.spec.whatwg.org/#dom-document-importnode
  700. ExceptionOr<NonnullRefPtr<Node>> Document::import_node(NonnullRefPtr<Node> node, bool deep)
  701. {
  702. // 1. If node is a document or shadow root, then throw a "NotSupportedError" DOMException.
  703. if (is<Document>(*node) || is<ShadowRoot>(*node))
  704. return DOM::NotSupportedError::create("Cannot import a document or shadow root.");
  705. // 2. Return a clone of node, with this and the clone children flag set if deep is true.
  706. return node->clone_node(this, deep);
  707. }
  708. // https://dom.spec.whatwg.org/#concept-node-adopt
  709. void Document::adopt_node(Node& node)
  710. {
  711. auto& old_document = node.document();
  712. if (node.parent())
  713. node.remove();
  714. if (&old_document != this) {
  715. // FIXME: This should be shadow-including.
  716. node.for_each_in_inclusive_subtree([&](auto& inclusive_descendant) {
  717. inclusive_descendant.set_document({}, *this);
  718. // FIXME: If inclusiveDescendant is an element, then set the node document of each attribute in inclusiveDescendant’s attribute list to document.
  719. return IterationDecision::Continue;
  720. });
  721. // FIXME: For each inclusiveDescendant in node’s shadow-including inclusive descendants that is custom,
  722. // enqueue a custom element callback reaction with inclusiveDescendant, callback name "adoptedCallback",
  723. // and an argument list containing oldDocument and document.
  724. // FIXME: This should be shadow-including.
  725. node.for_each_in_inclusive_subtree([&](auto& inclusive_descendant) {
  726. inclusive_descendant.adopted_from(old_document);
  727. return IterationDecision::Continue;
  728. });
  729. }
  730. }
  731. // https://dom.spec.whatwg.org/#dom-document-adoptnode
  732. ExceptionOr<NonnullRefPtr<Node>> Document::adopt_node_binding(NonnullRefPtr<Node> node)
  733. {
  734. if (is<Document>(*node))
  735. return DOM::NotSupportedError::create("Cannot adopt a document into a document");
  736. if (is<ShadowRoot>(*node))
  737. return DOM::HierarchyRequestError::create("Cannot adopt a shadow root into a document");
  738. if (is<DocumentFragment>(*node) && verify_cast<DocumentFragment>(*node).host())
  739. return node;
  740. adopt_node(*node);
  741. return node;
  742. }
  743. const DocumentType* Document::doctype() const
  744. {
  745. return first_child_of_type<DocumentType>();
  746. }
  747. const String& Document::compat_mode() const
  748. {
  749. static String back_compat = "BackCompat";
  750. static String css1_compat = "CSS1Compat";
  751. if (m_quirks_mode == QuirksMode::Yes)
  752. return back_compat;
  753. return css1_compat;
  754. }
  755. bool Document::is_editable() const
  756. {
  757. return m_editable;
  758. }
  759. void Document::set_focused_element(Element* element)
  760. {
  761. if (m_focused_element == element)
  762. return;
  763. m_focused_element = element;
  764. if (m_layout_root)
  765. m_layout_root->set_needs_display();
  766. }
  767. void Document::set_active_element(Element* element)
  768. {
  769. if (m_active_element == element)
  770. return;
  771. m_active_element = element;
  772. if (m_layout_root)
  773. m_layout_root->set_needs_display();
  774. }
  775. String Document::ready_state() const
  776. {
  777. switch (m_readiness) {
  778. case HTML::DocumentReadyState::Loading:
  779. return "loading"sv;
  780. case HTML::DocumentReadyState::Interactive:
  781. return "interactive"sv;
  782. case HTML::DocumentReadyState::Complete:
  783. return "complete"sv;
  784. }
  785. VERIFY_NOT_REACHED();
  786. }
  787. // https://html.spec.whatwg.org/#update-the-current-document-readiness
  788. void Document::update_readiness(HTML::DocumentReadyState readiness_value)
  789. {
  790. // 1. If document's current document readiness equals readinessValue, then return.
  791. if (m_readiness == readiness_value)
  792. return;
  793. // The spec doesn't actually mention updating the current readiness value.
  794. // FIXME: https://github.com/whatwg/html/issues/7120
  795. m_readiness = readiness_value;
  796. // FIXME: 2. If document is associated with an HTML parser, then:
  797. // FIXME: 1. If document is associated with an HTML parser, then:
  798. // FIXME: 2. If readinessValue is "complete", and document's load timing info's DOM complete time is 0, then set document's load timing info's DOM complete time to now.
  799. // FIXME: 3. Otherwise, if readinessValue is "interactive", and document's load timing info's DOM interactive time is 0, then set document's load timing info's DOM interactive time to now.
  800. // 3. Fire an event named readystatechange at document.
  801. dispatch_event(Event::create(HTML::EventNames::readystatechange));
  802. }
  803. Page* Document::page()
  804. {
  805. return m_browsing_context ? m_browsing_context->page() : nullptr;
  806. }
  807. const Page* Document::page() const
  808. {
  809. return m_browsing_context ? m_browsing_context->page() : nullptr;
  810. }
  811. EventTarget* Document::get_parent(const Event& event)
  812. {
  813. if (event.type() == HTML::EventNames::load)
  814. return nullptr;
  815. return &window();
  816. }
  817. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#completely-finish-loading
  818. void Document::completely_finish_loading()
  819. {
  820. // 1. Assert: document's browsing context is non-null.
  821. VERIFY(browsing_context());
  822. // FIXME: 2. Set document's completely loaded time to the current time.
  823. // 3. Let container be document's browsing context's container.
  824. auto* container = browsing_context()->container();
  825. // If container is an iframe element, then queue an element task on the DOM manipulation task source given container to run the iframe load event steps given container.
  826. if (container && is<HTML::HTMLIFrameElement>(*container)) {
  827. container->queue_an_element_task(HTML::Task::Source::DOMManipulation, [container]() mutable {
  828. run_iframe_load_event_steps(static_cast<HTML::HTMLIFrameElement&>(*container));
  829. });
  830. }
  831. // Otherwise, if container is non-null, then queue an element task on the DOM manipulation task source given container to fire an event named load at container.
  832. else if (container) {
  833. container->queue_an_element_task(HTML::Task::Source::DOMManipulation, [container]() mutable {
  834. container->dispatch_event(DOM::Event::create(HTML::EventNames::load));
  835. });
  836. }
  837. }
  838. String Document::cookie(Cookie::Source source)
  839. {
  840. if (auto* page = this->page())
  841. return page->client().page_did_request_cookie(m_url, source);
  842. return {};
  843. }
  844. void Document::set_cookie(String cookie_string, Cookie::Source source)
  845. {
  846. auto cookie = Cookie::parse_cookie(cookie_string);
  847. if (!cookie.has_value())
  848. return;
  849. if (auto* page = this->page())
  850. page->client().page_did_set_cookie(m_url, cookie.value(), source);
  851. }
  852. String Document::dump_dom_tree_as_json() const
  853. {
  854. StringBuilder builder;
  855. JsonObjectSerializer json(builder);
  856. serialize_tree_as_json(json);
  857. json.finish();
  858. return builder.to_string();
  859. }
  860. // https://html.spec.whatwg.org/multipage/semantics.html#has-a-style-sheet-that-is-blocking-scripts
  861. bool Document::has_a_style_sheet_that_is_blocking_scripts() const
  862. {
  863. // A Document has a style sheet that is blocking scripts if its script-blocking style sheet counter is greater than 0,
  864. if (m_script_blocking_style_sheet_counter > 0)
  865. return true;
  866. // ...or if that Document has a non-null browsing context whose container document is non-null and has a script-blocking style sheet counter greater than 0.
  867. if (!browsing_context() || !browsing_context()->container_document())
  868. return false;
  869. return browsing_context()->container_document()->m_script_blocking_style_sheet_counter > 0;
  870. }
  871. String Document::referrer() const
  872. {
  873. // FIXME: Return the document's actual referrer.
  874. return "";
  875. }
  876. // https://html.spec.whatwg.org/multipage/browsers.html#fully-active
  877. bool Document::is_fully_active() const
  878. {
  879. // A Document d is said to be fully active when d's browsing context is non-null, d's browsing context's active document is d,
  880. // and either d's browsing context is a top-level browsing context, or d's browsing context's container document is fully active.
  881. return browsing_context() && browsing_context()->active_document() == this && (browsing_context()->is_top_level() || browsing_context()->container_document()->is_fully_active());
  882. }
  883. // https://html.spec.whatwg.org/multipage/browsers.html#active-document
  884. bool Document::is_active() const
  885. {
  886. // A browsing context's active document is its active window's associated Document.
  887. return browsing_context() && browsing_context()->active_document() == this;
  888. }
  889. // https://html.spec.whatwg.org/multipage/history.html#dom-document-location
  890. Bindings::LocationObject* Document::location()
  891. {
  892. // The Document object's location attribute's getter must return this Document object's relevant global object's Location object,
  893. // if this Document object is fully active, and null otherwise.
  894. if (!is_fully_active())
  895. return nullptr;
  896. return window().wrapper()->location_object();
  897. }
  898. // https://html.spec.whatwg.org/multipage/interaction.html#dom-document-hidden
  899. bool Document::hidden() const
  900. {
  901. return false;
  902. }
  903. // https://html.spec.whatwg.org/multipage/interaction.html#dom-document-visibilitystate
  904. String Document::visibility_state() const
  905. {
  906. return hidden() ? "hidden" : "visible";
  907. }
  908. // https://drafts.csswg.org/cssom-view/#run-the-resize-steps
  909. void Document::run_the_resize_steps()
  910. {
  911. // 1. If doc’s viewport has had its width or height changed
  912. // (e.g. as a result of the user resizing the browser window, or changing the page zoom scale factor,
  913. // or an iframe element’s dimensions are changed) since the last time these steps were run,
  914. // fire an event named resize at the Window object associated with doc.
  915. if (!browsing_context())
  916. return;
  917. auto viewport_size = browsing_context()->viewport_rect().size();
  918. if (m_last_viewport_size == viewport_size)
  919. return;
  920. m_last_viewport_size = viewport_size;
  921. dispatch_event(DOM::Event::create(UIEvents::EventNames::resize));
  922. update_layout();
  923. }
  924. void Document::add_media_query_list(NonnullRefPtr<CSS::MediaQueryList>& media_query_list)
  925. {
  926. m_media_query_lists.append(media_query_list);
  927. }
  928. // https://drafts.csswg.org/cssom-view/#evaluate-media-queries-and-report-changes
  929. void Document::evaluate_media_queries_and_report_changes()
  930. {
  931. // NOTE: Not in the spec, but we take this opportunity to prune null WeakPtrs.
  932. m_media_query_lists.remove_all_matching([](auto& it) {
  933. return it.is_null();
  934. });
  935. // 1. For each MediaQueryList object target that has doc as its document,
  936. // in the order they were created, oldest first, run these substeps:
  937. for (auto& media_query_list_ptr : m_media_query_lists) {
  938. // 1.1. If target’s matches state has changed since the last time these steps
  939. // were run, fire an event at target using the MediaQueryListEvent constructor,
  940. // with its type attribute initialized to change, its isTrusted attribute
  941. // initialized to true, its media attribute initialized to target’s media,
  942. // and its matches attribute initialized to target’s matches state.
  943. if (media_query_list_ptr.is_null())
  944. continue;
  945. auto media_query_list = media_query_list_ptr.strong_ref();
  946. bool did_match = media_query_list->matches();
  947. bool now_matches = media_query_list->evaluate();
  948. if (did_match != now_matches) {
  949. CSS::MediaQueryListEventInit init;
  950. init.media = media_query_list->media();
  951. init.matches = now_matches;
  952. auto event = CSS::MediaQueryListEvent::create(HTML::EventNames::change, init);
  953. event->set_is_trusted(true);
  954. media_query_list->dispatch_event(event);
  955. }
  956. }
  957. // Also not in the spec, but this is as good a place as any to evaluate @media rules!
  958. for (auto& style_sheet : style_sheets().sheets()) {
  959. style_sheet.evaluate_media_queries(window());
  960. }
  961. }
  962. }