vcl/qt5/Qt5Clipboard.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  */
  10
  11 #include <Qt5Clipboard.hxx>
  12 #include <Qt5Clipboard.moc>
  13
  14 #include <cppuhelper/supportsservice.hxx>
  15 #include <sal/log.hxx>
  16
  17 #include <QtWidgets/QApplication>
  18
  19 #include <Qt5Instance.hxx>
  20 #include <Qt5Transferable.hxx>
  21 #include <Qt5Tools.hxx>
  22
  23 #include <cassert>
  24 #include <map>
  25
  26 Qt5Clipboard::Qt5Clipboard(const OUString& aModeString, const QClipboard::Mode aMode)
  27     : cppu::WeakComponentImplHelper<css::datatransfer::clipboard::XSystemClipboard,
  28                                     css::datatransfer::clipboard::XFlushableClipboard,
  29                                     XServiceInfo>(m_aMutex)
  30     , m_aClipboardName(aModeString)
  31     , m_aClipboardMode(aMode)
  32     , m_bOwnClipboardChange(false)
  33 {
  34     assert(isSupported(m_aClipboardMode));
  35     // DirectConnection guarantees the changed slot runs in the same thread as the QClipboard
  36     connect(QApplication::clipboard(), &QClipboard::changed, this, &Qt5Clipboard::handleChanged,
  37             Qt::DirectConnection);
  38 }
  39
  40 css::uno::Reference<css::uno::XInterface> Qt5Clipboard::create(const OUString& aModeString)
  41 {
  42     static const std::map<OUString, QClipboard::Mode> aNameToClipboardMap
  43         = { { "CLIPBOARD", QClipboard::Clipboard }, { "PRIMARY", QClipboard::Selection } };
  44
  45     assert(QApplication::clipboard()->thread() == qApp->thread());
  46
  47     auto iter = aNameToClipboardMap.find(aModeString);
  48     if (iter != aNameToClipboardMap.end() && isSupported(iter->second))
  49         return static_cast<cppu::OWeakObject*>(new Qt5Clipboard(aModeString, iter->second));
  50     SAL_WARN("vcl.qt5", "Ignoring unrecognized clipboard type: '" << aModeString << "'");
  51     return css::uno::Reference<css::uno::XInterface>();
  52 }
  53
  54 void Qt5Clipboard::flushClipboard()
  55 {
  56     auto* pSalInst(static_cast<Qt5Instance*>(GetSalData()->m_pInstance));
  57     SolarMutexGuard g;
  58     pSalInst->RunInMainThread([&, this]() {
  59         if (!isOwner(m_aClipboardMode))
  60             return;
  61
  62         QClipboard* pClipboard = QApplication::clipboard();
  63         const Qt5MimeData* pQt5MimeData
  64             = dynamic_cast<const Qt5MimeData*>(pClipboard->mimeData(m_aClipboardMode));
  65         assert(pQt5MimeData);
  66
  67         QMimeData* pMimeCopy = nullptr;
  68         if (pQt5MimeData && pQt5MimeData->deepCopy(&pMimeCopy))
  69         {
  70             m_bOwnClipboardChange = true;
  71             pClipboard->setMimeData(pMimeCopy, m_aClipboardMode);
  72             m_bOwnClipboardChange = false;
  73         }
  74     });
  75 }
  76
  77 css::uno::Reference<css::datatransfer::XTransferable> Qt5Clipboard::getContents()
  78 {
  79     osl::MutexGuard aGuard(m_aMutex);
  80
  81     // if we're the owner, we might have the XTransferable from setContents. but
  82     // maybe a non-LO clipboard change from within LO, like some C'n'P in the
  83     // QFileDialog, might have invalidated m_aContents, so we need to check it too.
  84     if (isOwner(m_aClipboardMode) && m_aContents.is())
  85         return m_aContents;
  86
  87     // check if we can still use the shared Qt5ClipboardTransferable
  88     const QMimeData* pMimeData = QApplication::clipboard()->mimeData(m_aClipboardMode);
  89     if (m_aContents.is())
  90     {
  91         const auto* pTrans = dynamic_cast<Qt5ClipboardTransferable*>(m_aContents.get());
  92         assert(pTrans);
  93         if (pTrans && pTrans->mimeData() == pMimeData)
  94             return m_aContents;
  95     }
  96
  97     m_aContents = new Qt5ClipboardTransferable(m_aClipboardMode, pMimeData);
  98     return m_aContents;
  99 }
 100
 101 void Qt5Clipboard::setContents(
 102     const css::uno::Reference<css::datatransfer::XTransferable>& xTrans,
 103     const css::uno::Reference<css::datatransfer::clipboard::XClipboardOwner>& xClipboardOwner)
 104 {
 105     // it's actually possible to get a non-empty xTrans and an empty xClipboardOwner!
 106     osl::ClearableMutexGuard aGuard(m_aMutex);
 107
 108     css::uno::Reference<css::datatransfer::clipboard::XClipboardOwner> xOldOwner(m_aOwner);
 109     css::uno::Reference<css::datatransfer::XTransferable> xOldContents(m_aContents);
 110     m_aContents = xTrans;
 111     m_aOwner = xClipboardOwner;
 112
 113     m_bOwnClipboardChange = true;
 114     if (m_aContents.is())
 115         QApplication::clipboard()->setMimeData(new Qt5MimeData(m_aContents), m_aClipboardMode);
 116     else
 117     {
 118         assert(!m_aOwner.is());
 119         QApplication::clipboard()->clear(m_aClipboardMode);
 120     }
 121     m_bOwnClipboardChange = false;
 122
 123     aGuard.clear();
 124
 125     // we have to notify only an owner change, since handleChanged can't
 126     // access the previous owner anymore and can just handle lost ownership.
 127     if (xOldOwner.is() && xOldOwner != xClipboardOwner)
 128         xOldOwner->lostOwnership(this, xOldContents);
 129 }
 130
 131 void Qt5Clipboard::handleChanged(QClipboard::Mode aMode)
 132 {
 133     if (aMode != m_aClipboardMode)
 134         return;
 135
 136     osl::ClearableMutexGuard aGuard(m_aMutex);
 137
 138     css::uno::Reference<css::datatransfer::clipboard::XClipboardOwner> xOldOwner(m_aOwner);
 139     css::uno::Reference<css::datatransfer::XTransferable> xOldContents(m_aContents);
 140     // ownership change from LO POV is handled in setContents
 141     if (!m_bOwnClipboardChange)
 142     {
 143         m_aContents.clear();
 144         m_aOwner.clear();
 145     }
 146
 147     std::vector<css::uno::Reference<css::datatransfer::clipboard::XClipboardListener>> aListeners(
 148         m_aListeners);
 149     css::datatransfer::clipboard::ClipboardEvent aEv;
 150     aEv.Contents = getContents();
 151
 152     aGuard.clear();
 153
 154     if (!m_bOwnClipboardChange && xOldOwner.is())
 155         xOldOwner->lostOwnership(this, xOldContents);
 156     for (auto const& listener : aListeners)
 157         listener->changedContents(aEv);
 158 }
 159
 160 OUString Qt5Clipboard::getImplementationName() { return "com.sun.star.datatransfer.Qt5Clipboard"; }
 161
 162 css::uno::Sequence<OUString> Qt5Clipboard::getSupportedServiceNames()
 163 {
 164     return { "com.sun.star.datatransfer.clipboard.SystemClipboard" };
 165 }
 166
 167 sal_Bool Qt5Clipboard::supportsService(const OUString& ServiceName)
 168 {
 169     return cppu::supportsService(this, ServiceName);
 170 }
 171
 172 OUString Qt5Clipboard::getName() { return m_aClipboardName; }
 173
 174 sal_Int8 Qt5Clipboard::getRenderingCapabilities() { return 0; }
 175
 176 void Qt5Clipboard::addClipboardListener(
 177     const css::uno::Reference<css::datatransfer::clipboard::XClipboardListener>& listener)
 178 {
 179     osl::MutexGuard aGuard(m_aMutex);
 180     m_aListeners.push_back(listener);
 181 }
 182
 183 void Qt5Clipboard::removeClipboardListener(
 184     const css::uno::Reference<css::datatransfer::clipboard::XClipboardListener>& listener)
 185 {
 186     osl::MutexGuard aGuard(m_aMutex);
 187     m_aListeners.erase(std::remove(m_aListeners.begin(), m_aListeners.end(), listener),
 188                        m_aListeners.end());
 189 }
 190
 191 bool Qt5Clipboard::isSupported(const QClipboard::Mode aMode)
 192 {
 193     const QClipboard* pClipboard = QApplication::clipboard();
 194     switch (aMode)
 195     {
 196         case QClipboard::Selection:
 197             return pClipboard->supportsSelection();
 198
 199         case QClipboard::FindBuffer:
 200             return pClipboard->supportsFindBuffer();
 201
 202         case QClipboard::Clipboard:
 203             return true;
 204     }
 205     return false;
 206 }
 207
 208 bool Qt5Clipboard::isOwner(const QClipboard::Mode aMode)
 209 {
 210     if (!isSupported(aMode))
 211         return false;
 212
 213     const QClipboard* pClipboard = QApplication::clipboard();
 214     switch (aMode)
 215     {
 216         case QClipboard::Selection:
 217             return pClipboard->ownsSelection();
 218
 219         case QClipboard::FindBuffer:
 220             return pClipboard->ownsFindBuffer();
 221
 222         case QClipboard::Clipboard:
 223             return pClipboard->ownsClipboard();
 224     }
 225     return false;
 226 }
 227
 228 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */