/* * 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 "TestsShell.h" #include "TestsInterface.h" #include #include #include #include #include #include #include #include // Uncomment the following to render to the shell window instead of the dummy renderer. Useful for viewing the result while building RML. // #define RMLUI_TESTS_USE_SHELL namespace { const Rml::Vector2i window_size(1500, 800); bool shell_initialized = false; bool debugger_allowed = true; int num_documents_begin = 0; Rml::Context* shell_context = nullptr; TestsSystemInterface tests_system_interface; #ifdef RMLUI_TESTS_USE_SHELL class TestsShellEventListener : public Rml::EventListener { public: void ProcessEvent(Rml::Event& event) override { if (event.GetId() == Rml::EventId::Keydown) { Rml::Input::KeyIdentifier key_identifier = (Rml::Input::KeyIdentifier)event.GetParameter("key_identifier", 0); // Will escape the current render loop if (key_identifier == Rml::Input::KI_ESCAPE || key_identifier == Rml::Input::KI_RETURN || key_identifier == Rml::Input::KI_NUMPADENTER) Backend::RequestExit(); } } } shell_event_listener; #else // The tests renderer only collects statistics, does not render anything. TestsRenderInterface shell_render_interface; #endif } // namespace static void InitializeShell(bool allow_debugger) { // Initialize shell and create context. if (!shell_initialized) { shell_initialized = true; debugger_allowed = allow_debugger; REQUIRE(Shell::Initialize()); #ifdef RMLUI_TESTS_USE_SHELL // Initialize the backend and launch a window. REQUIRE(Backend::Initialize("RmlUi Tests", window_size.x, window_size.y, true)); // Use our custom tests system interface. Rml::SetSystemInterface(&tests_system_interface); // However, use the backend's render interface. Rml::SetRenderInterface(Backend::GetRenderInterface()); REQUIRE(Rml::Initialise()); shell_context = Rml::CreateContext("main", window_size); Shell::LoadFonts(); if (allow_debugger) { Rml::Debugger::Initialise(shell_context); num_documents_begin = shell_context->GetNumDocuments(); } shell_context->GetRootElement()->AddEventListener(Rml::EventId::Keydown, &shell_event_listener, true); #else // Set our custom system and render interfaces. Rml::SetSystemInterface(&tests_system_interface); Rml::SetRenderInterface(&shell_render_interface); REQUIRE(Rml::Initialise()); shell_context = Rml::CreateContext("main", window_size); Shell::LoadFonts(); #endif } } Rml::Context* TestsShell::GetContext(bool allow_debugger) { InitializeShell(allow_debugger); return shell_context; } void TestsShell::BeginFrame() { #ifdef RMLUI_TESTS_USE_SHELL Backend::BeginFrame(); #endif } void TestsShell::PresentFrame() { #ifdef RMLUI_TESTS_USE_SHELL Backend::PresentFrame(); #endif } void TestsShell::RenderLoop() { REQUIRE(shell_context); #ifdef RMLUI_TESTS_USE_SHELL bool running = true; while (running) { running = Backend::ProcessEvents(shell_context, &Shell::ProcessKeyDownShortcuts); shell_context->Update(); BeginFrame(); shell_context->Render(); PresentFrame(); } #else shell_context->Update(); shell_context->Render(); #endif } void TestsShell::ShutdownShell() { if (shell_initialized) { if (debugger_allowed) { RMLUI_ASSERTMSG(shell_context->GetNumDocuments() == num_documents_begin, "Make sure all previously opened documents have been closed."); (void)num_documents_begin; } tests_system_interface.SetNumExpectedWarnings(0); Rml::Shutdown(); #ifdef RMLUI_TESTS_USE_SHELL Backend::Shutdown(); #endif Shell::Shutdown(); shell_context = nullptr; shell_initialized = false; } } void TestsShell::SetNumExpectedWarnings(int num_warnings) { tests_system_interface.SetNumExpectedWarnings(num_warnings); } Rml::String TestsShell::GetRenderStats() { Rml::String result; #if !defined(RMLUI_TESTS_USE_SHELL) shell_context->Update(); shell_render_interface.ResetCounters(); shell_context->Render(); auto& counters = shell_render_interface.GetCounters(); result = Rml::CreateString("Context::Render() stats:\n" " Compile geometry: %zu\n" " Render geometry: %zu\n" " Release geometry: %zu\n" " Texture load: %zu\n" " Texture generate: %zu\n" " Texture release: %zu\n" " Scissor enable: %zu\n" " Scissor set: %zu\n" " Clip mask enable: %zu\n" " Clip mask render: %zu\n" " Transform set: %zu", counters.compile_geometry, counters.render_geometry, counters.release_geometry, counters.load_texture, counters.generate_texture, counters.release_texture, counters.enable_scissor, counters.set_scissor, counters.enable_clip_mask, counters.render_to_clip_mask, counters.set_transform); #endif return result; } TestsRenderInterface* TestsShell::GetTestsRenderInterface() { #if defined(RMLUI_TESTS_USE_SHELL) return nullptr; #else return &shell_render_interface; #endif } TestsSystemInterface* TestsShell::GetTestsSystemInterface() { return &tests_system_interface; }