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>

6 files changed, 211 insertions, 14 deletions

diff --git a/tests/auto/gui/text/qfont/qfont.pro b/tests/auto/gui/text/qfont/qfont.pro
index 048d952faf..96cd4cfdab 100644
--- a/tests/auto/gui/text/qfont/qfont.pro
+++ b/tests/auto/gui/text/qfont/qfont.pro
@@ -4,3 +4,4 @@ QT += testlib
 QT += core-private gui-private
 qtHaveModule(widgets): QT += widgets
 SOURCES  += tst_qfont.cpp
+RESOURCES += testfont.qrc
diff --git a/tests/auto/gui/text/qfont/testfont.qrc b/tests/auto/gui/text/qfont/testfont.qrc
new file mode 100644
index 0000000000..cf51e4a2b4
--- /dev/null
+++ b/tests/auto/gui/text/qfont/testfont.qrc
@@ -0,0 +1,5 @@
+<RCC>
+    <qresource prefix="/">
+        <file>weirdfont.otf</file>
+    </qresource>
+</RCC>
diff --git a/tests/auto/gui/text/qfont/tst_qfont.cpp b/tests/auto/gui/text/qfont/tst_qfont.cpp
index 8090f38a2c..9acf877790 100644
--- a/tests/auto/gui/text/qfont/tst_qfont.cpp
+++ b/tests/auto/gui/text/qfont/tst_qfont.cpp
@@ -66,6 +66,12 @@ private slots:
     void fromStringWithoutStyleName();
 
     void sharing();
+    void familyNameWithCommaQuote_data();
+    void familyNameWithCommaQuote();
+    void setFamilies_data();
+    void setFamilies();
+    void setFamiliesAndFamily_data();
+    void setFamiliesAndFamily();
 };
 
 // Testing get/set functions
@@ -116,6 +122,14 @@ void tst_QFont::exactMatch()
     QVERIFY(!QFont("sans-serif").exactMatch());
     QVERIFY(!QFont("serif").exactMatch());
     QVERIFY(!QFont("monospace").exactMatch());
+
+    font.setFamilies(QStringList() << "BogusFont");
+    QVERIFY(!font.exactMatch());
+    QVERIFY(!QFont("sans").exactMatch());
+    QVERIFY(!QFont("sans-serif").exactMatch());
+    QVERIFY(!QFont("serif").exactMatch());
+    QVERIFY(!QFont("monospace").exactMatch());
+
 }
 
 void tst_QFont::italicOblique()
@@ -277,6 +291,12 @@ void tst_QFont::resolve()
     QCOMPARE(f4.pointSize(), 45);
     f4 = f4.resolve(f3);
     QCOMPARE(f4.pointSize(), 55);
+
+    QFont font5, font6;
+    const QStringList fontFamilies = { QStringLiteral("Arial") };
+    font5.setFamilies(fontFamilies);
+    font6 = font6.resolve(font5);
+    QCOMPARE(font6.families(), fontFamilies);
 }
 
 #ifndef QT_NO_WIDGETS
@@ -624,5 +644,108 @@ void tst_QFont::sharing()
     QVERIFY(QFontPrivate::get(f2)->engineData != QFontPrivate::get(f)->engineData);
 }
 
+void tst_QFont::familyNameWithCommaQuote_data()
+{
+    QTest::addColumn<QString>("familyName");
+    QTest::addColumn<QString>("chosenFamilyName");
+
+    const QString standardFont(QFont().defaultFamily());
+    if (standardFont.isEmpty())
+        QSKIP("No default font available on the system");
+    const QString weirdFont(QLatin1String("'My, weird'' font name',"));
+    const QString commaSeparated(standardFont + QLatin1String(",Times New Roman"));
+    const QString commaSeparatedWeird(weirdFont + QLatin1String(",") + standardFont);
+    const QString commaSeparatedBogus(QLatin1String("BogusFont,") + standardFont);
+
+    QTest::newRow("standard") << standardFont << standardFont;
+    QTest::newRow("weird") << weirdFont << weirdFont;
+    QTest::newRow("commaSeparated") << commaSeparated << standardFont;
+    QTest::newRow("commaSeparatedWeird") << commaSeparatedWeird << weirdFont;
+    QTest::newRow("commaSeparatedBogus") << commaSeparatedBogus << standardFont;
+}
+
+void tst_QFont::familyNameWithCommaQuote()
+{
+    QFETCH(QString, familyName);
+    QFETCH(QString, chosenFamilyName);
+
+    const int weirdFontId = QFontDatabase::addApplicationFont(":/weirdfont.otf");
+
+    QVERIFY(weirdFontId != -1);
+    QFont f(familyName);
+    QCOMPARE(f.family(), familyName);
+    QCOMPARE(QFontInfo(f).family(), chosenFamilyName);
+
+    QFontDatabase::removeApplicationFont(weirdFontId);
+}
+
+void tst_QFont::setFamilies_data()
+{
+    QTest::addColumn<QStringList>("families");
+    QTest::addColumn<QString>("chosenFamilyName");
+
+    const QString weirdFont(QLatin1String("'My, weird'' font name',"));
+    const QString standardFont(QFont().defaultFamily());
+    if (standardFont.isEmpty())
+        QSKIP("No default font available on the system");
+
+    QTest::newRow("standard") << (QStringList() << standardFont) << standardFont;
+    QTest::newRow("weird") << (QStringList() << weirdFont) << weirdFont;
+    QTest::newRow("standard-weird") << (QStringList() << standardFont << weirdFont) << standardFont;
+    QTest::newRow("weird-standard") << (QStringList() << weirdFont << standardFont) << weirdFont;
+    QTest::newRow("nonexist-weird") << (QStringList() << "NonExistentFont" << weirdFont) << weirdFont;
+}
+
+void tst_QFont::setFamilies()
+{
+    QFETCH(QStringList, families);
+    QFETCH(QString, chosenFamilyName);
+
+    const int weirdFontId = QFontDatabase::addApplicationFont(":/weirdfont.otf");
+
+    QVERIFY(weirdFontId != -1);
+    QFont f;
+    f.setFamilies(families);
+    QCOMPARE(QFontInfo(f).family(), chosenFamilyName);
+
+    QFontDatabase::removeApplicationFont(weirdFontId);
+}
+
+void tst_QFont::setFamiliesAndFamily_data()
+{
+    QTest::addColumn<QStringList>("families");
+    QTest::addColumn<QString>("family");
+    QTest::addColumn<QString>("chosenFamilyName");
+
+    const QString weirdFont(QLatin1String("'My, weird'' font name',"));
+    const QString defaultFont(QFont().defaultFamily());
+    if (defaultFont.isEmpty())
+        QSKIP("No default font available on the system");
+
+    const QString timesFont(QLatin1String("Times"));
+    const QString nonExistFont(QLatin1String("NonExistentFont"));
+
+    QTest::newRow("firstInFamilies") << (QStringList() << defaultFont << timesFont) << weirdFont << defaultFont;
+    QTest::newRow("secondInFamilies") << (QStringList() << nonExistFont << weirdFont) << defaultFont << weirdFont;
+    QTest::newRow("family") << (QStringList() << nonExistFont) << defaultFont << defaultFont;
+}
+
+void tst_QFont::setFamiliesAndFamily()
+{
+    QFETCH(QStringList, families);
+    QFETCH(QString, family);
+    QFETCH(QString, chosenFamilyName);
+
+    const int weirdFontId = QFontDatabase::addApplicationFont(":/weirdfont.otf");
+
+    QVERIFY(weirdFontId != -1);
+    QFont f;
+    f.setFamilies(families);
+    f.setFamily(family);
+    QCOMPARE(QFontInfo(f).family(), chosenFamilyName);
+
+    QFontDatabase::removeApplicationFont(weirdFontId);
+}
+
 QTEST_MAIN(tst_QFont)
 #include "tst_qfont.moc"
