/*
* 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-2023 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 "FormattingContext.h"
#include "../../../Include/RmlUi/Core/ComputedValues.h"
#include "../../../Include/RmlUi/Core/Element.h"
#include "../../../Include/RmlUi/Core/Profiling.h"
#include "BlockFormattingContext.h"
#include "ContainerBox.h"
#include "FlexFormattingContext.h"
#include "FormattingContextDebug.h"
#include "LayoutBox.h"
#include "LayoutDetails.h"
#include "ReplacedFormattingContext.h"
#include "TableFormattingContext.h"
namespace Rml {
FormattingContextType FormattingContext::GetFormattingContextType(Element* element)
{
if (element->IsReplaced())
return FormattingContextType::Replaced;
using namespace Style;
auto& computed = element->GetComputedValues();
const Display display = computed.display();
if (display == Display::Flex || display == Display::InlineFlex)
return FormattingContextType::Flex;
if (display == Display::Table || display == Display::InlineTable)
return FormattingContextType::Table;
if (display == Display::InlineBlock || display == Display::FlowRoot || display == Display::TableCell || computed.float_() != Float::None ||
computed.position() == Position::Absolute || computed.position() == Position::Fixed || computed.overflow_x() != Overflow::Visible ||
computed.overflow_y() != Overflow::Visible || !element->GetParentNode() || element->GetParentNode()->GetDisplay() == Display::Flex)
{
return FormattingContextType::Block;
}
return FormattingContextType::None;
}
UniquePtr FormattingContext::FormatIndependent(ContainerBox* parent_container, Element* element, const Box* override_initial_box,
FormattingContextType default_context)
{
RMLUI_ASSERT(parent_container && element);
RMLUI_ZoneScopedC(0xAFAFAF);
FormattingContextType type = GetFormattingContextType(element);
if (type == FormattingContextType::None)
type = default_context;
#ifdef RMLUI_DEBUG
auto* debug_tracker = FormatIndependentDebugTracker::GetIf();
FormatIndependentDebugTracker::Entry* tracker_entry = nullptr;
if (debug_tracker && type != FormattingContextType::None)
{
tracker_entry = &debug_tracker->entries.emplace_back(FormatIndependentDebugTracker::Entry{
debug_tracker->current_stack_level,
parent_container->GetElement() ? parent_container->GetElement()->GetAddress() : "",
parent_container->GetAbsolutePositioningContainingBlockElementForDebug()
? parent_container->GetAbsolutePositioningContainingBlockElementForDebug()->GetAddress()
: "",
parent_container->GetContainingBlockSize(Style::Position::Static),
parent_container->GetContainingBlockSize(Style::Position::Absolute),
element->GetAddress(),
override_initial_box ? Optional{*override_initial_box} : std::nullopt,
type,
});
debug_tracker->current_stack_level += 1;
}
#endif
UniquePtr layout_box;
switch (type)
{
case FormattingContextType::Block: layout_box = BlockFormattingContext::Format(parent_container, element, override_initial_box); break;
case FormattingContextType::Table: layout_box = TableFormattingContext::Format(parent_container, element, override_initial_box); break;
case FormattingContextType::Flex: layout_box = FlexFormattingContext::Format(parent_container, element, override_initial_box); break;
case FormattingContextType::Replaced: layout_box = ReplacedFormattingContext::Format(parent_container, element, override_initial_box); break;
case FormattingContextType::None: break;
}
#ifdef RMLUI_DEBUG
if (tracker_entry)
{
debug_tracker->current_stack_level -= 1;
if (layout_box)
{
tracker_entry->layout = Optional({
layout_box->GetVisibleOverflowSize(),
layout_box->GetIfBox() ? Optional{*layout_box->GetIfBox()} : std::nullopt,
});
}
}
#endif
return layout_box;
}
} // namespace Rml