Provide UI Theme editor

PR #18655.

src/gui/uithememanager.cpp

@@ -30,370 +30,24 @@
 
 #include "uithememanager.h"
 
-#include <QApplication>
-#include <QDir>
-#include <QFile>
-#include <QJsonDocument>
-#include <QJsonObject>
 #include <QPalette>
 #include <QPixmapCache>
 #include <QResource>
 
-#include "base/algorithm.h"
 #include "base/global.h"
 #include "base/logger.h"
 #include "base/path.h"
 #include "base/preferences.h"
-#include "base/profile.h"
-#include "base/utils/fs.h"
-#include "color.h"
+#include "uithemecommon.h"
 
 namespace
 {
-    const QString CONFIG_FILE_NAME = u"config.json"_qs;
-    const QString STYLESHEET_FILE_NAME = u"stylesheet.qss"_qs;
-
     bool isDarkTheme()
     {
         const QPalette palette = qApp->palette();
         const QColor &color = palette.color(QPalette::Active, QPalette::Base);
         return (color.lightness() < 127);
     }
-
-    QByteArray readFile(const Path &filePath)
-    {
-        QFile file {filePath.data()};
-        if (!file.exists())
-            return {};
-
-        if (file.open(QIODevice::ReadOnly | QIODevice::Text))
-            return file.readAll();
-
-        LogMsg(UIThemeManager::tr("UITheme - Failed to open \"%1\". Reason: %2")
-               .arg(filePath.filename(), file.errorString())
-               , Log::WARNING);
-        return {};
-    }
-
-    QJsonObject parseThemeConfig(const QByteArray &data)
-    {
-        if (data.isEmpty())
-            return {};
-
-        QJsonParseError jsonError;
-        const QJsonDocument configJsonDoc = QJsonDocument::fromJson(data, &jsonError);
-        if (jsonError.error != QJsonParseError::NoError)
-        {
-            LogMsg(UIThemeManager::tr("Couldn't parse UI Theme configuration file. Reason: %1")
-                   .arg(jsonError.errorString()), Log::WARNING);
-            return {};
-        }
-
-        if (!configJsonDoc.isObject())
-        {
-            LogMsg(UIThemeManager::tr("UI Theme configuration file has invalid format. Reason: %1")
-                   .arg(UIThemeManager::tr("Root JSON value is not an object")), Log::WARNING);
-            return {};
-        }
-
-        return configJsonDoc.object();
-    }
-
-    QHash<QString, QColor> colorsFromJSON(const QJsonObject &jsonObj)
-    {
-        QHash<QString, QColor> colors;
-        for (auto colorNode = jsonObj.constBegin(); colorNode != jsonObj.constEnd(); ++colorNode)
-        {
-            const QColor color {colorNode.value().toString()};
-            if (!color.isValid())
-            {
-                LogMsg(UIThemeManager::tr("Invalid color for ID \"%1\" is provided by theme")
-                       .arg(colorNode.key()), Log::WARNING);
-                continue;
-            }
-
-            colors.insert(colorNode.key(), color);
-        }
-
-        return colors;
-    }
-
-    Path findIcon(const QString &iconId, const Path &dir)
-    {
-        const Path pathSvg = dir / Path(iconId + u".svg");
-        if (pathSvg.exists())
-            return pathSvg;
-
-        const Path pathPng = dir / Path(iconId + u".png");
-        if (pathPng.exists())
-            return pathPng;
-
-        return {};
-    }
-
-    class DefaultThemeSource final : public UIThemeSource
-    {
-    public:
-        DefaultThemeSource()
-        {
-            loadColors();
-        }
-
-        QByteArray readStyleSheet() override
-        {
-            return {};
-        }
-
-        QColor getColor(const QString &colorId, const ColorMode colorMode) const override
-        {
-            if (colorMode == ColorMode::Dark)
-            {
-                if (const QColor color = m_darkModeColors.value(colorId)
-                        ; color.isValid())
-                {
-                    return color;
-                }
-            }
-
-            return m_colors.value(colorId);
-        }
-
-        Path getIconPath(const QString &iconId, const ColorMode colorMode) const override
-        {
-            const Path iconsPath {u"icons"_qs};
-            const Path darkModeIconsPath = iconsPath / Path(u"dark"_qs);
-
-            if (colorMode == ColorMode::Dark)
-            {
-                if (const Path iconPath = findIcon(iconId, (m_userPath / darkModeIconsPath))
-                        ; !iconPath.isEmpty())
-                {
-                    return iconPath;
-                }
-
-                if (const Path iconPath = findIcon(iconId, (m_defaultPath / darkModeIconsPath))
-                        ; !iconPath.isEmpty())
-                {
-                    return iconPath;
-                }
-            }
-
-            if (const Path iconPath = findIcon(iconId, (m_userPath / iconsPath))
-                    ; !iconPath.isEmpty())
-            {
-                return iconPath;
-            }
-
-            return findIcon(iconId, (m_defaultPath / iconsPath));
-        }
-
-    private:
-        void loadColors()
-        {
-            m_colors = {
-                {u"Log.TimeStamp"_qs, Color::Primer::Light::fgSubtle},
-                {u"Log.Normal"_qs, QApplication::palette().color(QPalette::Active, QPalette::WindowText)},
-                {u"Log.Info"_qs, Color::Primer::Light::accentFg},
-                {u"Log.Warning"_qs, Color::Primer::Light::severeFg},
-                {u"Log.Critical"_qs, Color::Primer::Light::dangerFg},
-                {u"Log.BannedPeer"_qs, Color::Primer::Light::dangerFg},
-
-                {u"RSS.ReadArticle"_qs, QApplication::palette().color(QPalette::Inactive, QPalette::WindowText)},
-                {u"RSS.UnreadArticle"_qs, QApplication::palette().color(QPalette::Active, QPalette::Link)},
-
-                {u"TransferList.Downloading"_qs, Color::Primer::Light::successFg},
-                {u"TransferList.StalledDownloading"_qs, Color::Primer::Light::successEmphasis},
-                {u"TransferList.DownloadingMetadata"_qs, Color::Primer::Light::successFg},
-                {u"TransferList.ForcedDownloadingMetadata"_qs, Color::Primer::Light::successFg},
-                {u"TransferList.ForcedDownloading"_qs, Color::Primer::Light::successFg},
-                {u"TransferList.Uploading"_qs, Color::Primer::Light::accentFg},
-                {u"TransferList.StalledUploading"_qs, Color::Primer::Light::accentEmphasis},
-                {u"TransferList.ForcedUploading"_qs, Color::Primer::Light::accentFg},
-                {u"TransferList.QueuedDownloading"_qs, Color::Primer::Light::scaleYellow6},
-                {u"TransferList.QueuedUploading"_qs, Color::Primer::Light::scaleYellow6},
-                {u"TransferList.CheckingDownloading"_qs, Color::Primer::Light::successFg},
-                {u"TransferList.CheckingUploading"_qs, Color::Primer::Light::successFg},
-                {u"TransferList.CheckingResumeData"_qs, Color::Primer::Light::successFg},
-                {u"TransferList.PausedDownloading"_qs, Color::Primer::Light::fgMuted},
-                {u"TransferList.PausedUploading"_qs, Color::Primer::Light::doneFg},
-                {u"TransferList.Moving"_qs, Color::Primer::Light::successFg},
-                {u"TransferList.MissingFiles"_qs, Color::Primer::Light::dangerFg},
-                {u"TransferList.Error"_qs, Color::Primer::Light::dangerFg}
-            };
-
-            m_darkModeColors = {
-                {u"Log.TimeStamp"_qs, Color::Primer::Dark::fgSubtle},
-                {u"Log.Normal"_qs, QApplication::palette().color(QPalette::Active, QPalette::WindowText)},
-                {u"Log.Info"_qs, Color::Primer::Dark::accentFg},
-                {u"Log.Warning"_qs, Color::Primer::Dark::severeFg},
-                {u"Log.Critical"_qs, Color::Primer::Dark::dangerFg},
-                {u"Log.BannedPeer"_qs, Color::Primer::Dark::dangerFg},
-
-                {u"RSS.ReadArticle"_qs, QApplication::palette().color(QPalette::Inactive, QPalette::WindowText)},
-                {u"RSS.UnreadArticle"_qs, QApplication::palette().color(QPalette::Active, QPalette::Link)},
-
-                {u"TransferList.Downloading"_qs, Color::Primer::Dark::successFg},
-                {u"TransferList.StalledDownloading"_qs, Color::Primer::Dark::successEmphasis},
-                {u"TransferList.DownloadingMetadata"_qs, Color::Primer::Dark::successFg},
-                {u"TransferList.ForcedDownloadingMetadata"_qs, Color::Primer::Dark::successFg},
-                {u"TransferList.ForcedDownloading"_qs, Color::Primer::Dark::successFg},
-                {u"TransferList.Uploading"_qs, Color::Primer::Dark::accentFg},
-                {u"TransferList.StalledUploading"_qs, Color::Primer::Dark::accentEmphasis},
-                {u"TransferList.ForcedUploading"_qs, Color::Primer::Dark::accentFg},
-                {u"TransferList.QueuedDownloading"_qs, Color::Primer::Dark::scaleYellow6},
-                {u"TransferList.QueuedUploading"_qs, Color::Primer::Dark::scaleYellow6},
-                {u"TransferList.CheckingDownloading"_qs, Color::Primer::Dark::successFg},
-                {u"TransferList.CheckingUploading"_qs, Color::Primer::Dark::successFg},
-                {u"TransferList.CheckingResumeData"_qs, Color::Primer::Dark::successFg},
-                {u"TransferList.PausedDownloading"_qs, Color::Primer::Dark::fgMuted},
-                {u"TransferList.PausedUploading"_qs, Color::Primer::Dark::doneFg},
-                {u"TransferList.Moving"_qs, Color::Primer::Dark::successFg},
-                {u"TransferList.MissingFiles"_qs, Color::Primer::Dark::dangerFg},
-                {u"TransferList.Error"_qs, Color::Primer::Dark::dangerFg}
-            };
-
-            const QByteArray configData = readFile(m_userPath / Path(CONFIG_FILE_NAME));
-            if (configData.isEmpty())
-                return;
-
-            const QJsonObject config = parseThemeConfig(configData);
-
-            auto colorOverrides = colorsFromJSON(config.value(u"colors").toObject());
-            // Overriding Palette colors is not allowed in the default theme
-            Algorithm::removeIf(colorOverrides, [](const QString &colorId, [[maybe_unused]] const QColor &color)
-            {
-                return colorId.startsWith(u"Palette.");
-            });
-            m_colors.insert(colorOverrides);
-
-            auto darkModeColorOverrides = colorsFromJSON(config.value(u"colors.dark").toObject());
-            // Overriding Palette colors is not allowed in the default theme
-            Algorithm::removeIf(darkModeColorOverrides, [](const QString &colorId, [[maybe_unused]] const QColor &color)
-            {
-                return colorId.startsWith(u"Palette.");
-            });
-            m_darkModeColors.insert(darkModeColorOverrides);
-        }
-
-        const Path m_defaultPath {u":"_qs};
-        const Path m_userPath = specialFolderLocation(SpecialFolder::Config) / Path(u"themes/default"_qs);
-        QHash<QString, QColor> m_colors;
-        QHash<QString, QColor> m_darkModeColors;
-    };
-
-    class CustomThemeSource : public UIThemeSource
-    {
-    public:
-        QColor getColor(const QString &colorId, const ColorMode colorMode) const override
-        {
-            if (colorMode == ColorMode::Dark)
-            {
-                if (const QColor color = m_darkModeColors.value(colorId)
-                        ; color.isValid())
-                {
-                    return color;
-                }
-            }
-
-            if (const QColor color = m_colors.value(colorId)
-                    ; color.isValid())
-            {
-                return color;
-            }
-
-            return defaultThemeSource()->getColor(colorId, colorMode);
-        }
-
-        Path getIconPath(const QString &iconId, const ColorMode colorMode) const override
-        {
-            const Path iconsPath {u"icons"_qs};
-            const Path darkModeIconsPath = iconsPath / Path(u"dark"_qs);
-
-            if (colorMode == ColorMode::Dark)
-            {
-                if (const Path iconPath = findIcon(iconId, (themeRootPath() / darkModeIconsPath))
-                        ; !iconPath.isEmpty())
-                {
-                    return iconPath;
-                }
-            }
-
-            if (const Path iconPath = findIcon(iconId, (themeRootPath() / iconsPath))
-                    ; !iconPath.isEmpty())
-            {
-                return iconPath;
-            }
-
-            return defaultThemeSource()->getIconPath(iconId, colorMode);
-        }
-
-        QByteArray readStyleSheet() override
-        {
-            return readFile(themeRootPath() / Path(STYLESHEET_FILE_NAME));
-        }
-
-    protected:
-        virtual Path themeRootPath() const = 0;
-
-        DefaultThemeSource *defaultThemeSource() const
-        {
-            return m_defaultThemeSource.get();
-        }
-
-    private:
-        void loadColors()
-        {
-            const QByteArray configData = readFile(themeRootPath() / Path(CONFIG_FILE_NAME));
-            if (configData.isEmpty())
-                return;
-
-            const QJsonObject config = parseThemeConfig(configData);
-
-            m_colors.insert(colorsFromJSON(config.value(u"colors").toObject()));
-            m_darkModeColors.insert(colorsFromJSON(config.value(u"colors.dark").toObject()));
-        }
-
-        const std::unique_ptr<DefaultThemeSource> m_defaultThemeSource = std::make_unique<DefaultThemeSource>();
-        QHash<QString, QColor> m_colors;
-        QHash<QString, QColor> m_darkModeColors;
-    };
-
-    class QRCThemeSource final : public CustomThemeSource
-    {
-    private:
-        Path themeRootPath() const override
-        {
-            return Path(u":/uitheme"_qs);
-        }
-    };
-
-    class FolderThemeSource : public CustomThemeSource
-    {
-    public:
-        explicit FolderThemeSource(const Path &folderPath)
-            : m_folder {folderPath}
-        {
-        }
-
-        QByteArray readStyleSheet() override
-        {
-            // Directory used by stylesheet to reference internal resources
-            // for example `icon: url(:/uitheme/file.svg)` will be expected to
-            // point to a file `file.svg` in root directory of CONFIG_FILE_NAME
-            const QString stylesheetResourcesDir = u":/uitheme"_qs;
-
-            QByteArray styleSheetData = CustomThemeSource::readStyleSheet();
-            return styleSheetData.replace(stylesheetResourcesDir.toUtf8(), themeRootPath().data().toUtf8());
-        }
-
-    private:
-        Path themeRootPath() const override
-        {
-            return m_folder;
-        }
-
-        const Path m_folder;
-    };
 }
 
 UIThemeManager *UIThemeManager::m_instance = nullptr;