qpdfiohandler.cpp

Go to the documentation of this file.

// Copyright (C) 2019 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 
#include "qpdfiohandler_p.h"
#include <QLoggingCategory>
#include <QPainter>
#include <QtPdf/private/qpdffile_p.h>
#include <QtPdf/private/qtpdfglobal_p.h>
 
QT_BEGIN_NAMESPACE
 
Q_PDF_LOGGING_CATEGORY(qLcPdf, "qt.imageformat.pdf")
 
QPdfIOHandler::QPdfIOHandler()
{
}
 
QPdfIOHandler::~QPdfIOHandler()
{
    if (m_ownsDocument)
        delete m_doc;
}
 
bool QPdfIOHandler::canRead() const
{
    if (!device())
        return false;
    if (m_loaded)
        return true;
    if (QPdfIOHandler::canRead(device())) {
        setFormat("pdf");
        return true;
    }
    return false;
}
 
bool QPdfIOHandler::canRead(QIODevice *device)
{
    char buf[6];
    if (device->peek(buf, 6) != 6)
        return false;
    return (!qstrncmp(buf, "%PDF-", 5) || Q_UNLIKELY(!qstrncmp(buf, "\012%PDF-", 6)));
}
 
int QPdfIOHandler::currentImageNumber() const
{
    return m_page;
}
 
QRect QPdfIOHandler::currentImageRect() const
{
    return QRect(QPoint(0, 0), m_doc->pagePointSize(m_page).toSize());
}
 
int QPdfIOHandler::imageCount() const
{
    int ret = 0;
    if (const_cast<QPdfIOHandler *>(this)->load(device()))
        ret = m_doc->pageCount();
    qCDebug(qLcPdf) << ret;
    return ret;
}
 
bool QPdfIOHandler::read(QImage *image)
{
    if (load(device())) {
        if (m_doc.isNull() || m_page >= m_doc->pageCount())
            return false;
        if (m_page < 0)
            m_page = 0;
        const bool xform = (m_clipRect.isValid() || m_scaledSize.isValid() || m_scaledClipRect.isValid());
        QSize pageSize = m_doc->pagePointSize(m_page).toSize();
        QSize finalSize = pageSize;
        QRectF bounds;
        if (xform && !finalSize.isEmpty()) {
            bounds = QRectF(QPointF(0,0), QSizeF(finalSize));
            QPoint tr1, tr2;
            QSizeF sc(1, 1);
            if (m_clipRect.isValid()) {
                tr1 = -m_clipRect.topLeft();
                finalSize = m_clipRect.size();
            }
            if (m_scaledSize.isValid()) {
                sc = QSizeF(qreal(m_scaledSize.width()) / finalSize.width(),
                            qreal(m_scaledSize.height()) / finalSize.height());
                finalSize = m_scaledSize;
                pageSize = m_scaledSize;
            }
            if (m_scaledClipRect.isValid()) {
                tr2 = -m_scaledClipRect.topLeft();
                finalSize = m_scaledClipRect.size();
            }
            QTransform t;
            t.translate(tr2.x(), tr2.y());
            t.scale(sc.width(), sc.height());
            t.translate(tr1.x(), tr1.y());
            bounds = t.mapRect(bounds);
        }
        qCDebug(qLcPdf) << m_page << finalSize;
        if (image->size() != finalSize || !image->reinterpretAsFormat(QImage::Format_ARGB32_Premultiplied)) {
            *image = QImage(finalSize, QImage::Format_ARGB32_Premultiplied);
            if (!finalSize.isEmpty() && image->isNull()) {
                // avoid QTBUG-68229
                qWarning("QPdfIOHandler: QImage allocation failed (size %i x %i)", finalSize.width(), finalSize.height());
                return false;
            }
        }
        if (!finalSize.isEmpty()) {
            QPdfDocumentRenderOptions options;
            if (m_scaledClipRect.isValid())
                options.setScaledClipRect(m_scaledClipRect);
            options.setScaledSize(pageSize);
            image->fill(m_backColor.rgba());
            QPainter p(image);
            if (!m_doc.isNull()) {
                QImage pageImage = m_doc->render(m_page, finalSize, options);
                p.drawImage(0, 0, pageImage);
                p.end();
            }
        }
        return true;
    }
 
    return false;
}
 
QVariant QPdfIOHandler::option(ImageOption option) const
{
    switch (option) {
    case ImageFormat:
        return QImage::Format_ARGB32_Premultiplied;
    case Size:
        const_cast<QPdfIOHandler *>(this)->load(device());
        return m_doc->pagePointSize(qMax(0, m_page));
    case ClipRect:
        return m_clipRect;
    case ScaledSize:
        return m_scaledSize;
    case ScaledClipRect:
        return m_scaledClipRect;
    case BackgroundColor:
        return m_backColor;
    case Name:
        return m_doc->metaData(QPdfDocument::MetaDataField::Title);
    default:
        break;
    }
    return QVariant();
}
 
void QPdfIOHandler::setOption(ImageOption option, const QVariant & value)
{
    switch (option) {
    case ClipRect:
        m_clipRect = value.toRect();
        break;
    case ScaledSize:
        m_scaledSize = value.toSize();
        break;
    case ScaledClipRect:
        m_scaledClipRect = value.toRect();
        break;
    case BackgroundColor:
        m_backColor = value.value<QColor>();
        break;
    default:
        break;
    }
}
 
bool QPdfIOHandler::supportsOption(ImageOption option) const
{
    switch (option)
    {
    case ImageFormat:
    case Size:
    case ClipRect:
    case ScaledSize:
    case ScaledClipRect:
    case BackgroundColor:
    case Name:
        return true;
    default:
        break;
    }
    return false;
}
 
bool QPdfIOHandler::jumpToImage(int frame)
{
    qCDebug(qLcPdf) << frame;
    if (frame < 0 || frame >= imageCount())
        return false;
    m_page = frame;
    return true;
}
 
bool QPdfIOHandler::jumpToNextImage()
{
    return jumpToImage(m_page + 1);
}
 
bool QPdfIOHandler::load(QIODevice *device)
{
    if (m_loaded)
        return true;
    if (format().isEmpty())
        if (!canRead())
            return false;
 
    QPdfFile *pdfFile = qobject_cast<QPdfFile *>(device);
    if (pdfFile) {
        m_doc = pdfFile->document();
        m_ownsDocument = false;
        qCDebug(qLcPdf) << "loading via QPdfFile, reusing document instance" << m_doc;
    } else {
        m_doc = new QPdfDocument();
        m_ownsDocument = true;
        m_doc->load(device);
        qCDebug(qLcPdf) << "loading via new document instance" << m_doc;
    }
    m_loaded = (m_doc->error() == QPdfDocument::Error::None);
 
    return m_loaded;
}
 
QT_END_NAMESPACE