Add widget text input benchmarks

mikke89 · Jul 7, 2024 · 31310b8 · 31310b8
1 parent b453efd
commit 31310b8
Show file tree

Hide file tree

Showing 3 changed files with 166 additions and 2 deletions.
diff --git a/Tests/Source/Benchmarks/CMakeLists.txt b/Tests/Source/Benchmarks/CMakeLists.txt
@@ -11,6 +11,7 @@ add_executable(${TARGET_NAME}
 	DataBinding.cpp
 	Flexbox.cpp
 	FontEffect.cpp
+	WidgetTextInput.cpp
 )
 
 set_common_target_options(${TARGET_NAME})
@@ -28,3 +29,8 @@ if(EMSCRIPTEN)
 	# The benchmarks additionally use data from the benchmark sample.
 	target_link_libraries(${TARGET_NAME} "--preload-file \"${PROJECT_SOURCE_DIR}/Samples/basic/benchmark/data/@/Samples/basic/benchmark/data/\"")
 endif()
+
+if(MSVC)
+	# Set UTF-8 on MSVC to properly encode non-ascii characters.
+	target_compile_options(${TARGET_NAME} PRIVATE /utf-8)
+endif()
diff --git a/Tests/Source/Benchmarks/WidgetTextInput.cpp b/Tests/Source/Benchmarks/WidgetTextInput.cpp
@@ -0,0 +1,160 @@
+/*
+ * 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 "../Common/TestsInterface.h"
+#include "../Common/TestsShell.h"
+#include <RmlUi/Core/Context.h>
+#include <RmlUi/Core/Element.h>
+#include <RmlUi/Core/ElementDocument.h>
+#include <RmlUi/Core/Elements/ElementFormControlTextArea.h>
+#include <RmlUi/Core/Types.h>
+#include <doctest.h>
+#include <nanobench.h>
+
+using namespace ankerl;
+using namespace Rml;
+
+static const String document_rml = R"(
+<rml>
+<head>
+	<link type="text/rcss" href="/../Tests/Data/style.rcss"/>
+	<title>Benchmark Sample</title>
+	<style>
+		body {
+			width: 800px;
+			height: 600px;
+		}
+		textarea {
+			width: 500px;
+			height: 300px;
+			border: 1px #000;
+			background: #fff;
+		}
+	</style>
+</head>
+
+<body>
+<textarea id="textarea">Hello, World!</textarea>
+</body>
+</rml>
+)";
+
+TEST_CASE("WidgetTextInput")
+{
+	Context* context = TestsShell::GetContext();
+	REQUIRE(context);
+
+	ElementDocument* document = context->LoadDocumentFromMemory(document_rml);
+	REQUIRE(document);
+	document->Show();
+
+	auto el = rmlui_dynamic_cast<ElementFormControlTextArea*>(document->GetElementById("textarea"));
+	REQUIRE(el);
+
+	auto IncrementTime = [system_interface = TestsShell::GetTestsSystemInterface(), t = 0.0]() mutable {
+		constexpr double dt = 0.5;
+		t += dt;
+		system_interface->SetTime(t);
+	};
+	struct TestCase {
+		String name;
+		String base;
+	};
+	const TestCase test_cases[] = {
+		{"ascii", "abc"},
+		{"emoji", "😍🌐😎"},
+		{"japanese", "こんに"},
+	};
+
+	nanobench::Bench bench;
+	bench.timeUnit(std::chrono::microseconds(1), "us");
+	bench.relative(true);
+	bench.complexityN(1);
+
+	SUBCASE("FormatText")
+	{
+		bench.title("WidgetTextInput.FormatText");
+
+		for (const TestCase& test_case : test_cases)
+		{
+			for (int num_character_repeats : {10, 20, 50, 100, 200})
+			{
+				String value;
+				for (int i = 0; i < num_character_repeats; i++)
+					value += test_case.base;
+
+				bench.complexityN(num_character_repeats).epochs(1).epochIterations(num_character_repeats >= 100 ? 1 : 0).run(test_case.name, [&] {
+					el->SetValue(value);
+					context->Update();
+				});
+			}
+		}
+	}
+
+	SUBCASE("CalculateCharacterIndex")
+	{
+		bench.title("WidgetTextInput.CalculateCharacterIndex");
+
+		el->SetWordWrap(false);
+		context->Update();
+
+		for (const TestCase& test_case : test_cases)
+		{
+			for (int num_character_repeats : {20, 50, 100, 200, 500})
+			{
+				String value;
+				for (int i = 0; i < num_character_repeats; i++)
+					value += test_case.base;
+
+				el->SetValue(value);
+				el->Focus();
+				context->ProcessKeyDown(Input::KI_END, 0);
+				context->ProcessKeyUp(Input::KI_END, 0);
+				context->Update();
+
+				bench.complexityN(num_character_repeats).epochs(1).epochIterations(num_character_repeats >= 100 ? 1 : 0).run(test_case.name, [&] {
+					context->ProcessMouseMove(250, 50, 0);
+					context->ProcessMouseButtonDown(0, 0);
+					context->ProcessMouseMove(350, 50, 0);
+					context->ProcessMouseButtonUp(0, 0);
+					IncrementTime();
+					context->Update();
+				});
+
+				// Sanity check that the above produces a selection as intended.
+				int selection_start = 0, selection_end = 0;
+				el->GetSelection(&selection_start, &selection_end, nullptr);
+				REQUIRE(selection_end - selection_start > 0);
+			}
+		}
+	}
+
+	TestsShell::RenderLoop();
+
+	document->Close();
+}
diff --git a/Tests/Source/Common/TestsShell.h b/Tests/Source/Common/TestsShell.h
@@ -55,8 +55,6 @@ void ShutdownShell();
 // or until 'ShutdownShell()'.
 void SetNumExpectedWarnings(int num_warnings);
 
-void SetTime(double t);
-
 // Stats only available for the dummy renderer.
 Rml::String GetRenderStats();