TreeBuilder.cpp 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781
  1. /*
  2. * Copyright (c) 2018-2022, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2022-2023, Sam Atkins <atkinssj@serenityos.org>
  4. * Copyright (c) 2022, MacDue <macdue@dueutil.tech>
  5. *
  6. * SPDX-License-Identifier: BSD-2-Clause
  7. */
  8. #include <AK/Error.h>
  9. #include <AK/Optional.h>
  10. #include <AK/TemporaryChange.h>
  11. #include <LibWeb/CSS/StyleComputer.h>
  12. #include <LibWeb/CSS/StyleValues/DisplayStyleValue.h>
  13. #include <LibWeb/CSS/StyleValues/IdentifierStyleValue.h>
  14. #include <LibWeb/CSS/StyleValues/PercentageStyleValue.h>
  15. #include <LibWeb/DOM/Document.h>
  16. #include <LibWeb/DOM/Element.h>
  17. #include <LibWeb/DOM/ParentNode.h>
  18. #include <LibWeb/DOM/ShadowRoot.h>
  19. #include <LibWeb/Dump.h>
  20. #include <LibWeb/HTML/HTMLButtonElement.h>
  21. #include <LibWeb/HTML/HTMLInputElement.h>
  22. #include <LibWeb/HTML/HTMLLIElement.h>
  23. #include <LibWeb/HTML/HTMLOListElement.h>
  24. #include <LibWeb/HTML/HTMLSlotElement.h>
  25. #include <LibWeb/Layout/ListItemBox.h>
  26. #include <LibWeb/Layout/ListItemMarkerBox.h>
  27. #include <LibWeb/Layout/Node.h>
  28. #include <LibWeb/Layout/TableGrid.h>
  29. #include <LibWeb/Layout/TableWrapper.h>
  30. #include <LibWeb/Layout/TextNode.h>
  31. #include <LibWeb/Layout/TreeBuilder.h>
  32. #include <LibWeb/Layout/Viewport.h>
  33. #include <LibWeb/SVG/SVGForeignObjectElement.h>
  34. namespace Web::Layout {
  35. TreeBuilder::TreeBuilder() = default;
  36. static bool has_inline_or_in_flow_block_children(Layout::Node const& layout_node)
  37. {
  38. for (auto child = layout_node.first_child(); child; child = child->next_sibling()) {
  39. if (child->is_inline())
  40. return true;
  41. if (!child->is_floating() && !child->is_absolutely_positioned())
  42. return true;
  43. }
  44. return false;
  45. }
  46. static bool has_in_flow_block_children(Layout::Node const& layout_node)
  47. {
  48. if (layout_node.children_are_inline())
  49. return false;
  50. for (auto child = layout_node.first_child(); child; child = child->next_sibling()) {
  51. if (child->is_inline())
  52. continue;
  53. if (!child->is_floating() && !child->is_absolutely_positioned())
  54. return true;
  55. }
  56. return false;
  57. }
  58. // The insertion_parent_for_*() functions maintain the invariant that the in-flow children of
  59. // block-level boxes must be either all block-level or all inline-level.
  60. static Layout::Node& insertion_parent_for_inline_node(Layout::NodeWithStyle& layout_parent)
  61. {
  62. auto last_child_creating_anonymous_wrapper_if_needed = [](auto& layout_parent) -> Layout::Node& {
  63. if (!layout_parent.last_child()
  64. || !layout_parent.last_child()->is_anonymous()
  65. || !layout_parent.last_child()->children_are_inline()
  66. || layout_parent.last_child()->is_generated()) {
  67. layout_parent.append_child(layout_parent.create_anonymous_wrapper());
  68. }
  69. return *layout_parent.last_child();
  70. };
  71. if (layout_parent.display().is_inline_outside() && layout_parent.display().is_flow_inside())
  72. return layout_parent;
  73. if (layout_parent.display().is_flex_inside() || layout_parent.display().is_grid_inside())
  74. return last_child_creating_anonymous_wrapper_if_needed(layout_parent);
  75. if (!has_in_flow_block_children(layout_parent) || layout_parent.children_are_inline())
  76. return layout_parent;
  77. // Parent has block-level children, insert into an anonymous wrapper block (and create it first if needed)
  78. return last_child_creating_anonymous_wrapper_if_needed(layout_parent);
  79. }
  80. static Layout::Node& insertion_parent_for_block_node(Layout::NodeWithStyle& layout_parent, Layout::Node& layout_node)
  81. {
  82. if (!has_inline_or_in_flow_block_children(layout_parent)) {
  83. // Parent block has no children, insert this block into parent.
  84. return layout_parent;
  85. }
  86. bool is_out_of_flow = layout_node.is_absolutely_positioned() || layout_node.is_floating();
  87. if (is_out_of_flow
  88. && !layout_parent.display().is_flex_inside()
  89. && !layout_parent.display().is_grid_inside()
  90. && layout_parent.last_child()->is_anonymous()
  91. && layout_parent.last_child()->children_are_inline()) {
  92. // Block is out-of-flow & previous sibling was wrapped in an anonymous block.
  93. // Join the previous sibling inside the anonymous block.
  94. return *layout_parent.last_child();
  95. }
  96. if (!layout_parent.children_are_inline()) {
  97. // Parent block has block-level children, insert this block into parent.
  98. return layout_parent;
  99. }
  100. if (is_out_of_flow) {
  101. // Block is out-of-flow, it can have inline siblings if necessary.
  102. return layout_parent;
  103. }
  104. // Parent block has inline-level children (our siblings).
  105. // First move these siblings into an anonymous wrapper block.
  106. Vector<JS::Handle<Layout::Node>> children;
  107. while (JS::GCPtr<Layout::Node> child = layout_parent.first_child()) {
  108. layout_parent.remove_child(*child);
  109. children.append(*child);
  110. }
  111. layout_parent.append_child(layout_parent.create_anonymous_wrapper());
  112. layout_parent.set_children_are_inline(false);
  113. for (auto& child : children) {
  114. layout_parent.last_child()->append_child(*child);
  115. }
  116. layout_parent.last_child()->set_children_are_inline(true);
  117. // Then it's safe to insert this block into parent.
  118. return layout_parent;
  119. }
  120. void TreeBuilder::insert_node_into_inline_or_block_ancestor(Layout::Node& node, CSS::Display display, AppendOrPrepend mode)
  121. {
  122. if (node.display().is_contents())
  123. return;
  124. if (display.is_inline_outside()) {
  125. // Inlines can be inserted into the nearest ancestor.
  126. auto& insertion_point = insertion_parent_for_inline_node(m_ancestor_stack.last());
  127. if (mode == AppendOrPrepend::Prepend)
  128. insertion_point.prepend_child(node);
  129. else
  130. insertion_point.append_child(node);
  131. insertion_point.set_children_are_inline(true);
  132. } else {
  133. // Non-inlines can't be inserted into an inline parent, so find the nearest non-inline ancestor.
  134. auto& nearest_non_inline_ancestor = [&]() -> Layout::NodeWithStyle& {
  135. for (auto& ancestor : m_ancestor_stack.in_reverse()) {
  136. if (ancestor->display().is_contents())
  137. continue;
  138. if (!ancestor->display().is_inline_outside())
  139. return ancestor;
  140. if (!ancestor->display().is_flow_inside())
  141. return ancestor;
  142. if (ancestor->dom_node() && is<SVG::SVGForeignObjectElement>(*ancestor->dom_node()))
  143. return ancestor;
  144. }
  145. VERIFY_NOT_REACHED();
  146. }();
  147. auto& insertion_point = insertion_parent_for_block_node(nearest_non_inline_ancestor, node);
  148. if (mode == AppendOrPrepend::Prepend)
  149. insertion_point.prepend_child(node);
  150. else
  151. insertion_point.append_child(node);
  152. // After inserting an in-flow block-level box into a parent, mark the parent as having non-inline children.
  153. if (!node.is_floating() && !node.is_absolutely_positioned())
  154. insertion_point.set_children_are_inline(false);
  155. }
  156. }
  157. ErrorOr<void> TreeBuilder::create_pseudo_element_if_needed(DOM::Element& element, CSS::Selector::PseudoElement pseudo_element, AppendOrPrepend mode)
  158. {
  159. auto& document = element.document();
  160. auto& style_computer = document.style_computer();
  161. auto pseudo_element_style = TRY(style_computer.compute_pseudo_element_style_if_needed(element, pseudo_element));
  162. if (!pseudo_element_style)
  163. return {};
  164. auto initial_quote_nesting_level = m_quote_nesting_level;
  165. auto [pseudo_element_content, final_quote_nesting_level] = pseudo_element_style->content(initial_quote_nesting_level);
  166. m_quote_nesting_level = final_quote_nesting_level;
  167. auto pseudo_element_display = pseudo_element_style->display();
  168. // ::before and ::after only exist if they have content. `content: normal` computes to `none` for them.
  169. // We also don't create them if they are `display: none`.
  170. if (pseudo_element_display.is_none()
  171. || pseudo_element_content.type == CSS::ContentData::Type::Normal
  172. || pseudo_element_content.type == CSS::ContentData::Type::None)
  173. return {};
  174. auto pseudo_element_node = DOM::Element::create_layout_node_for_display_type(document, pseudo_element_display, *pseudo_element_style, nullptr);
  175. if (!pseudo_element_node)
  176. return {};
  177. auto generated_for = Node::GeneratedFor::NotGenerated;
  178. if (pseudo_element == CSS::Selector::PseudoElement::Before) {
  179. generated_for = Node::GeneratedFor::PseudoBefore;
  180. } else if (pseudo_element == CSS::Selector::PseudoElement::After) {
  181. generated_for = Node::GeneratedFor::PseudoAfter;
  182. } else {
  183. VERIFY_NOT_REACHED();
  184. }
  185. pseudo_element_node->set_generated_for(generated_for, element);
  186. pseudo_element_node->set_initial_quote_nesting_level(initial_quote_nesting_level);
  187. // FIXME: Handle images, and multiple values
  188. if (pseudo_element_content.type == CSS::ContentData::Type::String) {
  189. auto text = document.heap().allocate<DOM::Text>(document.realm(), document, pseudo_element_content.data);
  190. auto text_node = document.heap().allocate_without_realm<Layout::TextNode>(document, *text);
  191. text_node->set_generated_for(generated_for, element);
  192. push_parent(verify_cast<NodeWithStyle>(*pseudo_element_node));
  193. insert_node_into_inline_or_block_ancestor(*text_node, text_node->display(), AppendOrPrepend::Append);
  194. pop_parent();
  195. } else {
  196. TODO();
  197. }
  198. element.set_pseudo_element_node({}, pseudo_element, pseudo_element_node);
  199. insert_node_into_inline_or_block_ancestor(*pseudo_element_node, pseudo_element_display, mode);
  200. return {};
  201. }
  202. static bool is_ignorable_whitespace(Layout::Node const& node)
  203. {
  204. if (node.is_text_node() && static_cast<TextNode const&>(node).text_for_rendering().bytes_as_string_view().is_whitespace())
  205. return true;
  206. if (node.is_anonymous() && node.is_block_container() && static_cast<BlockContainer const&>(node).children_are_inline()) {
  207. bool contains_only_white_space = true;
  208. node.for_each_in_inclusive_subtree_of_type<TextNode>([&contains_only_white_space](auto& text_node) {
  209. if (!text_node.text_for_rendering().bytes_as_string_view().is_whitespace()) {
  210. contains_only_white_space = false;
  211. return IterationDecision::Break;
  212. }
  213. return IterationDecision::Continue;
  214. });
  215. if (contains_only_white_space)
  216. return true;
  217. }
  218. return false;
  219. }
  220. i32 TreeBuilder::calculate_list_item_index(DOM::Node& dom_node)
  221. {
  222. if (is<HTML::HTMLLIElement>(dom_node)) {
  223. auto& li = static_cast<HTML::HTMLLIElement&>(dom_node);
  224. if (li.value() != 0)
  225. return li.value();
  226. }
  227. if (dom_node.previous_sibling() != nullptr) {
  228. DOM::Node* current = dom_node.previous_sibling();
  229. while (current != nullptr) {
  230. if (is<HTML::HTMLLIElement>(*current))
  231. return calculate_list_item_index(*current) + 1;
  232. current = current->previous_sibling();
  233. }
  234. }
  235. if (is<HTML::HTMLOListElement>(*dom_node.parent())) {
  236. auto& ol = static_cast<HTML::HTMLOListElement&>(*dom_node.parent());
  237. return ol.start();
  238. }
  239. return 1;
  240. }
  241. ErrorOr<void> TreeBuilder::create_layout_tree(DOM::Node& dom_node, TreeBuilder::Context& context)
  242. {
  243. JS::GCPtr<Layout::Node> layout_node;
  244. Optional<TemporaryChange<bool>> has_svg_root_change;
  245. ScopeGuard remove_stale_layout_node_guard = [&] {
  246. // If we didn't create a layout node for this DOM node,
  247. // go through the DOM tree and remove any old layout nodes since they are now all stale.
  248. if (!layout_node) {
  249. dom_node.for_each_in_inclusive_subtree([&](auto& node) {
  250. node.detach_layout_node({});
  251. if (is<DOM::Element>(node))
  252. static_cast<DOM::Element&>(node).clear_pseudo_element_nodes({});
  253. return IterationDecision::Continue;
  254. });
  255. }
  256. };
  257. if (dom_node.is_svg_container()) {
  258. has_svg_root_change.emplace(context.has_svg_root, true);
  259. } else if (dom_node.requires_svg_container() && !context.has_svg_root) {
  260. return {};
  261. }
  262. auto& document = dom_node.document();
  263. auto& style_computer = document.style_computer();
  264. RefPtr<CSS::StyleProperties> style;
  265. CSS::Display display;
  266. if (is<DOM::Element>(dom_node)) {
  267. auto& element = static_cast<DOM::Element&>(dom_node);
  268. // Special path for elements that use pseudo selectors.
  269. // FIXME: This is very hackish. Find a better way to architect this.
  270. if (element.pseudo_element() == CSS::Selector::PseudoElement::Placeholder || element.pseudo_element() == CSS::Selector::PseudoElement::MeterBar || element.pseudo_element() == CSS::Selector::PseudoElement::MeterOptimumValue || element.pseudo_element() == CSS::Selector::PseudoElement::MeterSuboptimumValue || element.pseudo_element() == CSS::Selector::PseudoElement::MeterEvenLessGoodValue || element.pseudo_element() == CSS::Selector::PseudoElement::ProgressBar || element.pseudo_element() == CSS::Selector::PseudoElement::ProgressValue) {
  271. auto& parent_element = verify_cast<HTML::HTMLElement>(*element.root().parent_or_shadow_host());
  272. style = TRY(style_computer.compute_style(parent_element, element.pseudo_element()));
  273. display = style->display();
  274. if (element.pseudo_element() == CSS::Selector::PseudoElement::Placeholder) {
  275. auto& input_element = verify_cast<HTML::HTMLInputElement>(parent_element);
  276. if (!input_element.placeholder_value().has_value())
  277. display = CSS::Display::from_short(CSS::Display::Short::None);
  278. }
  279. if (element.pseudo_element() == CSS::Selector::PseudoElement::MeterOptimumValue || element.pseudo_element() == CSS::Selector::PseudoElement::MeterSuboptimumValue || element.pseudo_element() == CSS::Selector::PseudoElement::MeterEvenLessGoodValue || element.pseudo_element() == CSS::Selector::PseudoElement::ProgressValue) {
  280. auto computed_style = element.computed_css_values();
  281. style->set_property(CSS::PropertyID::Width, computed_style->property(CSS::PropertyID::Width));
  282. }
  283. }
  284. // Common path: this is a regular DOM element. Style should be present already, thanks to Document::update_style().
  285. else {
  286. element.clear_pseudo_element_nodes({});
  287. VERIFY(!element.needs_style_update());
  288. style = element.computed_css_values();
  289. display = style->display();
  290. }
  291. if (display.is_none())
  292. return {};
  293. layout_node = element.create_layout_node(*style);
  294. } else if (is<DOM::Document>(dom_node)) {
  295. style = style_computer.create_document_style();
  296. display = style->display();
  297. layout_node = document.heap().allocate_without_realm<Layout::Viewport>(static_cast<DOM::Document&>(dom_node), *style);
  298. } else if (is<DOM::Text>(dom_node)) {
  299. layout_node = document.heap().allocate_without_realm<Layout::TextNode>(document, static_cast<DOM::Text&>(dom_node));
  300. display = CSS::Display(CSS::DisplayOutside::Inline, CSS::DisplayInside::Flow);
  301. }
  302. if (!layout_node)
  303. return {};
  304. if (!dom_node.parent_or_shadow_host()) {
  305. m_layout_root = layout_node;
  306. } else if (layout_node->is_svg_box()) {
  307. m_ancestor_stack.last()->append_child(*layout_node);
  308. } else {
  309. insert_node_into_inline_or_block_ancestor(*layout_node, display, AppendOrPrepend::Append);
  310. }
  311. auto* shadow_root = is<DOM::Element>(dom_node) ? verify_cast<DOM::Element>(dom_node).shadow_root_internal() : nullptr;
  312. // Add node for the ::before pseudo-element.
  313. if (is<DOM::Element>(dom_node) && layout_node->can_have_children()) {
  314. auto& element = static_cast<DOM::Element&>(dom_node);
  315. push_parent(verify_cast<NodeWithStyle>(*layout_node));
  316. TRY(create_pseudo_element_if_needed(element, CSS::Selector::PseudoElement::Before, AppendOrPrepend::Prepend));
  317. pop_parent();
  318. }
  319. if ((dom_node.has_children() || shadow_root) && layout_node->can_have_children()) {
  320. push_parent(verify_cast<NodeWithStyle>(*layout_node));
  321. if (shadow_root) {
  322. for (auto* node = shadow_root->first_child(); node; node = node->next_sibling()) {
  323. TRY(create_layout_tree(*node, context));
  324. }
  325. } else {
  326. // This is the same as verify_cast<DOM::ParentNode>(dom_node).for_each_child
  327. for (auto* node = verify_cast<DOM::ParentNode>(dom_node).first_child(); node; node = node->next_sibling())
  328. TRY(create_layout_tree(*node, context));
  329. }
  330. pop_parent();
  331. }
  332. if (is<ListItemBox>(*layout_node)) {
  333. auto& element = static_cast<DOM::Element&>(dom_node);
  334. auto marker_style = TRY(style_computer.compute_style(element, CSS::Selector::PseudoElement::Marker));
  335. auto list_item_marker = document.heap().allocate_without_realm<ListItemMarkerBox>(document, layout_node->computed_values().list_style_type(), layout_node->computed_values().list_style_position(), calculate_list_item_index(dom_node), *marker_style);
  336. static_cast<ListItemBox&>(*layout_node).set_marker(list_item_marker);
  337. element.set_pseudo_element_node({}, CSS::Selector::PseudoElement::Marker, list_item_marker);
  338. layout_node->append_child(*list_item_marker);
  339. }
  340. if (is<HTML::HTMLSlotElement>(dom_node)) {
  341. auto slottables = static_cast<HTML::HTMLSlotElement&>(dom_node).assigned_nodes_internal();
  342. push_parent(verify_cast<NodeWithStyle>(*layout_node));
  343. for (auto const& slottable : slottables) {
  344. TRY(slottable.visit([&](auto& node) -> ErrorOr<void> {
  345. return create_layout_tree(node, context);
  346. }));
  347. }
  348. pop_parent();
  349. }
  350. // https://html.spec.whatwg.org/multipage/rendering.html#button-layout
  351. // If the computed value of 'inline-size' is 'auto', then the used value is the fit-content inline size.
  352. if (dom_node.is_html_button_element() && dom_node.layout_node()->computed_values().width().is_auto()) {
  353. auto& computed_values = verify_cast<NodeWithStyle>(*dom_node.layout_node()).mutable_computed_values();
  354. computed_values.set_width(CSS::Size::make_fit_content());
  355. }
  356. // https://html.spec.whatwg.org/multipage/rendering.html#button-layout
  357. // If the element is an input element, or if it is a button element and its computed value for
  358. // 'display' is not 'inline-grid', 'grid', 'inline-flex', or 'flex', then the element's box has
  359. // a child anonymous button content box with the following behaviors:
  360. if (dom_node.is_html_button_element() && !display.is_grid_inside() && !display.is_flex_inside()) {
  361. auto& parent = *dom_node.layout_node();
  362. // If the box does not overflow in the vertical axis, then it is centered vertically.
  363. // FIXME: Only apply alignment when box overflows
  364. auto flex_computed_values = parent.computed_values().clone_inherited_values();
  365. auto& mutable_flex_computed_values = static_cast<CSS::MutableComputedValues&>(flex_computed_values);
  366. mutable_flex_computed_values.set_display(CSS::Display { CSS::DisplayOutside::Block, CSS::DisplayInside::Flex });
  367. mutable_flex_computed_values.set_justify_content(CSS::JustifyContent::Center);
  368. mutable_flex_computed_values.set_flex_direction(CSS::FlexDirection::Column);
  369. mutable_flex_computed_values.set_height(CSS::Size::make_percentage(CSS::Percentage(100)));
  370. auto flex_wrapper = parent.heap().template allocate_without_realm<BlockContainer>(parent.document(), nullptr, move(flex_computed_values));
  371. auto content_box_computed_values = parent.computed_values().clone_inherited_values();
  372. auto content_box_wrapper = parent.heap().template allocate_without_realm<BlockContainer>(parent.document(), nullptr, move(content_box_computed_values));
  373. content_box_wrapper->set_font(parent.font());
  374. content_box_wrapper->set_line_height(parent.line_height());
  375. content_box_wrapper->set_children_are_inline(parent.children_are_inline());
  376. Vector<JS::Handle<Node>> sequence;
  377. for (auto child = parent.first_child(); child; child = child->next_sibling()) {
  378. if (child->is_generated_for_before_pseudo_element())
  379. continue;
  380. sequence.append(*child);
  381. }
  382. for (auto& node : sequence) {
  383. parent.remove_child(*node);
  384. content_box_wrapper->append_child(*node);
  385. }
  386. flex_wrapper->append_child(*content_box_wrapper);
  387. parent.append_child(*flex_wrapper);
  388. parent.set_children_are_inline(false);
  389. }
  390. // Add nodes for the ::after pseudo-element.
  391. if (is<DOM::Element>(dom_node) && layout_node->can_have_children()) {
  392. auto& element = static_cast<DOM::Element&>(dom_node);
  393. push_parent(verify_cast<NodeWithStyle>(*layout_node));
  394. TRY(create_pseudo_element_if_needed(element, CSS::Selector::PseudoElement::After, AppendOrPrepend::Append));
  395. pop_parent();
  396. }
  397. return {};
  398. }
  399. JS::GCPtr<Layout::Node> TreeBuilder::build(DOM::Node& dom_node)
  400. {
  401. VERIFY(dom_node.is_document());
  402. Context context;
  403. m_quote_nesting_level = 0;
  404. MUST(create_layout_tree(dom_node, context)); // FIXME propagate errors
  405. if (auto* root = dom_node.document().layout_node())
  406. fixup_tables(*root);
  407. return move(m_layout_root);
  408. }
  409. template<CSS::DisplayInternal internal, typename Callback>
  410. void TreeBuilder::for_each_in_tree_with_internal_display(NodeWithStyle& root, Callback callback)
  411. {
  412. root.for_each_in_inclusive_subtree_of_type<Box>([&](auto& box) {
  413. auto const display = box.display();
  414. if (display.is_internal() && display.internal() == internal)
  415. callback(box);
  416. return IterationDecision::Continue;
  417. });
  418. }
  419. template<CSS::DisplayInside inside, typename Callback>
  420. void TreeBuilder::for_each_in_tree_with_inside_display(NodeWithStyle& root, Callback callback)
  421. {
  422. root.for_each_in_inclusive_subtree_of_type<Box>([&](auto& box) {
  423. auto const display = box.display();
  424. if (display.is_outside_and_inside() && display.inside() == inside)
  425. callback(box);
  426. return IterationDecision::Continue;
  427. });
  428. }
  429. void TreeBuilder::fixup_tables(NodeWithStyle& root)
  430. {
  431. remove_irrelevant_boxes(root);
  432. generate_missing_child_wrappers(root);
  433. auto table_root_boxes = generate_missing_parents(root);
  434. missing_cells_fixup(table_root_boxes);
  435. }
  436. void TreeBuilder::remove_irrelevant_boxes(NodeWithStyle& root)
  437. {
  438. // The following boxes are discarded as if they were display:none:
  439. Vector<JS::Handle<Node>> to_remove;
  440. // Children of a table-column.
  441. for_each_in_tree_with_internal_display<CSS::DisplayInternal::TableColumn>(root, [&](Box& table_column) {
  442. table_column.for_each_child([&](auto& child) {
  443. to_remove.append(child);
  444. });
  445. });
  446. // Children of a table-column-group which are not a table-column.
  447. for_each_in_tree_with_internal_display<CSS::DisplayInternal::TableColumnGroup>(root, [&](Box& table_column_group) {
  448. table_column_group.for_each_child([&](auto& child) {
  449. if (!child.display().is_table_column())
  450. to_remove.append(child);
  451. });
  452. });
  453. // FIXME:
  454. // Anonymous inline boxes which contain only white space and are between two immediate siblings each of which is a table-non-root box.
  455. // Anonymous inline boxes which meet all of the following criteria:
  456. // - they contain only white space
  457. // - they are the first and/or last child of a tabular container
  458. // - whose immediate sibling, if any, is a table-non-root box
  459. for (auto& box : to_remove)
  460. box->parent()->remove_child(*box);
  461. }
  462. static bool is_table_track(CSS::Display display)
  463. {
  464. return display.is_table_row() || display.is_table_column();
  465. }
  466. static bool is_table_track_group(CSS::Display display)
  467. {
  468. // Unless explicitly mentioned otherwise, mentions of table-row-groups in this spec also encompass the specialized
  469. // table-header-groups and table-footer-groups.
  470. return display.is_table_row_group()
  471. || display.is_table_header_group()
  472. || display.is_table_footer_group()
  473. || display.is_table_column_group();
  474. }
  475. static bool is_proper_table_child(Node const& node)
  476. {
  477. auto const display = node.display();
  478. return is_table_track_group(display) || is_table_track(display) || display.is_table_caption();
  479. }
  480. static bool is_not_proper_table_child(Node const& node)
  481. {
  482. if (!node.has_style())
  483. return true;
  484. return !is_proper_table_child(node);
  485. }
  486. static bool is_table_row(Node const& node)
  487. {
  488. return node.display().is_table_row();
  489. }
  490. static bool is_not_table_row(Node const& node)
  491. {
  492. if (!node.has_style())
  493. return true;
  494. return !is_table_row(node);
  495. }
  496. static bool is_table_cell(Node const& node)
  497. {
  498. return node.display().is_table_cell();
  499. }
  500. static bool is_not_table_cell(Node const& node)
  501. {
  502. if (!node.has_style())
  503. return true;
  504. return !is_table_cell(node);
  505. }
  506. template<typename Matcher, typename Callback>
  507. static void for_each_sequence_of_consecutive_children_matching(NodeWithStyle& parent, Matcher matcher, Callback callback)
  508. {
  509. Vector<JS::Handle<Node>> sequence;
  510. auto sequence_is_all_ignorable_whitespace = [&]() -> bool {
  511. for (auto& node : sequence) {
  512. if (!is_ignorable_whitespace(*node))
  513. return false;
  514. }
  515. return true;
  516. };
  517. for (auto child = parent.first_child(); child; child = child->next_sibling()) {
  518. if (matcher(*child) || (!sequence.is_empty() && is_ignorable_whitespace(*child))) {
  519. sequence.append(*child);
  520. } else {
  521. if (!sequence.is_empty()) {
  522. if (!sequence_is_all_ignorable_whitespace())
  523. callback(sequence, child);
  524. sequence.clear();
  525. }
  526. }
  527. }
  528. if (!sequence.is_empty() && !sequence_is_all_ignorable_whitespace())
  529. callback(sequence, nullptr);
  530. }
  531. template<typename WrapperBoxType>
  532. static void wrap_in_anonymous(Vector<JS::Handle<Node>>& sequence, Node* nearest_sibling, CSS::Display display)
  533. {
  534. VERIFY(!sequence.is_empty());
  535. auto& parent = *sequence.first()->parent();
  536. auto computed_values = parent.computed_values().clone_inherited_values();
  537. static_cast<CSS::MutableComputedValues&>(computed_values).set_display(display);
  538. auto wrapper = parent.heap().template allocate_without_realm<WrapperBoxType>(parent.document(), nullptr, move(computed_values));
  539. for (auto& child : sequence) {
  540. parent.remove_child(*child);
  541. wrapper->append_child(*child);
  542. }
  543. wrapper->set_children_are_inline(parent.children_are_inline());
  544. wrapper->set_line_height(parent.line_height());
  545. wrapper->set_font(parent.font());
  546. if (nearest_sibling)
  547. parent.insert_before(*wrapper, *nearest_sibling);
  548. else
  549. parent.append_child(*wrapper);
  550. }
  551. void TreeBuilder::generate_missing_child_wrappers(NodeWithStyle& root)
  552. {
  553. // An anonymous table-row box must be generated around each sequence of consecutive children of a table-root box which are not proper table child boxes.
  554. for_each_in_tree_with_inside_display<CSS::DisplayInside::Table>(root, [&](auto& parent) {
  555. for_each_sequence_of_consecutive_children_matching(parent, is_not_proper_table_child, [&](auto sequence, auto nearest_sibling) {
  556. wrap_in_anonymous<Box>(sequence, nearest_sibling, CSS::Display { CSS::DisplayInternal::TableRow });
  557. });
  558. });
  559. // An anonymous table-row box must be generated around each sequence of consecutive children of a table-row-group box which are not table-row boxes.
  560. for_each_in_tree_with_internal_display<CSS::DisplayInternal::TableRowGroup>(root, [&](auto& parent) {
  561. for_each_sequence_of_consecutive_children_matching(parent, is_not_table_row, [&](auto& sequence, auto nearest_sibling) {
  562. wrap_in_anonymous<Box>(sequence, nearest_sibling, CSS::Display { CSS::DisplayInternal::TableRow });
  563. });
  564. });
  565. // Unless explicitly mentioned otherwise, mentions of table-row-groups in this spec also encompass the specialized
  566. // table-header-groups and table-footer-groups.
  567. for_each_in_tree_with_internal_display<CSS::DisplayInternal::TableHeaderGroup>(root, [&](auto& parent) {
  568. for_each_sequence_of_consecutive_children_matching(parent, is_not_table_row, [&](auto& sequence, auto nearest_sibling) {
  569. wrap_in_anonymous<Box>(sequence, nearest_sibling, CSS::Display { CSS::DisplayInternal::TableRow });
  570. });
  571. });
  572. for_each_in_tree_with_internal_display<CSS::DisplayInternal::TableFooterGroup>(root, [&](auto& parent) {
  573. for_each_sequence_of_consecutive_children_matching(parent, is_not_table_row, [&](auto& sequence, auto nearest_sibling) {
  574. wrap_in_anonymous<Box>(sequence, nearest_sibling, CSS::Display { CSS::DisplayInternal::TableRow });
  575. });
  576. });
  577. // An anonymous table-cell box must be generated around each sequence of consecutive children of a table-row box which are not table-cell boxes. !Testcase
  578. for_each_in_tree_with_internal_display<CSS::DisplayInternal::TableRow>(root, [&](auto& parent) {
  579. for_each_sequence_of_consecutive_children_matching(parent, is_not_table_cell, [&](auto& sequence, auto nearest_sibling) {
  580. wrap_in_anonymous<BlockContainer>(sequence, nearest_sibling, CSS::Display { CSS::DisplayInternal::TableCell });
  581. });
  582. });
  583. }
  584. Vector<JS::Handle<Box>> TreeBuilder::generate_missing_parents(NodeWithStyle& root)
  585. {
  586. Vector<JS::Handle<Box>> table_roots_to_wrap;
  587. root.for_each_in_inclusive_subtree_of_type<Box>([&](auto& parent) {
  588. // An anonymous table-row box must be generated around each sequence of consecutive table-cell boxes whose parent is not a table-row.
  589. if (is_not_table_row(parent)) {
  590. for_each_sequence_of_consecutive_children_matching(parent, is_table_cell, [&](auto& sequence, auto nearest_sibling) {
  591. wrap_in_anonymous<Box>(sequence, nearest_sibling, CSS::Display { CSS::DisplayInternal::TableRow });
  592. });
  593. }
  594. // A table-row is misparented if its parent is neither a table-row-group nor a table-root box.
  595. if (!parent.display().is_table_inside() && !is_proper_table_child(parent)) {
  596. for_each_sequence_of_consecutive_children_matching(parent, is_table_row, [&](auto& sequence, auto nearest_sibling) {
  597. wrap_in_anonymous<Box>(sequence, nearest_sibling, CSS::Display::from_short(parent.display().is_inline_outside() ? CSS::Display::Short::InlineTable : CSS::Display::Short::Table));
  598. });
  599. }
  600. // A table-row-group, table-column-group, or table-caption box is misparented if its parent is not a table-root box.
  601. if (!parent.display().is_table_inside() && !is_proper_table_child(parent)) {
  602. for_each_sequence_of_consecutive_children_matching(parent, is_proper_table_child, [&](auto& sequence, auto nearest_sibling) {
  603. wrap_in_anonymous<Box>(sequence, nearest_sibling, CSS::Display::from_short(parent.display().is_inline_outside() ? CSS::Display::Short::InlineTable : CSS::Display::Short::Table));
  604. });
  605. }
  606. // An anonymous table-wrapper box must be generated around each table-root.
  607. if (parent.display().is_table_inside()) {
  608. table_roots_to_wrap.append(parent);
  609. }
  610. return IterationDecision::Continue;
  611. });
  612. for (auto& table_box : table_roots_to_wrap) {
  613. auto* nearest_sibling = table_box->next_sibling();
  614. auto& parent = *table_box->parent();
  615. CSS::ComputedValues wrapper_computed_values = table_box->computed_values().clone_inherited_values();
  616. table_box->transfer_table_box_computed_values_to_wrapper_computed_values(wrapper_computed_values);
  617. auto wrapper = parent.heap().allocate_without_realm<TableWrapper>(parent.document(), nullptr, move(wrapper_computed_values));
  618. parent.remove_child(*table_box);
  619. wrapper->append_child(*table_box);
  620. wrapper->set_font(parent.font());
  621. wrapper->set_line_height(parent.line_height());
  622. if (nearest_sibling)
  623. parent.insert_before(*wrapper, *nearest_sibling);
  624. else
  625. parent.append_child(*wrapper);
  626. }
  627. return table_roots_to_wrap;
  628. }
  629. template<typename Matcher, typename Callback>
  630. static void for_each_child_box_matching(Box& parent, Matcher matcher, Callback callback)
  631. {
  632. parent.for_each_child_of_type<Box>([&](Box& child_box) {
  633. if (matcher(child_box))
  634. callback(child_box);
  635. });
  636. }
  637. static void fixup_row(Box& row_box, TableGrid const& table_grid, size_t row_index)
  638. {
  639. bool missing_cells_run_has_started = false;
  640. for (size_t column_index = 0; column_index < table_grid.column_count(); ++column_index) {
  641. if (table_grid.occupancy_grid().contains({ column_index, row_index })) {
  642. VERIFY(!missing_cells_run_has_started);
  643. continue;
  644. }
  645. missing_cells_run_has_started = true;
  646. auto row_computed_values = row_box.computed_values().clone_inherited_values();
  647. auto& cell_computed_values = static_cast<CSS::MutableComputedValues&>(row_computed_values);
  648. cell_computed_values.set_display(Web::CSS::Display { CSS::DisplayInternal::TableCell });
  649. // Ensure that the cell (with zero content height) will have the same height as the row by setting vertical-align to middle.
  650. cell_computed_values.set_vertical_align(CSS::VerticalAlign::Middle);
  651. auto cell_box = row_box.heap().template allocate_without_realm<BlockContainer>(row_box.document(), nullptr, cell_computed_values);
  652. cell_box->set_font(row_box.font());
  653. cell_box->set_line_height(row_box.line_height());
  654. row_box.append_child(cell_box);
  655. }
  656. }
  657. void TreeBuilder::missing_cells_fixup(Vector<JS::Handle<Box>> const& table_root_boxes)
  658. {
  659. // Implements https://www.w3.org/TR/css-tables-3/#missing-cells-fixup.
  660. for (auto& table_box : table_root_boxes) {
  661. auto table_grid = TableGrid::calculate_row_column_grid(*table_box);
  662. size_t row_index = 0;
  663. for_each_child_box_matching(*table_box, TableGrid::is_table_row_group, [&](auto& row_group_box) {
  664. for_each_child_box_matching(row_group_box, is_table_row, [&](auto& row_box) {
  665. fixup_row(row_box, table_grid, row_index);
  666. ++row_index;
  667. return IterationDecision::Continue;
  668. });
  669. });
  670. for_each_child_box_matching(*table_box, is_table_row, [&](auto& row_box) {
  671. fixup_row(row_box, table_grid, row_index);
  672. ++row_index;
  673. return IterationDecision::Continue;
  674. });
  675. }
  676. }
  677. }