/*
* 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 "../../Include/RmlUi/Core/Factory.h"
#include "../../Include/RmlUi/Core/Context.h"
#include "../../Include/RmlUi/Core/ContextInstancer.h"
#include "../../Include/RmlUi/Core/Core.h"
#include "../../Include/RmlUi/Core/ElementDocument.h"
#include "../../Include/RmlUi/Core/ElementInstancer.h"
#include "../../Include/RmlUi/Core/ElementText.h"
#include "../../Include/RmlUi/Core/ElementUtilities.h"
#include "../../Include/RmlUi/Core/Elements/ElementForm.h"
#include "../../Include/RmlUi/Core/Elements/ElementFormControlInput.h"
#include "../../Include/RmlUi/Core/Elements/ElementFormControlSelect.h"
#include "../../Include/RmlUi/Core/Elements/ElementFormControlTextArea.h"
#include "../../Include/RmlUi/Core/Elements/ElementProgress.h"
#include "../../Include/RmlUi/Core/Elements/ElementTabSet.h"
#include "../../Include/RmlUi/Core/EventListenerInstancer.h"
#include "../../Include/RmlUi/Core/StreamMemory.h"
#include "../../Include/RmlUi/Core/StyleSheet.h"
#include "../../Include/RmlUi/Core/StyleSheetContainer.h"
#include "../../Include/RmlUi/Core/SystemInterface.h"
#include "ContextInstancerDefault.h"
#include "ControlledLifetimeResource.h"
#include "DataControllerDefault.h"
#include "DataViewDefault.h"
#include "DecoratorGradient.h"
#include "DecoratorNinePatch.h"
#include "DecoratorShader.h"
#include "DecoratorText.h"
#include "DecoratorTiledBox.h"
#include "DecoratorTiledHorizontal.h"
#include "DecoratorTiledImage.h"
#include "DecoratorTiledVertical.h"
#include "ElementHandle.h"
#include "Elements/ElementImage.h"
#include "Elements/ElementLabel.h"
#include "Elements/ElementTextSelection.h"
#include "Elements/XMLNodeHandlerSelect.h"
#include "Elements/XMLNodeHandlerTabSet.h"
#include "Elements/XMLNodeHandlerTextArea.h"
#include "EventInstancerDefault.h"
#include "FilterBasic.h"
#include "FilterBlur.h"
#include "FilterDropShadow.h"
#include "FontEffectBlur.h"
#include "FontEffectGlow.h"
#include "FontEffectOutline.h"
#include "FontEffectShadow.h"
#include "PluginRegistry.h"
#include "StreamFile.h"
#include "StyleSheetFactory.h"
#include "TemplateCache.h"
#include "XMLNodeHandlerBody.h"
#include "XMLNodeHandlerDefault.h"
#include "XMLNodeHandlerHead.h"
#include "XMLNodeHandlerTemplate.h"
#include "XMLParseTools.h"
#include
namespace Rml {
// Default instancers are constructed and destroyed on Initialise and Shutdown, respectively.
struct DefaultInstancers {
UniquePtr context_default;
UniquePtr event_default;
// Basic elements
ElementInstancerElement element_default;
ElementInstancerText element_text;
ElementInstancerGeneric element_img;
ElementInstancerGeneric element_handle;
ElementInstancerGeneric element_body;
// Control elements
ElementInstancerGeneric form;
ElementInstancerGeneric input;
ElementInstancerGeneric select;
ElementInstancerGeneric element_label;
ElementInstancerGeneric textarea;
ElementInstancerGeneric selection;
ElementInstancerGeneric tabset;
ElementInstancerGeneric progress;
// Decorators
DecoratorTextInstancer decorator_text;
DecoratorTiledHorizontalInstancer decorator_tiled_horizontal;
DecoratorTiledVerticalInstancer decorator_tiled_vertical;
DecoratorTiledBoxInstancer decorator_tiled_box;
DecoratorTiledImageInstancer decorator_image;
DecoratorNinePatchInstancer decorator_ninepatch;
DecoratorShaderInstancer decorator_shader;
DecoratorStraightGradientInstancer decorator_straight_gradient;
DecoratorLinearGradientInstancer decorator_linear_gradient;
DecoratorRadialGradientInstancer decorator_radial_gradient;
DecoratorConicGradientInstancer decorator_conic_gradient;
// Filters
FilterBasicInstancer filter_hue_rotate = {FilterBasicInstancer::ValueType::Angle, "0rad"};
FilterBasicInstancer filter_basic_d0 = {FilterBasicInstancer::ValueType::NumberPercent, "0"};
FilterBasicInstancer filter_basic_d1 = {FilterBasicInstancer::ValueType::NumberPercent, "1"};
FilterBlurInstancer filter_blur;
FilterDropShadowInstancer filter_drop_shadow;
// Font effects
FontEffectBlurInstancer font_effect_blur;
FontEffectGlowInstancer font_effect_glow;
FontEffectOutlineInstancer font_effect_outline;
FontEffectShadowInstancer font_effect_shadow;
// Data binding views
DataViewInstancerDefault data_view_attribute;
DataViewInstancerDefault data_view_attribute_if;
DataViewInstancerDefault data_view_class;
DataViewInstancerDefault data_view_if;
DataViewInstancerDefault data_view_visible;
DataViewInstancerDefault data_view_rml;
DataViewInstancerDefault data_view_style;
DataViewInstancerDefault data_view_text;
DataViewInstancerDefault data_view_value;
DataViewInstancerDefault data_view_checked;
DataViewInstancerDefault data_view_alias;
DataViewInstancerDefault structural_data_view_for;
// Data binding controllers
DataControllerInstancerDefault data_controller_event;
DataControllerInstancerDefault data_controller_value;
};
struct FactoryData {
DefaultInstancers default_instancers;
UnorderedMap element_instancers;
UnorderedMap decorator_instancers;
UnorderedMap filter_instancers;
UnorderedMap font_effect_instancers;
UnorderedMap data_view_instancers;
UnorderedMap data_controller_instancers;
SmallUnorderedSet structural_data_view_attribute_names;
};
static ControlledLifetimeResource factory_data;
static ContextInstancer* context_instancer = nullptr;
static EventInstancer* event_instancer = nullptr;
static EventListenerInstancer* event_listener_instancer = nullptr;
Factory::Factory() {}
Factory::~Factory() {}
void Factory::Initialise()
{
factory_data.Initialize();
DefaultInstancers& default_instancers = factory_data->default_instancers;
// Default context instancer
if (!context_instancer)
{
default_instancers.context_default = MakeUnique();
context_instancer = default_instancers.context_default.get();
}
// Default event instancer
if (!event_instancer)
{
default_instancers.event_default = MakeUnique();
event_instancer = default_instancers.event_default.get();
}
// No default event listener instancer
if (!event_listener_instancer)
event_listener_instancer = nullptr;
// Basic element instancers
RegisterElementInstancer("*", &default_instancers.element_default);
RegisterElementInstancer("img", &default_instancers.element_img);
RegisterElementInstancer("#text", &default_instancers.element_text);
RegisterElementInstancer("handle", &default_instancers.element_handle);
RegisterElementInstancer("body", &default_instancers.element_body);
// Control element instancers
RegisterElementInstancer("form", &default_instancers.form);
RegisterElementInstancer("input", &default_instancers.input);
RegisterElementInstancer("select", &default_instancers.select);
RegisterElementInstancer("label", &default_instancers.element_label);
RegisterElementInstancer("textarea", &default_instancers.textarea);
RegisterElementInstancer("#selection", &default_instancers.selection);
RegisterElementInstancer("tabset", &default_instancers.tabset);
RegisterElementInstancer("progress", &default_instancers.progress);
RegisterElementInstancer("progressbar", &default_instancers.progress);
// Decorator instancers
RegisterDecoratorInstancer("text", &default_instancers.decorator_text);
RegisterDecoratorInstancer("tiled-horizontal", &default_instancers.decorator_tiled_horizontal);
RegisterDecoratorInstancer("tiled-vertical", &default_instancers.decorator_tiled_vertical);
RegisterDecoratorInstancer("tiled-box", &default_instancers.decorator_tiled_box);
RegisterDecoratorInstancer("image", &default_instancers.decorator_image);
RegisterDecoratorInstancer("ninepatch", &default_instancers.decorator_ninepatch);
RegisterDecoratorInstancer("shader", &default_instancers.decorator_shader);
RegisterDecoratorInstancer("gradient", &default_instancers.decorator_straight_gradient);
RegisterDecoratorInstancer("horizontal-gradient", &default_instancers.decorator_straight_gradient);
RegisterDecoratorInstancer("vertical-gradient", &default_instancers.decorator_straight_gradient);
RegisterDecoratorInstancer("linear-gradient", &default_instancers.decorator_linear_gradient);
RegisterDecoratorInstancer("repeating-linear-gradient", &default_instancers.decorator_linear_gradient);
RegisterDecoratorInstancer("radial-gradient", &default_instancers.decorator_radial_gradient);
RegisterDecoratorInstancer("repeating-radial-gradient", &default_instancers.decorator_radial_gradient);
RegisterDecoratorInstancer("conic-gradient", &default_instancers.decorator_conic_gradient);
RegisterDecoratorInstancer("repeating-conic-gradient", &default_instancers.decorator_conic_gradient);
// Filter instancers
RegisterFilterInstancer("hue-rotate", &default_instancers.filter_hue_rotate);
RegisterFilterInstancer("brightness", &default_instancers.filter_basic_d1);
RegisterFilterInstancer("contrast", &default_instancers.filter_basic_d1);
RegisterFilterInstancer("grayscale", &default_instancers.filter_basic_d0);
RegisterFilterInstancer("invert", &default_instancers.filter_basic_d0);
RegisterFilterInstancer("opacity", &default_instancers.filter_basic_d1);
RegisterFilterInstancer("saturate", &default_instancers.filter_basic_d1);
RegisterFilterInstancer("sepia", &default_instancers.filter_basic_d0);
RegisterFilterInstancer("blur", &default_instancers.filter_blur);
RegisterFilterInstancer("drop-shadow", &default_instancers.filter_drop_shadow);
// Font effect instancers
RegisterFontEffectInstancer("blur", &default_instancers.font_effect_blur);
RegisterFontEffectInstancer("glow", &default_instancers.font_effect_glow);
RegisterFontEffectInstancer("outline", &default_instancers.font_effect_outline);
RegisterFontEffectInstancer("shadow", &default_instancers.font_effect_shadow);
// Data binding views
// clang-format off
RegisterDataViewInstancer(&default_instancers.data_view_attribute, "attr", false);
RegisterDataViewInstancer(&default_instancers.data_view_attribute_if, "attrif", false);
RegisterDataViewInstancer(&default_instancers.data_view_class, "class", false);
RegisterDataViewInstancer(&default_instancers.data_view_if, "if", false);
RegisterDataViewInstancer(&default_instancers.data_view_visible, "visible", false);
RegisterDataViewInstancer(&default_instancers.data_view_rml, "rml", false);
RegisterDataViewInstancer(&default_instancers.data_view_style, "style", false);
RegisterDataViewInstancer(&default_instancers.data_view_text, "text", false);
RegisterDataViewInstancer(&default_instancers.data_view_value, "value", false);
RegisterDataViewInstancer(&default_instancers.data_view_checked, "checked", false);
RegisterDataViewInstancer(&default_instancers.data_view_alias, "alias", false);
RegisterDataViewInstancer(&default_instancers.structural_data_view_for, "for", true );
// clang-format on
// Data binding controllers
RegisterDataControllerInstancer(&default_instancers.data_controller_value, "checked");
RegisterDataControllerInstancer(&default_instancers.data_controller_event, "event");
RegisterDataControllerInstancer(&default_instancers.data_controller_value, "value");
// XML nodes that only contain CDATA
XMLParser::RegisterPersistentCDATATag("script");
XMLParser::RegisterPersistentCDATATag("style");
// XML node handlers
XMLParser::RegisterNodeHandler("", MakeShared());
XMLParser::RegisterNodeHandler("body", MakeShared());
XMLParser::RegisterNodeHandler("head", MakeShared());
XMLParser::RegisterNodeHandler("template", MakeShared());
// XML node handlers for control elements
XMLParser::RegisterNodeHandler("tabset", MakeShared());
XMLParser::RegisterNodeHandler("textarea", MakeShared());
XMLParser::RegisterNodeHandler("select", MakeShared());
}
void Factory::Shutdown()
{
context_instancer = nullptr;
event_listener_instancer = nullptr;
event_instancer = nullptr;
XMLParser::ReleaseHandlers();
factory_data.Shutdown();
}
void Factory::RegisterContextInstancer(ContextInstancer* instancer)
{
context_instancer = instancer;
}
ContextPtr Factory::InstanceContext(const String& name, RenderManager* render_manager, TextInputHandler* text_input_handler)
{
ContextPtr new_context = context_instancer->InstanceContext(name, render_manager, text_input_handler);
if (new_context)
new_context->SetInstancer(context_instancer);
return new_context;
}
void Factory::RegisterElementInstancer(const String& name, ElementInstancer* instancer)
{
factory_data->element_instancers[StringUtilities::ToLower(name)] = instancer;
}
ElementInstancer* Factory::GetElementInstancer(const String& tag)
{
auto instancer_iterator = factory_data->element_instancers.find(tag);
if (instancer_iterator == factory_data->element_instancers.end())
{
instancer_iterator = factory_data->element_instancers.find("*");
if (instancer_iterator == factory_data->element_instancers.end())
return nullptr;
}
return instancer_iterator->second;
}
ElementPtr Factory::InstanceElement(Element* parent, const String& instancer_name, const String& tag, const XMLAttributes& attributes)
{
if (ElementInstancer* instancer = GetElementInstancer(instancer_name))
{
if (ElementPtr element = instancer->InstanceElement(parent, tag, attributes))
{
element->SetInstancer(instancer);
element->SetAttributes(attributes);
PluginRegistry::NotifyElementCreate(element.get());
return element;
}
}
return nullptr;
}
bool Factory::InstanceElementText(Element* parent, const String& in_text)
{
RMLUI_ASSERT(parent);
String text;
if (SystemInterface* system_interface = GetSystemInterface())
system_interface->TranslateString(text, in_text);
// If this text node only contains white-space we don't want to construct it.
const bool only_white_space = std::all_of(text.begin(), text.end(), &StringUtilities::IsWhitespace);
if (only_white_space)
return true;
// See if we need to parse it as RML, and whether the text contains data expressions (curly brackets).
bool parse_as_rml = false;
bool has_data_expression = false;
bool inside_brackets = false;
bool inside_string = false;
char previous = 0;
for (const char c : text)
{
const char* error_str = XMLParseTools::ParseDataBrackets(inside_brackets, inside_string, c, previous);
if (error_str)
{
Log::Message(Log::LT_WARNING, "Failed to instance text element '%s'. %s", text.c_str(), error_str);
return false;
}
if (inside_brackets)
has_data_expression = true;
else if (c == '<')
parse_as_rml = true;
previous = c;
}
// If the text contains RML elements then run it through the XML parser again.
if (parse_as_rml)
{
RMLUI_ZoneScopedNC("InstanceStream", 0xDC143C);
auto stream = MakeUnique(text.size() + 32);
Context* context = parent->GetContext();
String tag = context ? context->GetDocumentsBaseTag() : "body";
String open_tag = "<" + tag + ">";
String close_tag = "" + tag + ">";
stream->Write(open_tag.c_str(), open_tag.size());
stream->Write(text);
stream->Write(close_tag.c_str(), close_tag.size());
stream->Seek(0, SEEK_SET);
InstanceElementStream(parent, stream.get());
}
else
{
RMLUI_ZoneScopedNC("InstanceText", 0x8FBC8F);
// Attempt to instance the element.
XMLAttributes attributes;
// If we have curly brackets in the text, we tag the element so that the appropriate data view (DataViewText) is constructed.
if (has_data_expression)
attributes.emplace("data-text", Variant());
ElementPtr element = Factory::InstanceElement(parent, "#text", "#text", attributes);
if (!element)
{
Log::Message(Log::LT_ERROR, "Failed to instance text element '%s', instancer returned nullptr.", text.c_str());
return false;
}
// Assign the element its text value.
ElementText* text_element = rmlui_dynamic_cast(element.get());
if (!text_element)
{
Log::Message(Log::LT_ERROR, "Failed to instance text element '%s'. Found type '%s', was expecting a derivative of ElementText.",
text.c_str(), rmlui_type_name(*element));
return false;
}
// Unescape any escaped entities or unicode symbols
text = StringUtilities::DecodeRml(text);
text_element->SetText(text);
// Add to active node.
parent->AppendChild(std::move(element));
}
return true;
}
bool Factory::InstanceElementStream(Element* parent, Stream* stream)
{
XMLParser parser(parent);
parser.Parse(stream);
return true;
}
ElementPtr Factory::InstanceDocumentStream(Context* context, Stream* stream, const String& document_base_tag)
{
RMLUI_ZoneScoped;
ElementPtr element = Factory::InstanceElement(nullptr, document_base_tag, document_base_tag, XMLAttributes());
if (!element)
{
Log::Message(Log::LT_ERROR, "Failed to instance document, instancer returned nullptr.");
return nullptr;
}
ElementDocument* document = rmlui_dynamic_cast(element.get());
if (!document)
{
Log::Message(Log::LT_ERROR, "Failed to instance document element. Found type '%s', was expecting derivative of ElementDocument.",
rmlui_type_name(*element));
return nullptr;
}
document->context = context;
XMLParser parser(element.get());
parser.Parse(stream);
return element;
}
void Factory::RegisterDecoratorInstancer(const String& name, DecoratorInstancer* instancer)
{
RMLUI_ASSERT(instancer);
factory_data->decorator_instancers[StringUtilities::ToLower(name)] = instancer;
}
DecoratorInstancer* Factory::GetDecoratorInstancer(const String& name)
{
auto iterator = factory_data->decorator_instancers.find(name);
if (iterator == factory_data->decorator_instancers.end())
return nullptr;
return iterator->second;
}
void Factory::RegisterFilterInstancer(const String& name, FilterInstancer* instancer)
{
RMLUI_ASSERT(instancer);
factory_data->filter_instancers[StringUtilities::ToLower(name)] = instancer;
}
FilterInstancer* Factory::GetFilterInstancer(const String& name)
{
auto iterator = factory_data->filter_instancers.find(name);
if (iterator == factory_data->filter_instancers.end())
return nullptr;
return iterator->second;
}
void Factory::RegisterFontEffectInstancer(const String& name, FontEffectInstancer* instancer)
{
RMLUI_ASSERT(instancer);
factory_data->font_effect_instancers[StringUtilities::ToLower(name)] = instancer;
}
FontEffectInstancer* Factory::GetFontEffectInstancer(const String& name)
{
auto iterator = factory_data->font_effect_instancers.find(name);
if (iterator == factory_data->font_effect_instancers.end())
return nullptr;
return iterator->second;
}
SharedPtr Factory::InstanceStyleSheetString(const String& string)
{
auto memory_stream = MakeUnique((const byte*)string.c_str(), string.size());
return InstanceStyleSheetStream(memory_stream.get());
}
SharedPtr Factory::InstanceStyleSheetFile(const String& file_name)
{
auto file_stream = MakeUnique();
file_stream->Open(file_name);
return InstanceStyleSheetStream(file_stream.get());
}
SharedPtr Factory::InstanceStyleSheetStream(Stream* stream)
{
SharedPtr style_sheet_container = MakeShared();
if (style_sheet_container->LoadStyleSheetContainer(stream))
{
return style_sheet_container;
}
return nullptr;
}
void Factory::ClearStyleSheetCache()
{
StyleSheetFactory::ClearStyleSheetCache();
}
void Factory::ClearTemplateCache()
{
TemplateCache::Clear();
}
void Factory::RegisterEventInstancer(EventInstancer* instancer)
{
event_instancer = instancer;
}
EventPtr Factory::InstanceEvent(Element* target, EventId id, const String& type, const Dictionary& parameters, bool interruptible)
{
EventPtr event = event_instancer->InstanceEvent(target, id, type, parameters, interruptible);
if (event)
event->instancer = event_instancer;
return event;
}
void Factory::RegisterEventListenerInstancer(EventListenerInstancer* instancer)
{
event_listener_instancer = instancer;
}
EventListener* Factory::InstanceEventListener(const String& value, Element* element)
{
// If we have an event listener instancer, use it
if (event_listener_instancer)
return event_listener_instancer->InstanceEventListener(value, element);
return nullptr;
}
void Factory::RegisterDataViewInstancer(DataViewInstancer* instancer, const String& name, bool is_structural_view)
{
const bool inserted = factory_data->data_view_instancers.emplace(name, instancer).second;
if (!inserted)
{
Log::Message(Log::LT_WARNING, "Could not register data view instancer '%s'. The given name is already registered.", name.c_str());
return;
}
if (is_structural_view)
factory_data->structural_data_view_attribute_names.emplace("data-" + name);
}
void Factory::RegisterDataControllerInstancer(DataControllerInstancer* instancer, const String& name)
{
bool inserted = factory_data->data_controller_instancers.emplace(name, instancer).second;
if (!inserted)
Log::Message(Log::LT_WARNING, "Could not register data controller instancer '%s'. The given name is already registered.", name.c_str());
}
DataViewPtr Factory::InstanceDataView(const String& type_name, Element* element)
{
RMLUI_ASSERT(element);
const auto it = factory_data->data_view_instancers.find(type_name);
if (it != factory_data->data_view_instancers.end())
return it->second->InstanceView(element);
return nullptr;
}
DataControllerPtr Factory::InstanceDataController(const String& type_name, Element* element)
{
const auto it = factory_data->data_controller_instancers.find(type_name);
if (it != factory_data->data_controller_instancers.end())
return it->second->InstanceController(element);
return nullptr;
}
bool Factory::IsStructuralDataView(const String& type_name)
{
const String attribute = "data-" + type_name;
return factory_data->structural_data_view_attribute_names.find(attribute) != factory_data->structural_data_view_attribute_names.end();
}
const SmallUnorderedSet& Factory::GetStructuralDataViewAttributeNames()
{
return factory_data->structural_data_view_attribute_names;
}
} // namespace Rml