Handle fonts that have commas/quotes in the family name

Since the comma character was originally used as a separator, we
need to extend QFont to have setFamilies() so that we can avoid
joining the family strings together. This enables us to see the
family name as a single string and for multiple family names,
we have families().

Subsequently, this has added functions to QTextCharFormat to
account for multiple font families too. So it is now possible to
set a single one directly with setFontFamily() and multiple ones
with setFontFamilies().

This also bumps up the datastream version to 19 as QFont now
streams the families list as well.

[ChangeLog][QtGui][QFont] Add setFamilies()/families() to aid using of font families with commas and quotes in their name.
[ChangeLog][Important Behavior Changes] QDataStream version bumped up to 19 to account for changes in the serialization of QFont.

Fixes: QTBUG-46322
Change-Id: Iee9f715e47544a7a705c7f36401aba216a7d42b0
Reviewed-by: Lars Knoll <lars.knoll@qt.io>
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>

1 files changed, 66 insertions, 1 deletions

diff --git a/src/gui/text/qfont.cpp b/src/gui/text/qfont.cpp
index a23ef95fde..258a9ba675 100644
--- a/src/gui/text/qfont.cpp
+++ b/src/gui/text/qfont.cpp
@@ -116,7 +116,17 @@ bool QFontDef::exactMatch(const QFontDef &other) const
     if (stretch != 0 && other.stretch != 0 && stretch != other.stretch)
         return false;
 
+    if (families.size() != other.families.size())
+        return false;
+
     QString this_family, this_foundry, other_family, other_foundry;
+    for (int i = 0; i < families.size(); ++i) {
+        QFontDatabase::parseFontName(families.at(i), this_foundry, this_family);
+        QFontDatabase::parseFontName(other.families.at(i), other_foundry, other_family);
+        if (this_family != other_family || this_foundry != other_foundry)
+            return false;
+    }
+
     QFontDatabase::parseFontName(family, this_foundry, this_family);
     QFontDatabase::parseFontName(other.family, other_foundry, other_family);
 
@@ -261,6 +271,9 @@ void QFontPrivate::resolve(uint mask, const QFontPrivate *other)
     if (! (mask & QFont::FamilyResolved))
         request.family = other->request.family;
 
+    if (!(mask & QFont::FamiliesResolved))
+        request.families = other->request.families;
+
     if (! (mask & QFont::StyleNameResolved))
         request.styleName = other->request.styleName;
 
@@ -424,7 +437,8 @@ QFontEngineData::~QFontEngineData()
     \target fontmatching
     The font matching algorithm works as follows:
     \list 1
-    \li If the specified font family exists and can be used to represent
+    \li The specified font families (set by setFamilies()) are searched for.
+    \li If not found, then if set the specified font family exists and can be used to represent
         the writing system in use, it will be selected.
     \li If not, a replacement font that supports the writing system is
         selected. The font matching algorithm will try to find the
@@ -506,6 +520,7 @@ QFontEngineData::~QFontEngineData()
     individually and then considered resolved.
 
     \value FamilyResolved
+    \value FamiliesResolved
     \value SizeResolved
     \value StyleHintResolved
     \value StyleStrategyResolved
@@ -1691,6 +1706,7 @@ bool QFont::operator<(const QFont &f) const
     if (r1.stretch != r2.stretch) return r1.stretch < r2.stretch;
     if (r1.styleHint != r2.styleHint) return r1.styleHint < r2.styleHint;
     if (r1.styleStrategy != r2.styleStrategy) return r1.styleStrategy < r2.styleStrategy;
+    if (r1.families != r2.families) return r1.families < r2.families;
     if (r1.family != r2.family) return r1.family < r2.family;
     if (f.d->capital != d->capital) return f.d->capital < d->capital;
 
@@ -2192,6 +2208,48 @@ QString QFont::lastResortFont() const
 }
 #endif
 
+/*!
+    \since 5.13
+
+    Returns the requested font family names, i.e. the names set in the last
+    setFamilies() call or via the constructor. Otherwise it returns an
+    empty list.
+
+    \sa setFamily(), setFamilies(), family(), substitutes(), substitute()
+*/
+
+QStringList QFont::families() const
+{
+    return d->request.families;
+}
+
+/*!
+    \since 5.13
+
+    Sets the list of family names for the font. The names are case
+    insensitive and may include a foundry name. The first family in
+    \a families will be set as the main family for the font.
+
+    Each family name entry in \a families may optionally also include a
+    foundry name, e.g. "Helvetica [Cronyx]". If the family is
+    available from more than one foundry and the foundry isn't
+    specified, an arbitrary foundry is chosen. If the family isn't
+    available a family will be set using the \l{QFont}{font matching}
+    algorithm.
+
+    \sa family(), families(), setFamily(), setStyleHint(), QFontInfo
+*/
+
+void QFont::setFamilies(const QStringList &families)
+{
+    if ((resolve_mask & QFont::FamiliesResolved) && d->request.families == families)
+        return;
+    detach();
+    d->request.families = families;
+    resolve_mask |= QFont::FamiliesResolved;
+}
+
+
 /*****************************************************************************
   QFont stream functions
  *****************************************************************************/
@@ -2256,6 +2314,8 @@ QDataStream &operator<<(QDataStream &s, const QFont &font)
         s << (quint8)font.d->request.hintingPreference;
     if (s.version() >= QDataStream::Qt_5_6)
         s << (quint8)font.d->capital;
+    if (s.version() >= QDataStream::Qt_5_13)
+        s << font.d->request.families;
     return s;
 }
 
@@ -2351,6 +2411,11 @@ QDataStream &operator>>(QDataStream &s, QFont &font)
         s >> value;
         font.d->capital = QFont::Capitalization(value);
     }
+    if (s.version() >= QDataStream::Qt_5_13) {
+        QStringList value;
+        s >> value;
+        font.d->request.families = value;
+    }
     return s;
 }