X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ef3ab009984534c308ca0ee94cd3fcbccdc63448..c57e33394ca152e6e13f10363b76aef6e74a4705:/src/msw/clipbrd.cpp diff --git a/src/msw/clipbrd.cpp b/src/msw/clipbrd.cpp index 33407bebc0..5386a032e6 100644 --- a/src/msw/clipbrd.cpp +++ b/src/msw/clipbrd.cpp @@ -55,16 +55,31 @@ #include #include "wx/msw/private.h" + +#ifndef __WXMICROWIN__ #include "wx/msw/dib.h" +#endif + +// wxDataObject is tied to OLE/drag and drop implementation, therefore so are +// the functions using wxDataObject in wxClipboard +//#define wxUSE_DATAOBJ wxUSE_DRAG_AND_DROP -// wxDataObject is tied to OLE/drag and drop implementation, -// therefore so is wxClipboard :-( -#if wxUSE_DRAG_AND_DROP +#if wxUSE_DATAOBJ #include "wx/dataobj.h" +#endif - static bool wxSetClipboardData(wxDataObject *data); +#if wxUSE_OLE + // use OLE clipboard + #define wxUSE_OLE_CLIPBOARD 1 +#else // !wxUSE_DATAOBJ + // use Win clipboard API + #define wxUSE_OLE_CLIPBOARD 0 #endif +#if wxUSE_OLE_CLIPBOARD + #include +#endif // wxUSE_OLE_CLIPBOARD + #ifdef __WIN16__ #define memcpy hmemcpy #endif @@ -81,7 +96,7 @@ static bool gs_wxClipboardIsOpen = FALSE; bool wxOpenClipboard() { - wxCHECK_MSG( !gs_wxClipboardIsOpen, TRUE, _T("clipboard already opened.") ); + wxCHECK_MSG( !gs_wxClipboardIsOpen, TRUE, wxT("clipboard already opened.") ); wxWindow *win = wxTheApp->GetTopWindow(); if ( win ) @@ -95,7 +110,7 @@ bool wxOpenClipboard() } else { - wxLogDebug(_T("Can not open clipboard without a main window.")); + wxLogDebug(wxT("Can not open clipboard without a main window.")); return FALSE; } @@ -103,7 +118,7 @@ bool wxOpenClipboard() bool wxCloseClipboard() { - wxCHECK_MSG( gs_wxClipboardIsOpen, FALSE, _T("clipboard is not opened") ); + wxCHECK_MSG( gs_wxClipboardIsOpen, FALSE, wxT("clipboard is not opened") ); gs_wxClipboardIsOpen = FALSE; @@ -136,40 +151,28 @@ bool wxIsClipboardOpened() bool wxIsClipboardFormatAvailable(wxDataFormat dataFormat) { - return ::IsClipboardFormatAvailable(dataFormat) != 0; -} - -#if wxUSE_DRAG_AND_DROP -static bool wxSetClipboardData(wxDataObject *data) -{ - size_t size = data->GetDataSize(); - HANDLE hGlobal = ::GlobalAlloc(GMEM_MOVEABLE | GMEM_DDESHARE, size); - if ( !hGlobal ) + if ( ::IsClipboardFormatAvailable(dataFormat) ) { - wxLogSysError(_("Failed to allocate %dKb of memory for clipboard " - "transfer."), size / 1024); - - return FALSE; + // ok from the first try + return TRUE; } - LPVOID lpGlobalMemory = ::GlobalLock(hGlobal); - - data->GetDataHere(lpGlobalMemory); - - GlobalUnlock(hGlobal); - - wxDataFormat format = data->GetPreferredFormat(); - if ( !::SetClipboardData(format, hGlobal) ) + // for several standard formats, we can convert from some other ones too + switch ( dataFormat.GetFormatId() ) { - wxLogSysError(_("Failed to set clipboard data in format %s"), - wxDataObject::GetFormatName(format)); + // for bitmaps, DIBs will also do + case CF_BITMAP: + return ::IsClipboardFormatAvailable(CF_DIB) != 0; - return FALSE; - } +#if wxUSE_ENH_METAFILE && !defined(__WIN16__) + case CF_METAFILEPICT: + return ::IsClipboardFormatAvailable(CF_ENHMETAFILE) != 0; +#endif // wxUSE_ENH_METAFILE - return TRUE; + default: + return FALSE; + } } -#endif // wxUSE_DRAG_AND_DROP bool wxSetClipboardData(wxDataFormat dataFormat, const void *data, @@ -221,13 +224,16 @@ bool wxSetClipboardData(wxDataFormat dataFormat, wxBitmap *bitmap = (wxBitmap *)data; HBITMAP hBitmap = (HBITMAP)bitmap->GetHBITMAP(); // NULL palette means to use the system one - HANDLE hDIB = wxBitmapToDIB(hBitmap, (HPALETTE)NULL); + HANDLE hDIB = wxBitmapToDIB(hBitmap, (HPALETTE)NULL); handle = SetClipboardData(CF_DIB, hDIB); -#endif +#endif // wxUSE_IMAGE_LOADING_IN_MSW break; } -#if wxUSE_METAFILE + // VZ: I'm told that this code works, but it doesn't seem to work for me + // and, anyhow, I'd be highly surprized if it did. So I leave it here + // but IMNSHO it is completely broken. +#if wxUSE_METAFILE && !defined(wxMETAFILE_IS_ENH) case wxDF_METAFILE: { wxMetafile *wxMF = (wxMetafile *)data; @@ -244,7 +250,20 @@ bool wxSetClipboardData(wxDataFormat dataFormat, handle = SetClipboardData(CF_METAFILEPICT, data); break; } -#endif +#endif // wxUSE_METAFILE + +#if wxUSE_ENH_METAFILE && !defined(__WIN16__) + case wxDF_ENHMETAFILE: + { + wxEnhMetaFile *emf = (wxEnhMetaFile *)data; + wxEnhMetaFile emfCopy = *emf; + + handle = SetClipboardData(CF_ENHMETAFILE, + (void *)emfCopy.GetHENHMETAFILE()); + } + break; +#endif // wxUSE_ENH_METAFILE + case CF_SYLK: case CF_DIF: case CF_TIFF: @@ -338,7 +357,9 @@ void *wxGetClipboardData(wxDataFormat dataFormat, long *len) wxBM->SetWidth(bm.bmWidth); wxBM->SetHeight(bm.bmHeight); wxBM->SetDepth(bm.bmPlanes); +#if WXWIN_COMPATIBILITY_2 wxBM->SetOk(TRUE); +#endif // WXWIN_COMPATIBILITY_2 retval = wxBM; break; } @@ -417,7 +438,7 @@ void *wxGetClipboardData(wxDataFormat dataFormat, long *len) wxDataFormat wxEnumClipboardFormats(wxDataFormat dataFormat) { - return ::EnumClipboardFormats(dataFormat); + return (wxDataFormat::NativeFormat)::EnumClipboardFormats(dataFormat); } int wxRegisterClipboardFormat(wxChar *formatName) @@ -438,29 +459,73 @@ bool wxGetClipboardFormatName(wxDataFormat dataFormat, IMPLEMENT_DYNAMIC_CLASS(wxClipboard, wxObject) -wxClipboard* wxTheClipboard = (wxClipboard *)NULL; - wxClipboard::wxClipboard() { + m_clearOnExit = FALSE; } wxClipboard::~wxClipboard() { - Clear(); + if ( m_clearOnExit ) + { + Clear(); + } } void wxClipboard::Clear() { +#if wxUSE_OLE_CLIPBOARD + if ( FAILED(OleSetClipboard(NULL)) ) + { + wxLogLastError(wxT("OleSetClipboard(NULL)")); + } +#endif +} + +bool wxClipboard::Flush() +{ +#if wxUSE_OLE_CLIPBOARD + if ( FAILED(OleFlushClipboard()) ) + { + wxLogLastError(wxT("OleFlushClipboard")); + + return FALSE; + } + else + { + m_clearOnExit = FALSE; + + return TRUE; + } +#else // !wxUSE_OLE_CLIPBOARD + return FALSE; +#endif // wxUSE_OLE_CLIPBOARD/!wxUSE_OLE_CLIPBOARD } bool wxClipboard::Open() { + // OLE opens clipboard for us +#if wxUSE_OLE_CLIPBOARD + return TRUE; +#else return wxOpenClipboard(); +#endif +} + +bool wxClipboard::IsOpened() const +{ +#if wxUSE_OLE_CLIPBOARD + return TRUE; +#else + return wxIsClipboardOpened(); +#endif } bool wxClipboard::SetData( wxDataObject *data ) { +#if !wxUSE_OLE_CLIPBOARD (void)wxEmptyClipboard(); +#endif // wxUSE_OLE_CLIPBOARD if ( data ) return AddData(data); @@ -470,10 +535,35 @@ bool wxClipboard::SetData( wxDataObject *data ) bool wxClipboard::AddData( wxDataObject *data ) { - wxCHECK_MSG( data, FALSE, _T("data is invalid") ); + wxCHECK_MSG( data, FALSE, wxT("data is invalid") ); + +#if wxUSE_OLE_CLIPBOARD + HRESULT hr = OleSetClipboard(data->GetInterface()); + if ( FAILED(hr) ) + { + wxLogSysError(hr, _("Failed to put data on the clipboard")); + + // don't free anything in this case + + return FALSE; + } -#if wxUSE_DRAG_AND_DROP - wxCHECK_MSG( wxIsClipboardOpened(), FALSE, _T("clipboard not open") ); + // we have a problem here because we should delete wxDataObject, but we + // can't do it because IDataObject which we just gave to the clipboard + // would try to use it when it will need the data. IDataObject is ref + // counted and so doesn't suffer from such problem, so we release it now + // and tell it to delete wxDataObject when it is deleted itself. + data->SetAutoDelete(); + + // we have to call either OleSetClipboard(NULL) or OleFlushClipboard() when + // using OLE clipboard when the app terminates - by default, we call + // OleSetClipboard(NULL) which won't waste RAM, but the app can call + // wxClipboard::Flush() to chaneg this + m_clearOnExit = TRUE; + + return TRUE; +#elif wxUSE_DATAOBJ + wxCHECK_MSG( wxIsClipboardOpened(), FALSE, wxT("clipboard not open") ); wxDataFormat format = data->GetFormat(); @@ -498,7 +588,7 @@ bool wxClipboard::AddData( wxDataObject *data ) #if wxUSE_METAFILE case wxDF_METAFILE: { - wxMetafileDataObject* metaFileDataObject = + wxMetafileDataObject* metaFileDataObject = (wxMetafileDataObject*) data; wxMetafile metaFile = metaFileDataObject->GetMetafile(); return wxSetClipboardData(wxDF_METAFILE, &metaFile, @@ -510,14 +600,17 @@ bool wxClipboard::AddData( wxDataObject *data ) default: return wxSetClipboardData(data); } -#else // !wxUSE_DRAG_AND_DROP +#else // !wxUSE_DATAOBJ return FALSE; -#endif // wxUSE_DRAG_AND_DROP/!wxUSE_DRAG_AND_DROP +#endif // wxUSE_DATAOBJ/!wxUSE_DATAOBJ } void wxClipboard::Close() { + // OLE closes clipboard for us +#if !wxUSE_OLE_CLIPBOARD wxCloseClipboard(); +#endif } bool wxClipboard::IsSupported( wxDataFormat format ) @@ -525,99 +618,217 @@ bool wxClipboard::IsSupported( wxDataFormat format ) return wxIsClipboardFormatAvailable(format); } -bool wxClipboard::GetData( wxDataObject *data ) +bool wxClipboard::GetData( wxDataObject& data ) { - wxCHECK_MSG( wxIsClipboardOpened(), FALSE, _T("clipboard not open") ); +#if wxUSE_OLE_CLIPBOARD + IDataObject *pDataObject = NULL; + HRESULT hr = OleGetClipboard(&pDataObject); + if ( FAILED(hr) || !pDataObject ) + { + wxLogSysError(hr, _("Failed to get data from the clipboard")); -#if wxUSE_DRAG_AND_DROP - wxDataFormat format = data->GetFormat(); + return FALSE; + } + + // build the list of supported formats + size_t nFormats = data.GetFormatCount(wxDataObject::Set); + wxDataFormat format; + wxDataFormat *formats; + if ( nFormats == 1 ) + { + // the most common case + formats = &format; + } + else + { + // bad luck, need to alloc mem + formats = new wxDataFormat[nFormats]; + } + + data.GetAllFormats(formats, wxDataObject::Set); + + // get the format enumerator + bool result = FALSE; + wxArrayInt supportedFormats; + IEnumFORMATETC *pEnumFormatEtc = NULL; + hr = pDataObject->EnumFormatEtc(DATADIR_GET, &pEnumFormatEtc); + if ( FAILED(hr) || !pEnumFormatEtc ) + { + wxLogSysError(hr, + _("Failed to retrieve the supported clipboard formats")); + } + else + { + // ask for the supported formats and see if there are any we support + FORMATETC formatEtc; + for ( ;; ) + { + ULONG nCount; + hr = pEnumFormatEtc->Next(1, &formatEtc, &nCount); + + // don't use FAILED() because S_FALSE would pass it + if ( hr != S_OK ) + { + // no more formats + break; + } + + CLIPFORMAT cf = formatEtc.cfFormat; + +#ifdef __WXDEBUG__ + wxLogTrace(wxTRACE_OleCalls, + wxT("Object on the clipboard supports format %s."), + wxDataObject::GetFormatName(cf)); +#endif // Debug + + // is supported? + for ( size_t n = 0; n < nFormats; n++ ) + { + if ( formats[n].GetFormatId() == cf ) + { + if ( supportedFormats.Index(cf) == wxNOT_FOUND ) + { + supportedFormats.Add(cf); + } + } + } + } + + pEnumFormatEtc->Release(); + } + + if ( formats != &format ) + { + delete [] formats; + } + //else: we didn't allocate any memory + + if ( !supportedFormats.IsEmpty() ) + { + FORMATETC formatEtc; + formatEtc.ptd = NULL; + formatEtc.dwAspect = DVASPECT_CONTENT; + formatEtc.lindex = -1; + + size_t nSupportedFormats = supportedFormats.GetCount(); + for ( size_t n = 0; !result && (n < nSupportedFormats); n++ ) + { + STGMEDIUM medium; + formatEtc.cfFormat = supportedFormats[n]; + + // use the appropriate tymed + switch ( formatEtc.cfFormat ) + { + case CF_BITMAP: + formatEtc.tymed = TYMED_GDI; + break; + + case CF_METAFILEPICT: + formatEtc.tymed = TYMED_MFPICT; + break; + + case CF_ENHMETAFILE: + formatEtc.tymed = TYMED_ENHMF; + break; + + default: + formatEtc.tymed = TYMED_HGLOBAL; + } + + // try to get data + hr = pDataObject->GetData(&formatEtc, &medium); + if ( FAILED(hr) ) + { + // try other tymed for GDI objects + if ( formatEtc.cfFormat == CF_BITMAP ) + { + formatEtc.tymed = TYMED_HGLOBAL; + hr = pDataObject->GetData(&formatEtc, &medium); + } + } + + if ( SUCCEEDED(hr) ) + { + // pass the data to the data object + hr = data.GetInterface()->SetData(&formatEtc, &medium, TRUE); + if ( FAILED(hr) ) + { + wxLogDebug(wxT("Failed to set data in wxIDataObject")); + + // IDataObject only takes the ownership of data if it + // successfully got it - which is not the case here + ReleaseStgMedium(&medium); + } + else + { + result = TRUE; + } + } + //else: unsupported tymed? + } + } + //else: unsupported format + + // clean up and return + pDataObject->Release(); + + return result; +#elif wxUSE_DATAOBJ + wxCHECK_MSG( wxIsClipboardOpened(), FALSE, wxT("clipboard not open") ); + + wxDataFormat format = data.GetFormat(); switch ( format ) { case wxDF_TEXT: case wxDF_OEMTEXT: { - wxTextDataObject* textDataObject = (wxTextDataObject*) data; - char* s = (char*) wxGetClipboardData(format); - if ( s ) - { - textDataObject->SetText(s); - delete[] s; - return TRUE; - } - else + wxTextDataObject& textDataObject = (wxTextDataObject &)data; + char* s = (char*)wxGetClipboardData(format); + if ( !s ) return FALSE; + + textDataObject.SetText(s); + delete [] s; + + return TRUE; } case wxDF_BITMAP: case wxDF_DIB: { - wxBitmapDataObject* bitmapDataObject = (wxBitmapDataObject *)data; + wxBitmapDataObject& bitmapDataObject = (wxBitmapDataObject &)data; wxBitmap* bitmap = (wxBitmap *)wxGetClipboardData(data->GetFormat()); - if (bitmap) - { - bitmapDataObject->SetBitmap(* bitmap); - delete bitmap; - return TRUE; - } - else + if ( !bitmap ) return FALSE; + + bitmapDataObject.SetBitmap(*bitmap); + delete bitmap; + + return TRUE; } #if wxUSE_METAFILE case wxDF_METAFILE: { - wxMetafileDataObject* metaFileDataObject = (wxMetafileDataObject *)data; + wxMetafileDataObject& metaFileDataObject = (wxMetafileDataObject &)data; wxMetafile* metaFile = (wxMetafile *)wxGetClipboardData(wxDF_METAFILE); - if (metaFile) - { - metaFileDataObject->SetMetafile(*metaFile); - delete metaFile; - return TRUE; - } - else + if ( !metaFile ) return FALSE; - } -#endif - default: - { - long len; - void *buf = wxGetClipboardData(format, &len); - if ( buf ) - { - // FIXME this is for testing only!! - ((wxPrivateDataObject *)data)->SetData(buf, len); - free(buf); - return TRUE; - } - } + metaFileDataObject.SetMetafile(*metaFile); + delete metaFile; - return FALSE; + return TRUE; + } +#endif // wxUSE_METAFILE } -#else return FALSE; -#endif -} - -//----------------------------------------------------------------------------- -// wxClipboardModule -//----------------------------------------------------------------------------- - -IMPLEMENT_DYNAMIC_CLASS(wxClipboardModule,wxModule) - -bool wxClipboardModule::OnInit() -{ - wxTheClipboard = new wxClipboard(); - - return TRUE; -} - -void wxClipboardModule::OnExit() -{ - if (wxTheClipboard) delete wxTheClipboard; - wxTheClipboard = (wxClipboard*) NULL; +#else // !wxUSE_DATAOBJ + wxFAIL_MSG( wxT("no clipboard implementation") ); + return FALSE; +#endif // wxUSE_OLE_CLIPBOARD/wxUSE_DATAOBJ } #else - #error "Please turn wxUSE_CLIPBOARD on to compile this file." +// #error "Please turn wxUSE_CLIPBOARD on to compile this file." #endif // wxUSE_CLIPBOARD