3 * \file qt4/GuiClipboard.cpp
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
8 * \author Abdelrazak Younes
10 * Full author contact details are available in file CREDITS.
15 #include "FileDialog.h"
17 #include "GuiClipboard.h"
18 #include "qt_helpers.h"
21 #include "BufferView.h"
24 #include "support/lassert.h"
25 #include "support/convert.h"
26 #include "support/debug.h"
27 #include "support/filetools.h"
28 #include "support/gettext.h"
29 #include "support/lstrings.h"
31 #include "support/linkback/LinkBackProxy.h"
34 #include "frontends/alert.h"
36 #include <QApplication>
39 #include <QDataStream>
42 #include <QMacPasteboardMime>
45 #include <QStringList>
49 #include <QWindowsMime>
50 #if defined(Q_CYGWIN_WIN) || defined(Q_CC_MINGW)
60 using namespace lyx::support;
62 static char const * const lyx_mime_type = "application/x-lyx";
63 static char const * const pdf_mime_type = "application/pdf";
64 static char const * const emf_mime_type = "image/x-emf";
65 static char const * const wmf_mime_type = "image/x-wmf";
73 static FORMATETC cfFromMime(QString const & mimetype)
76 if (mimetype == emf_mime_type) {
77 formatetc.cfFormat = CF_ENHMETAFILE;
78 formatetc.tymed = TYMED_ENHMF;
79 } else if (mimetype == wmf_mime_type) {
80 formatetc.cfFormat = CF_METAFILEPICT;
81 formatetc.tymed = TYMED_MFPICT;
84 formatetc.dwAspect = DVASPECT_CONTENT;
85 formatetc.lindex = -1;
90 class QWindowsMimeMetafile : public QWindowsMime {
92 QWindowsMimeMetafile() {}
93 bool canConvertFromMime(FORMATETC const & formatetc, QMimeData const * mimedata) const;
94 bool canConvertToMime(QString const & mimetype, IDataObject * pDataObj) const;
95 bool convertFromMime(FORMATETC const & formatetc, const QMimeData * mimedata, STGMEDIUM * pmedium) const;
96 QVariant convertToMime(QString const & mimetype, IDataObject * pDataObj, QVariant::Type preferredType) const;
97 QVector<FORMATETC> formatsForMime(QString const & mimeType, QMimeData const * mimeData) const;
98 QString mimeForFormat(FORMATETC const &) const;
102 QString QWindowsMimeMetafile::mimeForFormat(FORMATETC const & formatetc) const
105 if (formatetc.cfFormat == CF_ENHMETAFILE)
107 else if (formatetc.cfFormat == CF_METAFILEPICT)
113 bool QWindowsMimeMetafile::canConvertFromMime(FORMATETC const & formatetc,
114 QMimeData const * mimedata) const
120 bool QWindowsMimeMetafile::canConvertToMime(QString const & mimetype,
121 IDataObject * pDataObj) const
123 if (mimetype != emf_mime_type && mimetype != wmf_mime_type)
125 FORMATETC formatetc = cfFromMime(mimetype);
126 return pDataObj->QueryGetData(&formatetc) == S_OK;
130 bool QWindowsMimeMetafile::convertFromMime(FORMATETC const & formatetc,
131 QMimeData const * mimedata, STGMEDIUM * pmedium) const
137 QVariant QWindowsMimeMetafile::convertToMime(QString const & mimetype,
138 IDataObject * pDataObj, QVariant::Type preferredType) const
141 if (!canConvertToMime(mimetype, pDataObj))
144 FORMATETC formatetc = cfFromMime(mimetype);
146 if (pDataObj->GetData(&formatetc, &s) != S_OK)
150 if (s.tymed == TYMED_ENHMF) {
151 dataSize = GetEnhMetaFileBits(s.hEnhMetaFile, 0, 0);
152 data.resize(dataSize);
153 dataSize = GetEnhMetaFileBits(s.hEnhMetaFile, dataSize, (LPBYTE)data.data());
154 } else if (s.tymed == TYMED_MFPICT) {
155 dataSize = GetMetaFileBitsEx((HMETAFILE)s.hMetaFilePict, 0, 0);
156 data.resize(dataSize);
157 dataSize = GetMetaFileBitsEx((HMETAFILE)s.hMetaFilePict, dataSize, (LPBYTE)data.data());
160 ReleaseStgMedium(&s);
166 QVector<FORMATETC> QWindowsMimeMetafile::formatsForMime(
167 QString const & mimetype, QMimeData const * mimedata) const
169 QVector<FORMATETC> formats;
170 formats += cfFromMime(mimetype);
174 static QWindowsMimeMetafile * metafileWindowsMime = 0;
180 class QMacPasteboardMimeGraphics : public QMacPasteboardMime {
182 QMacPasteboardMimeGraphics()
183 : QMacPasteboardMime(MIME_QT_CONVERTOR|MIME_ALL)
185 QString convertorName();
186 QString flavorFor(QString const & mime);
187 QString mimeFor(QString flav);
188 bool canConvert(QString const & mime, QString flav);
189 QVariant convertToMime(QString const & mime, QList<QByteArray> data, QString flav);
190 QList<QByteArray> convertFromMime(QString const & mime, QVariant data, QString flav);
194 QString QMacPasteboardMimeGraphics::convertorName()
200 QString QMacPasteboardMimeGraphics::flavorFor(QString const & mime)
202 LYXERR(Debug::ACTION, "flavorFor " << mime);
203 if (mime == QLatin1String(pdf_mime_type))
204 return QLatin1String("com.adobe.pdf");
209 QString QMacPasteboardMimeGraphics::mimeFor(QString flav)
211 LYXERR(Debug::ACTION, "mimeFor " << flav);
212 if (flav == QLatin1String("com.adobe.pdf"))
213 return QLatin1String(pdf_mime_type);
218 bool QMacPasteboardMimeGraphics::canConvert(QString const & mime, QString flav)
220 return mimeFor(flav) == mime;
224 QVariant QMacPasteboardMimeGraphics::convertToMime(QString const & mime, QList<QByteArray> data, QString)
227 qWarning("QMacPasteboardMimeGraphics: Cannot handle multiple member data");
232 QList<QByteArray> QMacPasteboardMimeGraphics::convertFromMime(QString const & mime, QVariant data, QString)
234 QList<QByteArray> ret;
235 ret.append(data.toByteArray());
239 static QMacPasteboardMimeGraphics * graphicsPasteboardMime = 0;
244 GuiClipboard::GuiClipboard()
246 connect(qApp->clipboard(), SIGNAL(dataChanged()),
247 this, SLOT(on_dataChanged()));
248 // initialize clipboard status.
252 if (!graphicsPasteboardMime)
253 graphicsPasteboardMime = new QMacPasteboardMimeGraphics();
257 if (!metafileWindowsMime)
258 metafileWindowsMime = new QWindowsMimeMetafile();
263 GuiClipboard::~GuiClipboard()
266 if (metafileWindowsMime) {
267 delete metafileWindowsMime;
268 metafileWindowsMime = 0;
272 closeAllLinkBackLinks();
273 if (graphicsPasteboardMime) {
274 delete graphicsPasteboardMime;
275 graphicsPasteboardMime = 0;
281 string const GuiClipboard::getAsLyX() const
283 LYXERR(Debug::ACTION, "GuiClipboard::getAsLyX(): `");
284 // We don't convert encodings here since the encoding of the
285 // clipboard contents is specified in the data itself
286 QMimeData const * source =
287 qApp->clipboard()->mimeData(QClipboard::Clipboard);
289 LYXERR(Debug::ACTION, "' (no QMimeData)");
293 if (source->hasFormat(lyx_mime_type)) {
294 // data from ourself or some other LyX instance
295 QByteArray const ar = source->data(lyx_mime_type);
296 string const s(ar.data(), ar.count());
297 LYXERR(Debug::ACTION, s << "'");
300 LYXERR(Debug::ACTION, "'");
305 FileName GuiClipboard::getPastedGraphicsFileName(Cursor const & cur,
306 Clipboard::GraphicsType & type) const
308 // create file dialog filter according to the existing types in the clipboard
309 vector<Clipboard::GraphicsType> types;
310 if (hasGraphicsContents(Clipboard::EmfGraphicsType))
311 types.push_back(Clipboard::EmfGraphicsType);
312 if (hasGraphicsContents(Clipboard::WmfGraphicsType))
313 types.push_back(Clipboard::WmfGraphicsType);
314 if (hasGraphicsContents(Clipboard::LinkBackGraphicsType))
315 types.push_back(Clipboard::LinkBackGraphicsType);
316 if (hasGraphicsContents(Clipboard::PdfGraphicsType))
317 types.push_back(Clipboard::PdfGraphicsType);
318 if (hasGraphicsContents(Clipboard::PngGraphicsType))
319 types.push_back(Clipboard::PngGraphicsType);
320 if (hasGraphicsContents(Clipboard::JpegGraphicsType))
321 types.push_back(Clipboard::JpegGraphicsType);
323 LASSERT(!types.empty(), /**/);
325 // select prefered type if AnyGraphicsType was passed
326 if (type == Clipboard::AnyGraphicsType)
327 type = types.front();
330 map<Clipboard::GraphicsType, string> extensions;
331 map<Clipboard::GraphicsType, docstring> typeNames;
333 extensions[Clipboard::EmfGraphicsType] = "emf";
334 extensions[Clipboard::WmfGraphicsType] = "wmf";
335 extensions[Clipboard::LinkBackGraphicsType] = "linkback";
336 extensions[Clipboard::PdfGraphicsType] = "pdf";
337 extensions[Clipboard::PngGraphicsType] = "png";
338 extensions[Clipboard::JpegGraphicsType] = "jpeg";
340 typeNames[Clipboard::EmfGraphicsType] = _("Enhanced Metafile");
341 typeNames[Clipboard::WmfGraphicsType] = _("Windows Metafile");
342 typeNames[Clipboard::LinkBackGraphicsType] = _("LinkBack PDF");
343 typeNames[Clipboard::PdfGraphicsType] = _("PDF");
344 typeNames[Clipboard::PngGraphicsType] = _("PNG");
345 typeNames[Clipboard::JpegGraphicsType] = _("JPEG");
347 // find unused filename with primary extension
348 string document_path = cur.buffer().fileName().onlyPath().absFilename();
349 unsigned newfile_number = 0;
353 filename = FileName(addName(document_path,
355 + convert<string>(newfile_number) + "."
356 + extensions[type]));
357 } while (filename.isReadableFile());
360 // create file type filter, putting the prefered on to the front
362 for (size_t i = 0; i != types.size(); ++i) {
363 docstring s = bformat(_("%1$s Files"), typeNames[types[i]])
364 + " (*." + from_ascii(extensions[types[i]]) + ")";
365 if (types[i] == type)
366 filter.prepend(toqstr(s));
368 filter.append(toqstr(s));
370 filter = fileFilters(filter.join(";;"));
372 // show save dialog for the graphic
373 FileDialog dlg(qt_("Choose a filename to save the pasted graphic as"));
374 FileDialog::Result result =
375 dlg.save(toqstr(filename.onlyPath().absFilename()), filter,
376 toqstr(filename.onlyFileName()));
378 if (result.first == FileDialog::Later)
381 string newFilename = fromqstr(result.second);
382 if (newFilename.empty()) {
383 cur.bv().message(_("Canceled."));
386 filename.set(newFilename);
388 // check the extension (the user could have changed it)
389 if (!suffixIs(ascii_lowercase(filename.absFilename()),
390 "." + extensions[type])) {
391 // the user changed the extension. Check if the type is available
393 for (i = 1; i != types.size(); ++i) {
394 if (suffixIs(ascii_lowercase(filename.absFilename()),
395 "." + extensions[types[i]])) {
401 // invalid extension found, or none at all. In the latter
402 // case set the default extensions.
403 if (i == types.size()
404 && filename.onlyFileName().find('.') == string::npos) {
405 filename.changeExtension("." + extensions[type]);
409 // check whether the file exists and warn the user
410 if (!filename.exists())
412 int ret = frontend::Alert::prompt(
413 _("Overwrite external file?"),
414 bformat(_("File %1$s already exists, do you want to overwrite it?"),
415 from_utf8(filename.absFilename())), 1, 1, _("&Overwrite"), _("&Cancel"));
417 // overwrite, hence break the dialog loop
420 // not overwrite, hence show the dialog again (i.e. loop)
427 FileName GuiClipboard::getAsGraphics(Cursor const & cur, GraphicsType type) const
429 // get the filename from the user
430 FileName filename = getPastedGraphicsFileName(cur, type);
431 if (filename.empty())
434 // handle image cases first
435 if (type == PngGraphicsType || type == JpegGraphicsType) {
436 // get image from QImage from clipboard
437 QImage image = qApp->clipboard()->image();
438 if (image.isNull()) {
439 LYXERR(Debug::ACTION, "No image in clipboard");
443 // convert into graphics format
446 buffer.open(QIODevice::WriteOnly);
447 if (type == PngGraphicsType)
448 image.save(toqstr(filename.absFilename()), "PNG");
449 else if (type == JpegGraphicsType)
450 image.save(toqstr(filename.absFilename()), "JPEG");
452 LASSERT(false, /**/);
458 QMimeData const * source =
459 qApp->clipboard()->mimeData(QClipboard::Clipboard);
461 LYXERR(Debug::ACTION, "0 bytes (no QMimeData)");
468 case PdfGraphicsType: mime = pdf_mime_type; break;
469 case LinkBackGraphicsType: mime = pdf_mime_type; break;
470 case EmfGraphicsType: mime = emf_mime_type; break;
471 case WmfGraphicsType: mime = wmf_mime_type; break;
472 default: LASSERT(false, /**/);
476 if (!source->hasFormat(mime))
478 // data from ourself or some other LyX instance
479 QByteArray const ar = source->data(mime);
480 LYXERR(Debug::ACTION, "Getting from clipboard: mime = " << mime.data()
481 << "length = " << ar.count());
483 QFile f(toqstr(filename.absFilename()));
484 if (!f.open(QIODevice::WriteOnly | QIODevice::Truncate)) {
485 LYXERR(Debug::ACTION, "Error opening file "
486 << filename.absFilename() << " for writing");
490 // write the (LinkBack) PDF data
492 if (type == LinkBackGraphicsType) {
494 void const * linkBackData;
495 unsigned linkBackLen;
496 getLinkBackData(&linkBackData, &linkBackLen);
497 f.write((char *)linkBackData, linkBackLen);
498 quint32 pdfLen = ar.size();
500 ds << pdfLen; // big endian by default
502 // only non-Mac this should never happen
503 LASSERT(false, /**/);
512 docstring const GuiClipboard::getAsText() const
514 // text data from other applications
515 QString const str = qApp->clipboard()->text(QClipboard::Clipboard)
516 .normalized(QString::NormalizationForm_C);
517 LYXERR(Debug::ACTION, "GuiClipboard::getAsText(): `" << str << "'");
521 return internalLineEnding(qstring_to_ucs4(str));
525 void GuiClipboard::put(string const & lyx, docstring const & text)
527 LYXERR(Debug::ACTION, "GuiClipboard::put(`" << lyx << "' `"
528 << to_utf8(text) << "')");
529 // We don't convert the encoding of lyx since the encoding of the
530 // clipboard contents is specified in the data itself
531 QMimeData * data = new QMimeData;
533 QByteArray const qlyx(lyx.c_str(), lyx.size());
534 data->setData(lyx_mime_type, qlyx);
536 // Don't test for text.empty() since we want to be able to clear the
538 QString const qtext = toqstr(text);
539 data->setText(qtext);
540 qApp->clipboard()->setMimeData(data, QClipboard::Clipboard);
544 bool GuiClipboard::hasLyXContents() const
546 QMimeData const * const source =
547 qApp->clipboard()->mimeData(QClipboard::Clipboard);
548 return source && source->hasFormat(lyx_mime_type);
552 bool GuiClipboard::hasGraphicsContents(Clipboard::GraphicsType type) const
554 if (type == AnyGraphicsType) {
555 return hasGraphicsContents(PdfGraphicsType)
556 || hasGraphicsContents(PngGraphicsType)
557 || hasGraphicsContents(JpegGraphicsType)
558 || hasGraphicsContents(EmfGraphicsType)
559 || hasGraphicsContents(WmfGraphicsType)
560 || hasGraphicsContents(LinkBackGraphicsType);
563 QMimeData const * const source =
564 qApp->clipboard()->mimeData(QClipboard::Clipboard);
566 // handle image cases first
567 if (type == PngGraphicsType || type == JpegGraphicsType)
568 return source->hasImage();
570 // handle LinkBack for Mac
572 if (type == LinkBackGraphicsType)
573 return isLinkBackDataInPasteboard();
575 if (type == LinkBackGraphicsType)
580 QStringList const & formats = source->formats();
581 LYXERR(Debug::ACTION, "We found " << formats.size() << " formats");
582 for (int i = 0; i < formats.size(); ++i) {
583 LYXERR(Debug::ACTION, "Found format " << formats[i]);
586 // compute mime for type
589 case EmfGraphicsType: mime = emf_mime_type; break;
590 case WmfGraphicsType: mime = wmf_mime_type; break;
591 case PdfGraphicsType: mime = pdf_mime_type; break;
592 default: LASSERT(false, /**/);
595 return source && source->hasFormat(mime);
599 bool GuiClipboard::isInternal() const
601 // ownsClipboard() is also true for stuff coming from dialogs, e.g.
602 // the preamble dialog
603 // FIXME: This does only work on X11, since ownsClipboard() is
604 // hardwired to return false on Windows and OS X.
605 return qApp->clipboard()->ownsClipboard() && hasLyXContents();
609 bool GuiClipboard::hasInternal() const
611 // Windows and Mac OS X does not have the concept of ownership;
612 // the clipboard is a fully global resource so all applications
613 // are notified of changes.
614 #if (defined(Q_WS_X11))
622 void GuiClipboard::on_dataChanged()
624 QMimeData const * const source =
625 qApp->clipboard()->mimeData(QClipboard::Clipboard);
626 QStringList l = source->formats();
627 LYXERR(Debug::ACTION, "Qt Clipboard changed. We found the following mime types:");
628 for (int i = 0; i < l.count(); i++)
629 LYXERR(Debug::ACTION, l.value(i));
631 text_clipboard_empty_ = qApp->clipboard()->
632 text(QClipboard::Clipboard).isEmpty();
634 has_lyx_contents_ = hasLyXContents();
635 has_graphics_contents_ = hasGraphicsContents();
639 bool GuiClipboard::empty() const
641 // We need to check both the plaintext and the LyX version of the
642 // clipboard. The plaintext version is empty if the LyX version
643 // contains only one inset, and the LyX version is empty if the
644 // clipboard does not come from LyX.
645 if (!text_clipboard_empty_)
647 return !has_lyx_contents_ && !has_graphics_contents_;
650 } // namespace frontend
653 #include "GuiClipboard_moc.cpp"