1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the plugins of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
42 #include "qmacclipboard.h"
43 #include "qclipboard.h"
44 #include "qapplication.h"
46 #include "qdatetime.h"
48 #include "qguiapplication.h"
53 #include "qcocoahelpers.h"
55 #include "qcocoaautoreleasepool.h"
61 /*****************************************************************************
62 QClipboard debug facilities
63 *****************************************************************************/
64 //#define DEBUG_PASTEBOARD
66 #ifndef QT_NO_CLIPBOARD
68 /*****************************************************************************
69 QClipboard member functions for mac.
70 *****************************************************************************/
72 static QMacPasteboard *qt_mac_pasteboards[2] = {0, 0};
74 static inline QMacPasteboard *qt_mac_pasteboard(QClipboard::Mode mode)
76 Q_ASSERT(mode == QClipboard::Clipboard || mode == QClipboard::FindBuffer);
77 if (mode == QClipboard::Clipboard)
78 return qt_mac_pasteboards[0];
80 return qt_mac_pasteboards[1];
83 static void qt_mac_cleanupPasteboard() {
84 delete qt_mac_pasteboards[0];
85 delete qt_mac_pasteboards[1];
86 qt_mac_pasteboards[0] = 0;
87 qt_mac_pasteboards[1] = 0;
90 static bool qt_mac_updateScrap(QClipboard::Mode mode)
92 if (!qt_mac_pasteboards[0]) {
93 qt_mac_pasteboards[0] = new QMacPasteboard(kPasteboardClipboard, QMacPasteboardMime::MIME_CLIP);
94 qt_mac_pasteboards[1] = new QMacPasteboard(kPasteboardFind, QMacPasteboardMime::MIME_CLIP);
95 qAddPostRoutine(qt_mac_cleanupPasteboard);
98 return qt_mac_pasteboard(mode)->sync();
101 void QClipboard::clear(Mode mode)
103 if (!supportsMode(mode))
105 qt_mac_updateScrap(mode);
106 qt_mac_pasteboard(mode)->clear();
107 setMimeData(0, mode);
110 void QClipboard::ownerDestroyed()
115 void QClipboard::connectNotify(const char *signal)
120 bool QClipboard::event(QEvent *e)
122 if (e->type() != QEvent::Clipboard)
123 return QObject::event(e);
125 if (qt_mac_updateScrap(QClipboard::Clipboard)) {
126 emitChanged(QClipboard::Clipboard);
129 if (qt_mac_updateScrap(QClipboard::FindBuffer)) {
130 emitChanged(QClipboard::FindBuffer);
133 return QObject::event(e);
136 const QMimeData *QClipboard::mimeData(Mode mode) const
138 if (!supportsMode(mode))
140 qt_mac_updateScrap(mode);
141 return qt_mac_pasteboard(mode)->mimeData();
144 void QClipboard::setMimeData(QMimeData *src, Mode mode)
146 if (!supportsMode(mode))
148 qt_mac_updateScrap(mode);
149 qt_mac_pasteboard(mode)->setMimeData(src);
153 bool QClipboard::supportsMode(Mode mode) const
155 return (mode == Clipboard || mode == FindBuffer);
158 bool QClipboard::ownsMode(Mode mode) const
164 #endif // QT_NO_CLIPBOARD
166 /*****************************************************************************
168 *****************************************************************************/
170 QMacPasteboard::QMacPasteboard(PasteboardRef p, uchar mt)
172 mac_mime_source = false;
173 mime_type = mt ? mt : uchar(QMacPasteboardMime::MIME_ALL);
178 QMacPasteboard::QMacPasteboard(uchar mt)
180 mac_mime_source = false;
181 mime_type = mt ? mt : uchar(QMacPasteboardMime::MIME_ALL);
183 OSStatus err = PasteboardCreate(0, &paste);
185 PasteboardSetPromiseKeeper(paste, promiseKeeper, this);
187 qDebug("PasteBoard: Error creating pasteboard: [%d]", (int)err);
191 QMacPasteboard::QMacPasteboard(CFStringRef name, uchar mt)
193 mac_mime_source = false;
194 mime_type = mt ? mt : uchar(QMacPasteboardMime::MIME_ALL);
196 OSStatus err = PasteboardCreate(name, &paste);
198 PasteboardSetPromiseKeeper(paste, promiseKeeper, this);
200 qDebug("PasteBoard: Error creating pasteboard: %s [%d]", QCFString::toQString(name).toLatin1().constData(), (int)err);
204 QMacPasteboard::~QMacPasteboard()
206 // commit all promises for paste after exit close
207 for (int i = 0; i < promises.count(); ++i) {
208 const Promise &promise = promises.at(i);
209 QCFString flavor = QCFString(promise.convertor->flavorFor(promise.mime));
210 promiseKeeper(paste, (PasteboardItemID)promise.itemId, flavor, this);
218 QMacPasteboard::pasteBoard() const
223 OSStatus QMacPasteboard::promiseKeeper(PasteboardRef paste, PasteboardItemID id, CFStringRef flavor, void *_qpaste)
225 QMacPasteboard *qpaste = (QMacPasteboard*)_qpaste;
226 const long promise_id = (long)id;
228 // Find the kept promise
229 const QString flavorAsQString = QCFString::toQString(flavor);
230 QMacPasteboard::Promise promise;
231 for (int i = 0; i < qpaste->promises.size(); i++){
232 QMacPasteboard::Promise tmp = qpaste->promises[i];
233 if (tmp.itemId == promise_id && tmp.convertor->canConvert(tmp.mime, flavorAsQString)){
239 if (!promise.itemId && flavorAsQString == QLatin1String("com.trolltech.qt.MimeTypeName")) {
240 // we have promised this data, but wont be able to convert, so return null data.
241 // This helps in making the application/x-qt-mime-type-name hidden from normal use.
243 QCFType<CFDataRef> data = CFDataCreate(0, (UInt8*)ba.constData(), ba.size());
244 PasteboardPutItemFlavor(paste, id, flavor, data, kPasteboardFlavorNoFlags);
248 if (!promise.itemId) {
249 // There was no promise that could deliver data for the
250 // given id and flavor. This should not happend.
251 qDebug("Pasteboard: %d: Request for %ld, %s, but no promise found!", __LINE__, promise_id, qPrintable(flavorAsQString));
252 return cantGetFlavorErr;
255 #ifdef DEBUG_PASTEBOARD
256 qDebug("PasteBoard: Calling in promise for %s[%ld] [%s] (%s) [%d]", qPrintable(promise.mime), promise_id,
257 qPrintable(flavorAsQString), qPrintable(promise.convertor->convertorName()), promise.offset);
260 QList<QByteArray> md = promise.convertor->convertFromMime(promise.mime, promise.data, flavorAsQString);
261 if (md.size() <= promise.offset)
262 return cantGetFlavorErr;
263 const QByteArray &ba = md[promise.offset];
264 QCFType<CFDataRef> data = CFDataCreate(0, (UInt8*)ba.constData(), ba.size());
265 PasteboardPutItemFlavor(paste, id, flavor, data, kPasteboardFlavorNoFlags);
270 QMacPasteboard::hasOSType(int c_flavor) const
278 if (PasteboardGetItemCount(paste, &cnt) || !cnt)
281 #ifdef DEBUG_PASTEBOARD
282 qDebug("PasteBoard: hasOSType [%c%c%c%c]", (c_flavor>>24)&0xFF, (c_flavor>>16)&0xFF,
283 (c_flavor>>8)&0xFF, (c_flavor>>0)&0xFF);
285 for (uint index = 1; index <= cnt; ++index) {
288 if (PasteboardGetItemIdentifier(paste, index, &id) != noErr)
291 QCFType<CFArrayRef> types;
292 if (PasteboardCopyItemFlavors(paste, id, &types ) != noErr)
295 const int type_count = CFArrayGetCount(types);
296 for (int i = 0; i < type_count; ++i) {
297 CFStringRef flavor = (CFStringRef)CFArrayGetValueAtIndex(types, i);
298 const int os_flavor = UTGetOSTypeFromString(UTTypeCopyPreferredTagWithClass(flavor, kUTTagClassOSType));
299 if (os_flavor == c_flavor) {
300 #ifdef DEBUG_PASTEBOARD
307 #ifdef DEBUG_PASTEBOARD
308 qDebug(" - NotFound!");
314 QMacPasteboard::hasFlavor(QString c_flavor) const
322 if (PasteboardGetItemCount(paste, &cnt) || !cnt)
325 #ifdef DEBUG_PASTEBOARD
326 qDebug("PasteBoard: hasFlavor [%s]", qPrintable(c_flavor));
328 for (uint index = 1; index <= cnt; ++index) {
331 if (PasteboardGetItemIdentifier(paste, index, &id) != noErr)
334 PasteboardFlavorFlags flags;
335 if (PasteboardGetItemFlavorFlags(paste, id, QCFString(c_flavor), &flags) == noErr) {
336 #ifdef DEBUG_PASTEBOARD
342 #ifdef DEBUG_PASTEBOARD
343 qDebug(" - NotFound!");
348 class QMacPasteboardMimeSource : public QMimeData {
349 const QMacPasteboard *paste;
351 QMacPasteboardMimeSource(const QMacPasteboard *p) : QMimeData(), paste(p) { }
352 ~QMacPasteboardMimeSource() { }
353 virtual QStringList formats() const { return paste->formats(); }
354 virtual QVariant retrieveData(const QString &format, QVariant::Type type) const { return paste->retrieveData(format, type); }
358 *QMacPasteboard::mimeData() const
361 mac_mime_source = true;
362 mime = new QMacPasteboardMimeSource(this);
368 class QMacMimeData : public QMimeData
371 QVariant variantData(const QString &mime) { return retrieveData(mime, QVariant::Invalid); }
377 QMacPasteboard::setMimeData(QMimeData *mime_src)
382 if (mime == mime_src || (!mime_src && mime && mac_mime_source))
384 mac_mime_source = false;
388 QList<QMacPasteboardMime*> availableConverters = QMacPasteboardMime::all(mime_type);
391 QStringList formats = mime_src->formats();
393 // QMimeData sub classes reimplementing the formats() might not expose the
394 // temporary "application/x-qt-mime-type-name" mimetype. So check the existence
395 // of this mime type while doing drag and drop.
396 QString dummyMimeType(QLatin1String("application/x-qt-mime-type-name"));
397 if (!formats.contains(dummyMimeType)) {
398 QByteArray dummyType = mime_src->data(dummyMimeType);
399 if (!dummyType.isEmpty()) {
400 formats.append(dummyMimeType);
403 for (int f = 0; f < formats.size(); ++f) {
404 QString mimeType = formats.at(f);
405 for (QList<QMacPasteboardMime *>::Iterator it = availableConverters.begin(); it != availableConverters.end(); ++it) {
406 QMacPasteboardMime *c = (*it);
407 QString flavor(c->flavorFor(mimeType));
408 if (!flavor.isEmpty()) {
409 QVariant mimeData = static_cast<QMacMimeData*>(mime_src)->variantData(mimeType);
411 //### Grrr, why didn't I put in a virtual int QMacPasteboardMime::count()? --Sam
412 const int numItems = c->convertFromMime(mimeType, mimeData, flavor).size();
414 int numItems = 1; //this is a hack but it is much faster than allowing conversion above
415 if (c->convertorName() == QLatin1String("FileURL"))
416 numItems = mime_src->urls().count();
418 for (int item = 0; item < numItems; ++item) {
419 const int itemID = item+1; //id starts at 1
420 promises.append(QMacPasteboard::Promise(itemID, c, mimeType, mimeData, item));
421 PasteboardPutItemFlavor(paste, (PasteboardItemID)itemID, QCFString(flavor), 0, kPasteboardFlavorNoFlags);
422 #ifdef DEBUG_PASTEBOARD
423 qDebug(" - adding %d %s [%s] <%s> [%d]",
424 itemID, qPrintable(mimeType), qPrintable(flavor), qPrintable(c->convertorName()), item);
434 QMacPasteboard::formats() const
437 return QStringList();
443 if (PasteboardGetItemCount(paste, &cnt) || !cnt)
446 #ifdef DEBUG_PASTEBOARD
447 qDebug("PasteBoard: Formats [%d]", (int)cnt);
449 for (uint index = 1; index <= cnt; ++index) {
452 if (PasteboardGetItemIdentifier(paste, index, &id) != noErr)
455 QCFType<CFArrayRef> types;
456 if (PasteboardCopyItemFlavors(paste, id, &types ) != noErr)
459 const int type_count = CFArrayGetCount(types);
460 for (int i = 0; i < type_count; ++i) {
461 const QString flavor = QCFString::toQString((CFStringRef)CFArrayGetValueAtIndex(types, i));
462 #ifdef DEBUG_PASTEBOARD
463 qDebug(" -%s", qPrintable(QString(flavor)));
465 QString mimeType = QMacPasteboardMime::flavorToMime(mime_type, flavor);
466 if (!mimeType.isEmpty() && !ret.contains(mimeType)) {
467 #ifdef DEBUG_PASTEBOARD
468 qDebug(" -<%d> %s [%s]", ret.size(), qPrintable(mimeType), qPrintable(QString(flavor)));
478 QMacPasteboard::hasFormat(const QString &format) const
486 if (PasteboardGetItemCount(paste, &cnt) || !cnt)
489 #ifdef DEBUG_PASTEBOARD
490 qDebug("PasteBoard: hasFormat [%s]", qPrintable(format));
492 for (uint index = 1; index <= cnt; ++index) {
495 if (PasteboardGetItemIdentifier(paste, index, &id) != noErr)
498 QCFType<CFArrayRef> types;
499 if (PasteboardCopyItemFlavors(paste, id, &types ) != noErr)
502 const int type_count = CFArrayGetCount(types);
503 for (int i = 0; i < type_count; ++i) {
504 const QString flavor = QCFString::toQString((CFStringRef)CFArrayGetValueAtIndex(types, i));
505 #ifdef DEBUG_PASTEBOARD
506 qDebug(" -%s [0x%x]", qPrintable(QString(flavor)), mime_type);
508 QString mimeType = QMacPasteboardMime::flavorToMime(mime_type, flavor);
509 #ifdef DEBUG_PASTEBOARD
510 if (!mimeType.isEmpty())
511 qDebug(" - %s", qPrintable(mimeType));
513 if (mimeType == format)
521 QMacPasteboard::retrieveData(const QString &format, QVariant::Type) const
529 if (PasteboardGetItemCount(paste, &cnt) || !cnt)
532 #ifdef DEBUG_PASTEBOARD
533 qDebug("Pasteboard: retrieveData [%s]", qPrintable(format));
535 const QList<QMacPasteboardMime *> mimes = QMacPasteboardMime::all(mime_type);
536 for (int mime = 0; mime < mimes.size(); ++mime) {
537 QMacPasteboardMime *c = mimes.at(mime);
538 QString c_flavor = c->flavorFor(format);
539 if (!c_flavor.isEmpty()) {
540 // Handle text/plain a little differently. Try handling Unicode first.
541 bool checkForUtf16 = (c_flavor == QLatin1String("com.apple.traditional-mac-plain-text")
542 || c_flavor == QLatin1String("public.utf8-plain-text"));
543 if (checkForUtf16 || c_flavor == QLatin1String("public.utf16-plain-text")) {
544 // Try to get the NSStringPboardType from NSPasteboard, newlines are mapped
545 // correctly (as '\n') in this data. The 'public.utf16-plain-text' type
546 // usually maps newlines to '\r' instead.
547 QString str = qt_mac_get_pasteboardString(paste);
551 if (checkForUtf16 && hasFlavor(QLatin1String("public.utf16-plain-text")))
552 c_flavor = QLatin1String("public.utf16-plain-text");
555 QList<QByteArray> retList;
556 for (uint index = 1; index <= cnt; ++index) {
558 if (PasteboardGetItemIdentifier(paste, index, &id) != noErr)
561 QCFType<CFArrayRef> types;
562 if (PasteboardCopyItemFlavors(paste, id, &types ) != noErr)
565 const int type_count = CFArrayGetCount(types);
566 for (int i = 0; i < type_count; ++i) {
567 CFStringRef flavor = static_cast<CFStringRef>(CFArrayGetValueAtIndex(types, i));
568 if (c_flavor == QCFString::toQString(flavor)) {
569 QCFType<CFDataRef> macBuffer;
570 if (PasteboardCopyItemFlavorData(paste, id, flavor, &macBuffer) == noErr) {
571 QByteArray buffer((const char *)CFDataGetBytePtr(macBuffer), CFDataGetLength(macBuffer));
572 if (!buffer.isEmpty()) {
573 #ifdef DEBUG_PASTEBOARD
574 qDebug(" - %s [%s] (%s)", qPrintable(format), qPrintable(QCFString::toQString(flavor)), qPrintable(c->convertorName()));
576 buffer.detach(); //detach since we release the macBuffer
577 retList.append(buffer);
578 break; //skip to next element
582 #ifdef DEBUG_PASTEBOARD
583 qDebug(" - NoMatch %s [%s] (%s)", qPrintable(c_flavor), qPrintable(QCFString::toQString(flavor)), qPrintable(c->convertorName()));
589 if (!retList.isEmpty()) {
590 ret = c->convertToMime(format, retList, c_flavor);
598 void QMacPasteboard::clear_helper()
601 PasteboardClear(paste);
606 QMacPasteboard::clear()
608 #ifdef DEBUG_PASTEBOARD
609 qDebug("PasteBoard: clear!");
615 QMacPasteboard::sync() const
619 const bool fromGlobal = PasteboardSynchronize(paste) & kPasteboardModified;
622 const_cast<QMacPasteboard *>(this)->setMimeData(0);
624 #ifdef DEBUG_PASTEBOARD
626 qDebug("Pasteboard: Synchronize!");
632 QString qt_mac_get_pasteboardString(PasteboardRef paste)
634 QCocoaAutoReleasePool pool;
635 NSPasteboard *pb = nil;
637 if (PasteboardCopyName(paste, &pbname) == noErr) {
638 pb = [NSPasteboard pasteboardWithName:const_cast<NSString *>(reinterpret_cast<const NSString *>(pbname))];
641 pb = [NSPasteboard generalPasteboard];
644 NSString *text = [pb stringForType:NSStringPboardType];
646 return QCFString::toQString(text);