Demo

/* * This source file is part of RmlUi, the HTML/CSS Interface Middleware * * For the latest information, see http://github.com/mikke89/RmlUi * * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd * Copyright (c) 2019-2025 The RmlUi Team, and contributors * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * */ #include "../../../Source/Core/Layout/FormattingContextDebug.h" #include "../../../Source/Core/Layout/LayoutNode.h" #include "../Common/TestsShell.h" #include "../Common/TypesToString.h" #include #include #include #include #include #include #include #include #include using namespace Rml; struct ElementLayoutInfo { ElementLayoutInfo(int tree_depth, const String& address, const Box& box, Vector2f absolute_offset) : tree_depth(tree_depth), address(address), box(box), absolute_offset(absolute_offset) {} int tree_depth; String address; Box box; Vector2f absolute_offset; bool operator==(const ElementLayoutInfo& other) const { return tree_depth == other.tree_depth && address == other.address && box == other.box && absolute_offset == other.absolute_offset; } bool operator!=(const ElementLayoutInfo& other) const { return !(*this == other); } String ToString() const { return String(size_t(4 * tree_depth), ' ') + CreateString("%s :: box = %g x %g (outer %g x %g) :: absolute_offset = %g x %g", address.c_str(), box.GetSize().x, box.GetSize().y, box.GetSizeAcross(BoxDirection::Horizontal, BoxArea::Margin), box.GetSizeAcross(BoxDirection::Vertical, BoxArea::Margin), absolute_offset.x, absolute_offset.y); } }; static Vector CaptureLayoutTree(Element* root_element) { Vector layout_info_list; ElementUtilities::VisitElementsDepthOrder(root_element, [&](Element* element, int tree_depth) { layout_info_list.emplace_back(tree_depth, element->GetAddress(false, false), element->GetBox(), element->GetAbsoluteOffset()); }); return layout_info_list; } static void LogLayoutTree(const Vector& layout_info_list) { String message = "Element layout tree:\n"; for (const auto& layout_info : layout_info_list) message += layout_info.ToString() + "\n"; Rml::Log::Message(Rml::Log::LT_DEBUG, "%s", message.c_str()); } static const String document_isolation_rml = R"(

Flex item 1

Flex item 2

Flex item 3

Overflow item 1

Overflow item 2

Overflow item 3

Overflow item 4

Overflow item 5

Absolute item 1

Absolute item 2

