New class: QGlyphs

Introduce an API to access glyph indexes in a font directly.

A bug was discovered during this work, where different hinting flags
in loadGlyph() and loadGlyphMetrics() would make the metrics in
the two functions different, thus causing drawCachedGlyphs()
(which uses loadGlyphMetrics() indirectly) to use different metrics
than the standard drawTextItem() code path (which uses loadGlyph()).
The bug was visible in the tst_QGlyphs::drawExistingGlyphs() test.

Reviewed-by: Simon Hausmann

3 files changed, 436 insertions, 0 deletions

diff --git a/tests/auto/qglyphs/qglyphs.pro b/tests/auto/qglyphs/qglyphs.pro
new file mode 100644
index 0000000..70920f0
--- /dev/null
+++ b/tests/auto/qglyphs/qglyphs.pro
@@ -0,0 +1,5 @@
+load(qttest_p4)
+QT = core gui
+
+SOURCES += \
+    tst_qglyphs.cpp
diff --git a/tests/auto/qglyphs/test.ttf b/tests/auto/qglyphs/test.ttf
new file mode 100644
index 0000000..9043a57
--- /dev/null
+++ b/tests/auto/qglyphs/test.ttf
diff --git a/tests/auto/qglyphs/tst_qglyphs.cpp b/tests/auto/qglyphs/tst_qglyphs.cpp
new file mode 100644
index 0000000..c906f10
--- /dev/null
+++ b/tests/auto/qglyphs/tst_qglyphs.cpp
@@ -0,0 +1,431 @@
+/****************************************************************************
+**
+** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the test suite of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QtTest/QtTest>
+
+#include <qglyphs.h>
+#include <qpainter.h>
+#include <qtextlayout.h>
+#include <qfontdatabase.h>
+
+//#define DEBUG_SAVE_IMAGE
+
+class tst_QGlyphs: public QObject
+{
+    Q_OBJECT
+
+private slots:
+    void initTestCase();
+    void cleanupTestCase();
+
+    void constructionAndDestruction();
+    void copyConstructor();
+    void assignment();
+    void equalsOperator_data();
+    void equalsOperator();
+    void textLayoutGlyphIndexes();
+    void drawExistingGlyphs();
+    void drawNonExistentGlyphs();
+    void drawMultiScriptText1();
+    void drawMultiScriptText2();
+    void detach();
+
+private:
+    int m_testFontId;
+    QFont m_testFont;
+};
+
+Q_DECLARE_METATYPE(QGlyphs);
+
+void tst_QGlyphs::initTestCase()
+{
+    m_testFontId = QFontDatabase::addApplicationFont("test.ttf");
+    QVERIFY(m_testFontId >= 0);
+
+    m_testFont = QFont("QtsSpecialTestFont");
+
+    QCOMPARE(QFontInfo(m_testFont).family(), QString::fromLatin1("QtsSpecialTestFont"));
+}
+
+void tst_QGlyphs::cleanupTestCase()
+{
+    QFontDatabase::removeApplicationFont(m_testFontId);
+}
+
+void tst_QGlyphs::constructionAndDestruction()
+{
+    QGlyphs glyphIndexes;
+}
+
+static QGlyphs make_dummy_indexes()
+{
+    QGlyphs glyphs;
+
+    QVector<quint32> glyphIndexes;
+    QVector<QPointF> positions;
+    QFont font;
+    font.setPointSize(18);
+
+    glyphIndexes.append(1);
+    glyphIndexes.append(2);
+    glyphIndexes.append(3);
+
+    positions.append(QPointF(1, 2));
+    positions.append(QPointF(3, 4));
+    positions.append(QPointF(5, 6));
+
+    glyphs.setFont(font);
+    glyphs.setGlyphIndexes(glyphIndexes);
+    glyphs.setPositions(positions);
+
+    return glyphs;
+}
+
+static QGlyphs make_dummy_indexes2()
+{
+    QGlyphs glyphs;
+
+    QVector<quint32> glyphIndexes;
+    QVector<QPointF> positions;
+    QFont font;
+    font.setPointSize(26);
+
+    glyphIndexes.append(4);
+    glyphIndexes.append(5);
+    glyphIndexes.append(6);
+
+    positions.append(QPointF(7, 8));
+    positions.append(QPointF(9, 10));
+    positions.append(QPointF(11, 12));
+
+    glyphs.setFont(font);
+    glyphs.setGlyphIndexes(glyphIndexes);
+    glyphs.setPositions(positions);
+
+    return glyphs;
+}
+
+
+void tst_QGlyphs::copyConstructor()
+{
+    QGlyphs glyphs;
+
+    {
+        QVector<quint32> glyphIndexes;
+        QVector<QPointF> positions;
+        QFont font;
+        font.setPointSize(18);
+
+        glyphIndexes.append(1);
+        glyphIndexes.append(2);
+        glyphIndexes.append(3);
+
+        positions.append(QPointF(1, 2));
+        positions.append(QPointF(3, 4));
+        positions.append(QPointF(5, 6));
+
+        glyphs.setFont(font);
+        glyphs.setGlyphIndexes(glyphIndexes);
+        glyphs.setPositions(positions);
+    }
+
+    QGlyphs otherGlyphs(glyphs);
+    QCOMPARE(otherGlyphs.font(), glyphs.font());
+    QCOMPARE(glyphs.glyphIndexes(), otherGlyphs.glyphIndexes());
+    QCOMPARE(glyphs.positions(), otherGlyphs.positions());
+}
+
+void tst_QGlyphs::assignment()
+{
+    QGlyphs glyphs(make_dummy_indexes());
+
+    QGlyphs otherGlyphs = glyphs;
+    QCOMPARE(otherGlyphs.font(), glyphs.font());
+    QCOMPARE(glyphs.glyphIndexes(), otherGlyphs.glyphIndexes());
+    QCOMPARE(glyphs.positions(), otherGlyphs.positions());
+}
+
+void tst_QGlyphs::equalsOperator_data()
+{
+    QTest::addColumn<QGlyphs>("one");
+    QTest::addColumn<QGlyphs>("two");
+    QTest::addColumn<bool>("equals");
+
+    QGlyphs one(make_dummy_indexes());
+    QGlyphs two(make_dummy_indexes());
+
+    QTest::newRow("Identical") << one << two << true;
+
+    {
+        QGlyphs busted(two);
+
+        QVector<QPointF> positions = busted.positions();
+        positions[2] += QPointF(1, 1);
+        busted.setPositions(positions);
+
+        QTest::newRow("Different positions") << one << busted << false;
+    }
+
+    {
+        QGlyphs busted(two);
+        QFont font = busted.font();
+        font.setPointSize(font.pointSize() * 2);
+        busted.setFont(font);
+
+        QTest::newRow("Different fonts") << one << busted << false;
+    }
+
+    {
+        QGlyphs busted(two);
+
+        QVector<quint32> glyphIndexes = busted.glyphIndexes();
+        glyphIndexes[2] += 1;
+        busted.setGlyphIndexes(glyphIndexes);
+
+        QTest::newRow("Different glyph indexes") << one << busted << false;
+    }
+
+}
+
+void tst_QGlyphs::equalsOperator()
+{
+    QFETCH(QGlyphs, one);
+    QFETCH(QGlyphs, two);
+    QFETCH(bool, equals);
+
+    QCOMPARE(one == two, equals);
+    QCOMPARE(one != two, !equals);
+}
+
+
+void tst_QGlyphs::textLayoutGlyphIndexes()
+{
+    QString s;
+    s.append(QLatin1Char('A'));
+    s.append(QChar(0xe000));
+
+    QTextLayout layout(s);
+    layout.setFont(m_testFont);
+    layout.beginLayout();
+    layout.createLine();
+    layout.endLayout();
+
+    QList<QGlyphs> listOfGlyphs = layout.glyphs();
+    QCOMPARE(listOfGlyphs.size(), 1);
+
+    QGlyphs glyphs = listOfGlyphs.at(0);
+
+    QCOMPARE(glyphs.glyphIndexes().size(), 2);
+    QCOMPARE(glyphs.glyphIndexes().at(0), quint32(2));
+    QCOMPARE(glyphs.glyphIndexes().at(1), quint32(1));
+}
+
+void tst_QGlyphs::drawExistingGlyphs()
+{
+    QImage textLayoutDraw(1000, 1000, QImage::Format_ARGB32);
+    QImage drawGlyphs(1000, 1000, QImage::Format_ARGB32);
+
+    textLayoutDraw.fill(0xffffffff);
+    drawGlyphs.fill(0xffffffff);
+
+    QString s;
+    s.append(QLatin1Char('A'));
+    s.append(QChar(0xe000));
+
+    QTextLayout layout(s);
+    layout.setFont(m_testFont);
+    layout.beginLayout();
+    layout.createLine();
+    layout.endLayout();
+
+    {
+        QPainter p(&textLayoutDraw);
+        layout.draw(&p, QPointF(50, 50));
+    }
+
+    QGlyphs glyphs = layout.glyphs().size() > 0
+                                 ? layout.glyphs().at(0)
+                                 : QGlyphs();
+
+    {
+        QPainter p(&drawGlyphs);
+        p.drawGlyphs(QPointF(50, 50), glyphs);
+    }
+
+#if defined(DEBUG_SAVE_IMAGE)
+    textLayoutDraw.save("drawExistingGlyphs_textLayoutDraw.png");
+    drawGlyphs.save("drawExistingGlyphs_drawGlyphIndexes.png");
+#endif
+
+    QCOMPARE(textLayoutDraw, drawGlyphs);
+}
+
+void tst_QGlyphs::drawNonExistentGlyphs()
+{
+    QVector<quint32> glyphIndexes;
+    glyphIndexes.append(3);
+
+    QVector<QPointF> glyphPositions;
+    glyphPositions.append(QPointF(0, 0));
+
+    QGlyphs glyphs;
+    glyphs.setGlyphIndexes(glyphIndexes);
+    glyphs.setPositions(glyphPositions);
+    glyphs.setFont(m_testFont);
+
+    QImage image(1000, 1000, QImage::Format_ARGB32);
+    image.fill(0);
+
+    QImage imageBefore = image;
+    {
+        QPainter p(&image);
+        p.drawGlyphs(QPointF(50, 50), glyphs);
+    }
+
+#if defined(DEBUG_SAVE_IMAGE)
+    image.save("drawNonExistentGlyphs.png");
+#endif
+
+    QCOMPARE(image, imageBefore); // Should be unchanged
+}
+
+void tst_QGlyphs::drawMultiScriptText1()
+{
+    QString text;
+    text += QChar(0x3131); // Hangul, Kiyeok
+
+    QTextLayout textLayout(text);
+    textLayout.beginLayout();
+    textLayout.createLine();
+    textLayout.endLayout();
+
+    QImage textLayoutDraw(1000, 1000, QImage::Format_ARGB32);
+    textLayoutDraw.fill(0xffffffff);
+
+    QImage drawGlyphs(1000, 1000, QImage::Format_ARGB32);
+    drawGlyphs.fill(0xffffffff);
+
+    QList<QGlyphs> glyphsList = textLayout.glyphs();
+    QCOMPARE(glyphsList.size(), 1);
+
+    {
+        QPainter p(&textLayoutDraw);
+        textLayout.draw(&p, QPointF(50, 50));
+    }
+
+    {
+        QPainter p(&drawGlyphs);
+        foreach (QGlyphs glyphs, glyphsList)
+            p.drawGlyphs(QPointF(50, 50), glyphs);
+    }
+
+#if defined(DEBUG_SAVE_IMAGE)
+    textLayoutDraw.save("drawMultiScriptText1_textLayoutDraw.png");
+    drawGlyphs.save("drawMultiScriptText1_drawGlyphIndexes.png");
+#endif
+
+    QCOMPARE(drawGlyphs, textLayoutDraw);
+}
+
+
+void tst_QGlyphs::drawMultiScriptText2()
+{
+#if defined(Q_WS_MAC)
+    QSKIP("Unstable because of QTBUG-11145", SkipAll);
+#endif
+
+    QString text;
+    text += QChar(0x0621); // Arabic, Hamza
+    text += QChar(0x3131); // Hangul, Kiyeok
+
+    QTextLayout textLayout(text);
+    textLayout.beginLayout();
+    textLayout.createLine();
+    textLayout.endLayout();
+
+    QImage textLayoutDraw(1000, 1000, QImage::Format_ARGB32);
+    textLayoutDraw.fill(0xffffffff);
+
+    QImage drawGlyphs(1000, 1000, QImage::Format_ARGB32);
+    drawGlyphs.fill(0xffffffff);
+
+    QList<QGlyphs> glyphsList = textLayout.glyphs();
+    QCOMPARE(glyphsList.size(), 2);
+
+    {
+        QPainter p(&textLayoutDraw);
+        textLayout.draw(&p, QPointF(50, 50));
+    }
+
+    {
+        QPainter p(&drawGlyphs);
+        foreach (QGlyphs glyphs, glyphsList)
+            p.drawGlyphs(QPointF(50, 50), glyphs);
+    }
+
+#if defined(DEBUG_SAVE_IMAGE)
+    textLayoutDraw.save("drawMultiScriptText2_textLayoutDraw.png");
+    drawGlyphs.save("drawMultiScriptText2_drawGlyphIndexes.png");
+#endif
+
+    QCOMPARE(drawGlyphs, textLayoutDraw);
+}
+
+void tst_QGlyphs::detach()
+{
+    QGlyphs glyphs;
+
+    glyphs.setGlyphIndexes(QVector<quint32>() << 1 << 2 << 3);
+
+    QGlyphs otherGlyphs;
+    otherGlyphs = glyphs;
+
+    QCOMPARE(otherGlyphs.glyphIndexes(), glyphs.glyphIndexes());
+
+    otherGlyphs.setGlyphIndexes(QVector<quint32>() << 4 << 5 << 6);
+
+    QCOMPARE(otherGlyphs.glyphIndexes(), QVector<quint32>() << 4 << 5 << 6);
+    QCOMPARE(glyphs.glyphIndexes(), QVector<quint32>() << 1 << 2 << 3);
+}
+
+QTEST_MAIN(tst_QGlyphs)
+#include "tst_qglyphs.moc"
+