HighlightController.hpp

Go to the documentation of this file.

#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)
    {
    }

    static HighlightResult emptyResult()
    {
        return {
            false, false, boost::none, nullptr, false,
        };
    }

    bool alert{false};

    bool playSound{false};

    boost::optional<QUrl> customSoundUrl{};

    std::shared_ptr<QColor> color{};

    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);
    }

    [[nodiscard]] bool empty() const
    {
        return !this->alert && !this->playSound &&
               !this->customSoundUrl.has_value() && !this->color &&
               !this->showInMentions;
    }

    [[nodiscard]] bool full() const
    {
        return this->alert && this->playSound &&
               this->customSoundUrl.has_value() && this->color &&
               this->showInMentions;
    }

    friend std::ostream &operator<<(std::ostream &os,
                                    const HighlightResult &result)
    {
        os << "Alert: " << (result.alert ? "Yes" : "No") << ", "
           << "Play sound: " << (result.playSound ? "Yes" : "No") << " ("
           << (result.customSoundUrl
                   ? result.customSoundUrl.get().toString().toStdString()
                   : "")
           << ")"
           << ", "
           << "Color: "
           << (result.color ? result.color->name().toStdString() : "") << ", "
           << "Show in mentions: " << (result.showInMentions ? "Yes" : "No");
        return os;
    }
};

struct HighlightCheck {
    using Checker = std::function<boost::optional<HighlightResult>(
        const MessageParseArgs &args, const std::vector<Badge> &badges,
        const QString &senderName, const QString &originalMessage,
        const MessageFlags &messageFlags, bool self)>;
    Checker cb;
};

class HighlightController final : public Singleton
{
public:
    void initialize(Settings &settings, Paths &paths) override;

    [[nodiscard]] std::pair<bool, HighlightResult> check(
        const MessageParseArgs &args, const std::vector<Badge> &badges,
        const QString &senderName, const QString &originalMessage,
        const MessageFlags &messageFlags) const;

private:
    void rebuildChecks(Settings &settings);

    UniqueAccess<std::vector<HighlightCheck>> checks_;

    pajlada::SettingListener rebuildListener_;
    pajlada::Signals::SignalHolder signalHolder_;
};

}  // namespace chatterino