Normal block box

)"; TEST_CASE("LayoutIsolation.InsideOutsideFormattingContexts") { Context* context = TestsShell::GetContext(); ElementDocument* document = context->LoadDocumentFromMemory(document_isolation_rml); document->Show(); TestsShell::RenderLoop(); SUBCASE("Flex") { Element* element = document->GetElementById("flex-item"); Element* next_sibling = element->GetNextSibling(); Element* normal_container = document->GetElementById("normal-container"); Element* normal_item = document->GetElementById("normal-item"); const Vector2f absolute_offset_element = element->GetAbsoluteOffset(); const Vector2f absolute_offset_next_sibling = next_sibling->GetAbsoluteOffset(); const Vector2f absolute_offset_normal_container = normal_container->GetAbsoluteOffset(); const Vector2f absolute_offset_normal_item = normal_item->GetAbsoluteOffset(); rmlui_dynamic_cast(element->GetFirstChild())->SetText("Modified text that is long enough to cause line break"); TestsShell::RenderLoop(); CHECK(element->GetAbsoluteOffset() == absolute_offset_element); CHECK(next_sibling->GetAbsoluteOffset() != absolute_offset_next_sibling); CHECK(normal_container->GetAbsoluteOffset() != absolute_offset_normal_container); CHECK(normal_item->GetAbsoluteOffset() != absolute_offset_normal_item); } SUBCASE("Overflow") { Element* element = document->GetElementById("overflow-item"); Element* next_sibling = element->GetNextSibling(); Element* normal_container = document->GetElementById("normal-container"); Element* normal_item = document->GetElementById("normal-item"); const Vector2f absolute_offset_element = element->GetAbsoluteOffset(); const Vector2f absolute_offset_next_sibling = next_sibling->GetAbsoluteOffset(); const Vector2f absolute_offset_normal_container = normal_container->GetAbsoluteOffset(); const Vector2f absolute_offset_normal_item = normal_item->GetAbsoluteOffset(); rmlui_dynamic_cast(element->GetFirstChild())->SetText("Modified text that is long enough to cause line break"); TestsShell::RenderLoop(); CHECK(element->GetAbsoluteOffset() == absolute_offset_element); CHECK(next_sibling->GetAbsoluteOffset() != absolute_offset_next_sibling); CHECK(normal_container->GetAbsoluteOffset() == absolute_offset_normal_container); CHECK(normal_item->GetAbsoluteOffset() == absolute_offset_normal_item); } SUBCASE("Absolute") { Element* element = document->GetElementById("absolute-item"); Element* next_sibling = element->GetNextSibling(); REQUIRE(element); REQUIRE(next_sibling); const Vector2f absolute_offset_element = element->GetAbsoluteOffset(); const Vector2f absolute_offset_next_sibling = next_sibling->GetAbsoluteOffset(); rmlui_dynamic_cast(element->GetFirstChild())->SetText("Modified text that is long enough to cause line break"); TestsShell::RenderLoop(); CHECK(element->GetAbsoluteOffset() == absolute_offset_element); CHECK(next_sibling->GetAbsoluteOffset() != absolute_offset_next_sibling); } SUBCASE("Normal") { Element* element = document->GetElementById("normal-item"); REQUIRE(element); const float initial_width = element->GetBox().GetSize().x; element->SetProperty("width", "250px"); TestsShell::RenderLoop(); float new_width = element->GetBox().GetSize().x; CHECK(new_width != initial_width); CHECK(new_width == doctest::Approx(250.0f)); } document->Close(); TestsShell::ShutdownShell(); } #ifdef RMLUI_DEBUG // Wrap all the following tests under this condition, since the format independent debug tracker is only available in debug mode. TEST_CASE("LayoutIsolation.FullLayoutFormatIndependentCount") { Context* context = TestsShell::GetContext(); ElementDocument* document = nullptr; { FormattingContextDebugTracker format_independent_tracker; document = context->LoadDocumentFromMemory(document_isolation_rml); document->Show(); TestsShell::RenderLoop(); format_independent_tracker.LogMessage(); const auto count_level_1 = std::count_if(format_independent_tracker.GetEntries().begin(), format_independent_tracker.GetEntries().end(), [](const auto& entry) { return entry.level == 1 && !entry.from_cache; }); CHECK_MESSAGE(count_level_1 == 3, "Expecting one entry for each of flex, overflow, and absolute"); // There are quite a few flex item format occurrences being performed currently. We might reduce the following // number while working on the flex formatting engine. If this fails for any other reason, it is likely a bug. CHECK(format_independent_tracker.CountEntries() == 10); CHECK(format_independent_tracker.CountFormattedEntries() == 10); } { FormattingContextDebugTracker format_independent_tracker; Element* element = document->GetElementById("flex-item"); rmlui_dynamic_cast(element->GetFirstChild())->SetText("Modified text that is long enough to cause line break"); TestsShell::RenderLoop(); const auto count_level_1 = std::count_if(format_independent_tracker.GetEntries().begin(), format_independent_tracker.GetEntries().end(), [](const auto& entry) { return entry.level == 1 && !entry.from_cache; }); CHECK_MESSAGE(count_level_1 == 1, "Only the flexbox should be formatted, the others should be cached"); } document->Close(); TestsShell::ShutdownShell(); } static const String document_isolation_absolute_rml = R"(

Absolutely positioned box

Normal block box

)"; TEST_CASE("LayoutIsolation.Absolute") { Context* context = TestsShell::GetContext(); ElementDocument* document = context->LoadDocumentFromMemory(document_isolation_absolute_rml); document->Show(); TestsShell::RenderLoop(); FormattingContextDebugTracker format_independent_tracker; SUBCASE("Modify absolute content") { Element* element = document->GetElementById("absolute-item"); const float initial_height = element->GetOffsetHeight(); rmlui_dynamic_cast(element->GetFirstChild())->SetText("Modified text that is long enough to cause line break"); TestsShell::RenderLoop(); CHECK(element->GetOffsetHeight() != initial_height); CHECK(format_independent_tracker.CountFormattedEntries() == 1); } SUBCASE("Modify absolute width") { Element* container = document->GetElementById("absolute-container"); Element* element = document->GetElementById("absolute-item"); const float container_initial_width = container->GetOffsetWidth(); const float element_initial_width = element->GetOffsetWidth(); container->SetProperty("width", "300px"); DebugLogDirtyLayoutTree(document); document->UpdatePropertiesForDebug(); DebugLogDirtyLayoutTree(document); TestsShell::RenderLoop(); CHECK(container->GetOffsetWidth() != container_initial_width); CHECK(element->GetOffsetWidth() != element_initial_width); // The following could in principle be reduced to 1, since the size of an absolute element should not affect the // layout of the formatting context it takes part in. CHECK(format_independent_tracker.CountEntries() == 2); CHECK(format_independent_tracker.CountFormattedEntries() == 2); } SUBCASE("Modify document width") { Element* container = document->GetElementById("absolute-container"); Element* element = document->GetElementById("absolute-item"); const float document_width = document->GetOffsetWidth(); const float container_width = container->GetOffsetWidth(); const float element_width = element->GetOffsetWidth(); document->SetProperty("width", "1000px"); TestsShell::RenderLoop(); CHECK(document->GetOffsetWidth() != document_width); CHECK(container->GetOffsetWidth() != container_width); CHECK(element->GetOffsetWidth() != element_width); } SUBCASE("Modify normal content") { Element* element = document->GetElementById("normal-item"); const float initial_height = element->GetOffsetHeight(); LogLayoutTree(CaptureLayoutTree(document)); rmlui_dynamic_cast(element->GetFirstChild())->SetText("Modified text that is long enough to cause line break"); TestsShell::RenderLoop(); CHECK(element->GetOffsetHeight() != initial_height); CHECK(format_independent_tracker.CountFormattedEntries() == 1); } SUBCASE("Modify normal content and absolute content") { Element* absolute_element = document->GetElementById("absolute-item"); Element* normal_element = document->GetElementById("normal-item"); const float absolute_initial_height = absolute_element->GetOffsetHeight(); const float normal_initial_height = normal_element->GetOffsetHeight(); rmlui_dynamic_cast(absolute_element->GetFirstChild())->SetText("Modified text that is long enough to cause line break"); rmlui_dynamic_cast(normal_element->GetFirstChild())->SetText("Modified text that is long enough to cause line break"); TestsShell::RenderLoop(); CHECK(absolute_element->GetOffsetHeight() != absolute_initial_height); CHECK(normal_element->GetOffsetHeight() != normal_initial_height); CHECK(format_independent_tracker.CountFormattedEntries() == 2); } format_independent_tracker.LogMessage(); document->Close(); TestsShell::ShutdownShell(); } static const String layout_isolation_hidden_absolute_rml = R"( Demo This is a sample.

Child element

)"; TEST_CASE("LayoutIsolation.HiddenSkipsFormatting") { Context* context = TestsShell::GetContext(); ElementDocument* document = context->LoadDocumentFromMemory(layout_isolation_hidden_absolute_rml); Element* element = document->GetElementById("child"); element->SetClass("hide", true); SUBCASE("Static") {} SUBCASE("Absolute") { element->SetClass("absolute", true); } FormattingContextDebugTracker format_independent_tracker; document->Show(); TestsShell::RenderLoop(); CHECK(format_independent_tracker.CountFormattedEntries() == 1); rmlui_dynamic_cast(element->GetFirstChild())->SetText("Modified text"); CHECK(format_independent_tracker.CountFormattedEntries() == 1); // Modifying text in a hidden element should not trigger a new layout. TestsShell::RenderLoop(); CHECK(format_independent_tracker.CountFormattedEntries() == 1); format_independent_tracker.LogMessage(); document->Close(); TestsShell::ShutdownShell(); } TEST_CASE("LayoutIsolation.HiddenToggleAndModify") { Context* context = TestsShell::GetContext(); ElementDocument* document = context->LoadDocumentFromMemory(layout_isolation_hidden_absolute_rml); Element* element = document->GetElementById("child"); element->SetClass("hide", true); float element_offset_left = 0; SUBCASE("Static") { element_offset_left = 305; } SUBCASE("Absolute") { element->SetClass("absolute", true); element_offset_left = 405; } document->Show(); TestsShell::RenderLoop(); CHECK(element->IsVisible() == false); element->SetClass("hide", false); document->UpdatePropertiesForDebug(); TestsShell::RenderLoop(); CHECK(element->GetAbsoluteLeft() == element_offset_left); CHECK(element->IsVisible() == true); CHECK(element->GetComputedValues().width().value == 300); CHECK(element->GetOffsetWidth() == 300.f); element->SetClass("hide", true); document->UpdatePropertiesForDebug(); TestsShell::RenderLoop(); CHECK(element->IsVisible() == false); CHECK(element->GetComputedValues().width().value == 300); CHECK(element->GetOffsetWidth() == 300.f); element->SetClass("wide", true); document->UpdatePropertiesForDebug(); TestsShell::RenderLoop(); CHECK(element->IsVisible() == false); CHECK(element->GetComputedValues().width().value == 400); CHECK(element->GetOffsetWidth() == 300.f); element->SetClass("hide", false); document->UpdatePropertiesForDebug(); TestsShell::RenderLoop(); CHECK(element->IsVisible() == true); CHECK(element->GetComputedValues().width().value == 400); CHECK(element->GetOffsetWidth() == 400.f); document->Close(); TestsShell::ShutdownShell(); } static const String layout_isolation_document_rml = R"( Demo This is a sample. )"; TEST_CASE("LayoutIsolation.Document") { Context* context = TestsShell::GetContext(); REQUIRE(context->GetDimensions() == Rml::Vector2i{1500, 800}); FormattingContextDebugTracker format_independent_tracker; ElementDocument* document = context->LoadDocumentFromMemory(layout_isolation_document_rml); document->Show(); TestsShell::RenderLoop(); CHECK(document->GetOffsetWidth() == 900.f); CHECK(document->GetOffsetHeight() == 400.f); SUBCASE("Modify absolute content") { context->SetDimensions(Rml::Vector2i{1600, 900}); document->UpdatePropertiesForDebug(); TestsShell::RenderLoop(); CHECK(document->GetOffsetWidth() == 1000.f); CHECK(document->GetOffsetHeight() == 500.f); CHECK(format_independent_tracker.CountFormattedEntries() == 2); } format_independent_tracker.LogMessage(); document->Close(); TestsShell::ShutdownShell(); } static const String rml_flexbox_shrink_to_fit_nested = R"( Flex - Shrink-to-fit 01

Before

Flex

After

)"; TEST_CASE("LayoutIsolation.FlexFormat.shrink-to-fit") { Context* context = TestsShell::GetContext(); REQUIRE(context); // The number of flex format count listed in this mapping is not an end-all be-all, but we should be made aware if // it changes, especially for the worse. const UnorderedMap expected_num_nest_levels_versus_num_flex_formats = { {1, 3}, {2, 8}, {3, 13}, {4, 18}, {5, 23}, {6, 28}, {7, 33}, {8, 38}, {9, 43}, {10, 48}, }; for (int num_nest_levels = 1; num_nest_levels <= 10; num_nest_levels++) { const Rml::String document_rml = Rml::CreateString(rml_flexbox_shrink_to_fit_nested.c_str(), StringUtilities::RepeatString(R"(

)", num_nest_levels - 1).c_str(), StringUtilities::RepeatString(R"(

)", num_nest_levels - 1).c_str()); FormattingContextDebugTracker format_independent_tracker; ElementDocument* document = context->LoadDocumentFromMemory(document_rml); document->Show(); TestsShell::RenderLoop(); int num_flex_formats = 0; for (const auto& entry : format_independent_tracker.GetEntries()) { if (entry.context_type == FormattingContextType::Flex && !entry.from_cache) num_flex_formats += 1; } CHECK(num_flex_formats == expected_num_nest_levels_versus_num_flex_formats.at(num_nest_levels)); document->Close(); } TestsShell::ShutdownShell(); } TEST_CASE("LayoutIsolation.FlexFormat.shrink-to-fit.cache") { Context* context = TestsShell::GetContext(); REQUIRE(context); constexpr int num_nest_levels = 2; const Rml::String document_rml = Rml::CreateString(rml_flexbox_shrink_to_fit_nested.c_str(), StringUtilities::RepeatString(R"(

)", num_nest_levels - 1).c_str(), StringUtilities::RepeatString(R"(

)", num_nest_levels - 1).c_str()); ElementDocument* document = nullptr; { FormattingContextDebugTracker format_independent_tracker; document = context->LoadDocumentFromMemory(document_rml); document->Show(); TestsShell::RenderLoop(); MESSAGE("Initial layout: ", format_independent_tracker.CountFormattedEntries()); } { FormattingContextDebugTracker format_independent_tracker; document->GetElementById("innermost")->SetInnerRML("Flex"); TestsShell::RenderLoop(); MESSAGE("With cache: ", format_independent_tracker.CountFormattedEntries()); } { FormattingContextDebugTracker format_independent_tracker; document->GetElementById("innermost")->SetInnerRML("Flex"); document->SetAttribute("rmlui-disable-layout-cache", true); TestsShell::RenderLoop(); MESSAGE("Without cache: ", format_independent_tracker.CountFormattedEntries()); } document->Close(); TestsShell::ShutdownShell(); } #endif // RMLUI_DEBUG