refactor: add Channel::addSystemMessage function (#5500)

Chatterino · Jul 7, 2024 · 354079c · 354079c
1 parent 4535823
commit 354079c
Show file tree

Hide file tree

Showing 47 changed files with 443 additions and 588 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -36,6 +36,7 @@
 - Dev: Refactor `TwitchIrcServer`, making it abstracted. (#5421, #5435)
 - Dev: Reduced the amount of scale events. (#5404, #5406)
 - Dev: Removed unused timegate settings. (#5361)
+- Dev: Add `Channel::addSystemMessage` helper function, allowing us to avoid the common `channel->addMessage(makeSystemMessage(...));` pattern. (#5500)
 - Dev: Unsingletonize `Resources2`. (#5460)
 - Dev: All Lua globals now show in the `c2` global in the LuaLS metadata. (#5385)
 - Dev: Images are now loaded in worker threads. (#5431)

diff --git a/src/Application.cpp b/src/Application.cpp
@@ -1,6 +1,7 @@
 #include "Application.hpp"
 
 #include "common/Args.hpp"
+#include "common/Channel.hpp"
 #include "common/QLogging.hpp"
 #include "common/Version.hpp"
 #include "controllers/accounts/AccountController.hpp"
@@ -233,10 +234,10 @@ void Application::initialize(Settings &settings, const Paths &paths)
                 {
                     if (auto channel = split->getChannel(); !channel->isEmpty())
                     {
-                        channel->addMessage(makeSystemMessage(
+                        channel->addSystemMessage(
                             "Chatterino unexpectedly crashed and restarted. "
                             "You can disable automatic restarts in the "
-                            "settings."));
+                            "settings.");
                     }
                 }
             }
@@ -584,9 +585,8 @@ void Application::initPubSub()
             QString text =
                 QString("%1 cleared the chat.").arg(action.source.login);
 
-            auto msg = makeSystemMessage(text);
-            postToThread([chan, msg] {
-                chan->addMessage(msg);
+            postToThread([chan, text] {
+                chan->addSystemMessage(text);
             });
         });
 
@@ -610,9 +610,8 @@ void Application::initPubSub()
                 text += QString(" (%1 seconds)").arg(action.duration);
             }
 
-            auto msg = makeSystemMessage(text);
-            postToThread([chan, msg] {
-                chan->addMessage(msg);
+            postToThread([chan, text] {
+                chan->addSystemMessage(text);
             });
         });
 
@@ -631,9 +630,8 @@ void Application::initPubSub()
                             (action.modded ? "modded" : "unmodded"),
                             action.target.login);
 
-            auto msg = makeSystemMessage(text);
-            postToThread([chan, msg] {
-                chan->addMessage(msg);
+            postToThread([chan, text] {
+                chan->addSystemMessage(text);
             });
         });
 

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -585,8 +585,6 @@ set(SOURCE_FILES
         widgets/dialogs/LastRunCrashDialog.hpp
         widgets/dialogs/LoginDialog.cpp
         widgets/dialogs/LoginDialog.hpp
-        widgets/dialogs/NotificationPopup.cpp
-        widgets/dialogs/NotificationPopup.hpp
         widgets/dialogs/QualityPopup.cpp
         widgets/dialogs/QualityPopup.hpp
         widgets/dialogs/ReplyThreadPopup.cpp

diff --git a/src/common/Channel.cpp b/src/common/Channel.cpp
@@ -120,6 +120,12 @@ void Channel::addMessage(MessagePtr message,
     this->messageAppended.invoke(message, overridingFlags);
 }
 
+void Channel::addSystemMessage(const QString &contents)
+{
+    auto msg = makeSystemMessage(contents);
+    this->addMessage(msg);
+}
+
 void Channel::addOrReplaceTimeout(MessagePtr message)
 {
     addOrReplaceChannelTimeout(

diff --git a/src/common/Channel.hpp b/src/common/Channel.hpp
@@ -83,6 +83,8 @@ class Channel : public std::enable_shared_from_this<Channel>
                     std::optional<MessageFlags> overridingFlags = std::nullopt);
     void addMessagesAtStart(const std::vector<MessagePtr> &messages_);
 
+    void addSystemMessage(const QString &contents);
+
     /// Inserts the given messages in order by Message::serverReceivedTime.
     void fillInMissingMessages(const std::vector<MessagePtr> &messages);
 

diff --git a/src/controllers/commands/CommandController.cpp b/src/controllers/commands/CommandController.cpp
@@ -554,8 +554,7 @@ QString CommandController::execCommand(const QString &textNoEmoji,
 
     if (!dryRun && channel->getType() == Channel::Type::TwitchWhispers)
     {
-        channel->addMessage(
-            makeSystemMessage("Use /w <username> <message> to whisper"));
+        channel->addSystemMessage("Use /w <username> <message> to whisper");
         return "";
     }