Changeset 326 for trunk/src/gui/kernel/qclipboard_pm.cpp

Timestamp:

Nov 19, 2009, 2:44:19 AM (16 years ago)

Author:

Dmitry A. Kuminov

Message:

gui/kernel: QClipboard: Added watching for the clipboard data changes and support for delayed data rendering.

File:

• trunk/src/gui/kernel/qclipboard_pm.cpp (modified) (9 diffs)

trunk/src/gui/kernel/qclipboard_pm.cpp

@@ -92 +92 @@
     if (!WinOpenClipbrd(NULLHANDLE)) {
 #ifndef QT_NO_DEBUG
-        qWarning("QClipboardWatcher: WinOpenClipbrd failed with 0x%lX",
-                 WinGetLastError(NULLHANDLE));
+        qWarning("QClipboardWatcher::peekData: WinOpenClipbrd "
+                 "failed with 0x%lX", WinGetLastError(NULLHANDLE));
 #endif
         return;
@@ -168 +168 @@
     ~QClipboardData();
 
-    void setSource(QMimeData *s)
+    void setSource(QMimeData *s);
+
+    void setAsClipboardViewer();
+    bool ownsClipboard();
+    void renderAllFormats(bool isDelayed);
+
+    static QClipboardData *instance()
     {
-        if (s == src)
-            return;
-        delete src;
-        src = s;
-    }
-
-    QMimeData *source()
+        if (instancePtr == 0) {
+            instancePtr = new QClipboardData;
+        }
+        Q_ASSERT(instancePtr);
+        return instancePtr;
+    }
+
+    static void deleteInstance()
     {
-        return src;
-    }
-
+        delete instancePtr;
+        instancePtr = 0;
+    }
+
+private:
+    bool openClipboard();
+    void closeClipboard();
     bool setClipboard(QPMMime *converter, ULONG format, bool isDelayed);
+    void renderFormat(ULONG format);
 
     MRESULT message(ULONG msg, MPARAM mp1, MPARAM mp2);
 
-private:
     QMimeData *src;
+    QList<QPMMime::Match> matches;
+    HWND prevClipboardViewer;
+
+    bool ignore_WM_DESTROYCLIPBOARD;
+
+    static QClipboardData *instancePtr;
 };
 
-QClipboardData::QClipboardData() : src(0)
+// static
+QClipboardData *QClipboardData::instancePtr = 0;
+
+QClipboardData::QClipboardData()
+    : src(0), prevClipboardViewer(NULLHANDLE)
+    , ignore_WM_DESTROYCLIPBOARD(false)
 {
 }
@@ -195 +217 @@
 QClipboardData::~QClipboardData()
 {
+    renderAllFormats(false);
+    setSource(0);
+
+    // make sure we are not the clipboard viewer any more
+    if (hwnd() == WinQueryClipbrdViewer(NULLHANDLE))
+        WinSetClipbrdViewer(NULLHANDLE, prevClipboardViewer);
+}
+
+void QClipboardData::setSource(QMimeData *s)
+{
+    if (s == src)
+        return;
     delete src;
+    src = s;
+
+    // build the list of all mime <-> cf matches
+    matches.clear();
+    if (src)
+        matches = QPMMime::allConvertersFromMimeData(src);
+}
+
+void QClipboardData::setAsClipboardViewer()
+{
+    HWND clipboardViewer = WinQueryClipbrdViewer(NULLHANDLE);
+    if (hwnd() != clipboardViewer) {
+        prevClipboardViewer = clipboardViewer;
+        BOOL ok = WinSetClipbrdViewer(NULLHANDLE, hwnd());
+        Q_UNUSED(ok);
+#ifndef QT_NO_DEBUG
+        if (!ok)
+            qWarning("QClipboardData::setAsClipboardViewer: WinSetClipbrdViewer "
+                     " failed with 0x%lX", WinGetLastError(NULLHANDLE));
+#endif
+    }
+}
+
+bool QClipboardData::ownsClipboard()
+{
+    return src && hwnd() == WinQueryClipbrdOwner(NULLHANDLE);
+}
+
+bool QClipboardData::openClipboard()
+{
+    if (!WinOpenClipbrd(NULLHANDLE)) {
+#ifndef QT_NO_DEBUG
+        qWarning("QClipboardData::openClipboard: WinOpenClipbrd "
+                 "failed with 0x%lX", WinGetLastError(NULLHANDLE));
+#endif
+        return false;
+    }
+    return true;
+}
+
+void QClipboardData::closeClipboard()
+{
+    WinCloseClipbrd(NULLHANDLE);
 }
 
