FlexFormattingContext.cpp 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937
  1. /*
  2. * This source file is part of RmlUi, the HTML/CSS Interface Middleware
  3. *
  4. * For the latest information, see http://github.com/mikke89/RmlUi
  5. *
  6. * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
  7. * Copyright (c) 2019-2023 The RmlUi Team, and contributors
  8. *
  9. * Permission is hereby granted, free of charge, to any person obtaining a copy
  10. * of this software and associated documentation files (the "Software"), to deal
  11. * in the Software without restriction, including without limitation the rights
  12. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13. * copies of the Software, and to permit persons to whom the Software is
  14. * furnished to do so, subject to the following conditions:
  15. *
  16. * The above copyright notice and this permission notice shall be included in
  17. * all copies or substantial portions of the Software.
  18. *
  19. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  25. * THE SOFTWARE.
  26. *
  27. */
  28. #include "FlexFormattingContext.h"
  29. #include "../../../Include/RmlUi/Core/ComputedValues.h"
  30. #include "../../../Include/RmlUi/Core/Element.h"
  31. #include "../../../Include/RmlUi/Core/ElementScroll.h"
  32. #include "../../../Include/RmlUi/Core/Profiling.h"
  33. #include "../../../Include/RmlUi/Core/Types.h"
  34. #include "ContainerBox.h"
  35. #include "LayoutDetails.h"
  36. #include "LayoutEngine.h"
  37. #include <algorithm>
  38. #include <float.h>
  39. #include <numeric>
  40. namespace Rml {
  41. UniquePtr<LayoutBox> FlexFormattingContext::Format(ContainerBox* parent_container, Element* element, const Box* override_initial_box)
  42. {
  43. RMLUI_ZoneScopedC(0xAFAF4F);
  44. auto flex_container_box = MakeUnique<FlexContainer>(element, parent_container);
  45. ElementScroll* element_scroll = element->GetElementScroll();
  46. const ComputedValues& computed = element->GetComputedValues();
  47. const Vector2f containing_block = LayoutDetails::GetContainingBlock(parent_container, element->GetPosition()).size;
  48. RMLUI_ASSERT(containing_block.x >= 0.f);
  49. // Build the initial box as specified by the flex's style, as if it was a normal block element.
  50. Box& box = flex_container_box->GetBox();
  51. if (override_initial_box)
  52. box = *override_initial_box;
  53. else
  54. LayoutDetails::BuildBox(box, containing_block, element, BuildBoxMode::Block);
  55. // Start with any auto-scrollbars off.
  56. flex_container_box->ResetScrollbars(box);
  57. FlexFormattingContext context;
  58. context.flex_container_box = flex_container_box.get();
  59. context.element_flex = element;
  60. LayoutDetails::GetMinMaxWidth(context.flex_min_size.x, context.flex_max_size.x, computed, box, containing_block.x);
  61. LayoutDetails::GetMinMaxHeight(context.flex_min_size.y, context.flex_max_size.y, computed, box, containing_block.y);
  62. const Vector2f box_content_size = box.GetSize();
  63. const bool auto_height = (box_content_size.y < 0.0f);
  64. context.flex_content_offset = box.GetPosition();
  65. for (int layout_iteration = 0; layout_iteration < 3; layout_iteration++)
  66. {
  67. // One or both scrollbars can be enabled between iterations.
  68. const Vector2f scrollbar_size = {
  69. element_scroll->GetScrollbarSize(ElementScroll::VERTICAL),
  70. element_scroll->GetScrollbarSize(ElementScroll::HORIZONTAL),
  71. };
  72. context.flex_available_content_size = Math::Max(box_content_size - scrollbar_size, Vector2f(0.f));
  73. context.flex_content_containing_block = context.flex_available_content_size;
  74. if (auto_height)
  75. {
  76. context.flex_available_content_size.y = -1.f; // Negative means infinite space
  77. context.flex_content_containing_block.y = containing_block.y;
  78. }
  79. Math::SnapToPixelGrid(context.flex_content_offset, context.flex_available_content_size);
  80. // Format the flexbox and all its children.
  81. Vector2f flex_resulting_content_size, content_overflow_size;
  82. float flex_baseline = 0.f;
  83. context.Format(flex_resulting_content_size, content_overflow_size, flex_baseline);
  84. // Output the size of the formatted flexbox. The width is determined as a normal block box so we don't need to change that.
  85. Vector2f formatted_content_size = box_content_size;
  86. if (auto_height)
  87. formatted_content_size.y = flex_resulting_content_size.y + scrollbar_size.y;
  88. Box sized_box = box;
  89. sized_box.SetContent(formatted_content_size);
  90. // Change the flex baseline coordinates to the element baseline, which is defined as the distance from the element's bottom margin edge.
  91. const float element_baseline =
  92. sized_box.GetSizeAcross(BoxDirection::Vertical, BoxArea::Border) + sized_box.GetEdge(BoxArea::Margin, BoxEdge::Bottom) - flex_baseline;
  93. // Close the box, and break out of the loop if it did not produce any new scrollbars, otherwise continue to format the flexbox again.
  94. if (flex_container_box->Close(content_overflow_size, sized_box, element_baseline))
  95. break;
  96. }
  97. return flex_container_box;
  98. }
  99. Vector2f FlexFormattingContext::GetMaxContentSize(Element* element)
  100. {
  101. // A large but finite number is used here, because the flexbox formatting algorithm
  102. // needs to round numbers, and it doesn't support infinities.
  103. const Vector2f infinity(10000.0f, 10000.0f);
  104. RootBox root(infinity);
  105. auto flex_container_box = MakeUnique<FlexContainer>(element, &root);
  106. FlexFormattingContext context;
  107. context.flex_container_box = flex_container_box.get();
  108. context.element_flex = element;
  109. context.flex_available_content_size = Vector2f(-1, -1);
  110. context.flex_content_containing_block = infinity;
  111. context.flex_max_size = Vector2f(FLT_MAX, FLT_MAX);
  112. // Format the flexbox and all its children.
  113. Vector2f flex_resulting_content_size, content_overflow_size;
  114. float flex_baseline = 0.f;
  115. context.Format(flex_resulting_content_size, content_overflow_size, flex_baseline);
  116. return flex_resulting_content_size;
  117. }
  118. struct FlexItem {
  119. // In the following, suffix '_a' means flex start edge while '_b' means flex end edge.
  120. struct Size {
  121. bool auto_margin_a, auto_margin_b;
  122. bool auto_size;
  123. float margin_a, margin_b;
  124. float sum_edges_a; // Start edge: margin (non-auto) + border + padding
  125. float sum_edges; // Inner->outer size
  126. float min_size, max_size; // Inner size
  127. };
  128. Element* element;
  129. Box box;
  130. // Filled during the build step.
  131. Size main;
  132. Size cross;
  133. float flex_shrink_factor;
  134. float flex_grow_factor;
  135. Style::AlignSelf align_self; // 'Auto' is replaced by container's 'align-items' value
  136. float inner_flex_base_size; // Inner size
  137. float flex_base_size; // Outer size
  138. float hypothetical_main_size; // Outer size
  139. // Used for resolving flexible length
  140. enum class Violation : uint8_t { None = 0, Min, Max };
  141. bool frozen;
  142. Violation violation;
  143. float target_main_size; // Outer size
  144. float used_main_size; // Outer size (without auto margins)
  145. float main_auto_margin_size_a, main_auto_margin_size_b;
  146. float main_offset;
  147. // Used for resolving cross size
  148. float hypothetical_cross_size; // Outer size
  149. float used_cross_size; // Outer size
  150. float cross_offset; // Offset within line
  151. float cross_baseline_top; // Only used for baseline cross alignment
  152. };
  153. struct FlexLine {
  154. FlexLine(Vector<FlexItem>&& items) : items(std::move(items)) {}
  155. Vector<FlexItem> items;
  156. float accumulated_hypothetical_main_size = 0;
  157. float cross_size = 0; // Excludes line spacing
  158. float cross_spacing_a = 0, cross_spacing_b = 0;
  159. float cross_offset = 0;
  160. };
  161. struct FlexLineContainer {
  162. Vector<FlexLine> lines;
  163. };
  164. static void GetItemSizing(FlexItem::Size& destination, const ComputedAxisSize& computed_size, const float base_value, const bool direction_reverse)
  165. {
  166. float margin_a, margin_b, padding_border_a, padding_border_b;
  167. LayoutDetails::GetEdgeSizes(margin_a, margin_b, padding_border_a, padding_border_b, computed_size, base_value);
  168. const float padding_border = padding_border_a + padding_border_b;
  169. const float margin = margin_a + margin_b;
  170. destination.auto_margin_a = (computed_size.margin_a.type == Style::Margin::Auto);
  171. destination.auto_margin_b = (computed_size.margin_b.type == Style::Margin::Auto);
  172. destination.auto_size = (computed_size.size.type == Style::LengthPercentageAuto::Auto);
  173. destination.margin_a = margin_a;
  174. destination.margin_b = margin_b;
  175. destination.sum_edges = padding_border + margin;
  176. destination.sum_edges_a = (direction_reverse ? padding_border_b + margin_b : padding_border_a + margin_a);
  177. destination.min_size = ResolveValue(computed_size.min_size, base_value);
  178. destination.max_size = ResolveValue(computed_size.max_size, base_value);
  179. if (computed_size.box_sizing == Style::BoxSizing::BorderBox)
  180. {
  181. destination.min_size = Math::Max(0.0f, destination.min_size - padding_border);
  182. if (destination.max_size < FLT_MAX)
  183. destination.max_size = Math::Max(0.0f, destination.max_size - padding_border);
  184. }
  185. if (direction_reverse)
  186. {
  187. std::swap(destination.auto_margin_a, destination.auto_margin_b);
  188. std::swap(destination.margin_a, destination.margin_b);
  189. }
  190. }
  191. void FlexFormattingContext::Format(Vector2f& flex_resulting_content_size, Vector2f& flex_content_overflow_size, float& flex_baseline) const
  192. {
  193. // The following procedure is based on the CSS flexible box layout algorithm.
  194. // For details, see https://drafts.csswg.org/css-flexbox/#layout-algorithm
  195. const ComputedValues& computed_flex = element_flex->GetComputedValues();
  196. const Style::FlexDirection direction = computed_flex.flex_direction();
  197. const bool main_axis_horizontal = (direction == Style::FlexDirection::Row || direction == Style::FlexDirection::RowReverse);
  198. const bool direction_reverse = (direction == Style::FlexDirection::RowReverse || direction == Style::FlexDirection::ColumnReverse);
  199. const bool flex_single_line = (computed_flex.flex_wrap() == Style::FlexWrap::Nowrap);
  200. const bool wrap_reverse = (computed_flex.flex_wrap() == Style::FlexWrap::WrapReverse);
  201. const float main_available_size = (main_axis_horizontal ? flex_available_content_size.x : flex_available_content_size.y);
  202. const float cross_available_size = (!main_axis_horizontal ? flex_available_content_size.x : flex_available_content_size.y);
  203. const float main_min_size = (main_axis_horizontal ? flex_min_size.x : flex_min_size.y);
  204. const float main_max_size = (main_axis_horizontal ? flex_max_size.x : flex_max_size.y);
  205. const float cross_min_size = (main_axis_horizontal ? flex_min_size.y : flex_min_size.x);
  206. const float cross_max_size = (main_axis_horizontal ? flex_max_size.y : flex_max_size.x);
  207. // For the purpose of placing items we make infinite size a big value.
  208. const float main_wrap_size = Math::Clamp(main_available_size < 0.0f ? FLT_MAX : main_available_size, main_min_size, main_max_size);
  209. // For the purpose of resolving lengths, infinite main size becomes zero.
  210. const float main_size_base_value = (main_available_size < 0.0f ? 0.0f : main_available_size);
  211. const float cross_size_base_value = (cross_available_size < 0.0f ? 0.0f : cross_available_size);
  212. // -- Build a list of all flex items with base size information --
  213. const int num_flex_children = element_flex->GetNumChildren();
  214. Vector<FlexItem> items;
  215. items.reserve(num_flex_children);
  216. for (int i = 0; i < num_flex_children; i++)
  217. {
  218. Element* element = element_flex->GetChild(i);
  219. const ComputedValues& computed = element->GetComputedValues();
  220. if (computed.display() == Style::Display::None)
  221. {
  222. continue;
  223. }
  224. else if (computed.position() == Style::Position::Absolute || computed.position() == Style::Position::Fixed)
  225. {
  226. ContainerBox* absolute_containing_block = LayoutDetails::GetContainingBlock(flex_container_box, computed.position()).container;
  227. absolute_containing_block->AddAbsoluteElement(element, {}, element_flex);
  228. continue;
  229. }
  230. else if (computed.position() == Style::Position::Relative)
  231. {
  232. flex_container_box->AddRelativeElement(element);
  233. }
  234. FlexItem item = {};
  235. item.element = element;
  236. LayoutDetails::BuildBox(item.box, flex_content_containing_block, element, BuildBoxMode::UnalignedBlock);
  237. Style::LengthPercentageAuto item_main_size;
  238. {
  239. const ComputedAxisSize computed_main_size =
  240. main_axis_horizontal ? LayoutDetails::BuildComputedHorizontalSize(computed) : LayoutDetails::BuildComputedVerticalSize(computed);
  241. const ComputedAxisSize computed_cross_size =
  242. !main_axis_horizontal ? LayoutDetails::BuildComputedHorizontalSize(computed) : LayoutDetails::BuildComputedVerticalSize(computed);
  243. GetItemSizing(item.main, computed_main_size, main_size_base_value, direction_reverse);
  244. GetItemSizing(item.cross, computed_cross_size, cross_size_base_value, wrap_reverse);
  245. item_main_size = computed_main_size.size;
  246. }
  247. item.flex_shrink_factor = computed.flex_shrink();
  248. item.flex_grow_factor = computed.flex_grow();
  249. item.align_self = computed.align_self();
  250. static_assert(int(Style::AlignSelf::FlexStart) == int(Style::AlignItems::FlexStart) + 1 &&
  251. int(Style::AlignSelf::Stretch) == int(Style::AlignItems::Stretch) + 1,
  252. "It is assumed below that align items is a shifted version (no auto value) of align self.");
  253. // Use the container's align-items property if align-self is auto.
  254. if (item.align_self == Style::AlignSelf::Auto)
  255. item.align_self = static_cast<Style::AlignSelf>(static_cast<int>(computed_flex.align_items()) + 1);
  256. const float sum_padding_border = item.main.sum_edges - (item.main.margin_a + item.main.margin_b);
  257. // Find the flex base size (possibly negative when using border box sizing)
  258. if (computed.flex_basis().type != Style::FlexBasis::Auto)
  259. {
  260. item.inner_flex_base_size = ResolveValue(computed.flex_basis(), main_size_base_value);
  261. if (computed.box_sizing() == Style::BoxSizing::BorderBox)
  262. item.inner_flex_base_size -= sum_padding_border;
  263. }
  264. else if (!item.main.auto_size)
  265. {
  266. item.inner_flex_base_size = ResolveValue(item_main_size, main_size_base_value);
  267. if (computed.box_sizing() == Style::BoxSizing::BorderBox)
  268. item.inner_flex_base_size -= sum_padding_border;
  269. }
  270. else if (main_axis_horizontal)
  271. {
  272. item.inner_flex_base_size = LayoutDetails::GetShrinkToFitWidth(element, flex_content_containing_block);
  273. }
  274. else
  275. {
  276. const Vector2f initial_box_size = item.box.GetSize();
  277. RMLUI_ASSERT(initial_box_size.y < 0.f);
  278. Box format_box = item.box;
  279. if (initial_box_size.x < 0.f && flex_available_content_size.x >= 0.f)
  280. format_box.SetContent(Vector2f(flex_available_content_size.x - item.cross.sum_edges, initial_box_size.y));
  281. FormattingContext::FormatIndependent(flex_container_box, element, (format_box.GetSize().x >= 0 ? &format_box : nullptr),
  282. FormattingContextType::Block);
  283. item.inner_flex_base_size = element->GetBox().GetSize().y;
  284. }
  285. // Calculate the hypothetical main size (clamped flex base size).
  286. item.hypothetical_main_size = Math::Clamp(item.inner_flex_base_size, item.main.min_size, item.main.max_size) + item.main.sum_edges;
  287. item.flex_base_size = item.inner_flex_base_size + item.main.sum_edges;
  288. items.push_back(std::move(item));
  289. }
  290. if (items.empty())
  291. {
  292. return;
  293. }
  294. // -- Collect the items into lines --
  295. FlexLineContainer container;
  296. if (flex_single_line)
  297. {
  298. container.lines.emplace_back(std::move(items));
  299. }
  300. else
  301. {
  302. float cursor = 0;
  303. Vector<FlexItem> line_items;
  304. for (FlexItem& item : items)
  305. {
  306. cursor += item.hypothetical_main_size;
  307. if (!line_items.empty() && cursor > main_wrap_size)
  308. {
  309. // Break into new line.
  310. container.lines.emplace_back(std::move(line_items));
  311. cursor = item.hypothetical_main_size;
  312. line_items = {std::move(item)};
  313. }
  314. else
  315. {
  316. // Add item to current line.
  317. line_items.push_back(std::move(item));
  318. }
  319. }
  320. if (!line_items.empty())
  321. container.lines.emplace_back(std::move(line_items));
  322. items.clear();
  323. items.shrink_to_fit();
  324. }
  325. for (FlexLine& line : container.lines)
  326. {
  327. line.accumulated_hypothetical_main_size = std::accumulate(line.items.begin(), line.items.end(), 0.0f,
  328. [](float value, const FlexItem& item) { return value + item.hypothetical_main_size; });
  329. }
  330. // If the available main size is infinite, the used main size becomes the accumulated outer size of all items of the widest line.
  331. const float used_main_size_unconstrained = main_available_size >= 0.f
  332. ? main_available_size
  333. : std::max_element(container.lines.begin(), container.lines.end(), [](const FlexLine& a, const FlexLine& b) {
  334. return a.accumulated_hypothetical_main_size < b.accumulated_hypothetical_main_size;
  335. })->accumulated_hypothetical_main_size;
  336. const float used_main_size = Math::Clamp(used_main_size_unconstrained, main_min_size, main_max_size);
  337. // -- Determine main size --
  338. // Resolve flexible lengths to find the used main size of all items.
  339. for (FlexLine& line : container.lines)
  340. {
  341. const float available_flex_space = used_main_size - line.accumulated_hypothetical_main_size; // Possibly negative
  342. const bool flex_mode_grow = (available_flex_space > 0.f);
  343. auto FlexFactor = [flex_mode_grow](const FlexItem& item) { return (flex_mode_grow ? item.flex_grow_factor : item.flex_shrink_factor); };
  344. // Initialize items and freeze inflexible items.
  345. for (FlexItem& item : line.items)
  346. {
  347. item.target_main_size = item.flex_base_size;
  348. if (FlexFactor(item) == 0.f || (flex_mode_grow && item.flex_base_size > item.hypothetical_main_size) ||
  349. (!flex_mode_grow && item.flex_base_size < item.hypothetical_main_size))
  350. {
  351. item.frozen = true;
  352. item.target_main_size = item.hypothetical_main_size;
  353. }
  354. }
  355. auto RemainingFreeSpace = [used_main_size, &line]() {
  356. return used_main_size - std::accumulate(line.items.begin(), line.items.end(), 0.f, [](float value, const FlexItem& item) {
  357. return value + (item.frozen ? item.target_main_size : item.flex_base_size);
  358. });
  359. };
  360. const float initial_free_space = RemainingFreeSpace();
  361. // Now iteratively distribute or shrink the size of all the items, until all the items are frozen.
  362. while (!std::all_of(line.items.begin(), line.items.end(), [](const FlexItem& item) { return item.frozen; }))
  363. {
  364. float remaining_free_space = RemainingFreeSpace();
  365. const float flex_factor_sum = std::accumulate(line.items.begin(), line.items.end(), 0.f,
  366. [&FlexFactor](float value, const FlexItem& item) { return value + (item.frozen ? 0.0f : FlexFactor(item)); });
  367. if (flex_factor_sum < 1.f)
  368. {
  369. const float scaled_initial_free_space = initial_free_space * flex_factor_sum;
  370. if (Math::Absolute(scaled_initial_free_space) < Math::Absolute(remaining_free_space))
  371. remaining_free_space = scaled_initial_free_space;
  372. }
  373. if (remaining_free_space != 0.f)
  374. {
  375. // Distribute free space proportionally to flex factors
  376. if (flex_mode_grow)
  377. {
  378. for (FlexItem& item : line.items)
  379. {
  380. if (!item.frozen)
  381. {
  382. const float distribute_ratio = item.flex_grow_factor / flex_factor_sum;
  383. item.target_main_size = item.flex_base_size + distribute_ratio * remaining_free_space;
  384. }
  385. }
  386. }
  387. else
  388. {
  389. const float scaled_flex_shrink_factor_sum =
  390. std::accumulate(line.items.begin(), line.items.end(), 0.f, [](float value, const FlexItem& item) {
  391. return value + (item.frozen ? 0.0f : item.flex_shrink_factor * item.inner_flex_base_size);
  392. });
  393. const float scaled_flex_shrink_factor_sum_nonzero = (scaled_flex_shrink_factor_sum == 0 ? 1 : scaled_flex_shrink_factor_sum);
  394. for (FlexItem& item : line.items)
  395. {
  396. if (!item.frozen)
  397. {
  398. const float scaled_flex_shrink_factor = item.flex_shrink_factor * item.inner_flex_base_size;
  399. const float distribute_ratio = scaled_flex_shrink_factor / scaled_flex_shrink_factor_sum_nonzero;
  400. item.target_main_size = item.flex_base_size - distribute_ratio * Math::Absolute(remaining_free_space);
  401. }
  402. }
  403. }
  404. }
  405. // Clamp min/max violations
  406. float total_minmax_violation = 0.f;
  407. for (FlexItem& item : line.items)
  408. {
  409. if (!item.frozen)
  410. {
  411. const float inner_target_main_size = Math::Max(0.0f, item.target_main_size - item.main.sum_edges);
  412. const float clamped_target_main_size =
  413. Math::Clamp(inner_target_main_size, item.main.min_size, item.main.max_size) + item.main.sum_edges;
  414. const float violation_diff = clamped_target_main_size - item.target_main_size;
  415. item.violation = (violation_diff > 0.0f ? FlexItem::Violation::Min
  416. : (violation_diff < 0.f ? FlexItem::Violation::Max : FlexItem::Violation::None));
  417. item.target_main_size = clamped_target_main_size;
  418. total_minmax_violation += violation_diff;
  419. }
  420. }
  421. for (FlexItem& item : line.items)
  422. {
  423. if (total_minmax_violation > 0.0f)
  424. item.frozen |= (item.violation == FlexItem::Violation::Min);
  425. else if (total_minmax_violation < 0.0f)
  426. item.frozen |= (item.violation == FlexItem::Violation::Max);
  427. else
  428. item.frozen = true;
  429. }
  430. }
  431. // Now, each item's used main size is found!
  432. for (FlexItem& item : line.items)
  433. item.used_main_size = item.target_main_size;
  434. }
  435. // -- Align main axis (§9.5) --
  436. // Main alignment is done before cross sizing. Due to rounding to the pixel grid, the main size can
  437. // change slightly after main alignment/offseting. Also, the cross sizing depends on the main sizing
  438. // so doing it in this order ensures no surprises (overflow/wrapping issues) due to pixel rounding.
  439. for (FlexLine& line : container.lines)
  440. {
  441. const float remaining_free_space = used_main_size -
  442. std::accumulate(line.items.begin(), line.items.end(), 0.f, [](float value, const FlexItem& item) { return value + item.used_main_size; });
  443. if (remaining_free_space > 0.0f)
  444. {
  445. const int num_auto_margins = std::accumulate(line.items.begin(), line.items.end(), 0,
  446. [](int value, const FlexItem& item) { return value + int(item.main.auto_margin_a) + int(item.main.auto_margin_b); });
  447. if (num_auto_margins > 0)
  448. {
  449. // Distribute the remaining space to the auto margins.
  450. const float space_per_auto_margin = remaining_free_space / float(num_auto_margins);
  451. for (FlexItem& item : line.items)
  452. {
  453. if (item.main.auto_margin_a)
  454. item.main_auto_margin_size_a = space_per_auto_margin;
  455. if (item.main.auto_margin_b)
  456. item.main_auto_margin_size_b = space_per_auto_margin;
  457. }
  458. }
  459. else
  460. {
  461. // Distribute the remaining space based on the 'justify-content' property.
  462. using Style::JustifyContent;
  463. const int num_items = int(line.items.size());
  464. switch (computed_flex.justify_content())
  465. {
  466. case JustifyContent::SpaceBetween:
  467. if (num_items > 1)
  468. {
  469. const float space_per_edge = remaining_free_space / float(2 * num_items - 2);
  470. for (int i = 0; i < num_items; i++)
  471. {
  472. FlexItem& item = line.items[i];
  473. if (i > 0)
  474. item.main_auto_margin_size_a = space_per_edge;
  475. if (i < num_items - 1)
  476. item.main_auto_margin_size_b = space_per_edge;
  477. }
  478. break;
  479. }
  480. //-fallthrough
  481. case JustifyContent::FlexStart: line.items.back().main_auto_margin_size_b = remaining_free_space; break;
  482. case JustifyContent::FlexEnd: line.items.front().main_auto_margin_size_a = remaining_free_space; break;
  483. case JustifyContent::Center:
  484. line.items.front().main_auto_margin_size_a = 0.5f * remaining_free_space;
  485. line.items.back().main_auto_margin_size_b = 0.5f * remaining_free_space;
  486. break;
  487. case JustifyContent::SpaceAround:
  488. {
  489. const float space_per_edge = remaining_free_space / float(2 * num_items);
  490. for (FlexItem& item : line.items)
  491. {
  492. item.main_auto_margin_size_a = space_per_edge;
  493. item.main_auto_margin_size_b = space_per_edge;
  494. }
  495. }
  496. break;
  497. case JustifyContent::SpaceEvenly:
  498. {
  499. const float space_per_edge = remaining_free_space / float(2 * (num_items + 1));
  500. for (int i = 0; i < num_items; i++)
  501. {
  502. FlexItem& item = line.items[i];
  503. item.main_auto_margin_size_a = space_per_edge;
  504. item.main_auto_margin_size_b = space_per_edge;
  505. if (i == 0)
  506. item.main_auto_margin_size_a *= 2.0f;
  507. else if (i == num_items - 1)
  508. item.main_auto_margin_size_b *= 2.0f;
  509. }
  510. }
  511. break;
  512. }
  513. }
  514. }
  515. // Now find the offset and snap the outer edges to the pixel grid.
  516. float cursor = 0.0f;
  517. for (FlexItem& item : line.items)
  518. {
  519. if (direction_reverse)
  520. item.main_offset = used_main_size - (cursor + item.used_main_size + item.main_auto_margin_size_a - item.main.margin_b);
  521. else
  522. item.main_offset = cursor + item.main.margin_a + item.main_auto_margin_size_a;
  523. cursor += item.used_main_size + item.main_auto_margin_size_a + item.main_auto_margin_size_b;
  524. Math::SnapToPixelGrid(item.main_offset, item.used_main_size);
  525. }
  526. }
  527. // -- Determine cross size (§9.4) --
  528. // First, determine the cross size of each item, format it if necessary.
  529. for (FlexLine& line : container.lines)
  530. {
  531. for (FlexItem& item : line.items)
  532. {
  533. const Vector2f content_size = item.box.GetSize();
  534. const float used_main_size_inner = item.used_main_size - item.main.sum_edges;
  535. if (main_axis_horizontal)
  536. {
  537. if (content_size.y < 0.0f)
  538. {
  539. item.box.SetContent(Vector2f(used_main_size_inner, content_size.y));
  540. FormattingContext::FormatIndependent(flex_container_box, item.element, &item.box, FormattingContextType::Block);
  541. item.hypothetical_cross_size = item.element->GetBox().GetSize().y + item.cross.sum_edges;
  542. }
  543. else
  544. {
  545. item.hypothetical_cross_size = content_size.y + item.cross.sum_edges;
  546. }
  547. }
  548. else
  549. {
  550. if (content_size.x < 0.0f || item.cross.auto_size)
  551. {
  552. item.box.SetContent(Vector2f(content_size.x, used_main_size_inner));
  553. item.hypothetical_cross_size =
  554. LayoutDetails::GetShrinkToFitWidth(item.element, flex_content_containing_block) + item.cross.sum_edges;
  555. }
  556. else
  557. {
  558. item.hypothetical_cross_size = content_size.x + item.cross.sum_edges;
  559. }
  560. }
  561. }
  562. }
  563. // Determine cross size of each line.
  564. if (cross_available_size >= 0.f && flex_single_line && container.lines.size() == 1)
  565. {
  566. container.lines[0].cross_size = cross_available_size;
  567. }
  568. else
  569. {
  570. for (FlexLine& line : container.lines)
  571. {
  572. const float largest_hypothetical_cross_size =
  573. std::max_element(line.items.begin(), line.items.end(), [](const FlexItem& a, const FlexItem& b) {
  574. return a.hypothetical_cross_size < b.hypothetical_cross_size;
  575. })->hypothetical_cross_size;
  576. // Currently, we don't handle the case where baseline alignment could extend the line's cross size, see CSS specs 9.4.8.
  577. line.cross_size = Math::Max(0.0f, Math::Round(largest_hypothetical_cross_size));
  578. if (flex_single_line)
  579. line.cross_size = Math::Clamp(line.cross_size, cross_min_size, cross_max_size);
  580. }
  581. }
  582. // Stretch out the lines if we have extra space.
  583. if (cross_available_size >= 0.f && computed_flex.align_content() == Style::AlignContent::Stretch)
  584. {
  585. int remaining_space = static_cast<int>(cross_available_size -
  586. std::accumulate(container.lines.begin(), container.lines.end(), 0.f,
  587. [](float value, const FlexLine& line) { return value + line.cross_size; }));
  588. if (remaining_space > 0)
  589. {
  590. // Here we use integer math to ensure all space is distributed to pixel boundaries.
  591. const int num_lines = (int)container.lines.size();
  592. for (int i = 0; i < num_lines; i++)
  593. {
  594. const int add_space_to_line = remaining_space / (num_lines - i);
  595. remaining_space -= add_space_to_line;
  596. container.lines[i].cross_size += static_cast<float>(add_space_to_line);
  597. }
  598. }
  599. }
  600. // Determine the used cross size of items.
  601. for (FlexLine& line : container.lines)
  602. {
  603. for (FlexItem& item : line.items)
  604. {
  605. const bool stretch_item = (item.align_self == Style::AlignSelf::Stretch);
  606. if (stretch_item && item.cross.auto_size && !item.cross.auto_margin_a && !item.cross.auto_margin_b)
  607. {
  608. item.used_cross_size =
  609. Math::Clamp(line.cross_size - item.cross.sum_edges, item.cross.min_size, item.cross.max_size) + item.cross.sum_edges;
  610. // Here we are supposed to re-format the item with the new size, so that percentages can be resolved, see CSS specs Sec. 9.4.11. Seems
  611. // very slow, we skip this for now.
  612. }
  613. else
  614. {
  615. item.used_cross_size = item.hypothetical_cross_size;
  616. }
  617. }
  618. }
  619. // -- Align cross axis (§9.6) --
  620. for (FlexLine& line : container.lines)
  621. {
  622. constexpr float UndefinedBaseline = -FLT_MAX;
  623. float max_baseline_edge_distance = UndefinedBaseline;
  624. FlexItem* max_baseline_item = nullptr;
  625. for (FlexItem& item : line.items)
  626. {
  627. const float remaining_space = line.cross_size - item.used_cross_size;
  628. item.cross_offset = item.cross.margin_a;
  629. item.cross_baseline_top = UndefinedBaseline;
  630. const int num_auto_margins = int(item.cross.auto_margin_a) + int(item.cross.auto_margin_b);
  631. if (num_auto_margins > 0)
  632. {
  633. const float space_per_auto_margin = Math::Max(remaining_space, 0.0f) / float(num_auto_margins);
  634. item.cross_offset = item.cross.margin_a + (item.cross.auto_margin_a ? space_per_auto_margin : 0.f);
  635. }
  636. else
  637. {
  638. using Style::AlignSelf;
  639. const AlignSelf align_self = item.align_self;
  640. switch (align_self)
  641. {
  642. case AlignSelf::Auto:
  643. // Never encountered here: should already have been replaced by container's align-items property.
  644. RMLUI_ERROR;
  645. break;
  646. case AlignSelf::FlexStart:
  647. // Do nothing, cross offset set above with this behavior.
  648. break;
  649. case AlignSelf::FlexEnd: item.cross_offset = item.cross.margin_a + remaining_space; break;
  650. case AlignSelf::Center: item.cross_offset = item.cross.margin_a + 0.5f * remaining_space; break;
  651. case AlignSelf::Baseline:
  652. {
  653. // We don't currently have a good way to get the true baseline here, so we make a very rough zero-effort approximation.
  654. const float baseline_heuristic = 0.5f * item.element->GetLineHeight();
  655. const float sum_edges_top = (wrap_reverse ? item.cross.sum_edges - item.cross.sum_edges_a : item.cross.sum_edges_a);
  656. item.cross_baseline_top = sum_edges_top + baseline_heuristic;
  657. const float baseline_edge_distance = (wrap_reverse ? item.used_cross_size - item.cross_baseline_top : item.cross_baseline_top);
  658. if (baseline_edge_distance > max_baseline_edge_distance)
  659. {
  660. max_baseline_item = &item;
  661. max_baseline_edge_distance = baseline_edge_distance;
  662. }
  663. }
  664. break;
  665. case AlignSelf::Stretch:
  666. // Handled above
  667. break;
  668. }
  669. }
  670. if (wrap_reverse)
  671. {
  672. const float reverse_offset = line.cross_size - item.used_cross_size + item.cross.margin_a + item.cross.margin_b;
  673. item.cross_offset = reverse_offset - item.cross_offset;
  674. }
  675. }
  676. if (max_baseline_item)
  677. {
  678. // Align all baseline items such that their baselines are aligned with the one with the max. baseline distance.
  679. // Cross offset for all baseline items are currently set as in 'flex-start'.
  680. const float max_baseline_margin_top = (wrap_reverse ? max_baseline_item->cross.margin_b : max_baseline_item->cross.margin_a);
  681. const float line_top_to_baseline_distance =
  682. max_baseline_item->cross_offset - max_baseline_margin_top + max_baseline_item->cross_baseline_top;
  683. for (FlexItem& item : line.items)
  684. {
  685. if (item.cross_baseline_top != UndefinedBaseline)
  686. {
  687. const float margin_top = (wrap_reverse ? item.cross.margin_b : item.cross.margin_a);
  688. item.cross_offset = line_top_to_baseline_distance - item.cross_baseline_top + margin_top;
  689. }
  690. }
  691. }
  692. // Snap the outer item cross edges to the pixel grid.
  693. for (FlexItem& item : line.items)
  694. Math::SnapToPixelGrid(item.cross_offset, item.used_cross_size);
  695. }
  696. const float accumulated_lines_cross_size = std::accumulate(container.lines.begin(), container.lines.end(), 0.f,
  697. [](float value, const FlexLine& line) { return value + line.cross_size; });
  698. // If the available cross size is infinite, the used cross size becomes the accumulated line cross size.
  699. const float used_cross_size_unconstrained = cross_available_size >= 0.f ? cross_available_size : accumulated_lines_cross_size;
  700. const float used_cross_size = Math::Clamp(used_cross_size_unconstrained, cross_min_size, cross_max_size);
  701. // Align the lines along the cross-axis.
  702. {
  703. const float remaining_free_space = used_cross_size - accumulated_lines_cross_size;
  704. const int num_lines = int(container.lines.size());
  705. if (remaining_free_space > 0.f)
  706. {
  707. using Style::AlignContent;
  708. switch (computed_flex.align_content())
  709. {
  710. case AlignContent::SpaceBetween:
  711. if (num_lines > 1)
  712. {
  713. const float space_per_edge = remaining_free_space / float(2 * num_lines - 2);
  714. for (int i = 0; i < num_lines; i++)
  715. {
  716. FlexLine& line = container.lines[i];
  717. if (i > 0)
  718. line.cross_spacing_a = space_per_edge;
  719. if (i < num_lines - 1)
  720. line.cross_spacing_b = space_per_edge;
  721. }
  722. }
  723. //-fallthrough
  724. case AlignContent::FlexStart: container.lines.back().cross_spacing_b = remaining_free_space; break;
  725. case AlignContent::FlexEnd: container.lines.front().cross_spacing_a = remaining_free_space; break;
  726. case AlignContent::Center:
  727. container.lines.front().cross_spacing_a = 0.5f * remaining_free_space;
  728. container.lines.back().cross_spacing_b = 0.5f * remaining_free_space;
  729. break;
  730. case AlignContent::SpaceAround:
  731. {
  732. const float space_per_edge = remaining_free_space / float(2 * num_lines);
  733. for (FlexLine& line : container.lines)
  734. {
  735. line.cross_spacing_a = space_per_edge;
  736. line.cross_spacing_b = space_per_edge;
  737. }
  738. }
  739. break;
  740. case AlignContent::SpaceEvenly:
  741. {
  742. const float space_per_edge = remaining_free_space / float(2 * (num_lines + 1));
  743. for (int i = 0; i < num_lines; i++)
  744. {
  745. FlexLine& line = container.lines[i];
  746. line.cross_spacing_a = space_per_edge;
  747. line.cross_spacing_b = space_per_edge;
  748. if (i == 0)
  749. line.cross_spacing_a *= 2.0f;
  750. else if (i == num_lines - 1)
  751. line.cross_spacing_b *= 2.0f;
  752. }
  753. }
  754. break;
  755. case AlignContent::Stretch:
  756. // Handled above.
  757. break;
  758. }
  759. }
  760. // Now find the offset and snap the line edges to the pixel grid.
  761. float cursor = 0.f;
  762. for (FlexLine& line : container.lines)
  763. {
  764. if (wrap_reverse)
  765. line.cross_offset = used_cross_size - (cursor + line.cross_spacing_a + line.cross_size);
  766. else
  767. line.cross_offset = cursor + line.cross_spacing_a;
  768. cursor += line.cross_spacing_a + line.cross_size + line.cross_spacing_b;
  769. Math::SnapToPixelGrid(line.cross_offset, line.cross_size);
  770. }
  771. }
  772. auto MainCrossToVec2 = [main_axis_horizontal](const float v_main, const float v_cross) {
  773. return main_axis_horizontal ? Vector2f(v_main, v_cross) : Vector2f(v_cross, v_main);
  774. };
  775. bool baseline_set = false;
  776. // -- Format items --
  777. for (FlexLine& line : container.lines)
  778. {
  779. for (FlexItem& item : line.items)
  780. {
  781. const Vector2f item_size = MainCrossToVec2(item.used_main_size - item.main.sum_edges, item.used_cross_size - item.cross.sum_edges);
  782. const Vector2f item_offset = MainCrossToVec2(item.main_offset, line.cross_offset + item.cross_offset);
  783. item.box.SetContent(item_size);
  784. UniquePtr<LayoutBox> item_layout_box =
  785. FormattingContext::FormatIndependent(flex_container_box, item.element, &item.box, FormattingContextType::Block);
  786. // Set the position of the element within the the flex container
  787. item.element->SetOffset(flex_content_offset + item_offset, element_flex);
  788. // The flex container baseline is simply set to the first flex item that has a baseline.
  789. if (!baseline_set && item_layout_box->GetBaselineOfLastLine(flex_baseline))
  790. {
  791. flex_baseline += flex_content_offset.y + item_offset.y;
  792. baseline_set = true;
  793. }
  794. // The cell contents may overflow, propagate this to the flex container.
  795. const Vector2f overflow_size = item_offset + item_layout_box->GetVisibleOverflowSize();
  796. flex_content_overflow_size = Math::Max(flex_content_overflow_size, overflow_size);
  797. }
  798. }
  799. flex_resulting_content_size = MainCrossToVec2(used_main_size, used_cross_size);
  800. }
  801. } // namespace Rml