refactor: Fonts (#5228)

CHANGELOG.md

@@ -151,6 +151,7 @@
 - Dev: Move `clang-tidy` checker to its own CI job. (#4996)
 - Dev: Refactored the Image Uploader feature. (#4971)
 - Dev: Refactored the SplitOverlay code. (#5082)
+- Dev: Refactored the Fonts code, making it less of a singleton. (#5228)
 - Dev: Refactored the TwitchBadges structure, making it less of a singleton. (#5096, #5144)
 - Dev: Refactored emotes out of TwitchIrcServer. (#5120, #5146)
 - Dev: Refactored the ChatterinoBadges structure, making it less of a singleton. (#5103)

mocks/include/mocks/EmptyApplication.hpp

@@ -5,6 +5,8 @@
 #include "singletons/Paths.hpp"
 #include "singletons/Updates.hpp"
 
+#include <QTemporaryDir>
+
 namespace chatterino::mock {
 
 class EmptyApplication : public IApplication
@@ -235,7 +237,8 @@ public:
         return nullptr;
     }
 
-private:
+protected:
+    QTemporaryDir settingsDir;
     Paths paths_;
     Args args_;
     Updates updates_;

src/Application.cpp

@@ -118,7 +118,7 @@ Application::Application(Settings &_settings, const Paths &paths,
     : paths_(paths)
     , args_(_args)
     , themes(&this->emplace<Theme>())
-    , fonts(&this->emplace<Fonts>())
+    , fonts(new Fonts(_settings))
     , emotes(&this->emplace<Emotes>())
     , accounts(&this->emplace<AccountController>())
     , hotkeys(&this->emplace<HotkeyController>())
@@ -170,6 +170,7 @@ void Application::fakeDtor()
     this->bttvEmotes.reset();
     this->ffzEmotes.reset();
     this->seventvEmotes.reset();
+    this->fonts.reset();
 }
 
 void Application::initialize(Settings &settings, const Paths &paths)
@@ -335,8 +336,9 @@ Theme *Application::getThemes()
 Fonts *Application::getFonts()
 {
     assertInGuiThread();
+    assert(this->fonts);
 
-    return this->fonts;
+    return this->fonts.get();
 }
 
 IEmotes *Application::getEmotes()

src/Application.hpp

@@ -135,7 +135,7 @@ public:
 
 private:
     Theme *const themes{};
-    Fonts *const fonts{};
+    std::unique_ptr<Fonts> fonts{};
     Emotes *const emotes{};
     AccountController *const accounts{};
     HotkeyController *const hotkeys{};

src/singletons/Fonts.cpp

@@ -8,119 +8,73 @@
 #include <QDebug>
 #include <QtGlobal>
 
-#ifdef Q_OS_WIN32
-#    define DEFAULT_FONT_FAMILY "Segoe UI"
-#    define DEFAULT_FONT_SIZE 10
-#else
-#    ifdef Q_OS_MACOS
-#        define DEFAULT_FONT_FAMILY "Helvetica Neue"
-#        define DEFAULT_FONT_SIZE 12
-#    else
-#        define DEFAULT_FONT_FAMILY "Arial"
-#        define DEFAULT_FONT_SIZE 11
-#    endif
-#endif
-
-namespace chatterino {
 namespace {
-    int getBoldness()
+
-    {
+using namespace chatterino;
+
+int getBoldness()
+{
 #if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
-        // From qfont.cpp
+    // From qfont.cpp
-        // https://github.com/qt/qtbase/blob/589c6d066f84833a7c3dda1638037f4b2e91b7aa/src/gui/text/qfont.cpp#L143-L169
+    // https://github.com/qt/qtbase/blob/589c6d066f84833a7c3dda1638037f4b2e91b7aa/src/gui/text/qfont.cpp#L143-L169
-        static constexpr std::array<std::array<int, 2>, 9> legacyToOpenTypeMap{{
+    static constexpr std::array<std::array<int, 2>, 9> legacyToOpenTypeMap{{
-            {0, QFont::Thin},
+        {0, QFont::Thin},
-            {12, QFont::ExtraLight},
+        {12, QFont::ExtraLight},
-            {25, QFont::Light},
+        {25, QFont::Light},
-            {50, QFont::Normal},
+        {50, QFont::Normal},
-            {57, QFont::Medium},
+        {57, QFont::Medium},
-            {63, QFont::DemiBold},
+        {63, QFont::DemiBold},
-            {75, QFont::Bold},
+        {75, QFont::Bold},
-            {81, QFont::ExtraBold},
+        {81, QFont::ExtraBold},
-            {87, QFont::Black},
+        {87, QFont::Black},
-        }};
+    }};
 
-        const int target = getSettings()->boldScale.getValue();
+    const int target = getSettings()->boldScale.getValue();
 
-        int result = QFont::Medium;
+    int result = QFont::Medium;
-        int closestDist = INT_MAX;
+    int closestDist = INT_MAX;
 
-        // Go through and find the closest mapped value
+    // Go through and find the closest mapped value
-        for (const auto [weightOld, weightNew] : legacyToOpenTypeMap)
+    for (const auto [weightOld, weightNew] : legacyToOpenTypeMap)
+    {
+        const int dist = qAbs(weightOld - target);
+        if (dist < closestDist)
         {
-            const int dist = qAbs(weightOld - target);
+            result = weightNew;
-            if (dist < closestDist)
+            closestDist = dist;
-            {
+        }
-                result = weightNew;
+        else
-                closestDist = dist;
+        {
-            }
+            // Break early since following values will be further away
-            else
+            break;
-            {
-                // Break early since following values will be further away
-                break;
-            }
         }
-
-        return result;
-#else
-        return getSettings()->boldScale.getValue();
-#endif
     }
+
+    return result;
+#else
+    return getSettings()->boldScale.getValue();
+#endif
+}
 }  // namespace
 
-Fonts *Fonts::instance = nullptr;
+namespace chatterino {
 
-Fonts::Fonts()
+Fonts::Fonts(Settings &settings)
-    : chatFontFamily("/appearance/currentFontFamily", DEFAULT_FONT_FAMILY)
-    , chatFontSize("/appearance/currentFontSize", DEFAULT_FONT_SIZE)
 {
-    Fonts::instance = this;
-
     this->fontsByType_.resize(size_t(FontStyle::EndType));
-}
 
-void Fonts::initialize(Settings &, const Paths &)
+    this->fontChangedListener.setCB([this] {
-{
+        assertInGuiThread();
-    this->chatFontFamily.connect(
-        [this]() {
-            assertInGuiThread();
 
-            for (auto &map : this->fontsByType_)
+        for (auto &map : this->fontsByType_)
-            {
+        {
-                map.clear();
+            map.clear();
-            }
+        }
-            this->fontChanged.invoke();
+        this->fontChanged.invoke();
-        },
+    });
-        false);
+    this->fontChangedListener.addSetting(settings.chatFontFamily);
-
+    this->fontChangedListener.addSetting(settings.chatFontSize);
-    this->chatFontSize.connect(
+    this->fontChangedListener.addSetting(settings.boldScale);
-        [this]() {
-            assertInGuiThread();
-
-            for (auto &map : this->fontsByType_)
-            {
-                map.clear();
-            }
-            this->fontChanged.invoke();
-        },
-        false);
-
-#ifdef CHATTERINO
-    getSettings()->boldScale.connect(
-        [this]() {
-            assertInGuiThread();
-
-            // REMOVED
-            getIApp()->getWindows()->incGeneration();
-
-            for (auto &map : this->fontsByType_)
-            {
-                map.clear();
-            }
-            this->fontChanged.invoke();
-        },
-        false);
-#endif
 }
 
 QFont Fonts::getFont(FontStyle type, float scale)
@@ -159,6 +113,8 @@ Fonts::FontData &Fonts::getOrCreateFontData(FontStyle type, float scale)
 
 Fonts::FontData Fonts::createFontData(FontStyle type, float scale)
 {
+    auto *settings = getSettings();
+
     // check if it's a chat (scale the setting)
     if (type >= FontStyle::ChatStart && type <= FontStyle::ChatEnd)
     {
@@ -176,8 +132,8 @@ Fonts::FontData Fonts::createFontData(FontStyle type, float scale)
                                                 QFont::Weight(getBoldness())};
         auto data = sizeScale[type];
         return FontData(
-            QFont(this->chatFontFamily.getValue(),
+            QFont(settings->chatFontFamily.getValue(),
-                  int(this->chatFontSize.getValue() * data.scale * scale),
+                  int(settings->chatFontSize.getValue() * data.scale * scale),
                   data.weight, data.italic));
     }
 
@@ -205,9 +161,4 @@ Fonts::FontData Fonts::createFontData(FontStyle type, float scale)
     }
 }
 
-Fonts *getFonts()
-{
-    return Fonts::instance;
-}
-
 }  // namespace chatterino

src/singletons/Fonts.hpp

@@ -1,15 +1,13 @@
 #pragma once
 
-#include "common/ChatterinoSetting.hpp"
+#include "pajlada/settings/settinglistener.hpp"
-#include "common/Singleton.hpp"
 
 #include <pajlada/signals/signal.hpp>
 #include <QFont>
-#include <QFontDatabase>
 #include <QFontMetrics>
 
-#include <array>
 #include <unordered_map>
+#include <vector>
 
 namespace chatterino {
 
@@ -38,23 +36,17 @@ enum class FontStyle : uint8_t {
     ChatEnd = ChatVeryLarge,
 };
 
-class Fonts final : public Singleton
+class Fonts final
 {
 public:
-    Fonts();
+    explicit Fonts(Settings &settings);
-
-    void initialize(Settings &settings, const Paths &paths) override;
 
     // font data gets set in createFontData(...)
 
     QFont getFont(FontStyle type, float scale);
     QFontMetrics getFontMetrics(FontStyle type, float scale);
 
-    QStringSetting chatFontFamily;
-    IntSetting chatFontSize;
-
     pajlada::Signals::NoArgSignal fontChanged;
-    static Fonts *instance;
 
 private:
     struct FontData {
@@ -85,8 +77,8 @@ private:
     FontData createFontData(FontStyle type, float scale);
 
     std::vector<std::unordered_map<float, FontData>> fontsByType_;
+
+    pajlada::SettingListener fontChangedListener;
 };
 
-Fonts *getFonts();
-
 }  // namespace chatterino

src/singletons/Settings.hpp

@@ -25,6 +25,19 @@ using TimeoutButton = std::pair<QString, int>;
 
 namespace chatterino {
 
+#ifdef Q_OS_WIN32
+#    define DEFAULT_FONT_FAMILY "Segoe UI"
+#    define DEFAULT_FONT_SIZE 10
+#else
+#    ifdef Q_OS_MACOS
+#        define DEFAULT_FONT_FAMILY "Helvetica Neue"
+#        define DEFAULT_FONT_SIZE 12
+#    else
+#        define DEFAULT_FONT_FAMILY "Arial"
+#        define DEFAULT_FONT_SIZE 11
+#    endif
+#endif
+
 void _actuallyRegisterSetting(
     std::weak_ptr<pajlada::Settings::SettingData> setting);
 
@@ -134,6 +147,14 @@ public:
 
     //    BoolSetting collapseLongMessages =
     //    {"/appearance/messages/collapseLongMessages", false};
+    QStringSetting chatFontFamily{
+        "/appearance/currentFontFamily",
+        DEFAULT_FONT_FAMILY,
+    };
+    IntSetting chatFontSize{
+        "/appearance/currentFontSize",
+        DEFAULT_FONT_SIZE,
+    };
     BoolSetting hideReplyContext = {"/appearance/hideReplyContext", false};
     BoolSetting showReplyButton = {"/appearance/showReplyButton", false};
     BoolSetting stripReplyMention = {"/appearance/stripReplyMention", true};

src/singletons/WindowManager.cpp

@@ -9,7 +9,6 @@
 #include "providers/irc/IrcChannel2.hpp"
 #include "providers/irc/IrcServer.hpp"
 #include "providers/twitch/TwitchIrcServer.hpp"
-#include "singletons/Fonts.hpp"
 #include "singletons/Paths.hpp"
 #include "singletons/Settings.hpp"
 #include "singletons/Theme.hpp"

src/widgets/BaseWindow.cpp

@@ -775,7 +775,8 @@ void BaseWindow::scaleChangedEvent(float scale)
     this->calcButtonsSizes();
 #endif
 
-    this->setFont(getFonts()->getFont(FontStyle::UiTabs, this->qtFontScale()));
+    this->setFont(
+        getIApp()->getFonts()->getFont(FontStyle::UiTabs, this->qtFontScale()));
 }
 
 void BaseWindow::paintEvent(QPaintEvent *)

src/widgets/Label.cpp

@@ -1,4 +1,6 @@
-#include "Label.hpp"
+#include "widgets/Label.hpp"
+
+#include "Application.hpp"
 
 #include <QPainter>
 
@@ -14,9 +16,10 @@ Label::Label(BaseWidget *parent, QString text, FontStyle style)
     , text_(std::move(text))
     , fontStyle_(style)
 {
-    this->connections_.managedConnect(getFonts()->fontChanged, [this] {
+    this->connections_.managedConnect(getIApp()->getFonts()->fontChanged,
-        this->updateSize();
+                                      [this] {
-    });
+                                          this->updateSize();
+                                      });
 }
 
 const QString &Label::getText() const
@@ -92,12 +95,12 @@ void Label::paintEvent(QPaintEvent *)
         1.0;
 #endif
 
-    QFontMetrics metrics = getFonts()->getFontMetrics(
+    QFontMetrics metrics = getIApp()->getFonts()->getFontMetrics(
         this->getFontStyle(),
         this->scale() * 96.f /
             std::max<float>(
                 0.01F, static_cast<float>(this->logicalDpiX() * deviceDpi)));
-    painter.setFont(getFonts()->getFont(
+    painter.setFont(getIApp()->getFonts()->getFont(
         this->getFontStyle(),
         this->scale() * 96.f /
             std::max<float>(
@@ -128,7 +131,7 @@ void Label::paintEvent(QPaintEvent *)
 void Label::updateSize()
 {
     QFontMetrics metrics =
-        getFonts()->getFontMetrics(this->fontStyle_, this->scale());
+        getIApp()->getFonts()->getFontMetrics(this->fontStyle_, this->scale());
 
     int width =
         metrics.horizontalAdvance(this->text_) + (2 * this->getOffset());

src/widgets/TooltipWidget.cpp

@@ -47,9 +47,10 @@ TooltipWidget::TooltipWidget(BaseWidget *parent)
     this->setLayout(this->vLayout_);
     this->currentStyle_ = TooltipStyle::Vertical;
 
-    this->connections_.managedConnect(getFonts()->fontChanged, [this] {
+    this->connections_.managedConnect(getIApp()->getFonts()->fontChanged,
-        this->updateFont();
+                                      [this] {
-    });
+                                          this->updateFont();
+                                      });
     this->updateFont();
 
     auto *windows = getIApp()->getWindows();
@@ -299,8 +300,8 @@ void TooltipWidget::scaleChangedEvent(float)
 
 void TooltipWidget::updateFont()
 {
-    this->setFont(
+    this->setFont(getIApp()->getFonts()->getFont(FontStyle::ChatMediumSmall,
-        getFonts()->getFont(FontStyle::ChatMediumSmall, this->scale()));
+                                                 this->scale()));
 }
 
 void TooltipWidget::setWordWrap(bool wrap)

src/widgets/dialogs/UserInfoPopup.cpp

@@ -572,7 +572,8 @@ void UserInfoPopup::themeChangedEvent()
 
     for (auto &&child : this->findChildren<QCheckBox *>())
     {
-        child->setFont(getFonts()->getFont(FontStyle::UiMedium, this->scale()));
+        child->setFont(
+            getIApp()->getFonts()->getFont(FontStyle::UiMedium, this->scale()));
     }
 }
 

src/widgets/helper/ChannelView.cpp

@@ -620,7 +620,7 @@ void ChannelView::scaleChangedEvent(float scale)
                      0.01, this->logicalDpiX() * this->devicePixelRatioF());
 #endif
         this->goToBottom_->getLabel().setFont(
-            getFonts()->getFont(FontStyle::UiMedium, factor));
+            getIApp()->getFonts()->getFont(FontStyle::UiMedium, factor));
     }
 }
 

src/widgets/settingspages/GeneralPage.cpp

@@ -166,8 +166,7 @@ void GeneralPage::initLayout(GeneralPageView &layout)
     }
 
     layout.addDropdown<QString>(
-        "Font", {"Segoe UI", "Arial", "Choose..."},
+        "Font", {"Segoe UI", "Arial", "Choose..."}, s.chatFontFamily,
-        getIApp()->getFonts()->chatFontFamily,
         [](auto val) {
             return val;
         },
@@ -177,7 +176,7 @@ void GeneralPage::initLayout(GeneralPageView &layout)
         true, "", true);
     layout.addDropdown<int>(
         "Font size", {"9pt", "10pt", "12pt", "14pt", "16pt", "20pt"},
-        getIApp()->getFonts()->chatFontSize,
+        s.chatFontSize,
         [](auto val) {
             return QString::number(val) + "pt";
         },

tests/src/NotebookTab.cpp

@@ -5,6 +5,7 @@
 #include "gmock/gmock.h"
 #include "mocks/EmptyApplication.hpp"
 #include "singletons/Fonts.hpp"
+#include "singletons/Settings.hpp"
 #include "singletons/Theme.hpp"
 #include "widgets/Notebook.hpp"
 
@@ -21,6 +22,11 @@ namespace {
 class MockApplication : mock::EmptyApplication
 {
 public:
+    MockApplication()
+        : settings(this->settingsDir.filePath("settings.json"))
+        , fonts(this->settings)
+    {
+    }
     Theme *getThemes() override
     {
         return &this->theme;
@@ -36,6 +42,7 @@ public:
         return &this->fonts;
     }
 
+    Settings settings;
     Theme theme;
     HotkeyController hotkeys;
     Fonts fonts;

tests/src/SplitInput.cpp

@@ -9,6 +9,7 @@
 #include "singletons/Emotes.hpp"
 #include "singletons/Fonts.hpp"
 #include "singletons/Paths.hpp"
+#include "singletons/Settings.hpp"
 #include "singletons/Theme.hpp"
 #include "singletons/WindowManager.hpp"
 #include "widgets/Notebook.hpp"
@@ -28,7 +29,9 @@ class MockApplication : mock::EmptyApplication
 {
 public:
     MockApplication()
-        : windowManager(this->paths)
+        : settings(this->settingsDir.filePath("settings.json"))
+        , fonts(this->settings)
+        , windowManager(this->paths)
     {
     }
     Theme *getThemes() override
@@ -66,6 +69,7 @@ public:
         return &this->emotes;
     }
 
+    Settings settings;
     Theme theme;
     HotkeyController hotkeys;
     Fonts fonts;