Add basic benchmark (#3038)

* Add basic benchmark

* Add basic documentation for how to run and add tests/benchmarks

* Update benchmark example output

* Add changelog entry

Co-authored-by: zneix <zneix@zneix.eu>

benchmarks/.clang-format

@@ -0,0 +1,35 @@
+Language: Cpp
+
+AccessModifierOffset: -4
+AlignEscapedNewlinesLeft: true
+AllowShortFunctionsOnASingleLine: false
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLambdasOnASingleLine: Empty
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: false
+AlwaysBreakBeforeMultilineStrings: false
+BasedOnStyle: Google
+BraceWrapping: {
+    AfterClass: 'true'
+    AfterControlStatement: 'true'
+    AfterFunction: 'true'
+    AfterNamespace: 'false'
+    BeforeCatch: 'true'
+    BeforeElse: 'true'
+}
+BreakBeforeBraces: Custom
+BreakConstructorInitializersBeforeComma: true
+ColumnLimit: 80
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+DerivePointerBinding: false
+FixNamespaceComments: true
+IndentCaseLabels: true
+IndentWidth: 4
+IndentWrappedFunctionNames: true
+IndentPPDirectives: AfterHash
+IncludeBlocks: Preserve
+NamespaceIndentation: Inner
+PointerBindsToType: false
+SpacesBeforeTrailingComments: 2
+Standard: Auto
+ReflowComments: false

benchmarks/CMakeLists.txt

@@ -0,0 +1,28 @@
+project(chatterino-benchmark)
+
+set(benchmark_SOURCES
+    ${CMAKE_CURRENT_LIST_DIR}/src/main.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/src/Emojis.cpp
+    # Add your new file above this line!
+    )
+
+add_executable(${PROJECT_NAME} ${benchmark_SOURCES})
+add_sanitizers(${PROJECT_NAME})
+
+target_link_libraries(${PROJECT_NAME} PRIVATE chatterino-lib)
+
+target_link_libraries(${PROJECT_NAME} PRIVATE benchmark::benchmark)
+
+target_compile_definitions(${PROJECT_NAME} PRIVATE
+    CHATTERINO_TEST
+    )
+
+set_target_properties(${PROJECT_NAME}
+    PROPERTIES
+    ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib"
+    LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib"
+    RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin"
+    RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}/bin"
+    RUNTIME_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}/bin"
+    RUNTIME_OUTPUT_DIRECTORY_RELWITHDEBINFO "${CMAKE_BINARY_DIR}/bin"
+    )

benchmarks/src/Emojis.cpp

@@ -0,0 +1,57 @@
+#include "providers/emoji/Emojis.hpp"
+
+#include <benchmark/benchmark.h>
+#include <QDebug>
+#include <QString>
+
+using namespace chatterino;
+
+static void BM_ShortcodeParsing(benchmark::State &state)
+{
+    Emojis emojis;
+
+    emojis.load();
+
+    struct TestCase {
+        QString input;
+        QString expectedOutput;
+    };
+
+    std::vector<TestCase> tests{
+        {
+            // input
+            "foo :penguin: bar",
+            // expected output
+            "foo 🐧 bar",
+        },
+        {
+            // input
+            "foo :nonexistantcode: bar",
+            // expected output
+            "foo :nonexistantcode: bar",
+        },
+        {
+            // input
+            ":male-doctor:",
+            // expected output
+            "👨‍⚕️",
+        },
+    };
+
+    for (auto _ : state)
+    {
+        for (const auto &test : tests)
+        {
+            auto output = emojis.replaceShortCodes(test.input);
+
+            auto matches = output == test.expectedOutput;
+            if (!matches && !output.endsWith(QChar(0xFE0F)))
+            {
+                // Try to append 0xFE0F if needed
+                output = output.append(QChar(0xFE0F));
+            }
+        }
+    }
+}
+
+BENCHMARK(BM_ShortcodeParsing);

benchmarks/src/main.cpp

@@ -0,0 +1,18 @@
+#include <benchmark/benchmark.h>
+#include <QApplication>
+#include <QtConcurrent>
+
+int main(int argc, char **argv)
+{
+    QApplication app(argc, argv);
+
+    ::benchmark::Initialize(&argc, argv);
+
+    QtConcurrent::run([&app] {
+        ::benchmark::RunSpecifiedBenchmarks();
+
+        app.exit(0);
+    });
+
+    return app.exec();
+}