diff --git a/tests/auto/gui/text/qfont/weirdfont.otf b/tests/auto/gui/text/qfont/weirdfont.otf
new file mode 100644
index 0000000000..b91c559f5b
--- /dev/null
+++ b/tests/auto/gui/text/qfont/weirdfont.otf
diff --git a/tests/auto/gui/text/qfontcache/tst_qfontcache.cpp b/tests/auto/gui/text/qfontcache/tst_qfontcache.cpp
index fbca313ea3..785cc3fef2 100644
--- a/tests/auto/gui/text/qfontcache/tst_qfontcache.cpp
+++ b/tests/auto/gui/text/qfontcache/tst_qfontcache.cpp
@@ -45,6 +45,8 @@ public:
 private slots:
     void engineData_data();
     void engineData();
+    void engineDataFamilies_data();
+    void engineDataFamilies();
 
     void clear();
 };
@@ -109,6 +111,49 @@ void tst_QFontCache::engineData()
     QCOMPARE(engineData, QFontPrivate::get(f)->engineData);
 }
 
+void tst_QFontCache::engineDataFamilies_data()
+{
+    QTest::addColumn<QStringList>("families");
+
+    const QStringList multiple = { QLatin1String("invalid"), QLatin1String("Times New Roman") };
+    const QStringList multipleQuotes = { QLatin1String("'invalid'"), QLatin1String("Times New Roman") };
+    const QStringList multiple2 = { QLatin1String("invalid"), QLatin1String("Times New Roman"),
+                                    QLatin1String("foobar"), QLatin1String("'baz'") };
+
+    QTest::newRow("unquoted-family-name") << QStringList(QLatin1String("Times New Roman"));
+    QTest::newRow("quoted-family-name") << QStringList(QLatin1String("Times New Roman"));
+    QTest::newRow("invalid") << QStringList(QLatin1String("invalid"));
+    QTest::newRow("multiple") << multiple;
+    QTest::newRow("multiple spaces quotes") << multipleQuotes;
+    QTest::newRow("multiple2") << multiple2;
+}
+
+void tst_QFontCache::engineDataFamilies()
+{
+    QFETCH(QStringList, families);
+
+    QFont f;
+    f.setFamily(QString()); // Unset the family as taken from the QGuiApplication default
+    f.setFamilies(families);
+    f.exactMatch(); // loads engine
+    QFontPrivate *d = QFontPrivate::get(f);
+
+    QFontDef req = d->request;
+    // copy-pasted from QFontDatabase::load(), to engineer the cache key
+    if (req.pixelSize == -1) {
+        req.pixelSize = std::floor(((req.pointSize * d->dpi) / 72) * 100 + 0.5) / 100;
+        req.pixelSize = qRound(req.pixelSize);
+    }
+    if (req.pointSize < 0)
+        req.pointSize = req.pixelSize*72.0/d->dpi;
+
+    req.families = families;
+
+    QFontEngineData *engineData = QFontCache::instance()->findEngineData(req);
+
+    QCOMPARE(engineData, QFontPrivate::get(f)->engineData);
+}
+
 void tst_QFontCache::clear()
 {
 #ifdef QT_BUILD_INTERNAL
diff --git a/tests/auto/gui/text/qtextdocumentfragment/tst_qtextdocumentfragment.cpp b/tests/auto/gui/text/qtextdocumentfragment/tst_qtextdocumentfragment.cpp
index 3e354b7523..08f7cf4fb2 100644
--- a/tests/auto/gui/text/qtextdocumentfragment/tst_qtextdocumentfragment.cpp
+++ b/tests/auto/gui/text/qtextdocumentfragment/tst_qtextdocumentfragment.cpp
@@ -159,6 +159,7 @@ private slots:
     void nonZeroMarginOnImport();
     void html_charFormatPropertiesUnset();
     void html_headings();
+    void html_quotedFontFamily_data();
     void html_quotedFontFamily();
     void html_spanBackgroundColor();
     void defaultFont();
@@ -2184,23 +2185,45 @@ void tst_QTextDocumentFragment::html_headings()
     QCOMPARE(doc->blockCount(), 2);
 }
 
