QFont: Prefer setFamilies() over setFamily()

By depending on setFamilies() then we can be sure that font names with
spaces, commas, quotes and so on are correctly handled without being
misinterpreted. For now it will split on the comma when a string
containing one is passed to setFamily. But from Qt 6.2 this will be
removed to preserve the family string as a convenience function.

[ChangeLog][QtGui][QFont] Indicated that setFamilies/families is
preferred over setFamily/family to ensure that font family names are
preserved when spaces, commas and so on are used in the name.

Change-Id: Id3c1a4e827756a4c928fed461a4aafa5a0f06633
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>

5 files changed, 27 insertions, 23 deletions

diff --git a/src/gui/text/windows/qwindowsdirectwritefontdatabase.cpp b/src/gui/text/windows/qwindowsdirectwritefontdatabase.cpp
index c0d9e820c6..7a4ce0930a 100644
--- a/src/gui/text/windows/qwindowsdirectwritefontdatabase.cpp
+++ b/src/gui/text/windows/qwindowsdirectwritefontdatabase.cpp
@@ -414,8 +414,8 @@ void QWindowsDirectWriteFontDatabase::populateFontDatabase()
     bool hasDefaultLocale = GetUserDefaultLocaleName(defaultLocale, LOCALE_NAME_MAX_LENGTH) != 0;
     wchar_t englishLocale[] = L"en-us";
 
