/*
Copyright 2006-2026 The QElectroTech Team
This file is part of QElectroTech.
QElectroTech is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
QElectroTech is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with QElectroTech. If not, see .
*/
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include "inkcontrast.h"
#include "qeticons.h"
#include "qetpalette.h"
#include "qetstyle.h"
/**
Checks on QET's two icon themes, "qet" and "qet-dark", generated by
misc/make_icon_themes.py into ico/icon-themes.qrc, and on the icon
table that uses them.
Every icon name must resolve in both themes. The dark theme's files
must read on the dark palette, and an icon drawn as a light object
(a page sheet, the PDF import icon of GitHub #919) must come through
the dark theme untouched rather than inverted into a black page.
QET's own vector icons must serve every size in both themes. A
toolbar button painted with Fusion must show its icon at 3:1 (WCAG
1.4.11) in both themes, with the disabled state reading weaker than
the enabled one, which is what was reversed on macOS before (GitHub
#466, #870). And the icons the elements panel draws in its 50 px
slots must stay small.
*/
class tst_qeticons : public QObject
{
Q_OBJECT
private slots:
void initTestCase();
void everyIconResolvesInBothThemes();
void darkThemeFilesReadOnDarkPalette();
void lightIconsStayLightInDarkTheme();
void scalableIconsServeEverySize();
void breezeIconsAreSharpAtEverySize();
void tracedIconsKeepTheirPixels();
void toolbarIconIsReadable_data();
void toolbarIconIsReadable();
void hoverChangesTheIcon_data();
void hoverChangesTheIcon();
void hoverInkReadsWithAnyAccent_data();
void hoverInkReadsWithAnyAccent();
void coloredIconKeepsItsColorsOnHover();
void menuIconReadsOnHighlight_data();
void menuIconReadsOnHighlight();
void panelProjectIconStaysSmall();
void configPageIconsComeAtPageSize();
};
namespace {
const double kIconRatio = 3.0;
QStringList iconNames(const QString &theme)
{
QStringList names;
for (const QString &size : {"16x16", "22x22", "24x24", "32x32", "48x48", "64x64", "128x128", "scalable"})
{
QDir dir(QString(":/ico/themes/%1/%2").arg(theme, size));
for (const QString &file : dir.entryList(QDir::Files))
names << file.section('.', 0, -2);
}
names.removeDuplicates();
names.sort();
return names;
}
/**
Mean color of the visible pixels: what the icon reads as, taken
as a whole, on the background behind it. A page-shaped icon whose
white body was inverted keeps a light border, so the lightest
pixel would pass it; the mean does not.
*/
QColor meanVisibleColor(const QImage &image)
{
qint64 r = 0, g = 0, b = 0, n = 0;
for (int y = 0; y < image.height(); ++y)
for (int x = 0; x < image.width(); ++x)
{
const QColor c = image.pixelColor(x, y);
if (c.alpha() <= 64) continue;
r += c.red(); g += c.green(); b += c.blue(); ++n;
}
return n ? QColor(r / n, g / n, b / n) : QColor();
}
/**
Mean color of the ink: the visible pixels that are not saturated,
as misc/make_icon_themes.py tells ink from color. A traced icon
is a little ink beside a red or blue part that keeps its color in
both themes, so the mean of the whole icon says nothing about the
ink. An icon without ink gives the mean of all its pixels.
*/
QColor meanInkColor(const QImage &image)
{
qint64 r = 0, g = 0, b = 0, n = 0;
for (int y = 0; y < image.height(); ++y)
for (int x = 0; x < image.width(); ++x)
{
const QColor c = image.pixelColor(x, y);
if (c.alpha() <= 64) continue;
if (c.hslSaturationF() > 0.25 && qMax(c.red(), qMax(c.green(), c.blue())) > 60) continue;
r += c.red(); g += c.green(); b += c.blue(); ++n;
}
return n ? QColor(r / n, g / n, b / n) : meanVisibleColor(image);
}
/**
Line art is drawn in the text color: an element of Breeze's
ColorScheme-Text class, or currentColor in a file without Breeze's
stylesheet. Mirrors dark_svg() in misc/make_icon_themes.py.
*/
bool isColoredSvg(const QByteArray &svg)
{
static const QRegularExpression text_class(R"re(class="[^"]*\bColorScheme-(?:Text|ButtonText)\b)re");
return svg.contains("ColorScheme-")
? !text_class.match(QString::fromUtf8(svg)).hasMatch()
: !svg.contains("currentColor");
}
/**
True when the dark theme's SVG for name in folder is what
misc/make_icon_themes.py should write: a recolored copy of line
art, none for colored art, or, when another size of the icon is
line art, the colored file unchanged (Qt does not fall back to the
light theme for a name the dark theme holds).
*/
bool darkCopyFits(const QString &folder, const QString &name)
{
QFile light(QString(":/ico/themes/qet/%1/%2.svg").arg(folder, name));
QFile dark(QString(":/ico/themes/qet-dark/%1/%2.svg").arg(folder, name));
if (!light.open(QIODevice::ReadOnly))
return false;
const QByteArray svg = light.readAll();
if (!isColoredSvg(svg))
return dark.open(QIODevice::ReadOnly) && dark.readAll() != svg;
return !dark.open(QIODevice::ReadOnly) || dark.readAll() == svg;
}
const QStringList kSizes = {"16x16", "22x22", "24x24", "32x32", "48x48", "64x64", "128x128"};
/// Icons traced from QET's PNG art: the only ones with a file in the 24 pixel folder.
QStringList tracedIconFiles()
{
return QDir(":/ico/themes/qet/24x24").entryList({"*.svg"}, QDir::Files);
}
/// palette with the given selection colors, as QET::Palette::withPlatformAccent leaves them.
QPalette withAccent(QPalette palette, const QColor &highlight, const QColor &highlighted_text)
{
for (QPalette::ColorGroup group : {QPalette::Active, QPalette::Inactive})
{
palette.setColor(group, QPalette::Highlight, highlight);
palette.setColor(group, QPalette::HighlightedText, highlighted_text);
}
return palette;
}
}
void tst_qeticons::initTestCase()
{
QStringList paths = QIcon::themeSearchPaths();
paths.prepend(QStringLiteral(":/ico/themes"));
QIcon::setThemeSearchPaths(paths);
QIcon::setThemeName(QStringLiteral("qet"));
QVERIFY2(!iconNames("qet").isEmpty(), "light theme has no icons: is ico/icon-themes.qrc compiled in?");
}
void tst_qeticons::everyIconResolvesInBothThemes()
{
const QStringList names = iconNames("qet");
for (const QString &theme : {"qet", "qet-dark"})
{
QIcon::setThemeName(theme);
QVERIFY(QIcon::hasThemeIcon("list-add"));
for (const QString &name : names)
QVERIFY2(!QIcon::fromTheme(name).isNull(),
qPrintable(QString("%1 missing in theme %2").arg(name, theme)));
}
// Names the icon table relies on that come from the alias list in
// misc/make_icon_themes.py, not from a file of that name at 22 pixels.
QIcon::setThemeName("qet");
for (const QString &name : {"folio-new", "folio-delete", "folio-properties", "conductor-reset"})
QVERIFY2(!QIcon::fromTheme(name).pixmap(22).isNull(), qPrintable(name));
}
/**
The ink of every file the generator put in the dark theme must reach
3:1 against the dark palette's window color. Inverted
line art passes by a wide margin; an inverted light object (a white
page turned black) sits below 2:1 and fails, which is the defect
misc/make_icon_themes.py now avoids by leaving such icons to the
light theme.
*/
void tst_qeticons::darkThemeFilesReadOnDarkPalette()
{
const QColor window = QET::Palette::fusionDark().color(QPalette::Active, QPalette::Window);
int checked = 0;
for (const QString &size : kSizes + QStringList{"scalable"})
{
QDir dir(QString(":/ico/themes/qet-dark/%1").arg(size));
const int px = size == "scalable" ? 24 : size.section('x', 0, 0).toInt();
for (const QString &file : dir.entryList({"*.png", "*.svg"}, QDir::Files))
{
const QImage dark = QIcon(dir.filePath(file)).pixmap(px).toImage();
QVERIFY2(!dark.isNull(), qPrintable(file));
const QColor mean = meanInkColor(dark);
QVERIFY2(mean.isValid(), qPrintable(file));
const double contrast = QET::Palette::contrastRatio(mean, window);
QVERIFY2(contrast >= kIconRatio,
qPrintable(QString("%1/%2 reads %3:1 on the dark window").arg(size, file).arg(contrast)));
++checked;
}
}
QVERIFY(checked > 100);
}
/**
Icons drawn as a light object are not in the dark theme; the theme
inherits them from "qet". Asking the dark theme for them must return
the light art, not a dark page (GitHub #919, the PDF import icon).
*/
void tst_qeticons::lightIconsStayLightInDarkTheme()
{
const QColor window = QET::Palette::fusionDark().color(QPalette::Active, QPalette::Window);
QIcon::setThemeName(QStringLiteral("qet-dark"));
// The folio family is an SVG from 22 px up; their 16 px files are
// still the light page art, as is the background swatch at 22 px.
const QList> icons = {
{"diagram", 16}, {"label", 16}, {"folio-new", 16}, {"folio-delete", 16},
{"folio-properties", 16}, {"diagram_bg", 22}};
for (const auto &[name, size] : icons)
{
QVERIFY2(!QFile::exists(QString(":/ico/themes/qet-dark/%1x%1/%2.png").arg(size).arg(name)),
qPrintable(QString("%1 has a dark copy; the generator inverted a light icon").arg(name)));
const QImage image = QIcon::fromTheme(name).pixmap(size).toImage();
QVERIFY2(!image.isNull(), qPrintable(name));
const QColor mean = meanVisibleColor(image);
QVERIFY2(mean.lightnessF() > 0.6,
qPrintable(QString("%1 comes out dark in the dark theme (lightness %2)")
.arg(name).arg(mean.lightnessF())));
QVERIFY2(QET::Palette::contrastRatio(mean, window) >= kIconRatio, qPrintable(name));
}
}
/**
QET's own vector icons live in ico/scalable/, the Breeze ones in
ico/breeze/: one file for every size from the toolbar up. Line art
has a recolored copy in the dark theme; colored art has none and is
inherited. Each must resolve in both themes at 22, 24, 32 and 64 px,
line art in dark ink on the light theme and light ink on the dark
one, with no 22, 32 or 48 px PNG left beside it. Fusion's
toolbar slot is 24 px, so the files are drawn on a 24 px canvas and
their one pixel lines land on whole pixels there. A Breeze icon with
16 px art has it in the 16x16 folder, with no 16 px PNG beside it.
*/
void tst_qeticons::scalableIconsServeEverySize()
{
const QDir scalable(":/ico/themes/qet/scalable");
QStringList names;
for (const QString &file : scalable.entryList({"*.svg"}, QDir::Files))
names << file.section('.', 0, -2);
for (const QString &name : {"pdf-import", "folio-new", "folio-delete", "folio-properties", "diagram", "label"})
QVERIFY2(names.contains(name), qPrintable(name + " is not in the scalable folder"));
const QByteArray dump = qgetenv("QET_TEST_DUMP_DIR");
for (const QString &name : names)
{
// Colored art has no text color to change; the dark theme inherits
// it, as it does a colored PNG.
QFile light(QString(":/ico/themes/qet/scalable/%1.svg").arg(name));
QVERIFY(light.open(QIODevice::ReadOnly));
const bool colored = isColoredSvg(light.readAll());
const bool traced = tracedIconFiles().contains(name + ".svg");
QHash light_image;
QVERIFY2(darkCopyFits("scalable", name), qPrintable(name));
for (const QString &size : {"22x22", "32x32", "48x48"})
QVERIFY2(!QFile::exists(QString(":/ico/themes/qet/%1/%2.png").arg(size, name)),
qPrintable(QString("%1 still has a %2 PNG that hides the SVG").arg(name, size)));
QList sizes = {22, 24, 32, 64};
if (QFile::exists(QString(":/ico/themes/qet/16x16/%1.svg").arg(name)))
{
QVERIFY2(!QFile::exists(QString(":/ico/themes/qet/16x16/%1.png").arg(name)),
qPrintable(QString("%1 has both a 16 px SVG and a 16 px PNG").arg(name)));
QVERIFY2(darkCopyFits("16x16", name), qPrintable(name));
sizes.prepend(16);
}
for (const QString &theme : {"qet", "qet-dark"})
{
QIcon::setThemeName(theme);
const QIcon icon = QIcon::fromTheme(name);
QVERIFY2(!icon.isNull(), qPrintable(name));
for (int size : sizes)
{
const QPixmap pixmap = icon.pixmap(size);
QCOMPARE(pixmap.width(), size);
if (!dump.isEmpty())
pixmap.save(QString("%1/%2-%3-%4.png").arg(QString::fromLocal8Bit(dump), name, theme).arg(size));
const QColor mean = traced ? meanInkColor(pixmap.toImage()) : meanVisibleColor(pixmap.toImage());
QVERIFY2(mean.isValid(), qPrintable(QString("%1 in %2 at %3 px is empty").arg(name, theme).arg(size)));
if (colored)
continue;
// A traced icon keeps its light fills and its colors; only
// its ink changes, so its ink must be lighter than it was.
// The size of an icon that is colored at that size only is
// the light file.
if (traced && theme == "qet")
light_image[size] = pixmap.toImage();
else if (traced && pixmap.toImage() == light_image[size])
continue;
else if (traced)
QVERIFY2(mean.lightnessF() > meanInkColor(light_image[size]).lightnessF(), qPrintable(QString("%1 dark theme at %2 px: ink no lighter than in the light theme").arg(name).arg(size)));
else if (theme == "qet")
QVERIFY2(mean.lightnessF() < 0.5, qPrintable(QString("%1 light theme at %2 px: lightness %3").arg(name).arg(size).arg(mean.lightnessF())));
else
QVERIFY2(mean.lightnessF() > 0.6, qPrintable(QString("%1 dark theme at %2 px: lightness %3").arg(name).arg(size).arg(mean.lightnessF())));
}
}
}
}
/**
Qt draws an SVG at the size asked for, so art drawn on a 16 pixel grid
blurs at 24 pixels and is sharp at 32. Each size folder of a Breeze
icon (misc/make_icon_themes.py) must hold art whose canvas divides the
folder's size, and Qt must pick that file at that size: the icon's
pixmap must equal the file rendered alone. The same holds on a 2x
screen, for twice the pixels.
*/
void tst_qeticons::breezeIconsAreSharpAtEverySize()
{
const QList> folders = {
{"16x16", 16}, {"22x22", 22}, {"scalable", 24}, {"32x32", 32},
{"48x48", 48}, {"64x64", 64}, {"128x128", 128}};
const QRegularExpression canvas(R"re(