-void tst_QTextDocumentFragment::html_quotedFontFamily()
+void tst_QTextDocumentFragment::html_quotedFontFamily_data()
 {
-    setHtml("<div style=\"font-family: 'Foo Bar';\">Test</div>");
-    QCOMPARE(doc->begin().begin().fragment().charFormat().fontFamily(), QString("Foo Bar"));
-
-    setHtml("<div style='font-family: \"Foo Bar\";'>Test</div>");
-    QCOMPARE(doc->begin().begin().fragment().charFormat().fontFamily(), QString("Foo Bar"));
-
-    setHtml("<div style='font-family: \"Foo  Bar\";'>Test</div>");
-    QCOMPARE(doc->begin().begin().fragment().charFormat().fontFamily(), QString("Foo  Bar"));
-
-    setHtml("<div style='font-family: Foo\n  Bar;'>Test</div>");
-    QCOMPARE(doc->begin().begin().fragment().charFormat().fontFamily(), QString("Foo Bar"));
+    QTest::addColumn<QString>("html");
+    QTest::addColumn<QString>("fontFamily");
+    QTest::addColumn<QStringList>("fontFamilies");
+
+    const QString fooFamily = QLatin1String("Foo Bar");
+    const QString weirdFamily = QLatin1String("'Weird, & font '' name',");
+
+    QTest::newRow("data1") << QString("<div style=\"font-family: 'Foo Bar';\">Test</div>")
+                           << fooFamily << QStringList(fooFamily);
+    QTest::newRow("data2") << QString("<div style='font-family: \"Foo  Bar\";'>Test</div>")
+                           << QString("Foo  Bar") << QStringList("Foo  Bar");
+    QTest::newRow("data3") << QString("<div style='font-family: Foo\n  Bar;'>Test</div>")
+                           << fooFamily << QStringList(fooFamily);
+    QTest::newRow("data4") << QString("<div style='font-family: Foo\n  Bar, serif, \"bar foo\";'>Test"
+                                      "</div>")
+                           << fooFamily << (QStringList() << "Foo Bar" << "serif" << "bar foo");
+    QTest::newRow("data5") << QString("<div style='font-family: \"\\'Weird, & font \\'\\' name\\',"
+                                      "\";'>Test</div>")
+                           << weirdFamily << QStringList(weirdFamily);
+    QTest::newRow("data6") << QString("<div style='font-family: \"\\'Weird, & font \\'\\' name\\',"
+                                      "\";'>Test</div>")
+                           << weirdFamily << QStringList(weirdFamily);
+    QTest::newRow("data7") << QString("<div style='font-family: \"\\'Weird, & font \\'\\' name\\',\", "
+                                      "serif, \"bar foo\";'>Test</div>")
+                            << weirdFamily
+                            << (QStringList() << weirdFamily << "serif" << "bar foo");
+}
 
-    setHtml("<div style='font-family: Foo\n  Bar, serif, \"bar foo\";'>Test</div>");
-    QCOMPARE(doc->begin().begin().fragment().charFormat().fontFamily(), QString("Foo Bar,serif,bar foo"));
+void tst_QTextDocumentFragment::html_quotedFontFamily()
+{
+    QFETCH(QString, html);
+    QFETCH(QString, fontFamily);
+    QFETCH(QStringList, fontFamilies);
 
+    setHtml(html);
+    QCOMPARE(doc->begin().begin().fragment().charFormat().fontFamily(), fontFamily);
+    QCOMPARE(doc->begin().begin().fragment().charFormat().font().families(), fontFamilies);
 }
 
 void tst_QTextDocumentFragment::defaultFont()