@@ -223 +300 @@
 #ifdef QCLIPBOARD_DEBUG
     qDebug("QClipboardData::setClipboard: convert to CF 0x%lX, flags 0x%lX,"
-           "data 0x%lX, ok %d", format, flags, data, ok);
+           "data 0x%lX, delayed %d, ok %d", format, flags, data, isDelayed, ok);
 #endif
 
@@ -229 +306 @@
 }
 
+void QClipboardData::renderFormat(ULONG format)
+{
+#ifdef QCLIPBOARD_DEBUG
+    qDebug("QClipboardData::renderFormat: CF 0x%lX", format);
+#endif
+
+    if (!src)
+        return;
+
+    if (!openClipboard())
+        return;
+
+    foreach(QPMMime::Match match, matches) {
+        if (match.format == format) {
+            setClipboard(match.converter, match.format, false);
+            break;
+        }
+    }
+
+    closeClipboard();
+}
+
+void QClipboardData::renderAllFormats(bool isDelayed)
+{
+#ifdef QCLIPBOARD_DEBUG
+    qDebug() << "QClipboardData::renderAllFormats: isDelayed" << isDelayed;
+#endif
+
+    if (!openClipboard())
+        return;
+
+    // delete the clipboard contents before we render everything to make sure
+    // nothing is left there from another owner
+    ignore_WM_DESTROYCLIPBOARD = true;
+    BOOL ok = WinEmptyClipbrd(NULLHANDLE);
+    ignore_WM_DESTROYCLIPBOARD = false;
+    if (!ok) {
+#ifndef QT_NO_DEBUG
+        qWarning("QClipboardData::renderAllFormats: WinEmptyClipbrd "
+                 "failed with 0x%lX", WinGetLastError(NULLHANDLE));
+#endif
+        return;
+    }
+
+    if (src) {
+#ifdef QCLIPBOARD_DEBUG
+        qDebug() << "QClipboardData::renderAllFormats: mimes" << src->formats();
+#endif
+        foreach(QPMMime::Match match, matches)
+            setClipboard(match.converter, match.format, isDelayed);
+    }
+
+    closeClipboard();
+}
+
 MRESULT QClipboardData::message(ULONG msg, MPARAM mp1, MPARAM mp2)
 {
-    return 0;
-}
-
-static QClipboardData *ptrClipboardData = 0;
-
-static QClipboardData *clipboardData()
-{
-    if (ptrClipboardData == 0) {
-        ptrClipboardData = new QClipboardData;
-    }
-    return ptrClipboardData;
-}
-
-static void cleanupClipboardData()
-{
-    delete ptrClipboardData;
-    ptrClipboardData = 0;
+#ifdef QCLIPBOARD_DEBUG
+    qDebug("QClipboardData::message: msg %08lX, mp1 %p, mp2 %p",
+           msg, mp1, mp2);
+#endif
+
+    switch (msg) {
+
+        case WM_DRAWCLIPBOARD: {
+            // ask QClipboard to emit changed() signals
+            QClipboardEvent e(reinterpret_cast<QEventPrivate *>(1));
+            qt_sendSpontaneousEvent(QApplication::clipboard(), &e);
+
+            if (hwnd() != WinQueryClipbrdOwner(NULLHANDLE) && src) {
+                // we no longer the clipboard, clean up the clipboard object
+                setSource(0);
+            }
+            // PM doesn't inform the previous clipboard viewer if another
+            // app changes it (nor does it support viewer chains in some other
+            // way). The best we can do is to propagate the message to the
+            // previous clipboard viewer ourselves (though there is no guarantee
+            // that all non-Qt apps will do the same).
+            if (prevClipboardViewer) {
+                // propagate the message to the previous clipboard viewer
+                BOOL ok = WinPostMsg(prevClipboardViewer, msg, mp1, mp2);
+                if (!ok)
+                    prevClipboardViewer = NULLHANDLE;
+            }
+            break;
+        }
+
+        case WM_DESTROYCLIPBOARD:
+            if (!ignore_WM_DESTROYCLIPBOARD)
+                setSource(0);
+            break;
+
+        case WM_RENDERFMT:
+            renderFormat((ULONG)mp1);
+            break;
+
+        case WM_RENDERALLFMTS:
+            renderAllFormats(false);
+            break;
+
+        default:
+            break;
+    }
+
+    return (MRESULT)TRUE;
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 
-static bool ignore_WM_DESTROYCLIPBOARD = FALSE;
-
 QClipboard::~QClipboard()
 {
-    cleanupClipboardData();
+    QClipboardData::deleteInstance();
 }
 
 void QClipboard::setMimeData(QMimeData *src, Mode mode)
 {
+#ifdef QCLIPBOARD_DEBUG
+    qDebug() << "QClipboard::setMimeData: src" << src << "mode" << mode;
+#endif
+
     if (mode != Clipboard) {
         delete src;
@@ -266 +431 @@
     }
 
-    if (!WinOpenClipbrd(NULLHANDLE)) {
-#ifndef QT_NO_DEBUG
-        qWarning("QClipboard::setMimeData: WinOpenClipbrd failed with 0x%lX",
-                 WinGetLastError(NULLHANDLE));
-#endif
-        delete src;
-        return;
-    }
-
-    QClipboardData *d = clipboardData();
+    QClipboardData *d = QClipboardData::instance();
     d->setSource(src);
-
-    ignore_WM_DESTROYCLIPBOARD = TRUE;
-    BOOL ok = WinEmptyClipbrd(NULLHANDLE);
-    ignore_WM_DESTROYCLIPBOARD = FALSE;
-#ifndef QT_NO_DEBUG
-    if (!ok)
-        qWarning("QClipboard::setMimeData: WinEmptyClipbrd failed with 0x%lX",
-                 WinGetLastError(NULLHANDLE));
-#else
-    Q_UNUSED(ok);
-#endif
 
     if (!src)
@@ -295 +440 @@
                          QCoreApplication::instance()->d_func()->in_exec;
 
-    QStringList formats = src->formats();
-    foreach(QString mime, formats) {
-#ifdef QCLIPBOARD_DEBUG
-        qDebug() << "QClipboard::setMimeData: src mime" << mime;
-#endif
-        QList<QPMMime::Match> matches = QPMMime::allConvertersFromMimeData(src);
-        foreach(QPMMime::Match match, matches) {
-            d->setClipboard(match.converter, match.format, !runsEventLoop);
-        }
-    }
-
-    WinCloseClipbrd(NULLHANDLE);
+    d->renderAllFormats(runsEventLoop);
 }
 
 void QClipboard::clear(Mode mode)
 {
-    // @todo implement
+    setMimeData(0, Clipboard);
 }
 
 bool QClipboard::event(QEvent *e)
 {
-    // @todo implement
-    return false;
+    if (e->type() != QEvent::Clipboard)
+        return QObject::event(e);
+
+    if (!((QClipboardEvent*)e)->data()) {
+        // this is sent by QApplication to render all formats at app shut down
+        QClipboardData::instance()->renderAllFormats(false);
+    } else {
+        // this is sent by QClipboardData to notify about clipboard data change
+        emitChanged(QClipboard::Clipboard);
+    }
+
+    return true;
 }
 
 void QClipboard::connectNotify(const char *signal)
 {
-    // @todo implement
+    if (qstrcmp(signal, SIGNAL(dataChanged())) == 0) {
+        // ensure we are up and running (by instantiating QClipboardData and
+        // setting it as the clipboard viewer to receive notifications on
+        // clipboard contents chages) but block signals so the dataChange signal
+        // is not emitted while being connected to.
+        bool blocked = blockSignals(true);
+        QClipboardData::instance()->setAsClipboardViewer();
+        blockSignals(blocked);
+    }
 }
 
@@ -338 +490 @@
 bool QClipboard::ownsMode(Mode mode) const
 {
-    // @todo implement
+    if (mode == Clipboard) {
+        return QClipboardData::instance()->ownsClipboard();
+    }
     return false;
 }
@@ -344 +498 @@
 void QClipboard::ownerDestroyed()
 {
+    // not used
 }