Overhaul highlight system (#3399)

Checks have been moved into a Controller allowing for easier tests.

src/controllers/highlights/HighlightController.hpp

@@ -0,0 +1,159 @@
+#pragma once
+
+#include "common/Singleton.hpp"
+#include "common/UniqueAccess.hpp"
+#include "messages/MessageBuilder.hpp"
+#include "providers/twitch/TwitchBadge.hpp"
+#include "singletons/Paths.hpp"
+#include "singletons/Settings.hpp"
+
+#include <QColor>
+#include <QUrl>
+#include <boost/optional.hpp>
+
+#include <functional>
+#include <memory>
+#include <utility>
+
+namespace chatterino {
+
+struct HighlightResult {
+    HighlightResult(bool _alert, bool _playSound,
+                    boost::optional<QUrl> _customSoundUrl,
+                    std::shared_ptr<QColor> _color, bool _showInMentions)
+        : alert(_alert)
+        , playSound(_playSound)
+        , customSoundUrl(std::move(_customSoundUrl))
+        , color(std::move(_color))
+        , showInMentions(_showInMentions)
+    {
+    }
+
+    /**
+     * @brief Construct an empty HighlightResult with all side-effects disabled
+     **/
+    static HighlightResult emptyResult()
+    {
+        return {
+            false, false, boost::none, nullptr, false,
+        };
+    }
+
+    /**
+     * @brief true if highlight should trigger the taskbar to flash
+     **/
+    bool alert{false};
+
+    /**
+     * @brief true if highlight should play a notification sound
+     **/
+    bool playSound{false};
+
+    /**
+     * @brief Can be set to a different sound that should play when this highlight is activated
+     *
+     * May only be set if playSound is true
+     **/
+    boost::optional<QUrl> customSoundUrl{};
+
+    /**
+     * @brief set if highlight should set a background color
+     **/
+    std::shared_ptr<QColor> color{};
+
+    /**
+     * @brief true if highlight should show message in the /mentions split
+     **/
+    bool showInMentions{false};
+
+    bool operator==(const HighlightResult &other) const
+    {
+        if (this->alert != other.alert)
+        {
+            return false;
+        }
+        if (this->playSound != other.playSound)
+        {
+            return false;
+        }
+        if (this->customSoundUrl != other.customSoundUrl)
+        {
+            return false;
+        }
+
+        if (this->color && other.color)
+        {
+            if (*this->color != *other.color)
+            {
+                return false;
+            }
+        }
+
+        if (this->showInMentions != other.showInMentions)
+        {
+            return false;
+        }
+
+        return true;
+    }
+
+    bool operator!=(const HighlightResult &other) const
+    {
+        return !(*this == other);
+    }
+
+    /**
+     * @brief Returns true if no side-effect has been enabled
+     **/
+    [[nodiscard]] bool empty() const
+    {
+        return !this->alert && !this->playSound &&
+               !this->customSoundUrl.has_value() && !this->color &&
+               !this->showInMentions;
+    }
+
+    /**
+     * @brief Returns true if all side-effects have been enabled
+     **/
+    [[nodiscard]] bool full() const
+    {
+        return this->alert && this->playSound &&
+               this->customSoundUrl.has_value() && this->color &&
+               this->showInMentions;
+    }
+};
+
+struct HighlightCheck {
+    using Checker = std::function<boost::optional<HighlightResult>(
+        const MessageParseArgs &args, const std::vector<Badge> &badges,
+        const QString &senderName, const QString &originalMessage)>;
+    Checker cb;
+};
+
+class HighlightController final : public Singleton
+{
+public:
+    void initialize(Settings &settings, Paths &paths) override;
+
+    /**
+     * @brief Checks the given message parameters if it matches our internal checks, and returns a result
+     **/
+    [[nodiscard]] std::pair<bool, HighlightResult> check(
+        const MessageParseArgs &args, const std::vector<Badge> &badges,
+        const QString &senderName, const QString &originalMessage) const;
+
+private:
+    /**
+     * @brief rebuildChecks is called whenever some outside variable has been changed and our checks need to be updated
+     *
+     * rebuilds are always full, so if something changes we throw away all checks and build them all up from scratch
+     **/
+    void rebuildChecks(Settings &settings);
+
+    UniqueAccess<std::vector<HighlightCheck>> checks_;
+
+    pajlada::SettingListener rebuildListener_;
+    pajlada::Signals::SignalHolder signalHolder_;
+};
+
+}  // namespace chatterino