-    QString defaultFontName = defaultFont().family();
-    QString systemDefaultFontName = systemDefaultFont().family();
+    const QString defaultFontName = defaultFont().families().first();
+    const QString systemDefaultFontName = systemDefaultFont().families().first();
 
     IDWriteFontCollection *fontCollection;
     if (SUCCEEDED(data()->directWriteFactory->GetSystemFontCollection(&fontCollection))) {
diff --git a/src/gui/text/windows/qwindowsfontdatabase.cpp b/src/gui/text/windows/qwindowsfontdatabase.cpp
index 79ea08f9b6..381bcea0b3 100644
--- a/src/gui/text/windows/qwindowsfontdatabase.cpp
+++ b/src/gui/text/windows/qwindowsfontdatabase.cpp
@@ -162,7 +162,7 @@ QDebug operator<<(QDebug d, const QFontDef &def)
     QDebugStateSaver saver(d);
     d.nospace();
     d.noquote();
-    d << "QFontDef(Family=\"" << def.family << '"';
+    d << "QFontDef(Family=\"" << def.families.first() << '"';
     if (!def.styleName.isEmpty())
         d << ", stylename=" << def.styleName;
     d << ", pointsize=" << def.pointSize << ", pixelsize=" << def.pixelSize
@@ -628,6 +628,8 @@ static int QT_WIN_CALLBACK storeFont(const LOGFONT *logFont, const TEXTMETRIC *t
 {
     const ENUMLOGFONTEX *f = reinterpret_cast<const ENUMLOGFONTEX *>(logFont);
     const QString familyName = QString::fromWCharArray(f->elfLogFont.lfFaceName);
+    if (familyName == QLatin1String("Lucida Calligraphy"))
+        qDebug("BP");
     const QString styleName = QString::fromWCharArray(f->elfStyle);
 
     // NEWTEXTMETRICEX (passed for TT fonts) is a NEWTEXTMETRIC, which according
@@ -730,7 +732,7 @@ void QWindowsFontDatabase::populateFontDatabase()
     EnumFontFamiliesEx(dummy, &lf, populateFontFamilies, 0, 0);
     ReleaseDC(0, dummy);
     // Work around EnumFontFamiliesEx() not listing the system font.
-    QString systemDefaultFamily = QWindowsFontDatabase::systemDefaultFont().family();
+    const QString systemDefaultFamily = QWindowsFontDatabase::systemDefaultFont().families().first();
     if (QPlatformFontDatabase::resolveFontFamilyAlias(systemDefaultFamily) == systemDefaultFamily)
         QPlatformFontDatabase::registerFontFamily(systemDefaultFamily);
     addDefaultEUDCFont();
@@ -807,7 +809,7 @@ QT_WARNING_POP
             qWarning("%s: AddFontMemResourceEx failed", __FUNCTION__);
         } else {
             QFontDef request;
-            request.family = uniqueFamilyName;
+            request.families = QStringList(uniqueFamilyName);
             request.pixelSize = pixelSize;
             request.styleStrategy = QFont::PreferMatch;
             request.hintingPreference = hintingPreference;
@@ -818,9 +820,9 @@ QT_WARNING_POP
                                                             data());
 
             if (fontEngine) {
-                if (request.family != fontEngine->fontDef.family) {
-                    qWarning("%s: Failed to load font. Got fallback instead: %s",
-                             __FUNCTION__, qPrintable(fontEngine->fontDef.family));
+                if (request.families != fontEngine->fontDef.families) {
+                    qWarning("%s: Failed to load font. Got fallback instead: %s", __FUNCTION__,
+                             qPrintable(fontEngine->fontDef.families.first()));
                     if (fontEngine->ref.loadRelaxed() == 0)
                         delete fontEngine;
                     fontEngine = 0;
@@ -831,12 +833,12 @@ QT_WARNING_POP
                     switch (fontEngine->type()) {
                     case QFontEngine::Win:
                         static_cast<QWindowsFontEngine *>(fontEngine)->setUniqueFamilyName(uniqueFamilyName);
-                        fontEngine->fontDef.family = actualFontName;
+                        fontEngine->fontDef.families = QStringList(actualFontName);
                         break;
 #if QT_CONFIG(directwrite) && QT_CONFIG(direct2d)
                     case QFontEngine::DirectWrite:
                         static_cast<QWindowsFontEngineDirectWrite *>(fontEngine)->setUniqueFamilyName(uniqueFamilyName);
-                        fontEngine->fontDef.family = actualFontName;
+                        fontEngine->fontDef.families = QStringList(actualFontName);
                         break;
 #endif // directwrite && direct2d
 
@@ -1197,9 +1199,11 @@ QFontEngine *QWindowsFontDatabase::createEngine(const QFontDef &request, const Q
                 }
 #endif // direct2d
                 useDw = useDw || useDirectWrite(hintingPreference, fam, isColorFont);
-                qCDebug(lcQpaFonts) << __FUNCTION__ << request.family << request.pointSize
-                    << "pt" << "hintingPreference=" << hintingPreference << "color=" << isColorFont
-                    << dpi << "dpi" << "useDirectWrite=" << useDw;
+                qCDebug(lcQpaFonts)
+                        << __FUNCTION__ << request.families.first() << request.pointSize << "pt"
+                        << "hintingPreference=" << hintingPreference << "color=" << isColorFont
+                        << dpi << "dpi"
+                        << "useDirectWrite=" << useDw;
                 if (useDw) {
                     QWindowsFontEngineDirectWrite *fedw = new QWindowsFontEngineDirectWrite(directWriteFontFace,
                                                                                             request.pixelSize,
@@ -1209,7 +1213,7 @@ QFontEngine *QWindowsFontDatabase::createEngine(const QFontDef &request, const Q
                     GetTextFace(data->hdc, 64, n);
 
                     QFontDef fontDef = request;
-                    fontDef.family = QString::fromWCharArray(n);
+                    fontDef.families = QStringList(QString::fromWCharArray(n));
 
                     if (isColorFont)
                         fedw->glyphFormat = QFontEngine::Format_ARGB;
@@ -1230,7 +1234,7 @@ QFontEngine *QWindowsFontDatabase::createEngine(const QFontDef &request, const Q
 #endif // directwrite direct2d
 
     if (!fe) {
-        QWindowsFontEngine *few = new QWindowsFontEngine(request.family, lf, data);
+        QWindowsFontEngine *few = new QWindowsFontEngine(request.families.first(), lf, data);
         if (preferClearTypeAA)
             few->glyphFormat = QFontEngine::Format_A32;
         few->initFontInfo(request, dpi);
diff --git a/src/gui/text/windows/qwindowsfontdatabase_ft.cpp b/src/gui/text/windows/qwindowsfontdatabase_ft.cpp
index d047532c3c..e2c8d3455d 100644
--- a/src/gui/text/windows/qwindowsfontdatabase_ft.cpp
+++ b/src/gui/text/windows/qwindowsfontdatabase_ft.cpp
@@ -398,7 +398,7 @@ void QWindowsFontDatabaseFT::populateFontDatabase()
     EnumFontFamiliesEx(dummy, &lf, populateFontFamilies, 0, 0);
     ReleaseDC(0, dummy);
     // Work around EnumFontFamiliesEx() not listing the system font
-    QString systemDefaultFamily = QWindowsFontDatabase::systemDefaultFont().family();
+    const QString systemDefaultFamily = QWindowsFontDatabase::systemDefaultFont().families().first();
     if (QPlatformFontDatabase::resolveFontFamilyAlias(systemDefaultFamily) == systemDefaultFamily)
         QPlatformFontDatabase::registerFontFamily(systemDefaultFamily);
 }
@@ -406,7 +406,7 @@ void QWindowsFontDatabaseFT::populateFontDatabase()
 QFontEngine * QWindowsFontDatabaseFT::fontEngine(const QFontDef &fontDef, void *handle)
 {
     QFontEngine *fe = QFreeTypeFontDatabase::fontEngine(fontDef, handle);
-    qCDebug(lcQpaFonts) << __FUNCTION__ << "FONTDEF" << fontDef.family << fe << handle;
+    qCDebug(lcQpaFonts) << __FUNCTION__ << "FONTDEF" << fontDef.families.first() << fe << handle;
     return fe;
 }
 
diff --git a/src/gui/text/windows/qwindowsfontdatabasebase.cpp b/src/gui/text/windows/qwindowsfontdatabasebase.cpp
index b84fe20c93..279f696bbd 100644
--- a/src/gui/text/windows/qwindowsfontdatabasebase.cpp
+++ b/src/gui/text/windows/qwindowsfontdatabasebase.cpp
@@ -707,7 +707,7 @@ LOGFONT QWindowsFontDatabaseBase::fontDefToLOGFONT(const QFontDef &request, cons
 
     QString fam = faceName;
     if (fam.isEmpty())
-        fam = request.families.size() > 0 ? request.families.at(0) : request.family;
+        fam = request.families.first();
     if (Q_UNLIKELY(fam.size() >= LF_FACESIZE)) {
         qCritical("%s: Family name '%s' is too long.", __FUNCTION__, qPrintable(fam));
         fam.truncate(LF_FACESIZE - 1);
@@ -833,7 +833,7 @@ QFontEngine *QWindowsFontDatabaseBase::fontEngine(const QByteArray &fontData, qr
     // Get font family from font data
     EmbeddedFont font(fontData);
     font.updateFromOS2Table(fontEngine);
-    fontEngine->fontDef.family = font.familyName();
+    fontEngine->fontDef.families = QStringList(font.familyName());
     fontEngine->fontDef.hintingPreference = hintingPreference;
 
     directWriteFontFace->Release();
diff --git a/src/gui/text/windows/qwindowsfontengine.cpp b/src/gui/text/windows/qwindowsfontengine.cpp
index a8dba8b1f2..3335fcdc99 100644
--- a/src/gui/text/windows/qwindowsfontengine.cpp
+++ b/src/gui/text/windows/qwindowsfontengine.cpp
@@ -1145,9 +1145,9 @@ QImage QWindowsFontEngine::alphaRGBMapForGlyph(glyph_t glyph, QFixed, const QTra
 QFontEngine *QWindowsFontEngine::cloneWithSize(qreal pixelSize) const
 {
     QFontDef request = fontDef;
-    QString actualFontName = request.family;
+    QString actualFontName = request.families.first();
     if (!uniqueFamilyName.isEmpty())
-        request.family = uniqueFamilyName;
+        request.families = QStringList(uniqueFamilyName);
     request.pixelSize = pixelSize;
     const QString faceName = QString::fromWCharArray(m_logfont.lfFaceName);
 
@@ -1156,7 +1156,7 @@ QFontEngine *QWindowsFontEngine::cloneWithSize(qreal pixelSize) const
                                            QWindowsFontDatabase::defaultVerticalDPI(),
                                            m_fontEngineData);
     if (fontEngine) {
-        fontEngine->fontDef.family = actualFontName;
+        fontEngine->fontDef.families = QStringList(actualFontName);
         if (!uniqueFamilyName.isEmpty()) {
             static_cast<QWindowsFontEngine *>(fontEngine)->setUniqueFamilyName(uniqueFamilyName);
             if (QPlatformIntegration *pi = QGuiApplicationPrivate::platformIntegration()) {
@@ -1181,7 +1181,7 @@ void QWindowsFontEngine::initFontInfo(const QFontDef &request,
     SelectObject(dc, hfont);
     wchar_t n[64];
     GetTextFace(dc, 64, n);
-    fontDef.family = QString::fromWCharArray(n);
+    fontDef.families = QStringList(QString::fromWCharArray(n));
     fontDef.fixedPitch = !(tm.tmPitchAndFamily & TMPF_FIXED_PITCH);
     if (fontDef.pointSize < 0) {
         fontDef.pointSize = fontDef.pixelSize * 72. / dpi;