Add a QPlatformPrinterSupportPlugin for Cocoa

This is used to create the actual QPrintEngine and to query the system
about printer information.

The QCocoaPrinterSupport actually lives in the Cocoa platform plugin,
so the QCocoaPrinterSupportPlugin uses the
createPlatformPrinterSupport() function in the QPlatformNativeInterface
(since the latter is a QObject). This is done to avoid adding a printing
related virtual function to QPlatformIntegration (since we have plans
to do a new printing API in the future).

Change-Id: I8bf9be668ff8ae1d07840e2af1e0846dc3299334
Reviewed-by: Morten Johan Sørvig <morten.sorvig@nokia.com>

src/plugins/platforms/cocoa/cocoa.pro

@@ -34,6 +34,7 @@ OBJECTIVE_SOURCES += main.mm \
     qcocoainputcontext.mm \
     qpaintengine_mac.mm \
     qprintengine_mac.mm \
+    qcocoaprintersupport.mm \
 
 HEADERS += qcocoaintegration.h \
     qcocoatheme.h \
@@ -65,6 +66,7 @@ HEADERS += qcocoaintegration.h \
     qcocoainputcontext.h \
     qpaintengine_mac_p.h \
     qprintengine_mac_p.h \
+    qcocoaprintersupport.h \
 
 FORMS += $$PWD/../../../widgets/dialogs/qfiledialog.ui
 RESOURCES += qcocoaresources.qrc

src/plugins/platforms/cocoa/qcocoanativeinterface.h

@@ -43,6 +43,7 @@
 #define QCOCOANATIVEINTERFACE_H
 
 #include <QtGui/QPlatformNativeInterface>
+#include <QtPrintSupport/QPlatformPrinterSupport>
 
 class QWidget;
 
@@ -51,6 +52,20 @@ class QCocoaNativeInterface : public QPlatformNativeInterface
     Q_OBJECT
 public:
     void *nativeResourceForWindow(const QByteArray &resourceString, QWindow *window);
+
+private:
+    /*
+        "Virtual" function to create the platform printer support
+        implementation.
+
+        We use an invokable function instead of a virtual one, we do not want
+        this in the QPlatform* API yet.
+
+        This was added here only because QPlatformNativeInterface is a QObject
+        and allow us to use QMetaObject::indexOfMethod() from the printsupport
+        plugin.
+    */
+    Q_INVOKABLE QPlatformPrinterSupport *createPlatformPrinterSupport();
 };
 
 #endif // QCOCOANATIVEINTERFACE_H

src/plugins/platforms/cocoa/qcocoanativeinterface.mm

@@ -42,6 +42,8 @@
 #include "qcocoanativeinterface.h"
 #include "qcocoaglcontext.h"
 #include "qcocoawindow.h"
+#include "qcocoaprintersupport.h"
+
 #include <qbytearray.h>
 #include <qwindow.h>
 #include "qplatformwindow_qpa.h"
@@ -66,3 +68,8 @@ void *QCocoaNativeInterface::nativeResourceForWindow(const QByteArray &resourceS
     }
     return 0;
 }
+
+QPlatformPrinterSupport *QCocoaNativeInterface::createPlatformPrinterSupport()
+{
+    return new QCocoaPrinterSupport();
+}

src/plugins/platforms/cocoa/qcocoaprintersupport.h

@@ -0,0 +1,60 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the QtPrintSupport module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** GNU Lesser General Public License Usage
+** 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.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU General
+** Public License version 3.0 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 3.0 requirements will be met:
+** http://www.gnu.org/copyleft/gpl.html.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QCOCOAPRINTERSUPPORT_H
+#define QCOCOAPRINTERSUPPORT_H
+
+#include <QtPrintSupport/QPlatformPrinterSupport>
+
+class QCocoaPrinterSupport : public QPlatformPrinterSupport
+{
+public:
+    QCocoaPrinterSupport();
+    ~QCocoaPrinterSupport();
+
+    Q_DECL_OVERRIDE QPrintEngine *createNativePrintEngine(QPrinter::PrinterMode printerMode);
+    Q_DECL_OVERRIDE QPaintEngine *createPaintEngine(QPrintEngine *, QPrinter::PrinterMode printerMode);
+    Q_DECL_OVERRIDE QList<QPrinter::PaperSize> supportedPaperSizes(const QPrinterInfo &) const;
+
+    Q_DECL_OVERRIDE QList<QPrinterInfo> availablePrinters();
+};
+
+#endif // QCOCOAPRINTERSUPPORT_H

src/plugins/platforms/cocoa/qcocoaprintersupport.mm

