feat: add crash recovery on Windows

.clang-tidy

@@ -29,6 +29,7 @@ Checks: "-*,
   -readability-function-cognitive-complexity,
   -bugprone-easily-swappable-parameters,
   -cert-err58-cpp,
+  -modernize-avoid-c-arrays
   "
 CheckOptions:
   - key: readability-identifier-naming.ClassCase

.github/workflows/build.yml

@@ -230,7 +230,7 @@ jobs:
         run: |
           cd build
           set cl=/MP
-          nmake /S /NOLOGO crashpad_handler
+          nmake /S /NOLOGO chatterino-crash-handler
           mkdir Chatterino2/crashpad
           cp bin/crashpad/crashpad_handler.exe Chatterino2/crashpad/crashpad_handler.exe
           7z a bin/chatterino-Qt-${{ matrix.qt-version }}.pdb.7z bin/chatterino.pdb

.github/workflows/test-windows.yml

@@ -124,6 +124,7 @@ jobs:
               ..
           set cl=/MP
           nmake /S /NOLOGO
+          nmake /S /NOLOGO chatterino-crash-handler-test
         working-directory: build-test
 
       - name: Download and extract Twitch PubSub Server Test

CHANGELOG.md

@@ -52,6 +52,7 @@
 - Bugfix: Fixed support for Windows 11 Snap layouts. (#4994)
 - Bugfix: Fixed some windows appearing between screens. (#4797)
 - Bugfix: Fixed a bug on Wayland where tooltips would spawn as separate windows instead of behaving like tooltips. (#4998)
+- Bugfix: Fixed _Restart on crash_ option not working on Windows. (#5012)
 - Dev: Run miniaudio in a separate thread, and simplify it to not manage the device ourselves. There's a chance the simplification is a bad idea. (#4978)
 - Dev: Change clang-format from v14 to v16. (#4929)
 - Dev: Fixed UTF16 encoding of `modes` file for the installer. (#4791)

CMakeLists.txt

@@ -244,4 +244,6 @@ if (BUILD_BENCHMARKS)
     add_subdirectory(benchmarks)
 endif ()
 
+add_subdirectory(auxiliary)
+
 feature_summary(WHAT ALL)

auxiliary/.clang-format

@@ -0,0 +1,55 @@
+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
+SortIncludes: CaseInsensitive
+IncludeBlocks: Regroup
+IncludeCategories:
+  # Project includes
+  - Regex: '^"[a-zA-Z\._-]+(/[a-zA-Z0-9\._-]+)*"$'
+    Priority: 1
+  # Third party library includes
+  - Regex: '<[[:alnum:].]+/[a-zA-Z0-9\._\/-]+>'
+    Priority: 3
+  # Qt includes
+  - Regex: '^<Q[a-zA-Z0-9\._\/-]+>$'
+    Priority: 3
+    CaseSensitive: true
+  # LibCommuni includes
+  - Regex: "^<Irc[a-zA-Z]+>$"
+    Priority: 3
+  # Misc libraries
+  - Regex: '^<[a-zA-Z_0-9]+\.h(pp)?>$'
+    Priority: 3
+  # Standard library includes
+  - Regex: "^<[a-zA-Z_]+>$"
+    Priority: 4
+NamespaceIndentation: Inner
+PointerBindsToType: false
+SpacesBeforeTrailingComments: 2
+Standard: Auto
+ReflowComments: false

auxiliary/CMakeLists.txt

@@ -0,0 +1,8 @@
+if(BUILD_WITH_CRASHPAD)
+    if(WIN32)
+        # crash-handler is only used on Windows for now.
+        add_subdirectory(crash-handler)
+    else()
+        message(WARNING "Crashpad was enabled but the custom crash handler is Windows only!")
+    endif()
+endif()

auxiliary/crash-handler/CMakeLists.txt

@@ -0,0 +1,95 @@
+project(chatterino-crash-handler 
+        VERSION 0.1.0
+        LANGUAGES CXX
+)
+set(PROJECT_LIB "${PROJECT_NAME}-lib")
+
+set(LIB_SOURCE_FILES
+    commandline.hpp
+    commandline.cpp
+    recovery.hpp
+    recovery.cpp
+)
+
+set(EXE_SOURCE_FILES
+    main.cpp
+)
+
+if(WIN32)
+    list(APPEND LIB_SOURCE_FILES
+        win_support.hpp
+        win_support.cpp
+    )
+endif()
+
+add_library(${PROJECT_LIB} OBJECT ${LIB_SOURCE_FILES})
+target_link_libraries(${PROJECT_LIB}
+    PUBLIC
+        crashpad_handler_lib
+        crashpad_tools
+        MagicEnum
+)
+set_target_properties(${PROJECT_LIB}
+    PROPERTIES
+        CXX_STANDARD 23
+        CXX_STANDARD_REQUIRED On
+)
+
+add_executable(${PROJECT_NAME} WIN32 ${EXE_SOURCE_FILES})
+target_link_libraries(${PROJECT_NAME} PRIVATE ${PROJECT_LIB})
+set_target_properties(${PROJECT_NAME}
+    PROPERTIES
+        RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin/crashpad"
+        OUTPUT_NAME "crashpad_handler"
+        CXX_STANDARD 23
+        CXX_STANDARD_REQUIRED On
+)
+
+if(WIN32)
+    target_compile_definitions(${PROJECT_LIB} PUBLIC NOMINMAX WIN32_LEAN_AND_MEAN)
+endif()
+
+# Configure compilers
+if(MSVC)
+    target_compile_options(${PROJECT_LIB} PUBLIC /EHsc /bigobj /utf-8)
+    target_compile_options(${PROJECT_LIB} PUBLIC
+        /W4
+        # 5038 - warnings about initialization order
+        /w15038
+    )
+else()
+    message(WARNING "No warnings configured for this compiler!")
+endif()
+
+if(CHATTERINO_ENABLE_LTO)
+    message(STATUS "Enabling LTO for ${PROJECT_NAME}")
+    set_property(TARGET ${PROJECT_NAME}
+                 PROPERTY INTERPROCEDURAL_OPTIMIZATION TRUE)
+endif()
+
+# TESTS
+
+if(TARGET gtest)
+    message(STATUS "Tests enabled for ${PROJECT_NAME}")
+
+    set(PROJECT_TESTS "${PROJECT_NAME}-test")
+    set(TEST_FILES 
+        commandline_test.cpp
+        recovery_test.cpp
+    )
+    if(WIN32)
+        list(APPEND TEST_FILES
+            win_support_test.cpp
+        )
+    endif()
+
+    add_executable(${PROJECT_TESTS} ${TEST_FILES})
+    target_link_libraries(${PROJECT_TESTS} PRIVATE ${PROJECT_LIB} GTest::gtest_main gmock)
+    set_target_properties(${PROJECT_TESTS}
+        PROPERTIES
+            RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin"
+            CXX_STANDARD 23
+            CXX_STANDARD_REQUIRED On
+    )
+    gtest_discover_tests(${PROJECT_TESTS})
+endif()

auxiliary/crash-handler/commandline.cpp

@@ -0,0 +1,44 @@
+#include "commandline.hpp"
+
+std::vector<std::wstring> splitChatterinoArgs(const std::wstring &args)
+{
+    std::vector<std::wstring> parts;
+
+    std::wstring_view view(args);
+    std::wstring_view::size_type pos{};
+    std::wstring part;
+
+    while ((pos = view.find(L'+')) != std::wstring_view::npos)
+    {
+        if (pos + 1 == view.length())  // string ends with +
+        {
+            parts.emplace_back(std::move(part));
+            return parts;
+        }
+
+        auto next = view[pos + 1];
+        if (next == L'+')  // escaped plus (++)
+        {
+            part += view.substr(0, pos);
+            part.push_back(L'+');
+            view = view.substr(pos + 2);
+            continue;
+        }
+
+        // actual separator
+        part += view.substr(0, pos);
+        parts.emplace_back(std::move(part));
+        view = view.substr(pos + 1);
+    }
+
+    if (!view.empty())
+    {
+        part += view;
+    }
+    if (!part.empty())
+    {
+        parts.emplace_back(std::move(part));
+    }
+
+    return parts;
+}

auxiliary/crash-handler/commandline.hpp

@@ -0,0 +1,10 @@
+#pragma once
+
+#include <string>
+#include <vector>
+
+/// Parse a command line string from chatterino into its arguments.
+///
+/// The command line arguments are joined by '+'. A plus is escaped by an
+/// additional plus ('++' -> '+').
+std::vector<std::wstring> splitChatterinoArgs(const std::wstring &args);

auxiliary/crash-handler/commandline_test.cpp

@@ -0,0 +1,41 @@
+#include "commandline.hpp"
+
+#include <gtest/gtest.h>
+
+using namespace std::string_literals;
+
+TEST(CommandLineTest, splitChatterinoArgs)
+{
+    struct TestCase {
+        std::wstring input;
+        std::vector<std::wstring> output;
+    };
+
+    std::initializer_list<TestCase> testCases{
+        {
+            L"-c+t:alien+--safe-mode"s,
+            {L"-c"s, L"t:alien"s, L"--safe-mode"s},
+        },
+        {
+            L"-c+t:++++++breaking news++++++!!+-V"s,
+            {L"-c"s, L"t:+++breaking news+++!!"s, L"-V"s},
+        },
+        {
+            L"++"s,
+            {L"+"s},
+        },
+        {
+            L""s,
+            {},
+        },
+        {
+            L"--channels=t:foo;t:bar;t:++++++foo++++++"s,
+            {L"--channels=t:foo;t:bar;t:+++foo+++"},
+        },
+    };
+
+    for (const auto &testCase : testCases)
+    {
+        EXPECT_EQ(splitChatterinoArgs(testCase.input), testCase.output);
+    }
+}

auxiliary/crash-handler/main.cpp

@@ -0,0 +1,54 @@
+#include "recovery.hpp"
+
+#include <handler/handler_main.h>
+#include <tools/tool_support.h>
+
+#if BUILDFLAG(IS_WIN)
+#    include <Windows.h>
+#endif
+
+namespace {
+
+// NOLINTNEXTLINE(cppcoreguidelines-avoid-c-arrays)
+int actualMain(int argc, char *argv[])
+{
+    // We're tapping into the crash handling by registering a data source.
+    // Our source doesn't actually provide any data, but it records the crash.
+    // Once the crash is recorded, we know that one happened and can attempt to restart
+    // the host application.
+    crashpad::UserStreamDataSources sources;
+    sources.emplace_back(std::make_unique<CrashRecoverer>());
+
+    auto ret = crashpad::HandlerMain(argc, argv, &sources);
+
+    if (ret == 0)
+    {
+        auto *recoverer = dynamic_cast<CrashRecoverer *>(sources.front().get());
+        if (recoverer != nullptr)
+        {
+            recoverer->attemptRecovery();
+        }
+    }
+    return ret;
+}
+
+}  // namespace
+
+// The following is adapted from handler/main.cc
+#if BUILDFLAG(IS_POSIX)
+
+int main(int argc, char *argv[])
+{
+    return actualMain(argc, argv);
+}
+
+#elif BUILDFLAG(IS_WIN)
+
+// The default entry point for /subsystem:windows.
+int APIENTRY wWinMain(HINSTANCE /*hInstance*/, HINSTANCE /*hPrevInstance*/,
+                      PWSTR /*pCmdLine*/, int /*nCmdShow*/)
+{
+    return crashpad::ToolSupport::Wmain(__argc, __wargv, actualMain);
+}
+
+#endif  // BUILDFLAG(IS_POSIX)