Better Highlights (#1320)

* Support for user-defined sounds and colors

* Make color & sound columns selectable

* Add custom row for subscription highlights

* Add subscriptions to custom highlights and centrally manage highlight colors

* Dynamically update message highlight colors

src/providers/colors/ColorProvider.cpp

@@ -0,0 +1,124 @@
+#include "providers/colors/ColorProvider.hpp"
+
+#include "controllers/highlights/HighlightController.hpp"
+#include "singletons/Theme.hpp"
+
+namespace chatterino {
+
+const ColorProvider &ColorProvider::instance()
+{
+    static ColorProvider instance;
+    return instance;
+}
+
+ColorProvider::ColorProvider()
+    : typeColorMap_()
+    , defaultColors_()
+{
+    this->initTypeColorMap();
+    this->initDefaultColors();
+}
+
+const std::shared_ptr<QColor> ColorProvider::color(ColorType type) const
+{
+    return this->typeColorMap_.at(type);
+}
+
+void ColorProvider::updateColor(ColorType type, QColor color)
+{
+    auto colorPtr = this->typeColorMap_.at(type);
+    *colorPtr = color;
+}
+
+QSet<QColor> ColorProvider::recentColors() const
+{
+    QSet<QColor> retVal;
+
+    /*
+     * Currently, only colors used in highlight phrases are considered. This
+     * may change at any point in the future.
+     */
+    for (auto phrase : getApp()->highlights->phrases)
+    {
+        retVal.insert(*phrase.getColor());
+    }
+
+    for (auto userHl : getApp()->highlights->highlightedUsers)
+    {
+        retVal.insert(*userHl.getColor());
+    }
+
+    // Insert preset highlight colors
+    retVal.insert(*this->color(ColorType::SelfHighlight));
+    retVal.insert(*this->color(ColorType::Subscription));
+    retVal.insert(*this->color(ColorType::Whisper));
+
+    return retVal;
+}
+
+const std::vector<QColor> &ColorProvider::defaultColors() const
+{
+    return this->defaultColors_;
+}
+
+void ColorProvider::initTypeColorMap()
+{
+    // Read settings for custom highlight colors and save them in map.
+    // If no custom values can be found, set up default values instead.
+    auto backgrounds = getApp()->themes->messages.backgrounds;
+
+    QString customColor = getSettings()->selfHighlightColor;
+    if (QColor(customColor).isValid())
+    {
+        this->typeColorMap_.insert(
+            {ColorType::SelfHighlight, std::make_shared<QColor>(customColor)});
+    }
+    else
+    {
+        this->typeColorMap_.insert(
+            {ColorType::SelfHighlight,
+             std::make_shared<QColor>(backgrounds.highlighted)});
+    }
+
+    customColor = getSettings()->subHighlightColor;
+    if (QColor(customColor).isValid())
+    {
+        this->typeColorMap_.insert(
+            {ColorType::Subscription, std::make_shared<QColor>(customColor)});
+    }
+    else
+    {
+        this->typeColorMap_.insert(
+            {ColorType::Subscription,
+             std::make_shared<QColor>(backgrounds.subscription)});
+    }
+
+    customColor = getSettings()->whisperHighlightColor;
+    if (QColor(customColor).isValid())
+    {
+        this->typeColorMap_.insert(
+            {ColorType::Whisper, std::make_shared<QColor>(customColor)});
+    }
+    else
+    {
+        this->typeColorMap_.insert(
+            {ColorType::Whisper,
+             std::make_shared<QColor>(backgrounds.highlighted)});
+    }
+}
+
+void ColorProvider::initDefaultColors()
+{
+    // Init default colors
+    this->defaultColors_.emplace_back(31, 141, 43, 127);   // Green-ish
+    this->defaultColors_.emplace_back(28, 126, 141, 127);  // Blue-ish
+    this->defaultColors_.emplace_back(136, 141, 49, 127);  // Golden-ish
+    this->defaultColors_.emplace_back(143, 48, 24, 127);   // Red-ish
+    this->defaultColors_.emplace_back(28, 141, 117, 127);  // Cyan-ish
+
+    auto backgrounds = getApp()->themes->messages.backgrounds;
+    this->defaultColors_.push_back(backgrounds.highlighted);
+    this->defaultColors_.push_back(backgrounds.subscription);
+}
+
+}  // namespace chatterino

src/providers/colors/ColorProvider.hpp

@@ -0,0 +1,53 @@
+#pragma once
+
+namespace chatterino {
+
+enum class ColorType { SelfHighlight, Subscription, Whisper };
+
+class ColorProvider
+{
+public:
+    static const ColorProvider &instance();
+
+    /**
+     * @brief Return a std::shared_ptr to the color of the requested ColorType.
+     *
+     * If a custom color has been set for the requested ColorType, it is
+     * returned. If no custom color exists for the type, a default color is
+     * returned.
+     *
+     * We need to do this in order to be able to dynamically update the colors
+     * of already parsed predefined (self highlights, subscriptions,
+     * and whispers) highlights.
+     */
+    const std::shared_ptr<QColor> color(ColorType type) const;
+
+    void updateColor(ColorType type, QColor color);
+
+    /**
+     * @brief Return a set of recently used colors used anywhere in Chatterino.
+     */
+    QSet<QColor> recentColors() const;
+
+    /**
+     * @brief Return a vector of colors that are good defaults for use
+     *        throughout the program.
+     */
+    const std::vector<QColor> &defaultColors() const;
+
+private:
+    ColorProvider();
+
+    void initTypeColorMap();
+    void initDefaultColors();
+
+    std::unordered_map<ColorType, std::shared_ptr<QColor>> typeColorMap_;
+    std::vector<QColor> defaultColors_;
+};
+}  // namespace chatterino
+
+// Adapted from Qt example: https://doc.qt.io/qt-5/qhash.html#qhash
+inline uint qHash(const QColor &key)
+{
+    return qHash(key.name(QColor::HexArgb));
+}