@@ -0,0 +1,116 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the QtPrintSupport module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** GNU Lesser General Public License Usage
+** 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.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU General
+** Public License version 3.0 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 3.0 requirements will be met:
+** http://www.gnu.org/copyleft/gpl.html.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qcocoaprintersupport.h"
+#include "qprintengine_mac_p.h"
+
+#include <QtPrintSupport/QPrinter>
+#include <QtPrintSupport/QPrinterInfo>
+
+QCocoaPrinterSupport::QCocoaPrinterSupport()
+{ }
+
+QCocoaPrinterSupport::~QCocoaPrinterSupport()
+{ }
+
+QPrintEngine *QCocoaPrinterSupport::createNativePrintEngine(QPrinter::PrinterMode printerMode)
+{
+    return new QMacPrintEngine(printerMode);
+}
+
+QPaintEngine *QCocoaPrinterSupport::createPaintEngine(QPrintEngine *printEngine, QPrinter::PrinterMode printerMode)
+{
+    Q_UNUSED(printerMode);
+    /*
+        QMacPrintEngine multiply inherits from QPrintEngine and QPaintEngine,
+        the cast here allows conversion of QMacPrintEngine* to QPaintEngine*
+    */
+    return static_cast<QMacPrintEngine *>(printEngine);
+}
+
+QList<QPrinter::PaperSize> QCocoaPrinterSupport::supportedPaperSizes(const QPrinterInfo &printerInfo) const
+{
+    QList<QPrinter::PaperSize> returnValue;
+    if (printerInfo.isNull())
+        return returnValue;
+
+    PMPrinter printer = PMPrinterCreateFromPrinterID(QCFString::toCFStringRef(printerInfo.printerName()));
+    if (!printer)
+        return returnValue;
+
+    CFArrayRef array;
+    if (PMPrinterGetPaperList(printer, &array) != noErr) {
+        PMRelease(printer);
+        return returnValue;
+    }
+
+    CFIndex count = CFArrayGetCount(array);
+    for (CFIndex i = 0; i < count; ++i) {
+        PMPaper paper = static_cast<PMPaper>(const_cast<void *>(CFArrayGetValueAtIndex(array, i)));
+        double width, height;
+        if (PMPaperGetWidth(paper, &width) == noErr
+            && PMPaperGetHeight(paper, &height) == noErr) {
+            // width and height are in points, convertQSizeFToPaperSize() expects millimeters
+            static const double OnePointInMillimeters = 1.0 / 72.0 * 25.4;
+            QSizeF size(width * OnePointInMillimeters, height * OnePointInMillimeters);
+            returnValue += QPlatformPrinterSupport::convertQSizeFToPaperSize(size);
+        }
+    }
+
+    PMRelease(printer);
+
+    return returnValue;
+}
+
+QList<QPrinterInfo> QCocoaPrinterSupport::availablePrinters()
+{
+    QList<QPrinterInfo> returnValue;
+    QCFType<CFArrayRef> printerList;
+    if (PMServerCreatePrinterList(kPMServerLocal, &printerList) == noErr) {
+        CFIndex count = CFArrayGetCount(printerList);
+        for (CFIndex i = 0; i < count; ++i) {
+            PMPrinter printer = static_cast<PMPrinter>(const_cast<void *>(CFArrayGetValueAtIndex(printerList, i)));
+            QString printerName = QCFString::toQString(PMPrinterGetName(printer));
+            returnValue += QPlatformPrinterSupport::printerInfo(printerName, PMPrinterIsDefault(printer));
+        }
+    }
+    return returnValue;
+}

src/plugins/printsupport/cocoa/cocoa.json

@@ -0,0 +1,3 @@
+{
+    "Keys": [ "cocoaprintersupport" ]
+}

src/plugins/printsupport/cocoa/cocoa.pro

@@ -0,0 +1,13 @@
+TARGET = cocoaprintersupport
+load(qt_plugin)
+DESTDIR = $$QT.gui.plugins/printsupport
+
+QT += printsupport
+LIBS += -framework Cocoa
+
+SOURCES += main.cpp
+
+OTHER_FILES += cocoa.json
+
+target.path += $$[QT_INSTALL_PLUGINS]/printsupport
+INSTALLS += target

src/plugins/printsupport/cocoa/main.cpp

@@ -0,0 +1,84 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the QtPrintSupport module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** GNU Lesser General Public License Usage
+** 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.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU General
+** Public License version 3.0 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 3.0 requirements will be met:
+** http://www.gnu.org/copyleft/gpl.html.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QtCore/QMetaMethod>
+#include <QtGui/QGuiApplication>
+#include <QtGui/QPlatformNativeInterface>
+#include <QtPrintSupport/QPlatformPrinterSupportPlugin>
+
+QT_BEGIN_NAMESPACE
+
+class QCocoaPrinterSupportPlugin : public QPlatformPrinterSupportPlugin
+{
+    Q_OBJECT
+    Q_PLUGIN_METADATA(IID "org.qt-project.QPlatformPrinterSupportFactoryInterface" FILE "cocoa.json")
+
+public:
+    QStringList keys() const;
+    QPlatformPrinterSupport *create(const QString &);
+};
+
+QStringList QCocoaPrinterSupportPlugin::keys() const
+{
+    return QStringList(QStringLiteral("cocoaprintersupport"));
+}
+
+QPlatformPrinterSupport *QCocoaPrinterSupportPlugin::create(const QString &key)
+{
+    if (key.compare(key, QStringLiteral("cocoaprintersupport"), Qt::CaseInsensitive) != 0)
+        return 0;
+    QGuiApplication *app = qobject_cast<QGuiApplication *>(QCoreApplication::instance());
+    if (!app)
+        return 0;
+    QPlatformNativeInterface *platformNativeInterface = app->platformNativeInterface();
+    int at = platformNativeInterface->metaObject()->indexOfMethod("createPlatformPrinterSupport()");
+    if (at == -1)
+        return 0;
+    QMetaMethod createPlatformPrinterSupport = platformNativeInterface->metaObject()->method(at);
+    QPlatformPrinterSupport *platformPrinterSupport = 0;
+    if (!createPlatformPrinterSupport.invoke(platformNativeInterface, Q_RETURN_ARG(QPlatformPrinterSupport *, platformPrinterSupport)))
+        return 0;
+    return platformPrinterSupport;
+}
+
+QT_END_NAMESPACE
+
+#include "main.moc"

src/plugins/printsupport/printsupport.pro

@@ -1,3 +1,4 @@
 TEMPLATE = subdirs
 
+mac:   SUBDIRS += cocoa
 win32: SUBDIRS += windows