Add QPdfPageRenderer class

The QPdfPageRenderer renders a page of a QPdfDocument for a given
zoom factor. Depending on its render mode, it does the rendering
in the UI thread or a worker thread. Subsequent requests are queued
and processed in order.

Change-Id: I95820cd318cb443b2572f6d3db5a0bee53939bd1
Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com>

4 files changed, 191 insertions, 1 deletions

diff --git a/tests/auto/pdf/pdf.pro b/tests/auto/pdf/pdf.pro
index 388b8853d..a2b3fcff2 100644
--- a/tests/auto/pdf/pdf.pro
+++ b/tests/auto/pdf/pdf.pro
@@ -2,6 +2,7 @@ TEMPLATE = subdirs
 
 SUBDIRS = \
     qpdfbookmarkmodel \
-    qpdfpagenavigation
+    qpdfpagenavigation \
+    qpdfpagerenderer
 
 qtHaveModule(printsupport): SUBDIRS += qpdfdocument
diff --git a/tests/auto/pdf/qpdfpagerenderer/pdf-sample.pagerenderer.pdf b/tests/auto/pdf/qpdfpagerenderer/pdf-sample.pagerenderer.pdf
new file mode 100644
index 000000000..c4e1aa36e
--- /dev/null
+++ b/tests/auto/pdf/qpdfpagerenderer/pdf-sample.pagerenderer.pdf
diff --git a/tests/auto/pdf/qpdfpagerenderer/qpdfpagerenderer.pro b/tests/auto/pdf/qpdfpagerenderer/qpdfpagerenderer.pro
new file mode 100644
index 000000000..9ccb4e82c
--- /dev/null
+++ b/tests/auto/pdf/qpdfpagerenderer/qpdfpagerenderer.pro
@@ -0,0 +1,5 @@
+CONFIG += testcase
+TARGET = tst_qpdfpagerenderer
+QT += pdf testlib network
+macos:CONFIG -= app_bundle
+SOURCES += tst_qpdfpagerenderer.cpp
diff --git a/tests/auto/pdf/qpdfpagerenderer/tst_qpdfpagerenderer.cpp b/tests/auto/pdf/qpdfpagerenderer/tst_qpdfpagerenderer.cpp
new file mode 100644
index 000000000..8eaef7c6e
--- /dev/null
+++ b/tests/auto/pdf/qpdfpagerenderer/tst_qpdfpagerenderer.cpp
@@ -0,0 +1,184 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Tobias König <tobias.koenig@kdab.com>
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the QtPDF module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later as published by the Free
+** Software Foundation and appearing in the file LICENSE.GPL included in
+** the packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QPdfDocument>
+#include <QPdfPageRenderer>
+
+#include <QtTest/QtTest>
+
+class tst_QPdfPageRenderer: public QObject
+{
+    Q_OBJECT
+
+private slots:
+    void defaultValues();
+    void withNoDocument();
+    void withEmptyDocument();
+    void withLoadedDocumentSingleThreaded();
+    void withLoadedDocumentMultiThreaded();
+    void switchingRenderMode();
+};
+
+void tst_QPdfPageRenderer::defaultValues()
+{
+    QPdfPageRenderer pageRenderer;
+
+    QCOMPARE(pageRenderer.document(), nullptr);
+    QCOMPARE(pageRenderer.renderMode(), QPdfPageRenderer::SingleThreadedRenderMode);
+}
+
+void tst_QPdfPageRenderer::withNoDocument()
+{
+    QPdfPageRenderer pageRenderer;
+
+    const QSize imageSize(100, 100);
+    const quint64 requestId = pageRenderer.requestPage(0, imageSize);
+
+    QCOMPARE(requestId, quint64(0));
+}
+
+void tst_QPdfPageRenderer::withEmptyDocument()
+{
+    QPdfDocument document;
+    QPdfPageRenderer pageRenderer;
+
+    pageRenderer.setDocument(&document);
+
+    const QSize imageSize(100, 100);
+    const quint64 requestId = pageRenderer.requestPage(0, imageSize);
+
+    QCOMPARE(requestId, quint64(0));
+}
+
+void tst_QPdfPageRenderer::withLoadedDocumentSingleThreaded()
+{
+    QPdfDocument document;
+    QPdfPageRenderer pageRenderer;
+    pageRenderer.setDocument(&document);
+
+    QCOMPARE(document.load(QFINDTESTDATA("pdf-sample.pagerenderer.pdf")), QPdfDocument::NoError);
+
+    QSignalSpy pageRenderedSpy(&pageRenderer, &QPdfPageRenderer::pageRendered);
+
+    const QSize imageSize(100, 100);
+    const quint64 requestId = pageRenderer.requestPage(0, imageSize);
+
+    QCOMPARE(requestId, quint64(1));
+    QTRY_COMPARE(pageRenderedSpy.count(), 1);
+    QCOMPARE(pageRenderedSpy[0][0].toInt(), 0);
+    QCOMPARE(pageRenderedSpy[0][1].toSize(), imageSize);
+    QCOMPARE(pageRenderedSpy[0][2].value<QImage>().size(), imageSize);
+    QCOMPARE(pageRenderedSpy[0][4].toULongLong(), requestId);
+}
+
+void tst_QPdfPageRenderer::withLoadedDocumentMultiThreaded()
+{
+    QPdfDocument document;
+
+    QPdfPageRenderer pageRenderer;
+    pageRenderer.setDocument(&document);
+    pageRenderer.setRenderMode(QPdfPageRenderer::MultiThreadedRenderMode);
+
+    QCOMPARE(document.load(QFINDTESTDATA("pdf-sample.pagerenderer.pdf")), QPdfDocument::NoError);
+
+    QSignalSpy pageRenderedSpy(&pageRenderer, &QPdfPageRenderer::pageRendered);
+
+    const QSize imageSize(100, 100);
+    const quint64 requestId = pageRenderer.requestPage(0, imageSize);
+
+    QCOMPARE(requestId, quint64(1));
+    QTRY_COMPARE(pageRenderedSpy.count(), 1);
+    QCOMPARE(pageRenderedSpy[0][0].toInt(), 0);
+    QCOMPARE(pageRenderedSpy[0][1].toSize(), imageSize);
+    QCOMPARE(pageRenderedSpy[0][2].value<QImage>().size(), imageSize);
+    QCOMPARE(pageRenderedSpy[0][4].toULongLong(), requestId);
+}
+
+void tst_QPdfPageRenderer::switchingRenderMode()
+{
+    QPdfDocument document;
+    QPdfPageRenderer pageRenderer;
+    pageRenderer.setDocument(&document);
+
+    QCOMPARE(document.load(QFINDTESTDATA("pdf-sample.pagerenderer.pdf")), QPdfDocument::NoError);
+
+    QSignalSpy pageRenderedSpy(&pageRenderer, &QPdfPageRenderer::pageRendered);
+
+    // render single threaded
+    const QSize imageSize(100, 100);
+    const quint64 firstRequestId = pageRenderer.requestPage(0, imageSize);
+
+    QTRY_COMPARE(pageRenderedSpy.count(), 1);
+    QCOMPARE(pageRenderedSpy[0][0].toInt(), 0);
+    QCOMPARE(pageRenderedSpy[0][1].toSize(), imageSize);
+    QCOMPARE(pageRenderedSpy[0][2].value<QImage>().size(), imageSize);
+    QCOMPARE(pageRenderedSpy[0][4].toULongLong(), firstRequestId);
+
+    const QImage image = pageRenderedSpy[0][2].value<QImage>();
+
+    pageRenderedSpy.clear();
+
+    // switch to multi threaded
+    pageRenderer.setRenderMode(QPdfPageRenderer::MultiThreadedRenderMode);
+
+    const quint64 secondRequestId = pageRenderer.requestPage(0, imageSize);
+
+    QVERIFY(firstRequestId != secondRequestId);
+    QTRY_COMPARE(pageRenderedSpy.count(), 1);
+    QCOMPARE(pageRenderedSpy[0][0].toInt(), 0);
+    QCOMPARE(pageRenderedSpy[0][1].toSize(), imageSize);
+    QCOMPARE(pageRenderedSpy[0][2].value<QImage>(), image);
+    QCOMPARE(pageRenderedSpy[0][2].value<QImage>().size(), imageSize);
+    QCOMPARE(pageRenderedSpy[0][4].toULongLong(), secondRequestId);
+
+    pageRenderedSpy.clear();
+
+    // switch back to single threaded
+    pageRenderer.setRenderMode(QPdfPageRenderer::SingleThreadedRenderMode);
+
+    const quint64 thirdRequestId = pageRenderer.requestPage(0, imageSize);
+
+    QTRY_COMPARE(pageRenderedSpy.count(), 1);
+    QCOMPARE(pageRenderedSpy[0][0].toInt(), 0);
+    QCOMPARE(pageRenderedSpy[0][1].toSize(), imageSize);
+    QCOMPARE(pageRenderedSpy[0][2].value<QImage>(), image);
+    QCOMPARE(pageRenderedSpy[0][2].value<QImage>().size(), imageSize);
+    QCOMPARE(pageRenderedSpy[0][4].toULongLong(), thirdRequestId);
+}
+
+QTEST_MAIN(tst_QPdfPageRenderer)
+
+#include "tst_qpdfpagerenderer.moc"