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"
20 #include "frontends/alert.h"
23 #include "BufferView.h"
26 #include "support/convert.h"
27 #include "support/debug.h"
28 #include "support/filetools.h"
29 #include "support/FileFilterList.h"
30 #include "support/gettext.h"
31 #include "support/lstrings.h"
33 #include <QApplication>
36 #include <QDataStream>
39 #include <QMacPasteboardMime>
42 #include <QStringList>
45 #include <QWindowsMime>
52 #include "boost/assert.hpp"
57 #include "support/linkback/LinkBackProxy.h"
61 using namespace lyx::support;
63 static char const * const lyx_mime_type = "application/x-lyx";
64 static char const * const pdf_mime_type = "application/pdf";
65 static char const * const emf_mime_type = "image/x-emf";
66 static char const * const wmf_mime_type = "image/x-wmf";
74 static FORMATETC cfFromMime(QString const & mimetype)
77 if (mimetype == emf_mime_type) {
78 formatetc.cfFormat = CF_ENHMETAFILE;
79 formatetc.tymed = TYMED_ENHMF;
80 } else if (mimetype == wmf_mime_type) {
81 formatetc.cfFormat = CF_METAFILEPICT;
82 formatetc.tymed = TYMED_MFPICT;
85 formatetc.dwAspect = DVASPECT_CONTENT;
86 formatetc.lindex = -1;
91 class QWindowsMimeMetafile : public QWindowsMime {
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;
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 " << fromqstr(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 " << fromqstr(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;
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 closeAllLinkBackLinks();
271 string const GuiClipboard::getAsLyX() const
273 LYXERR(Debug::ACTION, "GuiClipboard::getAsLyX(): `");
274 // We don't convert encodings here since the encoding of the
275 // clipboard contents is specified in the data itself
276 QMimeData const * source =
277 qApp->clipboard()->mimeData(QClipboard::Clipboard);
279 LYXERR(Debug::ACTION, "' (no QMimeData)");
283 if (source->hasFormat(lyx_mime_type)) {
284 // data from ourself or some other LyX instance
285 QByteArray const ar = source->data(lyx_mime_type);
286 string const s(ar.data(), ar.count());
287 LYXERR(Debug::ACTION, s << "'");
290 LYXERR(Debug::ACTION, "'");
295 FileName GuiClipboard::getPastedGraphicsFileName(Cursor const & cur,
296 Clipboard::GraphicsType & type) const
298 // create file dialog filter according to the existing types in the clipboard
299 vector<Clipboard::GraphicsType> types;
300 if (hasGraphicsContents(Clipboard::EmfGraphicsType))
301 types.push_back(Clipboard::EmfGraphicsType);
302 if (hasGraphicsContents(Clipboard::WmfGraphicsType))
303 types.push_back(Clipboard::WmfGraphicsType);
304 if (hasGraphicsContents(Clipboard::LinkBackGraphicsType))
305 types.push_back(Clipboard::LinkBackGraphicsType);
306 if (hasGraphicsContents(Clipboard::PdfGraphicsType))
307 types.push_back(Clipboard::PdfGraphicsType);
308 if (hasGraphicsContents(Clipboard::PngGraphicsType))
309 types.push_back(Clipboard::PngGraphicsType);
310 if (hasGraphicsContents(Clipboard::JpegGraphicsType))
311 types.push_back(Clipboard::JpegGraphicsType);
313 BOOST_ASSERT(!types.empty());
315 // select prefered type if AnyGraphicsType was passed
316 if (type == Clipboard::AnyGraphicsType)
317 type = types.front();
320 map<Clipboard::GraphicsType, string> extensions;
321 map<Clipboard::GraphicsType, docstring> typeNames;
323 extensions[Clipboard::EmfGraphicsType] = "emf";
324 extensions[Clipboard::WmfGraphicsType] = "wmf";
325 extensions[Clipboard::LinkBackGraphicsType] = "linkback";
326 extensions[Clipboard::PdfGraphicsType] = "pdf";
327 extensions[Clipboard::PngGraphicsType] = "png";
328 extensions[Clipboard::JpegGraphicsType] = "jpeg";
330 typeNames[Clipboard::EmfGraphicsType] = _("Enhanced Metafile");
331 typeNames[Clipboard::WmfGraphicsType] = _("Windows Metafile");
332 typeNames[Clipboard::LinkBackGraphicsType] = _("LinkBack PDF");
333 typeNames[Clipboard::PdfGraphicsType] = _("PDF");
334 typeNames[Clipboard::PngGraphicsType] = _("PNG");
335 typeNames[Clipboard::JpegGraphicsType] = _("JPEG");
337 // find unused filename with primary extension
338 string document_path = cur.buffer().fileName().onlyPath().absFilename();
339 unsigned newfile_number = 0;
343 filename = FileName(addName(document_path,
345 + convert<string>(newfile_number) + "."
346 + extensions[type]));
347 } while (filename.isReadableFile());
350 // create file type filter, putting the prefered on to the front
351 docstring filterSpec;
352 for (size_t i = 0; i != types.size(); ++i) {
353 docstring s = bformat(_("%1$s Files"), typeNames[types[i]])
354 + " (*." + from_ascii(extensions[types[i]]) + ")";
355 if (types[i] == type)
356 filterSpec = s + filterSpec;
358 filterSpec += ";;" + s;
360 FileFilterList const filter(filterSpec);
362 // show save dialog for the graphic
363 FileDialog dlg(qt_("Choose a filename to save the pasted graphic as"));
364 FileDialog::Result result =
365 dlg.save(toqstr(filename.onlyPath().absFilename()), filter,
366 toqstr(filename.onlyFileName()));
368 if (result.first == FileDialog::Later)
371 string newFilename = fromqstr(result.second);
372 if (newFilename.empty()) {
373 cur.bv().message(_("Canceled."));
376 filename.set(newFilename);
378 // check the extension (the user could have changed it)
379 if (!suffixIs(ascii_lowercase(filename.absFilename()),
380 "." + extensions[type])) {
381 // the user changed the extension. Check if the type is available
383 for (i = 1; i != types.size(); ++i) {
384 if (suffixIs(ascii_lowercase(filename.absFilename()),
385 "." + extensions[types[i]])) {
391 // invalid extension found, or none at all. In the latter
392 // case set the default extensions.
393 if (i == types.size()
394 && filename.onlyFileName().find('.') == string::npos) {
395 filename.changeExtension("." + extensions[type]);
399 // check whether the file exists and warn the user
400 if (!filename.exists())
402 int ret = frontend::Alert::prompt(
403 _("Overwrite external file?"),
404 bformat(_("File %1$s already exists, do you want to overwrite it?"),
405 from_utf8(filename.absFilename())), 1, 1, _("&Overwrite"), _("&Cancel"));
407 // overwrite, hence break the dialog loop
410 // not overwrite, hence show the dialog again (i.e. loop)
417 FileName GuiClipboard::getAsGraphics(Cursor const & cur, GraphicsType type) const
419 // get the filename from the user
420 FileName filename = getPastedGraphicsFileName(cur, type);
421 if (filename.empty())
424 // handle image cases first
425 if (type == PngGraphicsType || type == JpegGraphicsType) {
426 // get image from QImage from clipboard
427 QImage image = qApp->clipboard()->image();
428 if (image.isNull()) {
429 LYXERR(Debug::ACTION, "No image in clipboard");
433 // convert into graphics format
436 buffer.open(QIODevice::WriteOnly);
437 if (type == PngGraphicsType)
438 image.save(toqstr(filename.absFilename()), "PNG");
439 else if (type == JpegGraphicsType)
440 image.save(toqstr(filename.absFilename()), "JPEG");
448 QMimeData const * source =
449 qApp->clipboard()->mimeData(QClipboard::Clipboard);
451 LYXERR(Debug::ACTION, "0 bytes (no QMimeData)");
458 case PdfGraphicsType: mime = pdf_mime_type; break;
459 case LinkBackGraphicsType: mime = pdf_mime_type; break;
460 case EmfGraphicsType: mime = emf_mime_type; break;
461 case WmfGraphicsType: mime = wmf_mime_type; break;
462 default: BOOST_ASSERT(false);
466 if (!source->hasFormat(mime))
468 // data from ourself or some other LyX instance
469 QByteArray const ar = source->data(mime);
470 LYXERR(Debug::ACTION, "Getting from clipboard: mime = " << mime.data()
471 << "length = " << ar.count());
473 QFile f(toqstr(filename.absFilename()));
474 if (!f.open(QIODevice::WriteOnly | QIODevice::Truncate)) {
475 LYXERR(Debug::ACTION, "Error opening file "
476 << filename.absFilename() << " for writing");
480 // write the (LinkBack) PDF data
482 if (type == LinkBackGraphicsType) {
484 void const * linkBackData;
485 unsigned linkBackLen;
486 getLinkBackData(&linkBackData, &linkBackLen);
487 f.write((char *)linkBackData, linkBackLen);
488 quint32 pdfLen = ar.size();
490 ds << pdfLen; // big endian by default
492 // only non-Mac this should never happen
502 docstring const GuiClipboard::getAsText() const
504 // text data from other applications
505 QString const str = qApp->clipboard()->text(QClipboard::Clipboard)
506 .normalized(QString::NormalizationForm_C);
507 LYXERR(Debug::ACTION, "GuiClipboard::getAsText(): `" << fromqstr(str) << "'");
511 return internalLineEnding(qstring_to_ucs4(str));
515 void GuiClipboard::put(string const & lyx, docstring const & text)
517 LYXERR(Debug::ACTION, "GuiClipboard::put(`" << lyx << "' `"
518 << to_utf8(text) << "')");
519 // We don't convert the encoding of lyx since the encoding of the
520 // clipboard contents is specified in the data itself
521 QMimeData * data = new QMimeData;
523 QByteArray const qlyx(lyx.c_str(), lyx.size());
524 data->setData(lyx_mime_type, qlyx);
526 // Don't test for text.empty() since we want to be able to clear the
528 QString const qtext = toqstr(text);
529 data->setText(qtext);
530 qApp->clipboard()->setMimeData(data, QClipboard::Clipboard);
534 bool GuiClipboard::hasLyXContents() const
536 QMimeData const * const source =
537 qApp->clipboard()->mimeData(QClipboard::Clipboard);
538 return source && source->hasFormat(lyx_mime_type);
542 bool GuiClipboard::hasGraphicsContents(Clipboard::GraphicsType type) const
544 if (type == AnyGraphicsType) {
545 return hasGraphicsContents(PdfGraphicsType)
546 || hasGraphicsContents(PngGraphicsType)
547 || hasGraphicsContents(JpegGraphicsType)
548 || hasGraphicsContents(EmfGraphicsType)
549 || hasGraphicsContents(WmfGraphicsType)
550 || hasGraphicsContents(LinkBackGraphicsType);
553 QMimeData const * const source =
554 qApp->clipboard()->mimeData(QClipboard::Clipboard);
556 // handle image cases first
557 if (type == PngGraphicsType || type == JpegGraphicsType)
558 return source->hasImage();
560 // handle LinkBack for Mac
562 if (type == LinkBackGraphicsType)
563 return isLinkBackDataInPasteboard();
565 if (type == LinkBackGraphicsType)
570 QStringList const & formats = source->formats();
571 LYXERR(Debug::ACTION, "We found " << formats.size() << " formats");
572 for (int i = 0; i < formats.size(); ++i) {
573 LYXERR(Debug::ACTION, "Found format " << fromqstr(formats[i]));
576 // compute mime for type
579 case EmfGraphicsType: mime = emf_mime_type; break;
580 case WmfGraphicsType: mime = wmf_mime_type; break;
581 case PdfGraphicsType: mime = pdf_mime_type; break;
582 default: BOOST_ASSERT(false);
585 return source && source->hasFormat(mime);
589 bool GuiClipboard::isInternal() const
591 // ownsClipboard() is also true for stuff coming from dialogs, e.g.
592 // the preamble dialog
593 // FIXME: This does only work on X11, since ownsClipboard() is
594 // hardwired to return false on Windows and OS X.
595 return qApp->clipboard()->ownsClipboard() && hasLyXContents();
599 bool GuiClipboard::hasInternal() const
601 // Windows and Mac OS X does not have the concept of ownership;
602 // the clipboard is a fully global resource so all applications
603 // are notified of changes.
604 #if (defined(Q_WS_X11))
612 void GuiClipboard::on_dataChanged()
614 QMimeData const * const source =
615 qApp->clipboard()->mimeData(QClipboard::Clipboard);
616 QStringList l = source->formats();
617 LYXERR(Debug::ACTION, "Qt Clipboard changed. We found the following mime types:");
618 for (int i = 0; i < l.count(); i++) {
619 LYXERR(Debug::ACTION, fromqstr(l.value(i)));
622 text_clipboard_empty_ = qApp->clipboard()->
623 text(QClipboard::Clipboard).isEmpty();
625 has_lyx_contents_ = hasLyXContents();
626 has_graphics_contents_ = hasGraphicsContents();
630 bool GuiClipboard::empty() const
632 // We need to check both the plaintext and the LyX version of the
633 // clipboard. The plaintext version is empty if the LyX version
634 // contains only one inset, and the LyX version is empty if the
635 // clipboard does not come from LyX.
636 if (!text_clipboard_empty_)
638 return !has_lyx_contents_ && !has_graphics_contents_;
641 } // namespace frontend
644 #include "GuiClipboard_moc.cpp"