/*
* 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/Core.h"
#include "../../Include/RmlUi/Core/Context.h"
#include "../../Include/RmlUi/Core/Element.h"
#include "../../Include/RmlUi/Core/ElementInstancer.h"
#include "../../Include/RmlUi/Core/Factory.h"
#include "../../Include/RmlUi/Core/FileInterface.h"
#include "../../Include/RmlUi/Core/FontEngineInterface.h"
#include "../../Include/RmlUi/Core/Plugin.h"
#include "../../Include/RmlUi/Core/RenderInterface.h"
#include "../../Include/RmlUi/Core/RenderManager.h"
#include "../../Include/RmlUi/Core/StyleSheetSpecification.h"
#include "../../Include/RmlUi/Core/SystemInterface.h"
#include "../../Include/RmlUi/Core/TextInputHandler.h"
#include "../../Include/RmlUi/Core/Types.h"
#include "BoxShadowCache.h"
#include "ComputeProperty.h"
#include "ControlledLifetimeResource.h"
#include "ElementMeta.h"
#include "EventSpecification.h"
#include "FileInterfaceDefault.h"
#include "Layout/LayoutPools.h"
#include "PluginRegistry.h"
#include "RenderManagerAccess.h"
#include "StyleSheetFactory.h"
#include "StyleSheetParser.h"
#include "TemplateCache.h"
#ifdef RMLUI_FONT_ENGINE_FREETYPE
#include "FontEngineDefault/FontEngineInterfaceDefault.h"
#endif
#ifdef RMLUI_LOTTIE_PLUGIN
#include "../Lottie/LottiePlugin.h"
#endif
#ifdef RMLUI_SVG_PLUGIN
#include "../SVG/SVGPlugin.h"
#endif
#include
namespace Rml {
static RenderInterface* render_interface = nullptr;
static SystemInterface* system_interface = nullptr;
static FileInterface* file_interface = nullptr;
static FontEngineInterface* font_interface = nullptr;
static TextInputHandler* text_input_handler = nullptr;
struct CoreData {
// Default interfaces should be created and destroyed on Initialise and Shutdown, respectively.
UniquePtr default_system_interface;
UniquePtr default_file_interface;
UniquePtr default_font_interface;
UniquePtr default_text_input_handler;
SmallUnorderedMap> render_managers;
UnorderedMap contexts;
};
static ControlledLifetimeResource core_data;
static bool initialised = false;
static void InitializeMemoryPools()
{
Detail::InitializeElementInstancerPools();
ElementMetaPool::Initialize();
LayoutPools::Initialize();
}
static void ReleaseMemoryPools()
{
LayoutPools::Shutdown();
ElementMetaPool::Shutdown();
Detail::ShutdownElementInstancerPools();
}
#ifndef RMLUI_VERSION
#define RMLUI_VERSION "custom"
#endif
bool Initialise()
{
RMLUI_ASSERTMSG(!initialised, "Rml::Initialise() called, but RmlUi is already initialised!");
InitializeMemoryPools();
InitializeComputeProperty();
core_data.Initialize();
// Install default interfaces as appropriate.
if (!system_interface)
{
core_data->default_system_interface = MakeUnique();
system_interface = core_data->default_system_interface.get();
}
if (!file_interface)
{
#ifndef RMLUI_NO_FILE_INTERFACE_DEFAULT
core_data->default_file_interface = MakeUnique();
file_interface = core_data->default_file_interface.get();
#else
Log::Message(Log::LT_ERROR, "No file interface set!");
return false;
#endif
}
if (!font_interface)
{
#ifdef RMLUI_FONT_ENGINE_FREETYPE
core_data->default_font_interface = MakeUnique();
font_interface = core_data->default_font_interface.get();
#else
Log::Message(Log::LT_ERROR, "No font engine interface set!");
return false;
#endif
}
if (!text_input_handler)
{
core_data->default_text_input_handler = MakeUnique();
text_input_handler = core_data->default_text_input_handler.get();
}
EventSpecificationInterface::Initialize();
Detail::InitializeObserverPtrPool();
if (render_interface)
core_data->render_managers[render_interface] = MakeUnique(render_interface);
font_interface->Initialize();
StyleSheetSpecification::Initialise();
StyleSheetParser::Initialise();
StyleSheetFactory::Initialise();
TemplateCache::Initialise();
Factory::Initialise();
// Initialise plugins integrated with Core.
#ifdef RMLUI_LOTTIE_PLUGIN
Lottie::Initialise();
#endif
#ifdef RMLUI_SVG_PLUGIN
SVG::Initialise();
#endif
BoxShadowCache::Initialize();
// Notify all plugins we're starting up.
PluginRegistry::NotifyInitialise();
initialised = true;
return true;
}
void Shutdown()
{
RMLUI_ASSERTMSG(initialised, "Rml::Shutdown() called, but RmlUi is not initialised!");
// Clear out all contexts, which should also clean up all attached elements.
core_data->contexts.clear();
// Notify all plugins we're being shutdown.
PluginRegistry::NotifyShutdown();
BoxShadowCache::Shutdown();
Factory::Shutdown();
TemplateCache::Shutdown();
StyleSheetFactory::Shutdown();
StyleSheetParser::Shutdown();
StyleSheetSpecification::Shutdown();
font_interface->Shutdown();
core_data->render_managers.clear();
Detail::ShutdownObserverPtrPool();
initialised = false;
text_input_handler = nullptr;
font_interface = nullptr;
render_interface = nullptr;
file_interface = nullptr;
system_interface = nullptr;
core_data.Shutdown();
EventSpecificationInterface::Shutdown();
ShutdownComputeProperty();
ReleaseMemoryPools();
}
String GetVersion()
{
return RMLUI_VERSION;
}
void SetSystemInterface(SystemInterface* _system_interface)
{
system_interface = _system_interface;
}
SystemInterface* GetSystemInterface()
{
return system_interface;
}
void SetRenderInterface(RenderInterface* _render_interface)
{
render_interface = _render_interface;
}
RenderInterface* GetRenderInterface()
{
return render_interface;
}
void SetFileInterface(FileInterface* _file_interface)
{
file_interface = _file_interface;
}
FileInterface* GetFileInterface()
{
return file_interface;
}
void SetFontEngineInterface(FontEngineInterface* _font_interface)
{
font_interface = _font_interface;
}
FontEngineInterface* GetFontEngineInterface()
{
return font_interface;
}
void SetTextInputHandler(TextInputHandler* _text_input_handler)
{
text_input_handler = _text_input_handler;
}
TextInputHandler* GetTextInputHandler()
{
return text_input_handler;
}
Context* CreateContext(const String& name, const Vector2i dimensions, RenderInterface* render_interface_for_context,
TextInputHandler* text_input_handler_for_context)
{
if (!initialised)
return nullptr;
if (!render_interface_for_context)
render_interface_for_context = render_interface;
if (!text_input_handler_for_context)
text_input_handler_for_context = text_input_handler;
if (!render_interface_for_context)
{
Log::Message(Log::LT_WARNING, "Failed to create context '%s', no render interface specified and no default render interface exists.",
name.c_str());
return nullptr;
}
if (GetContext(name))
{
Log::Message(Log::LT_WARNING, "Failed to create context '%s', context already exists.", name.c_str());
return nullptr;
}
// Each unique render interface gets its own render manager.
auto& render_manager = core_data->render_managers[render_interface_for_context];
if (!render_manager)
render_manager = MakeUnique(render_interface_for_context);
ContextPtr new_context = Factory::InstanceContext(name, render_manager.get(), text_input_handler_for_context);
if (!new_context)
{
Log::Message(Log::LT_WARNING, "Failed to instance context '%s', instancer returned nullptr.", name.c_str());
return nullptr;
}
new_context->SetDimensions(dimensions);
Context* new_context_raw = new_context.get();
core_data->contexts[name] = std::move(new_context);
PluginRegistry::NotifyContextCreate(new_context_raw);
return new_context_raw;
}
bool RemoveContext(const String& name)
{
return core_data->contexts.erase(name) != 0;
}
Context* GetContext(const String& name)
{
auto it = core_data->contexts.find(name);
if (it == core_data->contexts.end())
return nullptr;
return it->second.get();
}
Context* GetContext(int index)
{
if (index < 0 || index >= GetNumContexts())
return nullptr;
auto it = core_data->contexts.begin();
std::advance(it, index);
if (it == core_data->contexts.end())
return nullptr;
return it->second.get();
}
int GetNumContexts()
{
return (int)core_data->contexts.size();
}
bool LoadFontFace(const String& file_path, bool fallback_face, Style::FontWeight weight, int face_index)
{
return font_interface->LoadFontFace(file_path, face_index, fallback_face, weight);
}
bool LoadFontFace(Span data, const String& family, Style::FontStyle style, Style::FontWeight weight, bool fallback_face, int face_index)
{
return font_interface->LoadFontFace(data, face_index, family, style, weight, fallback_face);
}
void RegisterPlugin(Plugin* plugin)
{
if (initialised)
plugin->OnInitialise();
PluginRegistry::RegisterPlugin(plugin);
}
void UnregisterPlugin(Plugin* plugin)
{
PluginRegistry::UnregisterPlugin(plugin);
if (initialised)
plugin->OnShutdown();
}
EventId RegisterEventType(const String& type, bool interruptible, bool bubbles, DefaultActionPhase default_action_phase)
{
return EventSpecificationInterface::InsertOrReplaceCustom(type, interruptible, bubbles, default_action_phase);
}
StringList GetTextureSourceList()
{
StringList result;
if (!core_data)
return result;
for (const auto& render_manager : core_data->render_managers)
{
RenderManagerAccess::GetTextureSourceList(render_manager.second.get(), result);
}
return result;
}
void ReleaseTextures(RenderInterface* match_render_interface)
{
if (!core_data)
return;
for (auto& render_manager : core_data->render_managers)
{
if (!match_render_interface || render_manager.first == match_render_interface)
RenderManagerAccess::ReleaseAllTextures(render_manager.second.get());
}
}
bool ReleaseTexture(const String& source, RenderInterface* match_render_interface)
{
bool result = false;
if (!core_data)
return result;
for (auto& render_manager : core_data->render_managers)
{
if (!match_render_interface || render_manager.first == match_render_interface)
{
if (RenderManagerAccess::ReleaseTexture(render_manager.second.get(), source))
result = true;
}
}
return result;
}
void ReleaseCompiledGeometry(RenderInterface* match_render_interface)
{
if (!core_data)
return;
for (auto& render_manager : core_data->render_managers)
{
if (!match_render_interface || render_manager.first == match_render_interface)
RenderManagerAccess::ReleaseAllCompiledGeometry(render_manager.second.get());
}
}
void ReleaseFontResources()
{
if (!font_interface)
return;
for (const auto& name_context : core_data->contexts)
name_context.second->GetRootElement()->DirtyFontFaceRecursive();
font_interface->ReleaseFontResources();
for (const auto& name_context : core_data->contexts)
name_context.second->Update();
}
void ReleaseRenderManagers()
{
auto& contexts = core_data->contexts;
auto& render_managers = core_data->render_managers;
ReleaseFontResources();
for (auto it = render_managers.begin(); it != render_managers.end();)
{
RenderManager* render_manager = it->second.get();
const auto num_contexts_using_manager = std::count_if(contexts.begin(), contexts.end(),
[&](const auto& context_pair) { return &context_pair.second->GetRenderManager() == render_manager; });
if (num_contexts_using_manager == 0)
it = render_managers.erase(it);
else
++it;
}
}
// Functions that need to be accessible within the Core library, but not publicly.
namespace CoreInternal {
bool HasRenderManager(RenderInterface* match_render_interface)
{
return core_data && core_data->render_managers.find(match_render_interface) != core_data->render_managers.end();
}
} // namespace CoreInternal
} // namespace Rml